d8dfun/virtual-kubelet
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Vendor aws-sdk-go (dep ensure) (#178)

Browse Source
This commit is contained in:
Onur Filiz
2018-04-27 18:18:36 -07:00
committed by Robbie Zhang
parent 228a1f7a5f
commit 8d67098d06
2785 changed files with 1973570 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -0,0 +1,838 @@
{
"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"
]
},
"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/AWSMigrationHub/2017-05-31/docs-2.json generated vendored Normal file
View File

@@ -0,0 +1,497 @@
{
"version": "2.0",
"service": "<p>The AWS Migration Hub API methods help to obtain server and application migration status and integrate your resource-specific migration tool by providing a programmatic interface to Migration Hub. </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 delete 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> <ul> <li> <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> </li> <li> <p>Note the instructions regarding the special use case of the <code>ResourceAttributeList</code> parameter when specifying any \"VM\" related value.</p> </li> </ul> </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>ListDiscoveredResources</code>.</p> </note>"
},
"shapes": {
"AccessDeniedException": {
"base": "<p>You do not have sufficient access to perform this action.</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>migrationhub-discovery</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> <p>Note the corresponding format required per type listed below:</p> <dl> <dt>IPV4</dt> <dd> <p> <code>x.x.x.x</code> </p> <p> <i>where x is an integer in the range [0,255]</i> </p> </dd> <dt>IPV6</dt> <dd> <p> <code>y : y : y : y : y : y : y : y</code> </p> <p> <i>where y is a hexadecimal between 0 and FFFF. [0, FFFF]</i> </p> </dd> <dt>MAC_ADDRESS</dt> <dd> <p> <code>^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$</code> </p> </dd> <dt>FQDN</dt> <dd> <p> <code>^[^&lt;&gt;{}\\\\\\\\/?,=\\\\p{Cntrl}]{1,256}$</code> </p> </dd> </dl>",
"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> <note> <p>In the <code>ResourceAttribute</code> object array, the <code>Type</code> field is reserved for the following values: <code>IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER</code>, and the identifying value can be a string up to 256 characters.</p> </note> <important> <p>If any \"VM\" related value is used for a <code>ResourceAttribute</code> object, it is required that <code>VM_MANAGER_ID</code>, as a minimum, is always used. If it is not used, the server will not be associated in the Application Discovery Service (ADS)'s repository using any of the other \"VM\" related values, and you will experience data loss. See the Example section below for a use case of specifying \"VM\" related values.</p> </important>"
}
},
"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 there is an internal, configuration, or dependency error encountered.</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/AWSMigrationHub/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/AWSMigrationHub/2017-05-31/paginators-1.json generated vendored Normal file
View File

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

905
vendor/github.com/aws/aws-sdk-go/models/apis/acm-pca/2017-08-22/api-2.json generated vendored Normal file
View File

@@ -0,0 +1,905 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2017-08-22",
"endpointPrefix":"acm-pca",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"ACM-PCA",
"serviceFullName":"AWS Certificate Manager Private Certificate Authority",
"serviceId":"ACM PCA",
"signatureVersion":"v4",
"targetPrefix":"ACMPrivateCA",
"uid":"acm-pca-2017-08-22"
},
"operations":{
"CreateCertificateAuthority":{
"name":"CreateCertificateAuthority",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateCertificateAuthorityRequest"},
"output":{"shape":"CreateCertificateAuthorityResponse"},
"errors":[
{"shape":"InvalidArgsException"},
{"shape":"InvalidPolicyException"},
{"shape":"LimitExceededException"}
],
"idempotent":true
},
"CreateCertificateAuthorityAuditReport":{
"name":"CreateCertificateAuthorityAuditReport",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateCertificateAuthorityAuditReportRequest"},
"output":{"shape":"CreateCertificateAuthorityAuditReportResponse"},
"errors":[
{"shape":"RequestInProgressException"},
{"shape":"RequestFailedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidArgsException"},
{"shape":"InvalidStateException"}
],
"idempotent":true
},
"DeleteCertificateAuthority":{
"name":"DeleteCertificateAuthority",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteCertificateAuthorityRequest"},
"errors":[
{"shape":"ConcurrentModificationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidStateException"}
]
},
"DescribeCertificateAuthority":{
"name":"DescribeCertificateAuthority",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeCertificateAuthorityRequest"},
"output":{"shape":"DescribeCertificateAuthorityResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"}
]
},
"DescribeCertificateAuthorityAuditReport":{
"name":"DescribeCertificateAuthorityAuditReport",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeCertificateAuthorityAuditReportRequest"},
"output":{"shape":"DescribeCertificateAuthorityAuditReportResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArgsException"}
]
},
"GetCertificate":{
"name":"GetCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetCertificateRequest"},
"output":{"shape":"GetCertificateResponse"},
"errors":[
{"shape":"RequestInProgressException"},
{"shape":"RequestFailedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidStateException"}
]
},
"GetCertificateAuthorityCertificate":{
"name":"GetCertificateAuthorityCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetCertificateAuthorityCertificateRequest"},
"output":{"shape":"GetCertificateAuthorityCertificateResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidStateException"},
{"shape":"InvalidArnException"}
]
},
"GetCertificateAuthorityCsr":{
"name":"GetCertificateAuthorityCsr",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetCertificateAuthorityCsrRequest"},
"output":{"shape":"GetCertificateAuthorityCsrResponse"},
"errors":[
{"shape":"RequestInProgressException"},
{"shape":"RequestFailedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"}
]
},
"ImportCertificateAuthorityCertificate":{
"name":"ImportCertificateAuthorityCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ImportCertificateAuthorityCertificateRequest"},
"errors":[
{"shape":"ConcurrentModificationException"},
{"shape":"RequestInProgressException"},
{"shape":"RequestFailedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"},
{"shape":"MalformedCertificateException"},
{"shape":"CertificateMismatchException"}
]
},
"IssueCertificate":{
"name":"IssueCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"IssueCertificateRequest"},
"output":{"shape":"IssueCertificateResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidStateException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidArgsException"},
{"shape":"MalformedCSRException"}
],
"idempotent":true
},
"ListCertificateAuthorities":{
"name":"ListCertificateAuthorities",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListCertificateAuthoritiesRequest"},
"output":{"shape":"ListCertificateAuthoritiesResponse"},
"errors":[
{"shape":"InvalidNextTokenException"}
]
},
"ListTags":{
"name":"ListTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsRequest"},
"output":{"shape":"ListTagsResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"}
]
},
"RevokeCertificate":{
"name":"RevokeCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RevokeCertificateRequest"},
"errors":[
{"shape":"ConcurrentModificationException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidStateException"},
{"shape":"ResourceNotFoundException"},
{"shape":"RequestAlreadyProcessedException"},
{"shape":"RequestInProgressException"},
{"shape":"RequestFailedException"}
]
},
"TagCertificateAuthority":{
"name":"TagCertificateAuthority",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagCertificateAuthorityRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidTagException"},
{"shape":"TooManyTagsException"}
]
},
"UntagCertificateAuthority":{
"name":"UntagCertificateAuthority",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagCertificateAuthorityRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidTagException"}
]
},
"UpdateCertificateAuthority":{
"name":"UpdateCertificateAuthority",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateCertificateAuthorityRequest"},
"errors":[
{"shape":"ConcurrentModificationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArgsException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidStateException"},
{"shape":"InvalidPolicyException"}
]
}
},
"shapes":{
"ASN1Subject":{
"type":"structure",
"members":{
"Country":{"shape":"CountryCodeString"},
"Organization":{"shape":"String64"},
"OrganizationalUnit":{"shape":"String64"},
"DistinguishedNameQualifier":{"shape":"DistinguishedNameQualifierString"},
"State":{"shape":"String128"},
"CommonName":{"shape":"String64"},
"SerialNumber":{"shape":"String64"},
"Locality":{"shape":"String128"},
"Title":{"shape":"String64"},
"Surname":{"shape":"String40"},
"GivenName":{"shape":"String16"},
"Initials":{"shape":"String5"},
"Pseudonym":{"shape":"String128"},
"GenerationQualifier":{"shape":"String3"}
}
},
"Arn":{
"type":"string",
"max":200,
"min":5,
"pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=/,.@-]+)*"
},
"AuditReportId":{
"type":"string",
"max":36,
"min":36,
"pattern":"[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}"
},
"AuditReportResponseFormat":{
"type":"string",
"enum":[
"JSON",
"CSV"
]
},
"AuditReportStatus":{
"type":"string",
"enum":[
"CREATING",
"SUCCESS",
"FAILED"
]
},
"Boolean":{"type":"boolean"},
"CertificateAuthorities":{
"type":"list",
"member":{"shape":"CertificateAuthority"}
},
"CertificateAuthority":{
"type":"structure",
"members":{
"Arn":{"shape":"Arn"},
"CreatedAt":{"shape":"TStamp"},
"LastStateChangeAt":{"shape":"TStamp"},
"Type":{"shape":"CertificateAuthorityType"},
"Serial":{"shape":"String"},
"Status":{"shape":"CertificateAuthorityStatus"},
"NotBefore":{"shape":"TStamp"},
"NotAfter":{"shape":"TStamp"},
"FailureReason":{"shape":"FailureReason"},
"CertificateAuthorityConfiguration":{"shape":"CertificateAuthorityConfiguration"},
"RevocationConfiguration":{"shape":"RevocationConfiguration"}
}
},
"CertificateAuthorityConfiguration":{
"type":"structure",
"required":[
"KeyAlgorithm",
"SigningAlgorithm",
"Subject"
],
"members":{
"KeyAlgorithm":{"shape":"KeyAlgorithm"},
"SigningAlgorithm":{"shape":"SigningAlgorithm"},
"Subject":{"shape":"ASN1Subject"}
}
},
"CertificateAuthorityStatus":{
"type":"string",
"enum":[
"CREATING",
"PENDING_CERTIFICATE",
"ACTIVE",
"DISABLED",
"EXPIRED",
"FAILED"
]
},
"CertificateAuthorityType":{
"type":"string",
"enum":["SUBORDINATE"]
},
"CertificateBody":{"type":"string"},
"CertificateBodyBlob":{
"type":"blob",
"max":32768,
"min":1
},
"CertificateChain":{"type":"string"},
"CertificateChainBlob":{
"type":"blob",
"max":2097152,
"min":0
},
"CertificateMismatchException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"ConcurrentModificationException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"CountryCodeString":{
"type":"string",
"pattern":"[A-Za-z]{2}"
},
"CreateCertificateAuthorityAuditReportRequest":{
"type":"structure",
"required":[
"CertificateAuthorityArn",
"S3BucketName",
"AuditReportResponseFormat"
],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"S3BucketName":{"shape":"String"},
"AuditReportResponseFormat":{"shape":"AuditReportResponseFormat"}
}
},
"CreateCertificateAuthorityAuditReportResponse":{
"type":"structure",
"members":{
"AuditReportId":{"shape":"AuditReportId"},
"S3Key":{"shape":"String"}
}
},
"CreateCertificateAuthorityRequest":{
"type":"structure",
"required":[
"CertificateAuthorityConfiguration",
"CertificateAuthorityType"
],
"members":{
"CertificateAuthorityConfiguration":{"shape":"CertificateAuthorityConfiguration"},
"RevocationConfiguration":{"shape":"RevocationConfiguration"},
"CertificateAuthorityType":{"shape":"CertificateAuthorityType"},
"IdempotencyToken":{"shape":"IdempotencyToken"}
}
},
"CreateCertificateAuthorityResponse":{
"type":"structure",
"members":{
"CertificateAuthorityArn":{"shape":"Arn"}
}
},
"CrlConfiguration":{
"type":"structure",
"required":["Enabled"],
"members":{
"Enabled":{
"shape":"Boolean",
"box":true
},
"ExpirationInDays":{
"shape":"Integer1To5000",
"box":true
},
"CustomCname":{"shape":"String253"},
"S3BucketName":{"shape":"String3To255"}
}
},
"CsrBlob":{
"type":"blob",
"max":32768,
"min":1
},
"CsrBody":{"type":"string"},
"DeleteCertificateAuthorityRequest":{
"type":"structure",
"required":["CertificateAuthorityArn"],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"}
}
},
"DescribeCertificateAuthorityAuditReportRequest":{
"type":"structure",
"required":[
"CertificateAuthorityArn",
"AuditReportId"
],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"AuditReportId":{"shape":"AuditReportId"}
}
},
"DescribeCertificateAuthorityAuditReportResponse":{
"type":"structure",
"members":{
"AuditReportStatus":{"shape":"AuditReportStatus"},
"S3BucketName":{"shape":"String"},
"S3Key":{"shape":"String"},
"CreatedAt":{"shape":"TStamp"}
}
},
"DescribeCertificateAuthorityRequest":{
"type":"structure",
"required":["CertificateAuthorityArn"],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"}
}
},
"DescribeCertificateAuthorityResponse":{
"type":"structure",
"members":{
"CertificateAuthority":{"shape":"CertificateAuthority"}
}
},
"DistinguishedNameQualifierString":{
"type":"string",
"max":64,
"min":0,
"pattern":"[a-zA-Z0-9'()+-.?:/= ]*"
},
"FailureReason":{
"type":"string",
"enum":[
"REQUEST_TIMED_OUT",
"UNSUPPORTED_ALGORITHM",
"OTHER"
]
},
"GetCertificateAuthorityCertificateRequest":{
"type":"structure",
"required":["CertificateAuthorityArn"],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"}
}
},
"GetCertificateAuthorityCertificateResponse":{
"type":"structure",
"members":{
"Certificate":{"shape":"CertificateBody"},
"CertificateChain":{"shape":"CertificateChain"}
}
},
"GetCertificateAuthorityCsrRequest":{
"type":"structure",
"required":["CertificateAuthorityArn"],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"}
}
},
"GetCertificateAuthorityCsrResponse":{
"type":"structure",
"members":{
"Csr":{"shape":"CsrBody"}
}
},
"GetCertificateRequest":{
"type":"structure",
"required":[
"CertificateAuthorityArn",
"CertificateArn"
],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"CertificateArn":{"shape":"Arn"}
}
},
"GetCertificateResponse":{
"type":"structure",
"members":{
"Certificate":{"shape":"CertificateBody"},
"CertificateChain":{"shape":"CertificateChain"}
}
},
"IdempotencyToken":{
"type":"string",
"max":36,
"min":1,
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*"
},
"ImportCertificateAuthorityCertificateRequest":{
"type":"structure",
"required":[
"CertificateAuthorityArn",
"Certificate",
"CertificateChain"
],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"Certificate":{"shape":"CertificateBodyBlob"},
"CertificateChain":{"shape":"CertificateChainBlob"}
}
},
"Integer1To5000":{
"type":"integer",
"max":5000,
"min":1
},
"InvalidArgsException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"InvalidArnException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"InvalidNextTokenException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"InvalidPolicyException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"InvalidStateException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"InvalidTagException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"IssueCertificateRequest":{
"type":"structure",
"required":[
"CertificateAuthorityArn",
"Csr",
"SigningAlgorithm",
"Validity"
],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"Csr":{"shape":"CsrBlob"},
"SigningAlgorithm":{"shape":"SigningAlgorithm"},
"Validity":{"shape":"Validity"},
"IdempotencyToken":{"shape":"IdempotencyToken"}
}
},
"IssueCertificateResponse":{
"type":"structure",
"members":{
"CertificateArn":{"shape":"Arn"}
}
},
"KeyAlgorithm":{
"type":"string",
"enum":[
"RSA_2048",
"RSA_4096",
"EC_prime256v1",
"EC_secp384r1"
]
},
"LimitExceededException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"ListCertificateAuthoritiesRequest":{
"type":"structure",
"members":{
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"MaxResults"}
}
},
"ListCertificateAuthoritiesResponse":{
"type":"structure",
"members":{
"CertificateAuthorities":{"shape":"CertificateAuthorities"},
"NextToken":{"shape":"NextToken"}
}
},
"ListTagsRequest":{
"type":"structure",
"required":["CertificateAuthorityArn"],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"NextToken":{"shape":"NextToken"},
"MaxResults":{"shape":"MaxResults"}
}
},
"ListTagsResponse":{
"type":"structure",
"members":{
"Tags":{"shape":"TagList"},
"NextToken":{"shape":"NextToken"}
}
},
"MalformedCSRException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"MalformedCertificateException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"MaxResults":{
"type":"integer",
"max":1000,
"min":1
},
"NextToken":{
"type":"string",
"max":500,
"min":1
},
"PositiveLong":{
"type":"long",
"min":1
},
"RequestAlreadyProcessedException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"RequestFailedException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"RequestInProgressException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"RevocationConfiguration":{
"type":"structure",
"members":{
"CrlConfiguration":{"shape":"CrlConfiguration"}
}
},
"RevocationReason":{
"type":"string",
"enum":[
"UNSPECIFIED",
"KEY_COMPROMISE",
"CERTIFICATE_AUTHORITY_COMPROMISE",
"AFFILIATION_CHANGED",
"SUPERSEDED",
"CESSATION_OF_OPERATION",
"PRIVILEGE_WITHDRAWN",
"A_A_COMPROMISE"
]
},
"RevokeCertificateRequest":{
"type":"structure",
"required":[
"CertificateAuthorityArn",
"CertificateSerial",
"RevocationReason"
],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"CertificateSerial":{"shape":"String128"},
"RevocationReason":{"shape":"RevocationReason"}
}
},
"SigningAlgorithm":{
"type":"string",
"enum":[
"SHA256WITHECDSA",
"SHA384WITHECDSA",
"SHA512WITHECDSA",
"SHA256WITHRSA",
"SHA384WITHRSA",
"SHA512WITHRSA"
]
},
"String":{"type":"string"},
"String128":{
"type":"string",
"max":128,
"min":0
},
"String16":{
"type":"string",
"max":16,
"min":0
},
"String253":{
"type":"string",
"max":253,
"min":0
},
"String3":{
"type":"string",
"max":3,
"min":0
},
"String3To255":{
"type":"string",
"max":255,
"min":3
},
"String40":{
"type":"string",
"max":40,
"min":0
},
"String5":{
"type":"string",
"max":5,
"min":0
},
"String64":{
"type":"string",
"max":64,
"min":0
},
"TStamp":{"type":"timestamp"},
"Tag":{
"type":"structure",
"required":["Key"],
"members":{
"Key":{"shape":"TagKey"},
"Value":{"shape":"TagValue"}
}
},
"TagCertificateAuthorityRequest":{
"type":"structure",
"required":[
"CertificateAuthorityArn",
"Tags"
],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"Tags":{"shape":"TagList"}
}
},
"TagKey":{
"type":"string",
"max":128,
"min":1,
"pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*"
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"},
"max":50,
"min":1
},
"TagValue":{
"type":"string",
"max":256,
"min":0,
"pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*"
},
"TooManyTagsException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"UntagCertificateAuthorityRequest":{
"type":"structure",
"required":[
"CertificateAuthorityArn",
"Tags"
],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"Tags":{"shape":"TagList"}
}
},
"UpdateCertificateAuthorityRequest":{
"type":"structure",
"required":["CertificateAuthorityArn"],
"members":{
"CertificateAuthorityArn":{"shape":"Arn"},
"RevocationConfiguration":{"shape":"RevocationConfiguration"},
"Status":{"shape":"CertificateAuthorityStatus"}
}
},
"Validity":{
"type":"structure",
"required":[
"Value",
"Type"
],
"members":{
"Value":{
"shape":"PositiveLong",
"box":true
},
"Type":{"shape":"ValidityPeriodType"}
}
},
"ValidityPeriodType":{
"type":"string",
"enum":[
"END_DATE",
"ABSOLUTE",
"DAYS",
"MONTHS",
"YEARS"
]
}
}
}

575
vendor/github.com/aws/aws-sdk-go/models/apis/acm-pca/2017-08-22/docs-2.json generated vendored Normal file
View File

@@ -0,0 +1,575 @@
{
"version": "2.0",
"service": "<p>You can use the ACM PCA API to create a private certificate authority (CA). You must first call the <a>CreateCertificateAuthority</a> function. If successful, the function returns an Amazon Resource Name (ARN) for your private CA. Use this ARN as input to the <a>GetCertificateAuthorityCsr</a> function to retrieve the certificate signing request (CSR) for your private CA certificate. Sign the CSR using the root or an intermediate CA in your on-premises PKI hierarchy, and call the <a>ImportCertificateAuthorityCertificate</a> to import your signed private CA certificate into ACM PCA. </p> <p>Use your private CA to issue and revoke certificates. These are private certificates that identify and secure client computers, servers, applications, services, devices, and users over SSLS/TLS connections within your organization. Call the <a>IssueCertificate</a> function to issue a certificate. Call the <a>RevokeCertificate</a> function to revoke a certificate. </p> <note> <p>Certificates issued by your private CA can be trusted only within your organization, not publicly.</p> </note> <p>Your private CA can optionally create a certificate revocation list (CRL) to track the certificates you revoke. To create a CRL, you must specify a <a>RevocationConfiguration</a> object when you call the <a>CreateCertificateAuthority</a> function. ACM PCA writes the CRL to an S3 bucket that you specify. You must specify a bucket policy that grants ACM PCA write permission. </p> <p>You can also call the <a>CreateCertificateAuthorityAuditReport</a> to create an optional audit report that lists every time the CA private key is used. The private key is used for signing when the <b>IssueCertificate</b> or <b>RevokeCertificate</b> function is called. </p>",
"operations": {
"CreateCertificateAuthority": "<p>Creates a private subordinate certificate authority (CA). You must specify the CA configuration, the revocation configuration, the CA type, and an optional idempotency token. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses to sign, and X.500 subject information. The CRL (certificate revocation list) configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this function returns the Amazon Resource Name (ARN) of the CA.</p>",
"CreateCertificateAuthorityAuditReport": "<p>Creates an audit report that lists every time that the your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The <a>IssueCertificate</a> and <a>RevokeCertificate</a> functions use the private key. You can generate a new report every 30 minutes.</p>",
"DeleteCertificateAuthority": "<p>Deletes the private certificate authority (CA) that you created or started to create by calling the <a>CreateCertificateAuthority</a> function. This action requires that you enter an ARN (Amazon Resource Name) for the private CA that you want to delete. You can find the ARN by calling the <a>ListCertificateAuthorities</a> function. You can delete the CA if you are waiting for it to be created (the <b>Status</b> field of the <a>CertificateAuthority</a> is <code>CREATING</code>) or if the CA has been created but you haven't yet imported the signed certificate (the <b>Status</b> is <code>PENDING_CERTIFICATE</code>) into ACM PCA. If you've already imported the certificate, you cannot delete the CA unless it has been disabled for more than 30 days. To disable a CA, call the <a>UpdateCertificateAuthority</a> function and set the <b>CertificateAuthorityStatus</b> argument to <code>DISABLED</code>. </p>",
"DescribeCertificateAuthority": "<p>Lists information about your private certificate authority (CA). You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following: </p> <ul> <li> <p> <b>CREATING:</b> ACM PCA is creating your private certificate authority.</p> </li> <li> <p> <b>PENDING_CERTIFICATE:</b> The certificate is pending. You must use your on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA. </p> </li> <li> <p> <b>ACTIVE:</b> Your private CA is active.</p> </li> <li> <p> <b>DISABLED:</b> Your private CA has been disabled.</p> </li> <li> <p> <b>EXPIRED:</b> Your private CA certificate has expired.</p> </li> <li> <p> <b>FAILED:</b> Your private CA has failed. Your CA can fail for problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA. </p> </li> </ul>",
"DescribeCertificateAuthorityAuditReport": "<p>Lists information about a specific audit report created by calling the <a>CreateCertificateAuthorityAuditReport</a> function. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the <a>IssueCertificate</a> function or the <a>RevokeCertificate</a> function. </p>",
"GetCertificate": "<p>Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the <a>IssueCertificate</a> function. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the <b>GetCertificate</b> function. You can retrieve the certificate if it is in the <b>ISSUED</b> state. You can call the <a>CreateCertificateAuthorityAuditReport</a> function to create a report that contains information about all of the certificates issued and revoked by your private CA. </p>",
"GetCertificateAuthorityCertificate": "<p>Retrieves the certificate and certificate chain for your private certificate authority (CA). Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it. </p>",
"GetCertificateAuthorityCsr": "<p>Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the <a>CreateCertificateAuthority</a> function. Take the CSR to your on-premises X.509 infrastructure and sign it by using your root or a subordinate CA. Then import the signed certificate back into ACM PCA by calling the <a>ImportCertificateAuthorityCertificate</a> function. The CSR is returned as a base64 PEM-encoded string. </p>",
"ImportCertificateAuthorityCertificate": "<p>Imports your signed private CA certificate into ACM PCA. Before you can call this function, you must create the private certificate authority by calling the <a>CreateCertificateAuthority</a> function. You must then generate a certificate signing request (CSR) by calling the <a>GetCertificateAuthorityCsr</a> function. Take the CSR to your on-premises CA and use the root certificate or a subordinate certificate to sign it. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory. </p> <note> <p>Your certificate chain must not include the private CA certificate that you are importing.</p> </note> <note> <p>Your on-premises CA certificate must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built. </p> </note> <note> <p>The chain must be PEM-encoded.</p> </note>",
"IssueCertificate": "<p>Uses your private certificate authority (CA) to issue a client certificate. This function returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the <a>GetCertificate</a> function and specifying the ARN. </p> <note> <p>You cannot use the ACM <b>ListCertificateAuthorities</b> function to retrieve the ARNs of the certificates that you issue by using ACM PCA.</p> </note>",
"ListCertificateAuthorities": "<p>Lists the private certificate authorities that you created by using the <a>CreateCertificateAuthority</a> function.</p>",
"ListTags": "<p>Lists the tags, if any, that are associated with your private CA. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the <a>TagCertificateAuthority</a> function to add one or more tags to your CA. Call the <a>UntagCertificateAuthority</a> function to remove tags. </p>",
"RevokeCertificate": "<p>Revokes a certificate that you issued by calling the <a>IssueCertificate</a> function. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. ACM PCA writes the CRL to an S3 bucket that you specify. For more information about revocation, see the <a>CrlConfiguration</a> structure. ACM PCA also writes revocation information to the audit report. For more information, see <a>CreateCertificateAuthorityAuditReport</a>. </p>",
"TagCertificateAuthority": "<p>Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the <a>UntagCertificateAuthority</a> function. Call the <a>ListTags</a> function to see what tags are associated with your CA. </p>",
"UntagCertificateAuthority": "<p>Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the <a>TagCertificateAuthority</a>. Call the <a>ListTags</a> function to see what tags are associated with your CA. </p>",
"UpdateCertificateAuthority": "<p>Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the <b> <code>ACTIVE</code> </b> or <b> <code>DISABLED</code> </b> state before you can update it. You can disable a private CA that is in the <b> <code>ACTIVE</code> </b> state or make a CA that is in the <b> <code>DISABLED</code> </b> state active again.</p>"
},
"shapes": {
"ASN1Subject": {
"base": "<p>Contains information about the certificate subject. The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The <b>Subject</b> field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The <b>Subject</b> must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each for each entity, but your private CA can issue more than one certificate with the same DN to the same entity. </p>",
"refs": {
"CertificateAuthorityConfiguration$Subject": "<p>Structure that contains X.500 distinguished name information for your private CA.</p>"
}
},
"Arn": {
"base": null,
"refs": {
"CertificateAuthority$Arn": "<p>Amazon Resource Name (ARN) for your private certificate authority (CA). The format is <code> <i>12345678-1234-1234-1234-123456789012</i> </code>.</p>",
"CreateCertificateAuthorityAuditReportRequest$CertificateAuthorityArn": "<p>Amazon Resource Name (ARN) of the CA to be audited. This is of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>.</p>",
"CreateCertificateAuthorityResponse$CertificateAuthorityArn": "<p>If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This is of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
"DeleteCertificateAuthorityRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
"DescribeCertificateAuthorityAuditReportRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) of the private CA. This must be of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
"DescribeCertificateAuthorityRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
"GetCertificateAuthorityCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) of your private CA. This is of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
"GetCertificateAuthorityCsrRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called the <a>CreateCertificateAuthority</a> function. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
"GetCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
"GetCertificateRequest$CertificateArn": "<p>The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>/certificate/<i>286535153982981100925020015808220737245</i> </code> </p>",
"ImportCertificateAuthorityCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
"IssueCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
"IssueCertificateResponse$CertificateArn": "<p>The Amazon Resource Name (ARN) of the issued certificate and the certificate serial number. This is of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>/certificate/<i>286535153982981100925020015808220737245</i> </code> </p>",
"ListTagsRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called the <a>CreateCertificateAuthority</a> function. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
"RevokeCertificateRequest$CertificateAuthorityArn": "<p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
"TagCertificateAuthorityRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
"UntagCertificateAuthorityRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
"UpdateCertificateAuthorityRequest$CertificateAuthorityArn": "<p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
}
},
"AuditReportId": {
"base": null,
"refs": {
"CreateCertificateAuthorityAuditReportResponse$AuditReportId": "<p>An alphanumeric string that contains a report identifier.</p>",
"DescribeCertificateAuthorityAuditReportRequest$AuditReportId": "<p>The report ID returned by calling the <a>CreateCertificateAuthorityAuditReport</a> function.</p>"
}
},
"AuditReportResponseFormat": {
"base": null,
"refs": {
"CreateCertificateAuthorityAuditReportRequest$AuditReportResponseFormat": "<p>Format in which to create the report. This can be either <b>JSON</b> or <b>CSV</b>.</p>"
}
},
"AuditReportStatus": {
"base": null,
"refs": {
"DescribeCertificateAuthorityAuditReportResponse$AuditReportStatus": "<p>Specifies whether report creation is in progress, has succeeded, or has failed.</p>"
}
},
"Boolean": {
"base": null,
"refs": {
"CrlConfiguration$Enabled": "<p>Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the <a>CreateCertificateAuthority</a> function or for an existing CA when you call the <a>UpdateCertificateAuthority</a> function. </p>"
}
},
"CertificateAuthorities": {
"base": null,
"refs": {
"ListCertificateAuthoritiesResponse$CertificateAuthorities": "<p>Summary information about each certificate authority you have created.</p>"
}
},
"CertificateAuthority": {
"base": "<p>Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate <b>Subject</b> field owns or controls the public key contained in the <b>Subject Public Key Info</b> field. Call the <a>CreateCertificateAuthority</a> function to create your private CA. You must then call the <a>GetCertificateAuthorityCertificate</a> function to retrieve a private CA certificate signing request (CSR). Take the CSR to your on-premises CA and sign it with the root CA certificate or a subordinate certificate. Call the <a>ImportCertificateAuthorityCertificate</a> function to import the signed certificate into AWS Certificate Manager (ACM). </p>",
"refs": {
"CertificateAuthorities$member": null,
"DescribeCertificateAuthorityResponse$CertificateAuthority": "<p>A <a>CertificateAuthority</a> structure that contains information about your private CA.</p>"
}
},
"CertificateAuthorityConfiguration": {
"base": "<p>Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate, the signature algorithm it uses used when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the <a>CreateCertificateAuthority</a> function. </p>",
"refs": {
"CertificateAuthority$CertificateAuthorityConfiguration": "<p>Your private CA configuration.</p>",
"CreateCertificateAuthorityRequest$CertificateAuthorityConfiguration": "<p>Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.</p>"
}
},
"CertificateAuthorityStatus": {
"base": null,
"refs": {
"CertificateAuthority$Status": "<p>Status of your private CA.</p>",
"UpdateCertificateAuthorityRequest$Status": "<p>Status of your private CA.</p>"
}
},
"CertificateAuthorityType": {
"base": null,
"refs": {
"CertificateAuthority$Type": "<p>Type of your private CA.</p>",
"CreateCertificateAuthorityRequest$CertificateAuthorityType": "<p>The type of the certificate authority. Currently, this must be <b>SUBORDINATE</b>.</p>"
}
},
"CertificateBody": {
"base": null,
"refs": {
"GetCertificateAuthorityCertificateResponse$Certificate": "<p>Base64-encoded certificate authority (CA) certificate.</p>",
"GetCertificateResponse$Certificate": "<p>The base64 PEM-encoded certificate specified by the <code>CertificateArn</code> parameter.</p>"
}
},
"CertificateBodyBlob": {
"base": null,
"refs": {
"ImportCertificateAuthorityCertificateRequest$Certificate": "<p>The PEM-encoded certificate for your private CA. This must be signed by using your on-premises CA.</p>"
}
},
"CertificateChain": {
"base": null,
"refs": {
"GetCertificateAuthorityCertificateResponse$CertificateChain": "<p>Base64-encoded certificate chain that includes any intermediate certificates and chains up to root on-premises certificate that you used to sign your private CA certificate. The chain does not include your private CA certificate. </p>",
"GetCertificateResponse$CertificateChain": "<p>The base64 PEM-encoded certificate chain that chains up to the on-premises root CA certificate that you used to sign your private CA certificate. </p>"
}
},
"CertificateChainBlob": {
"base": null,
"refs": {
"ImportCertificateAuthorityCertificateRequest$CertificateChain": "<p>A PEM-encoded file that contains all of your certificates, other than the certificate you're importing, chaining up to your root CA. Your on-premises root certificate is the last in the chain, and each certificate in the chain signs the one preceding. </p>"
}
},
"CertificateMismatchException": {
"base": "<p>The certificate authority certificate you are importing does not comply with conditions specified in the certificate that signed it.</p>",
"refs": {
}
},
"ConcurrentModificationException": {
"base": "<p>A previous update to your private CA is still ongoing.</p>",
"refs": {
}
},
"CountryCodeString": {
"base": null,
"refs": {
"ASN1Subject$Country": "<p>Two digit code that specifies the country in which the certificate subject located.</p>"
}
},
"CreateCertificateAuthorityAuditReportRequest": {
"base": null,
"refs": {
}
},
"CreateCertificateAuthorityAuditReportResponse": {
"base": null,
"refs": {
}
},
"CreateCertificateAuthorityRequest": {
"base": null,
"refs": {
}
},
"CreateCertificateAuthorityResponse": {
"base": null,
"refs": {
}
},
"CrlConfiguration": {
"base": "<p>Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the <b>Enabled</b> parameter to <code>true</code>. Your private CA writes CRLs to an S3 bucket that you specify in the <b>S3BucketName</b> parameter. You can hide the name of your bucket by specifying a value for the <b>CustomCname</b> parameter. Your private CA copies the CNAME or the S3 bucket name to the <b>CRL Distribution Points</b> extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM PCA. </p> <p>Your private CA uses the value in the <b>ExpirationInDays</b> parameter to calculate the <b>nextUpdate</b> field in the CRL. The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked. When a certificate is revoked, it is recorded in the next CRL that is generated and in the next audit report. Only time valid certificates are listed in the CRL. Expired certificates are not included. </p> <p>CRLs contain the following fields:</p> <ul> <li> <p> <b>Version</b>: The current version number defined in RFC 5280 is V2. The integer value is 0x1. </p> </li> <li> <p> <b>Signature Algorithm</b>: The name of the algorithm used to sign the CRL.</p> </li> <li> <p> <b>Issuer</b>: The X.500 distinguished name of your private CA that issued the CRL.</p> </li> <li> <p> <b>Last Update</b>: The issue date and time of this CRL.</p> </li> <li> <p> <b>Next Update</b>: The day and time by which the next CRL will be issued.</p> </li> <li> <p> <b>Revoked Certificates</b>: List of revoked certificates. Each list item contains the following information.</p> <ul> <li> <p> <b>Serial Number</b>: The serial number, in hexadecimal format, of the revoked certificate.</p> </li> <li> <p> <b>Revocation Date</b>: Date and time the certificate was revoked.</p> </li> <li> <p> <b>CRL Entry Extensions</b>: Optional extensions for the CRL entry.</p> <ul> <li> <p> <b>X509v3 CRL Reason Code</b>: Reason the certificate was revoked.</p> </li> </ul> </li> </ul> </li> <li> <p> <b>CRL Extensions</b>: Optional extensions for the CRL.</p> <ul> <li> <p> <b>X509v3 Authority Key Identifier</b>: Identifies the public key associated with the private key used to sign the certificate.</p> </li> <li> <p> <b>X509v3 CRL Number:</b>: Decimal sequence number for the CRL.</p> </li> </ul> </li> <li> <p> <b>Signature Algorithm</b>: Algorithm used by your private CA to sign the CRL.</p> </li> <li> <p> <b>Signature Value</b>: Signature computed over the CRL.</p> </li> </ul> <p>Certificate revocation lists created by ACM PCA are DER-encoded. You can use the following OpenSSL command to list a CRL.</p> <p> <code>openssl crl -inform DER -text -in <i>crl_path</i> -noout</code> </p>",
"refs": {
"RevocationConfiguration$CrlConfiguration": "<p>Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.</p>"
}
},
"CsrBlob": {
"base": null,
"refs": {
"IssueCertificateRequest$Csr": "<p>The certificate signing request (CSR) for the certificate you want to issue. You can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key. </p> <p> <code>openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr</code> </p> <p>If you have a configuration file, you can use the following OpenSSL command. The <code>usr_cert</code> block in the configuration file contains your X509 version 3 extensions. </p> <p> <code>openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days -365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr</code> </p>"
}
},
"CsrBody": {
"base": null,
"refs": {
"GetCertificateAuthorityCsrResponse$Csr": "<p>The base64 PEM-encoded certificate signing request (CSR) for your private CA certificate.</p>"
}
},
"DeleteCertificateAuthorityRequest": {
"base": null,
"refs": {
}
},
"DescribeCertificateAuthorityAuditReportRequest": {
"base": null,
"refs": {
}
},
"DescribeCertificateAuthorityAuditReportResponse": {
"base": null,
"refs": {
}
},
"DescribeCertificateAuthorityRequest": {
"base": null,
"refs": {
}
},
"DescribeCertificateAuthorityResponse": {
"base": null,
"refs": {
}
},
"DistinguishedNameQualifierString": {
"base": null,
"refs": {
"ASN1Subject$DistinguishedNameQualifier": "<p>Disambiguating information for the certificate subject.</p>"
}
},
"FailureReason": {
"base": null,
"refs": {
"CertificateAuthority$FailureReason": "<p>Reason the request to create your private CA failed.</p>"
}
},
"GetCertificateAuthorityCertificateRequest": {
"base": null,
"refs": {
}
},
"GetCertificateAuthorityCertificateResponse": {
"base": null,
"refs": {
}
},
"GetCertificateAuthorityCsrRequest": {
"base": null,
"refs": {
}
},
"GetCertificateAuthorityCsrResponse": {
"base": null,
"refs": {
}
},
"GetCertificateRequest": {
"base": null,
"refs": {
}
},
"GetCertificateResponse": {
"base": null,
"refs": {
}
},
"IdempotencyToken": {
"base": null,
"refs": {
"CreateCertificateAuthorityRequest$IdempotencyToken": "<p>Alphanumeric string that can be used to distinguish between calls to <b>CreateCertificateAuthority</b>. Idempotency tokens time out after five minutes. Therefore, if you call <b>CreateCertificateAuthority</b> multiple times with the same idempotency token within a five minute period, ACM PCA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, however, ACM PCA recognizes that you are requesting multiple certificates.</p>",
"IssueCertificateRequest$IdempotencyToken": "<p>Custom string that can be used to distinguish between calls to the <b>IssueCertificate</b> function. Idempotency tokens time out after one hour. Therefore, if you call <b>IssueCertificate</b> multiple times with the same idempotency token within 5 minutes, ACM PCA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.</p>"
}
},
"ImportCertificateAuthorityCertificateRequest": {
"base": null,
"refs": {
}
},
"Integer1To5000": {
"base": null,
"refs": {
"CrlConfiguration$ExpirationInDays": "<p>Number of days until a certificate expires.</p>"
}
},
"InvalidArgsException": {
"base": "<p>One or more of the specified arguments was not valid.</p>",
"refs": {
}
},
"InvalidArnException": {
"base": "<p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>",
"refs": {
}
},
"InvalidNextTokenException": {
"base": "<p>The token specified in the <code>NextToken</code> argument is not valid. Use the token returned from your previous call to <a>ListCertificateAuthorities</a>.</p>",
"refs": {
}
},
"InvalidPolicyException": {
"base": "<p>The S3 bucket policy is not valid. The policy must give ACM PCA rights to read from and write to the bucket and find the bucket location.</p>",
"refs": {
}
},
"InvalidStateException": {
"base": "<p>The private CA is in a state during which a report cannot be generated.</p>",
"refs": {
}
},
"InvalidTagException": {
"base": "<p>The tag associated with the CA is not valid. The invalid argument is contained in the message field.</p>",
"refs": {
}
},
"IssueCertificateRequest": {
"base": null,
"refs": {
}
},
"IssueCertificateResponse": {
"base": null,
"refs": {
}
},
"KeyAlgorithm": {
"base": null,
"refs": {
"CertificateAuthorityConfiguration$KeyAlgorithm": "<p>Type of the public key algorithm and size, in bits, of the key pair that your key pair creates when it issues a certificate.</p>"
}
},
"LimitExceededException": {
"base": "<p>An ACM PCA limit has been exceeded. See the exception message returned to determine the limit that was exceeded.</p>",
"refs": {
}
},
"ListCertificateAuthoritiesRequest": {
"base": null,
"refs": {
}
},
"ListCertificateAuthoritiesResponse": {
"base": null,
"refs": {
}
},
"ListTagsRequest": {
"base": null,
"refs": {
}
},
"ListTagsResponse": {
"base": null,
"refs": {
}
},
"MalformedCSRException": {
"base": "<p>The certificate signing request is invalid.</p>",
"refs": {
}
},
"MalformedCertificateException": {
"base": "<p>One or more fields in the certificate are invalid.</p>",
"refs": {
}
},
"MaxResults": {
"base": null,
"refs": {
"ListCertificateAuthoritiesRequest$MaxResults": "<p>Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the <code>NextToken</code> element is sent in the response. Use this <code>NextToken</code> value in a subsequent request to retrieve additional items.</p>",
"ListTagsRequest$MaxResults": "<p>Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the <b>NextToken</b> element is sent in the response. Use this <b>NextToken</b> value in a subsequent request to retrieve additional items.</p>"
}
},
"NextToken": {
"base": null,
"refs": {
"ListCertificateAuthoritiesRequest$NextToken": "<p>Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the <code>NextToken</code> parameter from the response you just received.</p>",
"ListCertificateAuthoritiesResponse$NextToken": "<p>When the list is truncated, this value is present and should be used for the <code>NextToken</code> parameter in a subsequent pagination request.</p>",
"ListTagsRequest$NextToken": "<p>Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of <b>NextToken</b> from the response you just received.</p>",
"ListTagsResponse$NextToken": "<p>When the list is truncated, this value is present and should be used for the <b>NextToken</b> parameter in a subsequent pagination request. </p>"
}
},
"PositiveLong": {
"base": null,
"refs": {
"Validity$Value": "<p>Time period.</p>"
}
},
"RequestAlreadyProcessedException": {
"base": "<p>Your request has already been completed.</p>",
"refs": {
}
},
"RequestFailedException": {
"base": "<p>The request has failed for an unspecified reason.</p>",
"refs": {
}
},
"RequestInProgressException": {
"base": "<p>Your request is already in progress.</p>",
"refs": {
}
},
"ResourceNotFoundException": {
"base": "<p>A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.</p>",
"refs": {
}
},
"RevocationConfiguration": {
"base": "<p>Certificate revocation information used by the <a>CreateCertificateAuthority</a> and <a>UpdateCertificateAuthority</a> functions. Your private certificate authority (CA) can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates revoked by your CA. For more information, see <a>RevokeCertificate</a>.</p>",
"refs": {
"CertificateAuthority$RevocationConfiguration": "<p>Information about the certificate revocation list (CRL) created and maintained by your private CA. </p>",
"CreateCertificateAuthorityRequest$RevocationConfiguration": "<p>Contains a Boolean value that you can use to enable a certification revocation list (CRL) for the CA, the name of the S3 bucket to which ACM PCA will write the CRL, and an optional CNAME alias that you can use to hide the name of your bucket in the <b>CRL Distribution Points</b> extension of your CA certificate. For more information, see the <a>CrlConfiguration</a> structure. </p>",
"UpdateCertificateAuthorityRequest$RevocationConfiguration": "<p>Revocation information for your private CA.</p>"
}
},
"RevocationReason": {
"base": null,
"refs": {
"RevokeCertificateRequest$RevocationReason": "<p>Specifies why you revoked the certificate.</p>"
}
},
"RevokeCertificateRequest": {
"base": null,
"refs": {
}
},
"SigningAlgorithm": {
"base": null,
"refs": {
"CertificateAuthorityConfiguration$SigningAlgorithm": "<p>Name of the algorithm your private CA uses to sign certificate requests.</p>",
"IssueCertificateRequest$SigningAlgorithm": "<p>The name of the algorithm that will be used to sign the certificate to be issued.</p>"
}
},
"String": {
"base": null,
"refs": {
"CertificateAuthority$Serial": "<p>Serial number of your private CA.</p>",
"CertificateMismatchException$message": null,
"ConcurrentModificationException$message": null,
"CreateCertificateAuthorityAuditReportRequest$S3BucketName": "<p>Name of the S3 bucket that will contain the audit report.</p>",
"CreateCertificateAuthorityAuditReportResponse$S3Key": "<p>The <b>key</b> that uniquely identifies the report file in your S3 bucket.</p>",
"DescribeCertificateAuthorityAuditReportResponse$S3BucketName": "<p>Name of the S3 bucket that contains the report.</p>",
"DescribeCertificateAuthorityAuditReportResponse$S3Key": "<p>S3 <b>key</b> that uniquely identifies the report file in your S3 bucket.</p>",
"InvalidArgsException$message": null,
"InvalidArnException$message": null,
"InvalidNextTokenException$message": null,
"InvalidPolicyException$message": null,
"InvalidStateException$message": null,
"InvalidTagException$message": null,
"LimitExceededException$message": null,
"MalformedCSRException$message": null,
"MalformedCertificateException$message": null,
"RequestAlreadyProcessedException$message": null,
"RequestFailedException$message": null,
"RequestInProgressException$message": null,
"ResourceNotFoundException$message": null,
"TooManyTagsException$message": null
}
},
"String128": {
"base": null,
"refs": {
"ASN1Subject$State": "<p>State in which the subject of the certificate is located.</p>",
"ASN1Subject$Locality": "<p>The locality (such as a city or town) in which the certificate subject is located.</p>",
"ASN1Subject$Pseudonym": "<p>Typically a shortened version of a longer <b>GivenName</b>. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.</p>",
"RevokeCertificateRequest$CertificateSerial": "<p>Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling <a>GetCertificate</a> with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The <b>GetCertificate</b> function retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number. </p> <p> <code>openssl x509 -in <i>file_path</i> -text -noout</code> </p> <p>You can also copy the serial number from the console or use the <a href=\"http://docs.aws.amazon.comacm/latest/APIReferenceAPI_DescribeCertificate.html\">DescribeCertificate</a> function in the <i>AWS Certificate Manager API Reference</i>. </p>"
}
},
"String16": {
"base": null,
"refs": {
"ASN1Subject$GivenName": "<p>First name.</p>"
}
},
"String253": {
"base": null,
"refs": {
"CrlConfiguration$CustomCname": "<p>Name inserted into the certificate <b>CRL Distribution Points</b> extension that enables the use of an alias for the CRL distribution point. Use this value if you don't want the name of your S3 bucket to be public.</p>"
}
},
"String3": {
"base": null,
"refs": {
"ASN1Subject$GenerationQualifier": "<p>Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.</p>"
}
},
"String3To255": {
"base": null,
"refs": {
"CrlConfiguration$S3BucketName": "<p>Name of the S3 bucket that contains the CRL. If you do not provide a value for the <b>CustomCname</b> argument, the name of your S3 bucket is placed into the <b>CRL Distribution Points</b> extension of the issued certificate. You can change the name of your bucket by calling the <a>UpdateCertificateAuthority</a> function. You must specify a bucket policy that allows ACM PCA to write the CRL to your bucket.</p>"
}
},
"String40": {
"base": null,
"refs": {
"ASN1Subject$Surname": "<p>Family name. In the US and the UK for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.</p>"
}
},
"String5": {
"base": null,
"refs": {
"ASN1Subject$Initials": "<p>Concatenation that typically contains the first letter of the <b>GivenName</b>, the first letter of the middle name if one exists, and the first letter of the <b>SurName</b>.</p>"
}
},
"String64": {
"base": null,
"refs": {
"ASN1Subject$Organization": "<p>Legal name of the organization with which the certificate subject is affiliated. </p>",
"ASN1Subject$OrganizationalUnit": "<p>A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.</p>",
"ASN1Subject$CommonName": "<p>Fully qualified domain name (FQDN) associated with the certificate subject.</p>",
"ASN1Subject$SerialNumber": "<p>The certificate serial number.</p>",
"ASN1Subject$Title": "<p>A title such as Mr. or Ms. which is pre-pended to the name to refer formally to the certificate subject.</p>"
}
},
"TStamp": {
"base": null,
"refs": {
"CertificateAuthority$CreatedAt": "<p>Date and time at which your private CA was created.</p>",
"CertificateAuthority$LastStateChangeAt": "<p>Date and time at which your private CA was last updated.</p>",
"CertificateAuthority$NotBefore": "<p>Date and time before which your private CA certificate is not valid.</p>",
"CertificateAuthority$NotAfter": "<p>Date and time after which your private CA certificate is not valid.</p>",
"DescribeCertificateAuthorityAuditReportResponse$CreatedAt": "<p>The date and time at which the report was created.</p>"
}
},
"Tag": {
"base": "<p>Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the <a>TagCertificateAuthority</a> function. To remove a tag, call the <a>UntagCertificateAuthority</a> function. </p>",
"refs": {
"TagList$member": null
}
},
"TagCertificateAuthorityRequest": {
"base": null,
"refs": {
}
},
"TagKey": {
"base": null,
"refs": {
"Tag$Key": "<p>Key (name) of the tag.</p>"
}
},
"TagList": {
"base": null,
"refs": {
"ListTagsResponse$Tags": "<p>The tags associated with your private CA.</p>",
"TagCertificateAuthorityRequest$Tags": "<p>List of tags to be associated with the CA.</p>",
"UntagCertificateAuthorityRequest$Tags": "<p>List of tags to be removed from the CA.</p>"
}
},
"TagValue": {
"base": null,
"refs": {
"Tag$Value": "<p>Value of the tag.</p>"
}
},
"TooManyTagsException": {
"base": "<p>You can associate up to 50 tags with a private CA. Exception information is contained in the exception message field.</p>",
"refs": {
}
},
"UntagCertificateAuthorityRequest": {
"base": null,
"refs": {
}
},
"UpdateCertificateAuthorityRequest": {
"base": null,
"refs": {
}
},
"Validity": {
"base": "<p>Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years. You can issue a certificate by calling the <a>IssueCertificate</a> function.</p>",
"refs": {
"IssueCertificateRequest$Validity": "<p>The type of the validity period.</p>"
}
},
"ValidityPeriodType": {
"base": null,
"refs": {
"Validity$Type": "<p>Specifies whether the <code>Value</code> parameter represents days, months, or years.</p>"
}
}
}
}

5
vendor/github.com/aws/aws-sdk-go/models/apis/acm-pca/2017-08-22/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/acm-pca/2017-08-22/paginators-1.json generated vendored Normal file
View File

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

808
vendor/github.com/aws/aws-sdk-go/models/apis/acm/2015-12-08/api-2.json generated vendored Normal file
View File

@@ -0,0 +1,808 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2015-12-08",
"endpointPrefix":"acm",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"ACM",
"serviceFullName":"AWS Certificate Manager",
"serviceId":"ACM",
"signatureVersion":"v4",
"targetPrefix":"CertificateManager",
"uid":"acm-2015-12-08"
},
"operations":{
"AddTagsToCertificate":{
"name":"AddTagsToCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"AddTagsToCertificateRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidTagException"},
{"shape":"TooManyTagsException"}
]
},
"DeleteCertificate":{
"name":"DeleteCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteCertificateRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"},
{"shape":"InvalidArnException"}
]
},
"DescribeCertificate":{
"name":"DescribeCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeCertificateRequest"},
"output":{"shape":"DescribeCertificateResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"}
]
},
"ExportCertificate":{
"name":"ExportCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ExportCertificateRequest"},
"output":{"shape":"ExportCertificateResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"RequestInProgressException"},
{"shape":"InvalidArnException"}
]
},
"GetCertificate":{
"name":"GetCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetCertificateRequest"},
"output":{"shape":"GetCertificateResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"RequestInProgressException"},
{"shape":"InvalidArnException"}
]
},
"ImportCertificate":{
"name":"ImportCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ImportCertificateRequest"},
"output":{"shape":"ImportCertificateResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"}
]
},
"ListCertificates":{
"name":"ListCertificates",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListCertificatesRequest"},
"output":{"shape":"ListCertificatesResponse"}
},
"ListTagsForCertificate":{
"name":"ListTagsForCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForCertificateRequest"},
"output":{"shape":"ListTagsForCertificateResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"}
]
},
"RemoveTagsFromCertificate":{
"name":"RemoveTagsFromCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RemoveTagsFromCertificateRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidTagException"}
]
},
"RequestCertificate":{
"name":"RequestCertificate",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RequestCertificateRequest"},
"output":{"shape":"RequestCertificateResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"InvalidDomainValidationOptionsException"},
{"shape":"InvalidArnException"}
]
},
"ResendValidationEmail":{
"name":"ResendValidationEmail",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ResendValidationEmailRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidStateException"},
{"shape":"InvalidArnException"},
{"shape":"InvalidDomainValidationOptionsException"}
]
},
"UpdateCertificateOptions":{
"name":"UpdateCertificateOptions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateCertificateOptionsRequest"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidStateException"},
{"shape":"InvalidArnException"}
]
}
},
"shapes":{
"AddTagsToCertificateRequest":{
"type":"structure",
"required":[
"CertificateArn",
"Tags"
],
"members":{
"CertificateArn":{"shape":"Arn"},
"Tags":{"shape":"TagList"}
}
},
"Arn":{
"type":"string",
"max":2048,
"min":20,
"pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*"
},
"CertificateBody":{
"type":"string",
"max":32768,
"min":1,
"pattern":"-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?"
},
"CertificateBodyBlob":{
"type":"blob",
"max":32768,
"min":1
},
"CertificateChain":{
"type":"string",
"max":2097152,
"min":1,
"pattern":"(-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}\\u000D?\\u000A)*-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?"
},
"CertificateChainBlob":{
"type":"blob",
"max":2097152,
"min":1
},
"CertificateDetail":{
"type":"structure",
"members":{
"CertificateArn":{"shape":"Arn"},
"DomainName":{"shape":"DomainNameString"},
"SubjectAlternativeNames":{"shape":"DomainList"},
"DomainValidationOptions":{"shape":"DomainValidationList"},
"Serial":{"shape":"String"},
"Subject":{"shape":"String"},
"Issuer":{"shape":"String"},
"CreatedAt":{"shape":"TStamp"},
"IssuedAt":{"shape":"TStamp"},
"ImportedAt":{"shape":"TStamp"},
"Status":{"shape":"CertificateStatus"},
"RevokedAt":{"shape":"TStamp"},
"RevocationReason":{"shape":"RevocationReason"},
"NotBefore":{"shape":"TStamp"},
"NotAfter":{"shape":"TStamp"},
"KeyAlgorithm":{"shape":"KeyAlgorithm"},
"SignatureAlgorithm":{"shape":"String"},
"InUseBy":{"shape":"InUseList"},
"FailureReason":{"shape":"FailureReason"},
"Type":{"shape":"CertificateType"},
"RenewalSummary":{"shape":"RenewalSummary"},
"KeyUsages":{"shape":"KeyUsageList"},
"ExtendedKeyUsages":{"shape":"ExtendedKeyUsageList"},
"CertificateAuthorityArn":{"shape":"Arn"},
"RenewalEligibility":{"shape":"RenewalEligibility"},
"Options":{"shape":"CertificateOptions"}
}
},
"CertificateOptions":{
"type":"structure",
"members":{
"CertificateTransparencyLoggingPreference":{"shape":"CertificateTransparencyLoggingPreference"}
}
},
"CertificateStatus":{
"type":"string",
"enum":[
"PENDING_VALIDATION",
"ISSUED",
"INACTIVE",
"EXPIRED",
"VALIDATION_TIMED_OUT",
"REVOKED",
"FAILED"
]
},
"CertificateStatuses":{
"type":"list",
"member":{"shape":"CertificateStatus"}
},
"CertificateSummary":{
"type":"structure",
"members":{
"CertificateArn":{"shape":"Arn"},
"DomainName":{"shape":"DomainNameString"}
}
},
"CertificateSummaryList":{
"type":"list",
"member":{"shape":"CertificateSummary"}
},
"CertificateTransparencyLoggingPreference":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"CertificateType":{
"type":"string",
"enum":[
"IMPORTED",
"AMAZON_ISSUED",
"PRIVATE"
]
},
"DeleteCertificateRequest":{
"type":"structure",
"required":["CertificateArn"],
"members":{
"CertificateArn":{"shape":"Arn"}
}
},
"DescribeCertificateRequest":{
"type":"structure",
"required":["CertificateArn"],
"members":{
"CertificateArn":{"shape":"Arn"}
}
},
"DescribeCertificateResponse":{
"type":"structure",
"members":{
"Certificate":{"shape":"CertificateDetail"}
}
},
"DomainList":{
"type":"list",
"member":{"shape":"DomainNameString"},
"max":100,
"min":1
},
"DomainNameString":{
"type":"string",
"max":253,
"min":1,
"pattern":"^(\\*\\.)?(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$"
},
"DomainStatus":{
"type":"string",
"enum":[
"PENDING_VALIDATION",
"SUCCESS",
"FAILED"
]
},
"DomainValidation":{
"type":"structure",
"required":["DomainName"],
"members":{
"DomainName":{"shape":"DomainNameString"},
"ValidationEmails":{"shape":"ValidationEmailList"},
"ValidationDomain":{"shape":"DomainNameString"},
"ValidationStatus":{"shape":"DomainStatus"},
"ResourceRecord":{"shape":"ResourceRecord"},
"ValidationMethod":{"shape":"ValidationMethod"}
}
},
"DomainValidationList":{
"type":"list",
"member":{"shape":"DomainValidation"},
"max":1000,
"min":1
},
"DomainValidationOption":{
"type":"structure",
"required":[
"DomainName",
"ValidationDomain"
],
"members":{
"DomainName":{"shape":"DomainNameString"},
"ValidationDomain":{"shape":"DomainNameString"}
}
},
"DomainValidationOptionList":{
"type":"list",
"member":{"shape":"DomainValidationOption"},
"max":100,
"min":1
},
"ExportCertificateRequest":{
"type":"structure",
"required":[
"CertificateArn",
"Passphrase"
],
"members":{
"CertificateArn":{"shape":"Arn"},
"Passphrase":{"shape":"PassphraseBlob"}
}
},
"ExportCertificateResponse":{
"type":"structure",
"members":{
"Certificate":{"shape":"CertificateBody"},
"CertificateChain":{"shape":"CertificateChain"},
"PrivateKey":{"shape":"PrivateKey"}
}
},
"ExtendedKeyUsage":{
"type":"structure",
"members":{
"Name":{"shape":"ExtendedKeyUsageName"},
"OID":{"shape":"String"}
}
},
"ExtendedKeyUsageFilterList":{
"type":"list",
"member":{"shape":"ExtendedKeyUsageName"}
},
"ExtendedKeyUsageList":{
"type":"list",
"member":{"shape":"ExtendedKeyUsage"}
},
"ExtendedKeyUsageName":{
"type":"string",
"enum":[
"TLS_WEB_SERVER_AUTHENTICATION",
"TLS_WEB_CLIENT_AUTHENTICATION",
"CODE_SIGNING",
"EMAIL_PROTECTION",
"TIME_STAMPING",
"OCSP_SIGNING",
"IPSEC_END_SYSTEM",
"IPSEC_TUNNEL",
"IPSEC_USER",
"ANY",
"NONE",
"CUSTOM"
]
},
"FailureReason":{
"type":"string",
"enum":[
"NO_AVAILABLE_CONTACTS",
"ADDITIONAL_VERIFICATION_REQUIRED",
"DOMAIN_NOT_ALLOWED",
"INVALID_PUBLIC_DOMAIN",
"CAA_ERROR",
"PCA_LIMIT_EXCEEDED",
"PCA_INVALID_ARN",
"PCA_INVALID_STATE",
"PCA_REQUEST_FAILED",
"PCA_RESOURCE_NOT_FOUND",
"PCA_INVALID_ARGS",
"OTHER"
]
},
"Filters":{
"type":"structure",
"members":{
"extendedKeyUsage":{"shape":"ExtendedKeyUsageFilterList"},
"keyUsage":{"shape":"KeyUsageFilterList"},
"keyTypes":{"shape":"KeyAlgorithmList"}
}
},
"GetCertificateRequest":{
"type":"structure",
"required":["CertificateArn"],
"members":{
"CertificateArn":{"shape":"Arn"}
}
},
"GetCertificateResponse":{
"type":"structure",
"members":{
"Certificate":{"shape":"CertificateBody"},
"CertificateChain":{"shape":"CertificateChain"}
}
},
"IdempotencyToken":{
"type":"string",
"max":32,
"min":1,
"pattern":"\\w+"
},
"ImportCertificateRequest":{
"type":"structure",
"required":[
"Certificate",
"PrivateKey"
],
"members":{
"CertificateArn":{"shape":"Arn"},
"Certificate":{"shape":"CertificateBodyBlob"},
"PrivateKey":{"shape":"PrivateKeyBlob"},
"CertificateChain":{"shape":"CertificateChainBlob"}
}
},
"ImportCertificateResponse":{
"type":"structure",
"members":{
"CertificateArn":{"shape":"Arn"}
}
},
"InUseList":{
"type":"list",
"member":{"shape":"String"}
},
"InvalidArnException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"InvalidDomainValidationOptionsException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"InvalidStateException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"InvalidTagException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"KeyAlgorithm":{
"type":"string",
"enum":[
"RSA_2048",
"RSA_1024",
"RSA_4096",
"EC_prime256v1",
"EC_secp384r1",
"EC_secp521r1"
]
},
"KeyAlgorithmList":{
"type":"list",
"member":{"shape":"KeyAlgorithm"}
},
"KeyUsage":{
"type":"structure",
"members":{
"Name":{"shape":"KeyUsageName"}
}
},
"KeyUsageFilterList":{
"type":"list",
"member":{"shape":"KeyUsageName"}
},
"KeyUsageList":{
"type":"list",
"member":{"shape":"KeyUsage"}
},
"KeyUsageName":{
"type":"string",
"enum":[
"DIGITAL_SIGNATURE",
"NON_REPUDIATION",
"KEY_ENCIPHERMENT",
"DATA_ENCIPHERMENT",
"KEY_AGREEMENT",
"CERTIFICATE_SIGNING",
"CRL_SIGNING",
"ENCIPHER_ONLY",
"DECIPHER_ONLY",
"ANY",
"CUSTOM"
]
},
"LimitExceededException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"ListCertificatesRequest":{
"type":"structure",
"members":{
"CertificateStatuses":{"shape":"CertificateStatuses"},
"Includes":{"shape":"Filters"},
"NextToken":{"shape":"NextToken"},
"MaxItems":{"shape":"MaxItems"}
}
},
"ListCertificatesResponse":{
"type":"structure",
"members":{
"NextToken":{"shape":"NextToken"},
"CertificateSummaryList":{"shape":"CertificateSummaryList"}
}
},
"ListTagsForCertificateRequest":{
"type":"structure",
"required":["CertificateArn"],
"members":{
"CertificateArn":{"shape":"Arn"}
}
},
"ListTagsForCertificateResponse":{
"type":"structure",
"members":{
"Tags":{"shape":"TagList"}
}
},
"MaxItems":{
"type":"integer",
"max":1000,
"min":1
},
"NextToken":{
"type":"string",
"max":320,
"min":1,
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*"
},
"PassphraseBlob":{
"type":"blob",
"max":128,
"min":4,
"sensitive":true
},
"PrivateKey":{
"type":"string",
"max":524288,
"min":1,
"pattern":"-{5}BEGIN PRIVATE KEY-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END PRIVATE KEY-{5}(\\u000D?\\u000A)?",
"sensitive":true
},
"PrivateKeyBlob":{
"type":"blob",
"max":524288,
"min":1,
"sensitive":true
},
"RecordType":{
"type":"string",
"enum":["CNAME"]
},
"RemoveTagsFromCertificateRequest":{
"type":"structure",
"required":[
"CertificateArn",
"Tags"
],
"members":{
"CertificateArn":{"shape":"Arn"},
"Tags":{"shape":"TagList"}
}
},
"RenewalEligibility":{
"type":"string",
"enum":[
"ELIGIBLE",
"INELIGIBLE"
]
},
"RenewalStatus":{
"type":"string",
"enum":[
"PENDING_AUTO_RENEWAL",
"PENDING_VALIDATION",
"SUCCESS",
"FAILED"
]
},
"RenewalSummary":{
"type":"structure",
"required":[
"RenewalStatus",
"DomainValidationOptions"
],
"members":{
"RenewalStatus":{"shape":"RenewalStatus"},
"DomainValidationOptions":{"shape":"DomainValidationList"}
}
},
"RequestCertificateRequest":{
"type":"structure",
"required":["DomainName"],
"members":{
"DomainName":{"shape":"DomainNameString"},
"ValidationMethod":{"shape":"ValidationMethod"},
"SubjectAlternativeNames":{"shape":"DomainList"},
"IdempotencyToken":{"shape":"IdempotencyToken"},
"DomainValidationOptions":{"shape":"DomainValidationOptionList"},
"Options":{"shape":"CertificateOptions"},
"CertificateAuthorityArn":{"shape":"Arn"}
}
},
"RequestCertificateResponse":{
"type":"structure",
"members":{
"CertificateArn":{"shape":"Arn"}
}
},
"RequestInProgressException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"ResendValidationEmailRequest":{
"type":"structure",
"required":[
"CertificateArn",
"Domain",
"ValidationDomain"
],
"members":{
"CertificateArn":{"shape":"Arn"},
"Domain":{"shape":"DomainNameString"},
"ValidationDomain":{"shape":"DomainNameString"}
}
},
"ResourceInUseException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"ResourceRecord":{
"type":"structure",
"required":[
"Name",
"Type",
"Value"
],
"members":{
"Name":{"shape":"String"},
"Type":{"shape":"RecordType"},
"Value":{"shape":"String"}
}
},
"RevocationReason":{
"type":"string",
"enum":[
"UNSPECIFIED",
"KEY_COMPROMISE",
"CA_COMPROMISE",
"AFFILIATION_CHANGED",
"SUPERCEDED",
"CESSATION_OF_OPERATION",
"CERTIFICATE_HOLD",
"REMOVE_FROM_CRL",
"PRIVILEGE_WITHDRAWN",
"A_A_COMPROMISE"
]
},
"String":{"type":"string"},
"TStamp":{"type":"timestamp"},
"Tag":{
"type":"structure",
"required":["Key"],
"members":{
"Key":{"shape":"TagKey"},
"Value":{"shape":"TagValue"}
}
},
"TagKey":{
"type":"string",
"max":128,
"min":1,
"pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*"
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"},
"max":50,
"min":1
},
"TagValue":{
"type":"string",
"max":256,
"min":0,
"pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*"
},
"TooManyTagsException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"exception":true
},
"UpdateCertificateOptionsRequest":{
"type":"structure",
"required":[
"CertificateArn",
"Options"
],
"members":{
"CertificateArn":{"shape":"Arn"},
"Options":{"shape":"CertificateOptions"}
}
},
"ValidationEmailList":{
"type":"list",
"member":{"shape":"String"}
},
"ValidationMethod":{
"type":"string",
"enum":[
"EMAIL",
"DNS"
]
}
}
}

538
vendor/github.com/aws/aws-sdk-go/models/apis/acm/2015-12-08/docs-2.json generated vendored Normal file
View File

@@ -0,0 +1,538 @@
{
"version": "2.0",
"service": "<fullname>AWS Certificate Manager</fullname> <p>Welcome to the AWS Certificate Manager (ACM) API documentation.</p> <p>You can use ACM to manage SSL/TLS certificates for your AWS-based websites and applications. For general information about using ACM, see the <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/\"> <i>AWS Certificate Manager User Guide</i> </a>.</p>",
"operations": {
"AddTagsToCertificate": "<p>Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a <code>key</code> and an optional <code>value</code>. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. </p> <p>You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/tags.html\">Tagging ACM certificates</a>. </p> <p>To remove one or more tags, use the <a>RemoveTagsFromCertificate</a> action. To view all of the tags that have been applied to the certificate, use the <a>ListTagsForCertificate</a> action. </p>",
"DeleteCertificate": "<p>Deletes a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the <a>ListCertificates</a> action or be retrieved by calling the <a>GetCertificate</a> action. The certificate will not be available for use by AWS services integrated with ACM. </p> <note> <p>You cannot delete an ACM certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.</p> </note>",
"DescribeCertificate": "<p>Returns detailed metadata about the specified ACM certificate.</p>",
"ExportCertificate": "<p>Exports a certificate for use anywhere. You can export the certificate, the certificate chain, and the encrypted private key associated with the public key embedded in the certificate. You must store the private key securely. The private key is a 2048 bit RSA key. You must provide a passphrase for the private key when exporting it. You can use the following OpenSSL command to decrypt it later. Provide the passphrase when prompted. </p> <p> <code>openssl rsa -in encrypted_key.pem -out decrypted_key.pem</code> </p>",
"GetCertificate": "<p>Retrieves a certificate specified by an ARN and its certificate chain . The chain is an ordered list of certificates that contains the end entity certificate, intermediate certificates of subordinate CAs, and the root certificate in that order. The certificate and certificate chain are base64 encoded. If you want to decode the certificate to see the individual fields, you can use OpenSSL.</p>",
"ImportCertificate": "<p>Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-services.html\">integrated services</a> allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>. </p> <note> <p>ACM does not provide <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-renewal.html\">managed renewal</a> for certificates that you import.</p> </note> <p>Note the following guidelines when importing third party certificates:</p> <ul> <li> <p>You must enter the private key that matches the certificate you are importing.</p> </li> <li> <p>The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.</p> </li> <li> <p>If the certificate you are importing is not self-signed, you must enter its certificate chain.</p> </li> <li> <p>If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.</p> </li> <li> <p>The certificate, private key, and certificate chain must be PEM-encoded.</p> </li> <li> <p>The current time must be between the <code>Not Before</code> and <code>Not After</code> certificate fields.</p> </li> <li> <p>The <code>Issuer</code> field must not be empty.</p> </li> <li> <p>The OCSP authority URL, if present, must not exceed 1000 characters.</p> </li> <li> <p>To import a new certificate, omit the <code>CertificateArn</code> argument. Include this argument only when you want to replace a previously imported certificate.</p> </li> <li> <p>When you import a certificate by using the CLI or one of the SDKs, you must specify the certificate, the certificate chain, and the private key by their file names preceded by <code>file://</code>. For example, you can specify a certificate saved in the <code>C:\\temp</code> folder as <code>file://C:\\temp\\certificate_to_import.pem</code>. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. </p> </li> </ul> <p>This operation returns the <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>",
"ListCertificates": "<p>Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. </p>",
"ListTagsForCertificate": "<p>Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the <a>AddTagsToCertificate</a> action. To delete a tag, use the <a>RemoveTagsFromCertificate</a> action. </p>",
"RemoveTagsFromCertificate": "<p>Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. </p> <p>To add tags to a certificate, use the <a>AddTagsToCertificate</a> action. To view all of the tags that have been applied to a specific ACM certificate, use the <a>ListTagsForCertificate</a> action. </p>",
"RequestCertificate": "<p>Requests an ACM certificate for use with other AWS services. To request an ACM certificate, you must specify the fully qualified domain name (FQDN) for your site in the <code>DomainName</code> parameter. You can also specify additional FQDNs in the <code>SubjectAlternativeNames</code> parameter. </p> <p>Each domain name that you specify must be validated to verify that you own or control the domain. You can use <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/gs-acm-validate-dns.html\">DNS validation</a> or <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/gs-acm-validate-email.html\">email validation</a>. We recommend that you use DNS validation. </p> <p>If you choose email validation, email is sent to the domain owner to request approval to issue the certificate. Email is sent to three registered contact addresses in the WHOIS database and to five common system administration addresses formed from the <code>DomainName</code> you enter or the optional <code>ValidationDomain</code> parameter. For more information, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/gs-acm-validate-email.html\">Validate with Email</a>. </p> <p>After receiving approval from the domain owner, the ACM certificate is issued.</p>",
"ResendValidationEmail": "<p>Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking <b>I Approve</b>. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/setup-email.html\">Configure Email for your Domain</a>. </p>",
"UpdateCertificateOptions": "<p>Updates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-bestpractices.html#best-practices-transparency\"> Opting Out of Certificate Transparency Logging</a>. </p>"
},
"shapes": {
"AddTagsToCertificateRequest": {
"base": null,
"refs": {
}
},
"Arn": {
"base": null,
"refs": {
"AddTagsToCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM certificate to which the tag is to be applied. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </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>. </p>",
"CertificateDetail$CertificateArn": "<p>The Amazon Resource Name (ARN) of the certificate. 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>",
"CertificateDetail$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) of the ACM PCA private certificate authority (CA) that issued the certificate. This has the following format: </p> <p> <code>arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012</code> </p>",
"CertificateSummary$CertificateArn": "<p>Amazon Resource Name (ARN) of the certificate. This is of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </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>. </p>",
"DeleteCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM certificate to be deleted. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </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>.</p>",
"DescribeCertificateRequest$CertificateArn": "<p>The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </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>.</p>",
"ExportCertificateRequest$CertificateArn": "<p>An Amazon Resource Name (ARN) of the issued certificate. This must be of the form:</p> <p> <code>arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012</code> </p>",
"GetCertificateRequest$CertificateArn": "<p>String that contains a certificate ARN in the following format:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </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>.</p>",
"ImportCertificateRequest$CertificateArn": "<p>The <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of an imported certificate to replace. To import a new certificate, omit this field. </p>",
"ImportCertificateResponse$CertificateArn": "<p>The <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>",
"ListTagsForCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM certificate for which you want to list the tags. This must have the following form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </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>. </p>",
"RemoveTagsFromCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM Certificate with one or more tags that you want to remove. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </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>. </p>",
"RequestCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. For more information about private CAs, see the <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm-pca/latest/userguide/PcaWelcome.html\">AWS Certificate Manager Private Certificate Authority (PCA)</a> user guide. The ARN must have the following form: </p> <p> <code>arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012</code> </p>",
"RequestCertificateResponse$CertificateArn": "<p>String that contains the ARN of the issued certificate. This must be of the form:</p> <p> <code>arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p>",
"ResendValidationEmailRequest$CertificateArn": "<p>String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by the <a>RequestCertificate</a> action as soon as the request is made. By default, using this parameter causes email to be sent to all top-level domains you specified in the certificate request. The ARN must be of the form: </p> <p> <code>arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p>",
"UpdateCertificateOptionsRequest$CertificateArn": "<p>ARN of the requested certificate to update. This must be of the form:</p> <p> <code>arn:aws:acm:us-east-1:<i>account</i>:certificate/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
}
},
"CertificateBody": {
"base": null,
"refs": {
"ExportCertificateResponse$Certificate": "<p>The base64 PEM-encoded certificate.</p>",
"GetCertificateResponse$Certificate": "<p>String that contains the ACM certificate represented by the ARN specified at input.</p>"
}
},
"CertificateBodyBlob": {
"base": null,
"refs": {
"ImportCertificateRequest$Certificate": "<p>The certificate to import.</p>"
}
},
"CertificateChain": {
"base": null,
"refs": {
"ExportCertificateResponse$CertificateChain": "<p>The base64 PEM-encoded certificate chain. This does not include the certificate that you are exporting.</p>",
"GetCertificateResponse$CertificateChain": "<p>The certificate chain that contains the root certificate issued by the certificate authority (CA).</p>"
}
},
"CertificateChainBlob": {
"base": null,
"refs": {
"ImportCertificateRequest$CertificateChain": "<p>The PEM encoded certificate chain.</p>"
}
},
"CertificateDetail": {
"base": "<p>Contains metadata about an ACM certificate. This structure is returned in the response to a <a>DescribeCertificate</a> request. </p>",
"refs": {
"DescribeCertificateResponse$Certificate": "<p>Metadata about an ACM certificate.</p>"
}
},
"CertificateOptions": {
"base": "<p>Structure that contains options for your certificate. Currently, you can use this only to specify whether to opt in to or out of certificate transparency logging. Some browsers require that public certificates issued for your domain be recorded in a log. Certificates that are not logged typically generate a browser error. Transparency makes it possible for you to detect SSL/TLS certificates that have been mistakenly or maliciously issued for your domain. For general information, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-concepts.html#concept-transparency\">Certificate Transparency Logging</a>. </p>",
"refs": {
"CertificateDetail$Options": "<p>Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure. </p>",
"RequestCertificateRequest$Options": "<p>Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-bestpractices.html#best-practices-transparency\">Opting Out of Certificate Transparency Logging</a>.</p>",
"UpdateCertificateOptionsRequest$Options": "<p>Use to update the options for your certificate. Currently, you can specify whether to add your certificate to a transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. </p>"
}
},
"CertificateStatus": {
"base": null,
"refs": {
"CertificateDetail$Status": "<p>The status of the certificate.</p>",
"CertificateStatuses$member": null
}
},
"CertificateStatuses": {
"base": null,
"refs": {
"ListCertificatesRequest$CertificateStatuses": "<p>Filter the certificate list by status value.</p>"
}
},
"CertificateSummary": {
"base": "<p>This structure is returned in the response object of <a>ListCertificates</a> action. </p>",
"refs": {
"CertificateSummaryList$member": null
}
},
"CertificateSummaryList": {
"base": null,
"refs": {
"ListCertificatesResponse$CertificateSummaryList": "<p>A list of ACM certificates.</p>"
}
},
"CertificateTransparencyLoggingPreference": {
"base": null,
"refs": {
"CertificateOptions$CertificateTransparencyLoggingPreference": "<p>You can opt out of certificate transparency logging by specifying the <code>DISABLED</code> option. Opt in by specifying <code>ENABLED</code>. </p>"
}
},
"CertificateType": {
"base": null,
"refs": {
"CertificateDetail$Type": "<p>The source of the certificate. For certificates provided by ACM, this value is <code>AMAZON_ISSUED</code>. For certificates that you imported with <a>ImportCertificate</a>, this value is <code>IMPORTED</code>. ACM does not provide <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-renewal.html\">managed renewal</a> for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>. </p>"
}
},
"DeleteCertificateRequest": {
"base": null,
"refs": {
}
},
"DescribeCertificateRequest": {
"base": null,
"refs": {
}
},
"DescribeCertificateResponse": {
"base": null,
"refs": {
}
},
"DomainList": {
"base": null,
"refs": {
"CertificateDetail$SubjectAlternativeNames": "<p>One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website. </p>",
"RequestCertificateRequest$SubjectAlternativeNames": "<p>Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the <code>DomainName</code> field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial limit is 10 domain names. If you need more than 10 names, you must request a limit increase. For more information, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-limits.html\">Limits</a>.</p> <p> The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples: </p> <ul> <li> <p> <code>(63 octets).(63 octets).(63 octets).(61 octets)</code> is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.</p> </li> <li> <p> <code>(64 octets).(63 octets).(63 octets).(61 octets)</code> is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.</p> </li> <li> <p> <code>(63 octets).(63 octets).(63 octets).(62 octets)</code> is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.</p> </li> </ul>"
}
},
"DomainNameString": {
"base": null,
"refs": {
"CertificateDetail$DomainName": "<p>The fully qualified domain name for the certificate, such as www.example.com or example.com.</p>",
"CertificateSummary$DomainName": "<p>Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.</p>",
"DomainList$member": null,
"DomainValidation$DomainName": "<p>A fully qualified domain name (FQDN) in the certificate. For example, <code>www.example.com</code> or <code>example.com</code>. </p>",
"DomainValidation$ValidationDomain": "<p>The domain name that ACM used to send domain validation emails.</p>",
"DomainValidationOption$DomainName": "<p>A fully qualified domain name (FQDN) in the certificate request.</p>",
"DomainValidationOption$ValidationDomain": "<p>The domain name that you want ACM to use to send you validation emails. This domain name is the suffix of the email addresses that you want ACM to use. This must be the same as the <code>DomainName</code> value or a superdomain of the <code>DomainName</code> value. For example, if you request a certificate for <code>testing.example.com</code>, you can specify <code>example.com</code> for this value. In that case, ACM sends domain validation emails to the following five addresses:</p> <ul> <li> <p>admin@example.com</p> </li> <li> <p>administrator@example.com</p> </li> <li> <p>hostmaster@example.com</p> </li> <li> <p>postmaster@example.com</p> </li> <li> <p>webmaster@example.com</p> </li> </ul>",
"RequestCertificateRequest$DomainName": "<p> Fully qualified domain name (FQDN), such as www.example.com, of the site that you want to secure with an ACM Certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com. </p> <p> The first domain name you enter cannot exceed 63 octets, including periods. Each subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length. </p>",
"ResendValidationEmailRequest$Domain": "<p>The fully qualified domain name (FQDN) of the certificate that needs to be validated.</p>",
"ResendValidationEmailRequest$ValidationDomain": "<p>The base validation domain that will act as the suffix of the email addresses that are used to send the emails. This must be the same as the <code>Domain</code> value or a superdomain of the <code>Domain</code> value. For example, if you requested a certificate for <code>site.subdomain.example.com</code> and specify a <b>ValidationDomain</b> of <code>subdomain.example.com</code>, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses:</p> <ul> <li> <p>admin@subdomain.example.com</p> </li> <li> <p>administrator@subdomain.example.com</p> </li> <li> <p>hostmaster@subdomain.example.com</p> </li> <li> <p>postmaster@subdomain.example.com</p> </li> <li> <p>webmaster@subdomain.example.com</p> </li> </ul>"
}
},
"DomainStatus": {
"base": null,
"refs": {
"DomainValidation$ValidationStatus": "<p>The validation status of the domain name. This can be one of the following values:</p> <ul> <li> <p> <code>PENDING_VALIDATION</code> </p> </li> <li> <p> <code/>SUCCESS</p> </li> <li> <p> <code/>FAILED</p> </li> </ul>"
}
},
"DomainValidation": {
"base": "<p>Contains information about the validation of each domain name in the certificate.</p>",
"refs": {
"DomainValidationList$member": null
}
},
"DomainValidationList": {
"base": null,
"refs": {
"CertificateDetail$DomainValidationOptions": "<p>Contains information about the initial validation of each domain name that occurs as a result of the <a>RequestCertificate</a> request. This field exists only when the certificate type is <code>AMAZON_ISSUED</code>. </p>",
"RenewalSummary$DomainValidationOptions": "<p>Contains information about the validation of each domain name in the certificate, as it pertains to ACM's <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-renewal.html\">managed renewal</a>. This is different from the initial validation that occurs as a result of the <a>RequestCertificate</a> request. This field exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>"
}
},
"DomainValidationOption": {
"base": "<p>Contains information about the domain names that you want ACM to use to send you emails that enable you to validate domain ownership.</p>",
"refs": {
"DomainValidationOptionList$member": null
}
},
"DomainValidationOptionList": {
"base": null,
"refs": {
"RequestCertificateRequest$DomainValidationOptions": "<p>The domain name that you want ACM to use to send you emails so that you can validate domain ownership.</p>"
}
},
"ExportCertificateRequest": {
"base": null,
"refs": {
}
},
"ExportCertificateResponse": {
"base": null,
"refs": {
}
},
"ExtendedKeyUsage": {
"base": "<p>The Extended Key Usage X.509 v3 extension defines one or more purposes for which the public key can be used. This is in addition to or in place of the basic purposes specified by the Key Usage extension. </p>",
"refs": {
"ExtendedKeyUsageList$member": null
}
},
"ExtendedKeyUsageFilterList": {
"base": null,
"refs": {
"Filters$extendedKeyUsage": "<p>Specify one or more <a>ExtendedKeyUsage</a> extension values.</p>"
}
},
"ExtendedKeyUsageList": {
"base": null,
"refs": {
"CertificateDetail$ExtendedKeyUsages": "<p>Contains a list of Extended Key Usage X.509 v3 extension objects. Each object specifies a purpose for which the certificate public key can be used and consists of a name and an object identifier (OID). </p>"
}
},
"ExtendedKeyUsageName": {
"base": null,
"refs": {
"ExtendedKeyUsage$Name": "<p>The name of an Extended Key Usage value.</p>",
"ExtendedKeyUsageFilterList$member": null
}
},
"FailureReason": {
"base": null,
"refs": {
"CertificateDetail$FailureReason": "<p>The reason the certificate request failed. This value exists only when the certificate status is <code>FAILED</code>. For more information, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/troubleshooting.html#troubleshooting-failed\">Certificate Request Failed</a> in the <i>AWS Certificate Manager User Guide</i>. </p>"
}
},
"Filters": {
"base": "<p>This structure can be used in the <a>ListCertificates</a> action to filter the output of the certificate list. </p>",
"refs": {
"ListCertificatesRequest$Includes": "<p>Filter the certificate list. For more information, see the <a>Filters</a> structure.</p>"
}
},
"GetCertificateRequest": {
"base": null,
"refs": {
}
},
"GetCertificateResponse": {
"base": null,
"refs": {
}
},
"IdempotencyToken": {
"base": null,
"refs": {
"RequestCertificateRequest$IdempotencyToken": "<p>Customer chosen string that can be used to distinguish between calls to <code>RequestCertificate</code>. Idempotency tokens time out after one hour. Therefore, if you call <code>RequestCertificate</code> multiple times with the same idempotency token within one hour, ACM recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, ACM recognizes that you are requesting multiple certificates.</p>"
}
},
"ImportCertificateRequest": {
"base": null,
"refs": {
}
},
"ImportCertificateResponse": {
"base": null,
"refs": {
}
},
"InUseList": {
"base": null,
"refs": {
"CertificateDetail$InUseBy": "<p>A list of ARNs for the AWS resources that are using the certificate. A certificate can be used by multiple AWS resources. </p>"
}
},
"InvalidArnException": {
"base": "<p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>",
"refs": {
}
},
"InvalidDomainValidationOptionsException": {
"base": "<p>One or more values in the <a>DomainValidationOption</a> structure is incorrect.</p>",
"refs": {
}
},
"InvalidStateException": {
"base": "<p>Processing has reached an invalid state.</p>",
"refs": {
}
},
"InvalidTagException": {
"base": "<p>One or both of the values that make up the key-value pair is not valid. For example, you cannot specify a tag value that begins with <code>aws:</code>.</p>",
"refs": {
}
},
"KeyAlgorithm": {
"base": null,
"refs": {
"CertificateDetail$KeyAlgorithm": "<p>The algorithm that was used to generate the public-private key pair.</p>",
"KeyAlgorithmList$member": null
}
},
"KeyAlgorithmList": {
"base": null,
"refs": {
"Filters$keyTypes": "<p>Specify one or more algorithms that can be used to generate key pairs.</p>"
}
},
"KeyUsage": {
"base": "<p>The Key Usage X.509 v3 extension defines the purpose of the public key contained in the certificate.</p>",
"refs": {
"KeyUsageList$member": null
}
},
"KeyUsageFilterList": {
"base": null,
"refs": {
"Filters$keyUsage": "<p>Specify one or more <a>KeyUsage</a> extension values.</p>"
}
},
"KeyUsageList": {
"base": null,
"refs": {
"CertificateDetail$KeyUsages": "<p>A list of Key Usage X.509 v3 extension objects. Each object is a string value that identifies the purpose of the public key contained in the certificate. Possible extension values include DIGITAL_SIGNATURE, KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.</p>"
}
},
"KeyUsageName": {
"base": null,
"refs": {
"KeyUsage$Name": "<p>A string value that contains a Key Usage extension name.</p>",
"KeyUsageFilterList$member": null
}
},
"LimitExceededException": {
"base": "<p>An ACM limit has been exceeded.</p>",
"refs": {
}
},
"ListCertificatesRequest": {
"base": null,
"refs": {
}
},
"ListCertificatesResponse": {
"base": null,
"refs": {
}
},
"ListTagsForCertificateRequest": {
"base": null,
"refs": {
}
},
"ListTagsForCertificateResponse": {
"base": null,
"refs": {
}
},
"MaxItems": {
"base": null,
"refs": {
"ListCertificatesRequest$MaxItems": "<p>Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the <code>NextToken</code> element is sent in the response. Use this <code>NextToken</code> value in a subsequent request to retrieve additional items.</p>"
}
},
"NextToken": {
"base": null,
"refs": {
"ListCertificatesRequest$NextToken": "<p>Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextToken</code> from the response you just received.</p>",
"ListCertificatesResponse$NextToken": "<p>When the list is truncated, this value is present and contains the value to use for the <code>NextToken</code> parameter in a subsequent pagination request.</p>"
}
},
"PassphraseBlob": {
"base": null,
"refs": {
"ExportCertificateRequest$Passphrase": "<p>Passphrase to associate with the encrypted exported private key. If you want to later decrypt the private key, you must have the passphrase. You can use the following OpenSSL command to decrypt a private key: </p> <p> <code>openssl rsa -in encrypted_key.pem -out decrypted_key.pem</code> </p>"
}
},
"PrivateKey": {
"base": null,
"refs": {
"ExportCertificateResponse$PrivateKey": "<p>The PEM-encoded private key associated with the public key in the certificate.</p>"
}
},
"PrivateKeyBlob": {
"base": null,
"refs": {
"ImportCertificateRequest$PrivateKey": "<p>The private key that matches the public key in the certificate.</p>"
}
},
"RecordType": {
"base": null,
"refs": {
"ResourceRecord$Type": "<p>The type of DNS record. Currently this can be <code>CNAME</code>.</p>"
}
},
"RemoveTagsFromCertificateRequest": {
"base": null,
"refs": {
}
},
"RenewalEligibility": {
"base": null,
"refs": {
"CertificateDetail$RenewalEligibility": "<p>Specifies whether the certificate is eligible for renewal.</p>"
}
},
"RenewalStatus": {
"base": null,
"refs": {
"RenewalSummary$RenewalStatus": "<p>The status of ACM's <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-renewal.html\">managed renewal</a> of the certificate.</p>"
}
},
"RenewalSummary": {
"base": "<p>Contains information about the status of ACM's <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-renewal.html\">managed renewal</a> for the certificate. This structure exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>",
"refs": {
"CertificateDetail$RenewalSummary": "<p>Contains information about the status of ACM's <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-renewal.html\">managed renewal</a> for the certificate. This field exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>"
}
},
"RequestCertificateRequest": {
"base": null,
"refs": {
}
},
"RequestCertificateResponse": {
"base": null,
"refs": {
}
},
"RequestInProgressException": {
"base": "<p>The certificate request is in process and the certificate in your account has not yet been issued.</p>",
"refs": {
}
},
"ResendValidationEmailRequest": {
"base": null,
"refs": {
}
},
"ResourceInUseException": {
"base": "<p>The certificate is in use by another AWS service in the caller's account. Remove the association and try again.</p>",
"refs": {
}
},
"ResourceNotFoundException": {
"base": "<p>The specified certificate cannot be found in the caller's account or the caller's account cannot be found.</p>",
"refs": {
}
},
"ResourceRecord": {
"base": "<p>Contains a DNS record value that you can use to can use to validate ownership or control of a domain. This is used by the <a>DescribeCertificate</a> action. </p>",
"refs": {
"DomainValidation$ResourceRecord": "<p>Contains the CNAME record that you add to your DNS database for domain validation. For more information, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/gs-acm-validate-dns.html\">Use DNS to Validate Domain Ownership</a>.</p>"
}
},
"RevocationReason": {
"base": null,
"refs": {
"CertificateDetail$RevocationReason": "<p>The reason the certificate was revoked. This value exists only when the certificate status is <code>REVOKED</code>. </p>"
}
},
"String": {
"base": null,
"refs": {
"CertificateDetail$Serial": "<p>The serial number of the certificate.</p>",
"CertificateDetail$Subject": "<p>The name of the entity that is associated with the public key contained in the certificate.</p>",
"CertificateDetail$Issuer": "<p>The name of the certificate authority that issued and signed the certificate.</p>",
"CertificateDetail$SignatureAlgorithm": "<p>The algorithm that was used to sign the certificate.</p>",
"ExtendedKeyUsage$OID": "<p>An object identifier (OID) for the extension value. OIDs are strings of numbers separated by periods. The following OIDs are defined in RFC 3280 and RFC 5280. </p> <ul> <li> <p> <code>1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.3 (CODE_SIGNING)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.8 (TIME_STAMPING)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.9 (OCSP_SIGNING)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.7 (IPSEC_USER)</code> </p> </li> </ul>",
"InUseList$member": null,
"InvalidArnException$message": null,
"InvalidDomainValidationOptionsException$message": null,
"InvalidStateException$message": null,
"InvalidTagException$message": null,
"LimitExceededException$message": null,
"RequestInProgressException$message": null,
"ResourceInUseException$message": null,
"ResourceNotFoundException$message": null,
"ResourceRecord$Name": "<p>The name of the DNS record to create in your domain. This is supplied by ACM.</p>",
"ResourceRecord$Value": "<p>The value of the CNAME record to add to your DNS database. This is supplied by ACM.</p>",
"TooManyTagsException$message": null,
"ValidationEmailList$member": null
}
},
"TStamp": {
"base": null,
"refs": {
"CertificateDetail$CreatedAt": "<p>The time at which the certificate was requested. This value exists only when the certificate type is <code>AMAZON_ISSUED</code>. </p>",
"CertificateDetail$IssuedAt": "<p>The time at which the certificate was issued. This value exists only when the certificate type is <code>AMAZON_ISSUED</code>. </p>",
"CertificateDetail$ImportedAt": "<p>The date and time at which the certificate was imported. This value exists only when the certificate type is <code>IMPORTED</code>. </p>",
"CertificateDetail$RevokedAt": "<p>The time at which the certificate was revoked. This value exists only when the certificate status is <code>REVOKED</code>. </p>",
"CertificateDetail$NotBefore": "<p>The time before which the certificate is not valid.</p>",
"CertificateDetail$NotAfter": "<p>The time after which the certificate is not valid.</p>"
}
},
"Tag": {
"base": "<p>A key-value pair that identifies or specifies metadata about an ACM resource.</p>",
"refs": {
"TagList$member": null
}
},
"TagKey": {
"base": null,
"refs": {
"Tag$Key": "<p>The key of the tag.</p>"
}
},
"TagList": {
"base": null,
"refs": {
"AddTagsToCertificateRequest$Tags": "<p>The key-value pair that defines the tag. The tag value is optional.</p>",
"ListTagsForCertificateResponse$Tags": "<p>The key-value pairs that define the applied tags.</p>",
"RemoveTagsFromCertificateRequest$Tags": "<p>The key-value pair that defines the tag to remove.</p>"
}
},
"TagValue": {
"base": null,
"refs": {
"Tag$Value": "<p>The value of the tag.</p>"
}
},
"TooManyTagsException": {
"base": "<p>The request contains too many tags. Try the request again with fewer tags.</p>",
"refs": {
}
},
"UpdateCertificateOptionsRequest": {
"base": null,
"refs": {
}
},
"ValidationEmailList": {
"base": null,
"refs": {
"DomainValidation$ValidationEmails": "<p>A list of email addresses that ACM used to send domain validation emails.</p>"
}
},
"ValidationMethod": {
"base": null,
"refs": {
"DomainValidation$ValidationMethod": "<p>Specifies the domain validation method.</p>",
"RequestCertificateRequest$ValidationMethod": "<p>The method you want to use to validate that you own or control domain. You can <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/gs-acm-validate-dns.html\">validate with DNS</a> or <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/gs-acm-validate-email.html\">validate with email</a>. We recommend that you use DNS validation. </p>"
}
}
}
}

5
vendor/github.com/aws/aws-sdk-go/models/apis/acm/2015-12-08/examples-1.json generated vendored Normal file
View File

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

10
vendor/github.com/aws/aws-sdk-go/models/apis/acm/2015-12-08/paginators-1.json generated vendored Normal file
View File

@@ -0,0 +1,10 @@
{
"pagination": {
"ListCertificates": {
"input_token": "NextToken",
"limit_key": "MaxItems",
"output_token": "NextToken",
"result_key": "CertificateSummaryList"
}
}
}

18
vendor/github.com/aws/aws-sdk-go/models/apis/acm/2015-12-08/smoke.json generated vendored Normal file
View File

@@ -0,0 +1,18 @@
{
"version": 1,
"defaultRegion": "us-west-2",
"testCases": [
{
"operationName": "ListCertificates",
"input": {},
"errorExpectedFromService": false
},
{
"operationName": "GetCertificate",
"input": {
"CertificateArn": "arn:aws:acm:region:123456789012:certificate\/12345678-1234-1234-1234-123456789012"
},
"errorExpectedFromService": true
}
]
}

1860
vendor/github.com/aws/aws-sdk-go/models/apis/alexaforbusiness/2017-11-09/api-2.json generated vendored Normal file
View File

File diff suppressed because it is too large Load Diff

1288
vendor/github.com/aws/aws-sdk-go/models/apis/alexaforbusiness/2017-11-09/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/alexaforbusiness/2017-11-09/examples-1.json generated vendored Normal file
View File

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

49
vendor/github.com/aws/aws-sdk-go/models/apis/alexaforbusiness/2017-11-09/paginators-1.json generated vendored Normal file
View File

@@ -0,0 +1,49 @@
{
"pagination": {
"ListSkills": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListTags": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"SearchAddressBooks": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"SearchContacts": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"SearchDevices": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"SearchProfiles": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"SearchRooms": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"SearchSkillGroups": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"SearchUsers": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
}
}
}

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because one or more lines are too long

5
vendor/github.com/aws/aws-sdk-go/models/apis/apigateway/2015-07-09/examples-1.json generated vendored Normal file
View File

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

76
vendor/github.com/aws/aws-sdk-go/models/apis/apigateway/2015-07-09/paginators-1.json generated vendored Normal file
View File

@@ -0,0 +1,76 @@
{
"pagination": {
"GetApiKeys": {
"input_token": "position",
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
},
"GetBasePathMappings": {
"input_token": "position",
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
},
"GetClientCertificates": {
"input_token": "position",
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
},
"GetDeployments": {
"input_token": "position",
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
},
"GetDomainNames": {
"input_token": "position",
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
},
"GetModels": {
"input_token": "position",
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
},
"GetResources": {
"input_token": "position",
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
},
"GetRestApis": {
"input_token": "position",
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
},
"GetUsage": {
"input_token": "position",
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
},
"GetUsagePlanKeys": {
"input_token": "position",
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
},
"GetUsagePlans": {
"input_token": "position",
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
},
"GetVpcLinks": {
"input_token": "position",
"limit_key": "limit",
"output_token": "position",
"result_key": "items"
}
}
}

20
vendor/github.com/aws/aws-sdk-go/models/apis/apigateway/2015-07-09/smoke.json generated vendored Normal file
View File

@@ -0,0 +1,20 @@
{
"version": 1,
"defaultRegion": "us-west-2",
"testCases": [
{
"operationName": "GetDomainNames",
"input": {},
"errorExpectedFromService": false
},
{
"operationName": "CreateUsagePlanKey",
"input": {
"usagePlanId": "foo",
"keyId": "bar",
"keyType": "fixx"
},
"errorExpectedFromService": true
}
]
}

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

@@ -0,0 +1,764 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2016-02-06",
"endpointPrefix":"autoscaling",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Application Auto Scaling",
"serviceId":"Application Auto Scaling",
"signatureVersion":"v4",
"signingName":"application-autoscaling",
"targetPrefix":"AnyScaleFrontendService",
"uid":"application-autoscaling-2016-02-06"
},
"operations":{
"DeleteScalingPolicy":{
"name":"DeleteScalingPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteScalingPolicyRequest"},
"output":{"shape":"DeleteScalingPolicyResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ObjectNotFoundException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
]
},
"DeleteScheduledAction":{
"name":"DeleteScheduledAction",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteScheduledActionRequest"},
"output":{"shape":"DeleteScheduledActionResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ObjectNotFoundException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
]
},
"DeregisterScalableTarget":{
"name":"DeregisterScalableTarget",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeregisterScalableTargetRequest"},
"output":{"shape":"DeregisterScalableTargetResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ObjectNotFoundException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
]
},
"DescribeScalableTargets":{
"name":"DescribeScalableTargets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeScalableTargetsRequest"},
"output":{"shape":"DescribeScalableTargetsResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
]
},
"DescribeScalingActivities":{
"name":"DescribeScalingActivities",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeScalingActivitiesRequest"},
"output":{"shape":"DescribeScalingActivitiesResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
]
},
"DescribeScalingPolicies":{
"name":"DescribeScalingPolicies",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeScalingPoliciesRequest"},
"output":{"shape":"DescribeScalingPoliciesResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"FailedResourceAccessException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
]
},
"DescribeScheduledActions":{
"name":"DescribeScheduledActions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeScheduledActionsRequest"},
"output":{"shape":"DescribeScheduledActionsResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
]
},
"PutScalingPolicy":{
"name":"PutScalingPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutScalingPolicyRequest"},
"output":{"shape":"PutScalingPolicyResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"ObjectNotFoundException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"FailedResourceAccessException"},
{"shape":"InternalServiceException"}
]
},
"PutScheduledAction":{
"name":"PutScheduledAction",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutScheduledActionRequest"},
"output":{"shape":"PutScheduledActionResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"ObjectNotFoundException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
]
},
"RegisterScalableTarget":{
"name":"RegisterScalableTarget",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RegisterScalableTargetRequest"},
"output":{"shape":"RegisterScalableTargetResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
]
}
},
"shapes":{
"AdjustmentType":{
"type":"string",
"enum":[
"ChangeInCapacity",
"PercentChangeInCapacity",
"ExactCapacity"
]
},
"Alarm":{
"type":"structure",
"required":[
"AlarmName",
"AlarmARN"
],
"members":{
"AlarmName":{"shape":"ResourceId"},
"AlarmARN":{"shape":"ResourceId"}
}
},
"Alarms":{
"type":"list",
"member":{"shape":"Alarm"}
},
"ConcurrentUpdateException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"Cooldown":{"type":"integer"},
"CustomizedMetricSpecification":{
"type":"structure",
"required":[
"MetricName",
"Namespace",
"Statistic"
],
"members":{
"MetricName":{"shape":"MetricName"},
"Namespace":{"shape":"MetricNamespace"},
"Dimensions":{"shape":"MetricDimensions"},
"Statistic":{"shape":"MetricStatistic"},
"Unit":{"shape":"MetricUnit"}
}
},
"DeleteScalingPolicyRequest":{
"type":"structure",
"required":[
"PolicyName",
"ServiceNamespace",
"ResourceId",
"ScalableDimension"
],
"members":{
"PolicyName":{"shape":"ResourceIdMaxLen1600"},
"ServiceNamespace":{"shape":"ServiceNamespace"},
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"}
}
},
"DeleteScalingPolicyResponse":{
"type":"structure",
"members":{
}
},
"DeleteScheduledActionRequest":{
"type":"structure",
"required":[
"ServiceNamespace",
"ScheduledActionName",
"ResourceId"
],
"members":{
"ServiceNamespace":{"shape":"ServiceNamespace"},
"ScheduledActionName":{"shape":"ResourceIdMaxLen1600"},
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"}
}
},
"DeleteScheduledActionResponse":{
"type":"structure",
"members":{
}
},
"DeregisterScalableTargetRequest":{
"type":"structure",
"required":[
"ServiceNamespace",
"ResourceId",
"ScalableDimension"
],
"members":{
"ServiceNamespace":{"shape":"ServiceNamespace"},
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"}
}
},
"DeregisterScalableTargetResponse":{
"type":"structure",
"members":{
}
},
"DescribeScalableTargetsRequest":{
"type":"structure",
"required":["ServiceNamespace"],
"members":{
"ServiceNamespace":{"shape":"ServiceNamespace"},
"ResourceIds":{"shape":"ResourceIdsMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"},
"MaxResults":{"shape":"MaxResults"},
"NextToken":{"shape":"XmlString"}
}
},
"DescribeScalableTargetsResponse":{
"type":"structure",
"members":{
"ScalableTargets":{"shape":"ScalableTargets"},
"NextToken":{"shape":"XmlString"}
}
},
"DescribeScalingActivitiesRequest":{
"type":"structure",
"required":["ServiceNamespace"],
"members":{
"ServiceNamespace":{"shape":"ServiceNamespace"},
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"},
"MaxResults":{"shape":"MaxResults"},
"NextToken":{"shape":"XmlString"}
}
},
"DescribeScalingActivitiesResponse":{
"type":"structure",
"members":{
"ScalingActivities":{"shape":"ScalingActivities"},
"NextToken":{"shape":"XmlString"}
}
},
"DescribeScalingPoliciesRequest":{
"type":"structure",
"required":["ServiceNamespace"],
"members":{
"PolicyNames":{"shape":"ResourceIdsMaxLen1600"},
"ServiceNamespace":{"shape":"ServiceNamespace"},
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"},
"MaxResults":{"shape":"MaxResults"},
"NextToken":{"shape":"XmlString"}
}
},
"DescribeScalingPoliciesResponse":{
"type":"structure",
"members":{
"ScalingPolicies":{"shape":"ScalingPolicies"},
"NextToken":{"shape":"XmlString"}
}
},
"DescribeScheduledActionsRequest":{
"type":"structure",
"required":["ServiceNamespace"],
"members":{
"ScheduledActionNames":{"shape":"ResourceIdsMaxLen1600"},
"ServiceNamespace":{"shape":"ServiceNamespace"},
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"},
"MaxResults":{"shape":"MaxResults"},
"NextToken":{"shape":"XmlString"}
}
},
"DescribeScheduledActionsResponse":{
"type":"structure",
"members":{
"ScheduledActions":{"shape":"ScheduledActions"},
"NextToken":{"shape":"XmlString"}
}
},
"DisableScaleIn":{"type":"boolean"},
"ErrorMessage":{"type":"string"},
"FailedResourceAccessException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"InternalServiceException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"InvalidNextTokenException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"MaxResults":{"type":"integer"},
"MetricAggregationType":{
"type":"string",
"enum":[
"Average",
"Minimum",
"Maximum"
]
},
"MetricDimension":{
"type":"structure",
"required":[
"Name",
"Value"
],
"members":{
"Name":{"shape":"MetricDimensionName"},
"Value":{"shape":"MetricDimensionValue"}
}
},
"MetricDimensionName":{"type":"string"},
"MetricDimensionValue":{"type":"string"},
"MetricDimensions":{
"type":"list",
"member":{"shape":"MetricDimension"}
},
"MetricName":{"type":"string"},
"MetricNamespace":{"type":"string"},
"MetricScale":{"type":"double"},
"MetricStatistic":{
"type":"string",
"enum":[
"Average",
"Minimum",
"Maximum",
"SampleCount",
"Sum"
]
},
"MetricType":{
"type":"string",
"enum":[
"DynamoDBReadCapacityUtilization",
"DynamoDBWriteCapacityUtilization",
"ALBRequestCountPerTarget",
"RDSReaderAverageCPUUtilization",
"RDSReaderAverageDatabaseConnections",
"EC2SpotFleetRequestAverageCPUUtilization",
"EC2SpotFleetRequestAverageNetworkIn",
"EC2SpotFleetRequestAverageNetworkOut",
"SageMakerVariantInvocationsPerInstance",
"ECSServiceAverageCPUUtilization",
"ECSServiceAverageMemoryUtilization"
]
},
"MetricUnit":{"type":"string"},
"MinAdjustmentMagnitude":{"type":"integer"},
"ObjectNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"PolicyName":{
"type":"string",
"max":256,
"min":1,
"pattern":"\\p{Print}+"
},
"PolicyType":{
"type":"string",
"enum":[
"StepScaling",
"TargetTrackingScaling"
]
},
"PredefinedMetricSpecification":{
"type":"structure",
"required":["PredefinedMetricType"],
"members":{
"PredefinedMetricType":{"shape":"MetricType"},
"ResourceLabel":{"shape":"ResourceLabel"}
}
},
"PutScalingPolicyRequest":{
"type":"structure",
"required":[
"PolicyName",
"ServiceNamespace",
"ResourceId",
"ScalableDimension"
],
"members":{
"PolicyName":{"shape":"PolicyName"},
"ServiceNamespace":{"shape":"ServiceNamespace"},
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"},
"PolicyType":{"shape":"PolicyType"},
"StepScalingPolicyConfiguration":{"shape":"StepScalingPolicyConfiguration"},
"TargetTrackingScalingPolicyConfiguration":{"shape":"TargetTrackingScalingPolicyConfiguration"}
}
},
"PutScalingPolicyResponse":{
"type":"structure",
"required":["PolicyARN"],
"members":{
"PolicyARN":{"shape":"ResourceIdMaxLen1600"},
"Alarms":{"shape":"Alarms"}
}
},
"PutScheduledActionRequest":{
"type":"structure",
"required":[
"ServiceNamespace",
"ScheduledActionName",
"ResourceId"
],
"members":{
"ServiceNamespace":{"shape":"ServiceNamespace"},
"Schedule":{"shape":"ResourceIdMaxLen1600"},
"ScheduledActionName":{"shape":"ScheduledActionName"},
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"},
"StartTime":{"shape":"TimestampType"},
"EndTime":{"shape":"TimestampType"},
"ScalableTargetAction":{"shape":"ScalableTargetAction"}
}
},
"PutScheduledActionResponse":{
"type":"structure",
"members":{
}
},
"RegisterScalableTargetRequest":{
"type":"structure",
"required":[
"ServiceNamespace",
"ResourceId",
"ScalableDimension"
],
"members":{
"ServiceNamespace":{"shape":"ServiceNamespace"},
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"},
"MinCapacity":{"shape":"ResourceCapacity"},
"MaxCapacity":{"shape":"ResourceCapacity"},
"RoleARN":{"shape":"ResourceIdMaxLen1600"}
}
},
"RegisterScalableTargetResponse":{
"type":"structure",
"members":{
}
},
"ResourceCapacity":{"type":"integer"},
"ResourceId":{
"type":"string",
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
},
"ResourceIdMaxLen1600":{
"type":"string",
"max":1600,
"min":1,
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
},
"ResourceIdsMaxLen1600":{
"type":"list",
"member":{"shape":"ResourceIdMaxLen1600"}
},
"ResourceLabel":{
"type":"string",
"max":1023,
"min":1
},
"ScalableDimension":{
"type":"string",
"enum":[
"ecs:service:DesiredCount",
"ec2:spot-fleet-request:TargetCapacity",
"elasticmapreduce:instancegroup:InstanceCount",
"appstream:fleet:DesiredCapacity",
"dynamodb:table:ReadCapacityUnits",
"dynamodb:table:WriteCapacityUnits",
"dynamodb:index:ReadCapacityUnits",
"dynamodb:index:WriteCapacityUnits",
"rds:cluster:ReadReplicaCount",
"sagemaker:variant:DesiredInstanceCount"
]
},
"ScalableTarget":{
"type":"structure",
"required":[
"ServiceNamespace",
"ResourceId",
"ScalableDimension",
"MinCapacity",
"MaxCapacity",
"RoleARN",
"CreationTime"
],
"members":{
"ServiceNamespace":{"shape":"ServiceNamespace"},
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"},
"MinCapacity":{"shape":"ResourceCapacity"},
"MaxCapacity":{"shape":"ResourceCapacity"},
"RoleARN":{"shape":"ResourceIdMaxLen1600"},
"CreationTime":{"shape":"TimestampType"}
}
},
"ScalableTargetAction":{
"type":"structure",
"members":{
"MinCapacity":{"shape":"ResourceCapacity"},
"MaxCapacity":{"shape":"ResourceCapacity"}
}
},
"ScalableTargets":{
"type":"list",
"member":{"shape":"ScalableTarget"}
},
"ScalingActivities":{
"type":"list",
"member":{"shape":"ScalingActivity"}
},
"ScalingActivity":{
"type":"structure",
"required":[
"ActivityId",
"ServiceNamespace",
"ResourceId",
"ScalableDimension",
"Description",
"Cause",
"StartTime",
"StatusCode"
],
"members":{
"ActivityId":{"shape":"ResourceId"},
"ServiceNamespace":{"shape":"ServiceNamespace"},
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"},
"Description":{"shape":"XmlString"},
"Cause":{"shape":"XmlString"},
"StartTime":{"shape":"TimestampType"},
"EndTime":{"shape":"TimestampType"},
"StatusCode":{"shape":"ScalingActivityStatusCode"},
"StatusMessage":{"shape":"XmlString"},
"Details":{"shape":"XmlString"}
}
},
"ScalingActivityStatusCode":{
"type":"string",
"enum":[
"Pending",
"InProgress",
"Successful",
"Overridden",
"Unfulfilled",
"Failed"
]
},
"ScalingAdjustment":{"type":"integer"},
"ScalingPolicies":{
"type":"list",
"member":{"shape":"ScalingPolicy"}
},
"ScalingPolicy":{
"type":"structure",
"required":[
"PolicyARN",
"PolicyName",
"ServiceNamespace",
"ResourceId",
"ScalableDimension",
"PolicyType",
"CreationTime"
],
"members":{
"PolicyARN":{"shape":"ResourceIdMaxLen1600"},
"PolicyName":{"shape":"PolicyName"},
"ServiceNamespace":{"shape":"ServiceNamespace"},
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"},
"PolicyType":{"shape":"PolicyType"},
"StepScalingPolicyConfiguration":{"shape":"StepScalingPolicyConfiguration"},
"TargetTrackingScalingPolicyConfiguration":{"shape":"TargetTrackingScalingPolicyConfiguration"},
"Alarms":{"shape":"Alarms"},
"CreationTime":{"shape":"TimestampType"}
}
},
"ScheduledAction":{
"type":"structure",
"required":[
"ScheduledActionName",
"ScheduledActionARN",
"ServiceNamespace",
"Schedule",
"ResourceId",
"CreationTime"
],
"members":{
"ScheduledActionName":{"shape":"ScheduledActionName"},
"ScheduledActionARN":{"shape":"ResourceIdMaxLen1600"},
"ServiceNamespace":{"shape":"ServiceNamespace"},
"Schedule":{"shape":"ResourceIdMaxLen1600"},
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"},
"StartTime":{"shape":"TimestampType"},
"EndTime":{"shape":"TimestampType"},
"ScalableTargetAction":{"shape":"ScalableTargetAction"},
"CreationTime":{"shape":"TimestampType"}
}
},
"ScheduledActionName":{
"type":"string",
"max":256,
"min":1,
"pattern":"(?!((^[ ]+.*)|(.*([\\u0000-\\u001f]|[\\u007f-\\u009f]|[:/|])+.*)|(.*[ ]+$))).+"
},
"ScheduledActions":{
"type":"list",
"member":{"shape":"ScheduledAction"}
},
"ServiceNamespace":{
"type":"string",
"enum":[
"ecs",
"elasticmapreduce",
"ec2",
"appstream",
"dynamodb",
"rds",
"sagemaker"
]
},
"StepAdjustment":{
"type":"structure",
"required":["ScalingAdjustment"],
"members":{
"MetricIntervalLowerBound":{"shape":"MetricScale"},
"MetricIntervalUpperBound":{"shape":"MetricScale"},
"ScalingAdjustment":{"shape":"ScalingAdjustment"}
}
},
"StepAdjustments":{
"type":"list",
"member":{"shape":"StepAdjustment"}
},
"StepScalingPolicyConfiguration":{
"type":"structure",
"members":{
"AdjustmentType":{"shape":"AdjustmentType"},
"StepAdjustments":{"shape":"StepAdjustments"},
"MinAdjustmentMagnitude":{"shape":"MinAdjustmentMagnitude"},
"Cooldown":{"shape":"Cooldown"},
"MetricAggregationType":{"shape":"MetricAggregationType"}
}
},
"TargetTrackingScalingPolicyConfiguration":{
"type":"structure",
"required":["TargetValue"],
"members":{
"TargetValue":{"shape":"MetricScale"},
"PredefinedMetricSpecification":{"shape":"PredefinedMetricSpecification"},
"CustomizedMetricSpecification":{"shape":"CustomizedMetricSpecification"},
"ScaleOutCooldown":{"shape":"Cooldown"},
"ScaleInCooldown":{"shape":"Cooldown"},
"DisableScaleIn":{"shape":"DisableScaleIn"}
}
},
"TimestampType":{"type":"timestamp"},
"ValidationException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"XmlString":{
"type":"string",
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
}
}
}

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

@@ -0,0 +1,537 @@
{
"version": "2.0",
"service": "<p>With Application Auto Scaling, you can configure automatic scaling for your scalable AWS resources. 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>Schedule one-time or recurring scaling actions</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 Elastic 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> <li> <p>Amazon Aurora Replicas. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Integrating.AutoScaling.html\">Using Amazon Aurora Auto Scaling with Aurora Replicas</a>.</p> </li> <li> <p>Amazon SageMaker endpoints. For more information, see <a href=\"http://docs.aws.amazon.com/sagemaker/latest/dg/endpoint-auto-scaling.html\">Automatically Scaling Amazon SageMaker Models</a>.</p> </li> </ul> <p>To configure automatic scaling for multiple resources across multiple services, use AWS Auto Scaling to create a scaling plan for your application. For more information, see <a href=\"http://aws.amazon.com/autoscaling\">AWS Auto Scaling</a>.</p> <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>",
"DeleteScheduledAction": "<p>Deletes the specified Application Auto Scaling scheduled action.</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>",
"DescribeScalableTargets": "<p>Gets information about the scalable targets in the specified namespace.</p> <p>You can filter the results using the <code>ResourceIds</code> and <code>ScalableDimension</code> parameters.</p> <p>To create a scalable target or update an existing one, see <a>RegisterScalableTarget</a>. If you are no longer using a scalable target, you can deregister it using <a>DeregisterScalableTarget</a>.</p>",
"DescribeScalingActivities": "<p>Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.</p> <p>You can filter the results using the <code>ResourceId</code> and <code>ScalableDimension</code> parameters.</p> <p>Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see <a>DescribeScalingPolicies</a>. To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>.</p>",
"DescribeScalingPolicies": "<p>Describes the scaling policies for the specified service namespace.</p> <p>You can filter the results using the <code>ResourceId</code>, <code>ScalableDimension</code>, and <code>PolicyNames</code> parameters.</p> <p>To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>. If you are no longer using a scaling policy, you can delete it using <a>DeleteScalingPolicy</a>.</p>",
"DescribeScheduledActions": "<p>Describes the scheduled actions for the specified service namespace.</p> <p>You can filter the results using the <code>ResourceId</code>, <code>ScalableDimension</code>, and <code>ScheduledActionNames</code> parameters.</p> <p>To create a scheduled action or update an existing one, see <a>PutScheduledAction</a>. If you are no longer using a scheduled action, you can delete it using <a>DeleteScheduledAction</a>.</p>",
"PutScalingPolicy": "<p>Creates or updates a policy for an Application Auto Scaling scalable target.</p> <p>Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you register the scalable target using <a>RegisterScalableTarget</a>.</p> <p>To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request.</p> <p>You can view the scaling policies for a service namespace using <a>DescribeScalingPolicies</a>. If you are no longer using a scaling policy, you can delete it using <a>DeleteScalingPolicy</a>.</p>",
"PutScheduledAction": "<p>Creates or updates a scheduled action for an Application Auto Scaling scalable target.</p> <p>Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you register the scalable target using <a>RegisterScalableTarget</a>.</p> <p>To update an action, specify its name and the parameters that you want to change. If you don't specify start and end times, the old values are deleted. Any other parameters that you don't specify are not changed by this update request.</p> <p>You can view the scheduled actions using <a>DescribeScheduledActions</a>. If you are no longer using a scheduled action, you can delete it using <a>DeleteScheduledAction</a>.</p>",
"RegisterScalableTarget": "<p>Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out or scale in. After you have registered a scalable target, you can use this operation to update the minimum and maximum values for its scalable dimension.</p> <p>After you register a scalable target, you can create and apply scaling policies using <a>PutScalingPolicy</a>. You can view the scaling policies for a service namespace using <a>DescribeScalableTargets</a>. If you no longer need a scalable target, you can deregister it using <a>DeregisterScalableTarget</a>.</p>"
},
"shapes": {
"AdjustmentType": {
"base": null,
"refs": {
"StepScalingPolicyConfiguration$AdjustmentType": "<p>The adjustment type, which specifies how the <code>ScalingAdjustment</code> parameter in a <a>StepAdjustment</a> is interpreted.</p>"
}
},
"Alarm": {
"base": "<p>Represents a CloudWatch alarm associated with a scaling policy.</p>",
"refs": {
"Alarms$member": null
}
},
"Alarms": {
"base": null,
"refs": {
"PutScalingPolicyResponse$Alarms": "<p>The CloudWatch alarms created for the target tracking policy.</p>",
"ScalingPolicy$Alarms": "<p>The CloudWatch alarms associated with the scaling policy.</p>"
}
},
"ConcurrentUpdateException": {
"base": "<p>Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.</p>",
"refs": {
}
},
"Cooldown": {
"base": null,
"refs": {
"StepScalingPolicyConfiguration$Cooldown": "<p>The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.</p> <p>For scale out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the Cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.</p> <p>For scale in policies, the cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.</p>",
"TargetTrackingScalingPolicyConfiguration$ScaleOutCooldown": "<p>The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.</p> <p>While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.</p>",
"TargetTrackingScalingPolicyConfiguration$ScaleInCooldown": "<p>The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.</p> <p>The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.</p>"
}
},
"CustomizedMetricSpecification": {
"base": "<p>Configures a customized metric for a target tracking policy.</p>",
"refs": {
"TargetTrackingScalingPolicyConfiguration$CustomizedMetricSpecification": "<p>A customized metric.</p>"
}
},
"DeleteScalingPolicyRequest": {
"base": null,
"refs": {
}
},
"DeleteScalingPolicyResponse": {
"base": null,
"refs": {
}
},
"DeleteScheduledActionRequest": {
"base": null,
"refs": {
}
},
"DeleteScheduledActionResponse": {
"base": null,
"refs": {
}
},
"DeregisterScalableTargetRequest": {
"base": null,
"refs": {
}
},
"DeregisterScalableTargetResponse": {
"base": null,
"refs": {
}
},
"DescribeScalableTargetsRequest": {
"base": null,
"refs": {
}
},
"DescribeScalableTargetsResponse": {
"base": null,
"refs": {
}
},
"DescribeScalingActivitiesRequest": {
"base": null,
"refs": {
}
},
"DescribeScalingActivitiesResponse": {
"base": null,
"refs": {
}
},
"DescribeScalingPoliciesRequest": {
"base": null,
"refs": {
}
},
"DescribeScalingPoliciesResponse": {
"base": null,
"refs": {
}
},
"DescribeScheduledActionsRequest": {
"base": null,
"refs": {
}
},
"DescribeScheduledActionsResponse": {
"base": null,
"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": {
"ConcurrentUpdateException$Message": null,
"FailedResourceAccessException$Message": null,
"InternalServiceException$Message": null,
"InvalidNextTokenException$Message": null,
"LimitExceededException$Message": null,
"ObjectNotFoundException$Message": null,
"ValidationException$Message": null
}
},
"FailedResourceAccessException": {
"base": "<p>Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have permission to call the CloudWatch <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html\">DescribeAlarms</a> on your behalf.</p>",
"refs": {
}
},
"InternalServiceException": {
"base": "<p>The service encountered an internal error.</p>",
"refs": {
}
},
"InvalidNextTokenException": {
"base": "<p>The next token supplied was invalid.</p>",
"refs": {
}
},
"LimitExceededException": {
"base": "<p>A per-account resource limit is exceeded. For more information, see <a href=\"http://docs.aws.amazon.com/ApplicationAutoScaling/latest/userguide/application-auto-scaling-limits.html\">Application Auto Scaling Limits</a>.</p>",
"refs": {
}
},
"MaxResults": {
"base": null,
"refs": {
"DescribeScalableTargetsRequest$MaxResults": "<p>The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50.</p> <p>If this parameter is used, the operation returns up to <code>MaxResults</code> results at a time, along with a <code>NextToken</code> value. To get the next set of results, include the <code>NextToken</code> value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a <code>NextToken</code> value, if applicable.</p>",
"DescribeScalingActivitiesRequest$MaxResults": "<p>The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50.</p> <p>If this parameter is used, the operation returns up to <code>MaxResults</code> results at a time, along with a <code>NextToken</code> value. To get the next set of results, include the <code>NextToken</code> value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a <code>NextToken</code> value, if applicable.</p>",
"DescribeScalingPoliciesRequest$MaxResults": "<p>The maximum number of scalable targets. This value can be between 1 and 50. The default value is 50.</p> <p>If this parameter is used, the operation returns up to <code>MaxResults</code> results at a time, along with a <code>NextToken</code> value. To get the next set of results, include the <code>NextToken</code> value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a <code>NextToken</code> value, if applicable.</p>",
"DescribeScheduledActionsRequest$MaxResults": "<p>The maximum number of scheduled action results. This value can be between 1 and 50. The default value is 50.</p> <p>If this parameter is used, the operation returns up to <code>MaxResults</code> results at a time, along with a <code>NextToken</code> value. To get the next set of results, include the <code>NextToken</code> value in a subsequent call. If this parameter is not used, the operation returns up to 50 results and a <code>NextToken</code> value, if applicable.</p>"
}
},
"MetricAggregationType": {
"base": null,
"refs": {
"StepScalingPolicyConfiguration$MetricAggregationType": "<p>The aggregation type for the CloudWatch metrics. Valid values are <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code>.</p>"
}
},
"MetricDimension": {
"base": "<p>Describes the dimension of a metric.</p>",
"refs": {
"MetricDimensions$member": null
}
},
"MetricDimensionName": {
"base": null,
"refs": {
"MetricDimension$Name": "<p>The name of the dimension.</p>"
}
},
"MetricDimensionValue": {
"base": null,
"refs": {
"MetricDimension$Value": "<p>The value of the dimension.</p>"
}
},
"MetricDimensions": {
"base": null,
"refs": {
"CustomizedMetricSpecification$Dimensions": "<p>The dimensions of the metric.</p>"
}
},
"MetricName": {
"base": null,
"refs": {
"CustomizedMetricSpecification$MetricName": "<p>The name of the metric.</p>"
}
},
"MetricNamespace": {
"base": null,
"refs": {
"CustomizedMetricSpecification$Namespace": "<p>The namespace of the metric.</p>"
}
},
"MetricScale": {
"base": null,
"refs": {
"StepAdjustment$MetricIntervalLowerBound": "<p>The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.</p>",
"StepAdjustment$MetricIntervalUpperBound": "<p>The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.</p> <p>The upper bound must be greater than the lower bound.</p>",
"TargetTrackingScalingPolicyConfiguration$TargetValue": "<p>The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).</p>"
}
},
"MetricStatistic": {
"base": null,
"refs": {
"CustomizedMetricSpecification$Statistic": "<p>The statistic of the metric.</p>"
}
},
"MetricType": {
"base": null,
"refs": {
"PredefinedMetricSpecification$PredefinedMetricType": "<p>The metric type. The <code>ALBRequestCountPerTarget</code> metric type applies only to Spot fleet requests and ECS services.</p>"
}
},
"MetricUnit": {
"base": null,
"refs": {
"CustomizedMetricSpecification$Unit": "<p>The unit of the metric.</p>"
}
},
"MinAdjustmentMagnitude": {
"base": null,
"refs": {
"StepScalingPolicyConfiguration$MinAdjustmentMagnitude": "<p>The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is <code>PercentChangeInCapacity</code>, the scaling policy changes the scalable dimension of the scalable target by this amount.</p>"
}
},
"ObjectNotFoundException": {
"base": "<p>The specified object could not be found. For any operation that depends on the existence of a scalable target, this exception is thrown if the scalable target with the specified service namespace, resource ID, and scalable dimension does not exist. For any operation that deletes or deregisters a resource, this exception is thrown if the resource cannot be found.</p>",
"refs": {
}
},
"PolicyName": {
"base": null,
"refs": {
"PutScalingPolicyRequest$PolicyName": "<p>The name of the scaling policy.</p>",
"ScalingPolicy$PolicyName": "<p>The name of the scaling policy.</p>"
}
},
"PolicyType": {
"base": null,
"refs": {
"PutScalingPolicyRequest$PolicyType": "<p>The policy type. This parameter is required if you are creating a policy.</p> <p>For DynamoDB, only <code>TargetTrackingScaling</code> is supported. For Amazon ECS, Spot Fleet, and Amazon RDS, both <code>StepScaling</code> and <code>TargetTrackingScaling</code> are supported. For any other service, only <code>StepScaling</code> is supported.</p>",
"ScalingPolicy$PolicyType": "<p>The scaling policy type.</p>"
}
},
"PredefinedMetricSpecification": {
"base": "<p>Configures a predefined metric for a target tracking policy.</p>",
"refs": {
"TargetTrackingScalingPolicyConfiguration$PredefinedMetricSpecification": "<p>A predefined metric.</p>"
}
},
"PutScalingPolicyRequest": {
"base": null,
"refs": {
}
},
"PutScalingPolicyResponse": {
"base": null,
"refs": {
}
},
"PutScheduledActionRequest": {
"base": null,
"refs": {
}
},
"PutScheduledActionResponse": {
"base": null,
"refs": {
}
},
"RegisterScalableTargetRequest": {
"base": null,
"refs": {
}
},
"RegisterScalableTargetResponse": {
"base": null,
"refs": {
}
},
"ResourceCapacity": {
"base": null,
"refs": {
"RegisterScalableTargetRequest$MinCapacity": "<p>The minimum value to scale to in response to a scale in event. This parameter is required if you are registering a scalable target.</p>",
"RegisterScalableTargetRequest$MaxCapacity": "<p>The maximum value to scale to in response to a scale out event. This parameter is required if you are registering a scalable target.</p>",
"ScalableTarget$MinCapacity": "<p>The minimum value to scale to in response to a scale in event.</p>",
"ScalableTarget$MaxCapacity": "<p>The maximum value to scale to in response to a scale out event.</p>",
"ScalableTargetAction$MinCapacity": "<p>The minimum capacity.</p>",
"ScalableTargetAction$MaxCapacity": "<p>The maximum capacity.</p>"
}
},
"ResourceId": {
"base": null,
"refs": {
"Alarm$AlarmName": "<p>The name of the alarm.</p>",
"Alarm$AlarmARN": "<p>The Amazon Resource Name (ARN) of the alarm.</p>",
"ScalingActivity$ActivityId": "<p>The unique identifier of the scaling activity.</p>"
}
},
"ResourceIdMaxLen1600": {
"base": null,
"refs": {
"DeleteScalingPolicyRequest$PolicyName": "<p>The name of the scaling policy.</p>",
"DeleteScalingPolicyRequest$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
"DeleteScheduledActionRequest$ScheduledActionName": "<p>The name of the scheduled action.</p>",
"DeleteScheduledActionRequest$ResourceId": "<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
"DeregisterScalableTargetRequest$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
"DescribeScalingActivitiesRequest$ResourceId": "<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
"DescribeScalingPoliciesRequest$ResourceId": "<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
"DescribeScheduledActionsRequest$ResourceId": "<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
"PutScalingPolicyRequest$ResourceId": "<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
"PutScalingPolicyResponse$PolicyARN": "<p>The Amazon Resource Name (ARN) of the resulting scaling policy.</p>",
"PutScheduledActionRequest$Schedule": "<p>The schedule for this action. The following formats are supported:</p> <ul> <li> <p>At expressions - <code>at(<i>yyyy</i>-<i>mm</i>-<i>dd</i>T<i>hh</i>:<i>mm</i>:<i>ss</i>)</code> </p> </li> <li> <p>Rate expressions - <code>rate(<i>value</i> <i>unit</i>)</code> </p> </li> <li> <p>Cron expressions - <code>cron(<i>fields</i>)</code> </p> </li> </ul> <p>At expressions are useful for one-time schedules. Specify the time, in UTC.</p> <p>For rate expressions, <i>value</i> is a positive integer and <i>unit</i> is <code>minute</code> | <code>minutes</code> | <code>hour</code> | <code>hours</code> | <code>day</code> | <code>days</code>.</p> <p>For more information about cron expressions, see <a href=\"https://en.wikipedia.org/wiki/Cron\">Cron</a>.</p>",
"PutScheduledActionRequest$ResourceId": "<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
"RegisterScalableTargetRequest$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
"RegisterScalableTargetRequest$RoleARN": "<p>Application Auto Scaling creates a service-linked role that grants it permissions to modify the scalable target on your behalf. For more information, see <a href=\"http://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/application-autoscaling-service-linked-roles.html\">Service-Linked Roles for Application Auto Scaling</a>.</p> <p>For resources that are not supported using a service-linked role, this parameter is required and must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.</p>",
"ResourceIdsMaxLen1600$member": null,
"ScalableTarget$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
"ScalableTarget$RoleARN": "<p>The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.</p>",
"ScalingActivity$ResourceId": "<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
"ScalingPolicy$PolicyARN": "<p>The Amazon Resource Name (ARN) of the scaling policy.</p>",
"ScalingPolicy$ResourceId": "<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
"ScheduledAction$ScheduledActionARN": "<p>The Amazon Resource Name (ARN) of the scheduled action.</p>",
"ScheduledAction$Schedule": "<p>The schedule for this action. The following formats are supported:</p> <ul> <li> <p>At expressions - <code>at(<i>yyyy</i>-<i>mm</i>-<i>dd</i>T<i>hh</i>:<i>mm</i>:<i>ss</i>)</code> </p> </li> <li> <p>Rate expressions - <code>rate(<i>value</i> <i>unit</i>)</code> </p> </li> <li> <p>Cron expressions - <code>cron(<i>fields</i>)</code> </p> </li> </ul> <p>At expressions are useful for one-time schedules. Specify the time, in UTC.</p> <p>For rate expressions, <i>value</i> is a positive integer and <i>unit</i> is <code>minute</code> | <code>minutes</code> | <code>hour</code> | <code>hours</code> | <code>day</code> | <code>days</code>.</p> <p>For more information about cron expressions, see <a href=\"https://en.wikipedia.org/wiki/Cron\">Cron</a>.</p>",
"ScheduledAction$ResourceId": "<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>"
}
},
"ResourceIdsMaxLen1600": {
"base": null,
"refs": {
"DescribeScalableTargetsRequest$ResourceIds": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
"DescribeScalingPoliciesRequest$PolicyNames": "<p>The names of the scaling policies to describe.</p>",
"DescribeScheduledActionsRequest$ScheduledActionNames": "<p>The names of the scheduled actions to describe.</p>"
}
},
"ResourceLabel": {
"base": null,
"refs": {
"PredefinedMetricSpecification$ResourceLabel": "<p>Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is <code>ALBRequestCountPerTarget</code> and there is a target group attached to the Spot fleet request or ECS service.</p> <p>The format is app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt;/targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt;, where:</p> <ul> <li> <p>app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt; is the final portion of the load balancer ARN</p> </li> <li> <p>targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt; is the final portion of the target group ARN.</p> </li> </ul>"
}
},
"ScalableDimension": {
"base": null,
"refs": {
"DeleteScalingPolicyRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
"DeleteScheduledActionRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
"DeregisterScalableTargetRequest$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
"DescribeScalableTargetsRequest$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
"DescribeScalingActivitiesRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
"DescribeScalingPoliciesRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
"DescribeScheduledActionsRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
"PutScalingPolicyRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
"PutScheduledActionRequest$ScalableDimension": "<p>The scalable dimension. This parameter is required if you are creating a scheduled action. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
"RegisterScalableTargetRequest$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
"ScalableTarget$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
"ScalingActivity$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
"ScalingPolicy$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
"ScheduledAction$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>"
}
},
"ScalableTarget": {
"base": "<p>Represents a scalable target.</p>",
"refs": {
"ScalableTargets$member": null
}
},
"ScalableTargetAction": {
"base": "<p>Represents the minimum and maximum capacity for a scheduled action.</p>",
"refs": {
"PutScheduledActionRequest$ScalableTargetAction": "<p>The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.</p>",
"ScheduledAction$ScalableTargetAction": "<p>The new minimum and maximum capacity. You can set both values or just one. During the scheduled time, if the current capacity is below the minimum capacity, Application Auto Scaling scales out to the minimum capacity. If the current capacity is above the maximum capacity, Application Auto Scaling scales in to the maximum capacity.</p>"
}
},
"ScalableTargets": {
"base": null,
"refs": {
"DescribeScalableTargetsResponse$ScalableTargets": "<p>The scalable targets that match the request parameters.</p>"
}
},
"ScalingActivities": {
"base": null,
"refs": {
"DescribeScalingActivitiesResponse$ScalingActivities": "<p>A list of scaling activity objects.</p>"
}
},
"ScalingActivity": {
"base": "<p>Represents a scaling activity.</p>",
"refs": {
"ScalingActivities$member": null
}
},
"ScalingActivityStatusCode": {
"base": null,
"refs": {
"ScalingActivity$StatusCode": "<p>Indicates the status of the scaling activity.</p>"
}
},
"ScalingAdjustment": {
"base": null,
"refs": {
"StepAdjustment$ScalingAdjustment": "<p>The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension.</p>"
}
},
"ScalingPolicies": {
"base": null,
"refs": {
"DescribeScalingPoliciesResponse$ScalingPolicies": "<p>Information about the scaling policies.</p>"
}
},
"ScalingPolicy": {
"base": "<p>Represents a scaling policy.</p>",
"refs": {
"ScalingPolicies$member": null
}
},
"ScheduledAction": {
"base": "<p>Represents a scheduled action.</p>",
"refs": {
"ScheduledActions$member": null
}
},
"ScheduledActionName": {
"base": null,
"refs": {
"PutScheduledActionRequest$ScheduledActionName": "<p>The name of the scheduled action.</p>",
"ScheduledAction$ScheduledActionName": "<p>The name of the scheduled action.</p>"
}
},
"ScheduledActions": {
"base": null,
"refs": {
"DescribeScheduledActionsResponse$ScheduledActions": "<p>Information about the scheduled actions.</p>"
}
},
"ServiceNamespace": {
"base": null,
"refs": {
"DeleteScalingPolicyRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"DeleteScheduledActionRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"DeregisterScalableTargetRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"DescribeScalableTargetsRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"DescribeScalingActivitiesRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"DescribeScalingPoliciesRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"DescribeScheduledActionsRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"PutScalingPolicyRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"PutScheduledActionRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"RegisterScalableTargetRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"ScalableTarget$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"ScalingActivity$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"ScalingPolicy$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
"ScheduledAction$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
}
},
"StepAdjustment": {
"base": "<p>Represents a step adjustment for a <a>StepScalingPolicyConfiguration</a>. Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm. </p> <p>For the following examples, suppose that you have an alarm with a breach threshold of 50:</p> <ul> <li> <p>To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.</p> </li> <li> <p>To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.</p> </li> </ul> <p>There are a few rules for the step adjustments for your step policy:</p> <ul> <li> <p>The ranges of your step adjustments can't overlap or have a gap.</p> </li> <li> <p>At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.</p> </li> <li> <p>At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.</p> </li> <li> <p>The upper and lower bound can't be null in the same step adjustment.</p> </li> </ul>",
"refs": {
"StepAdjustments$member": null
}
},
"StepAdjustments": {
"base": null,
"refs": {
"StepScalingPolicyConfiguration$StepAdjustments": "<p>A set of adjustments that enable you to scale based on the size of the alarm breach.</p>"
}
},
"StepScalingPolicyConfiguration": {
"base": "<p>Represents a step scaling policy configuration.</p>",
"refs": {
"PutScalingPolicyRequest$StepScalingPolicyConfiguration": "<p>A step scaling policy.</p> <p>This parameter is required if you are creating a policy and the policy type is <code>StepScaling</code>.</p>",
"ScalingPolicy$StepScalingPolicyConfiguration": "<p>A step scaling policy.</p>"
}
},
"TargetTrackingScalingPolicyConfiguration": {
"base": "<p>Represents a target tracking scaling policy configuration.</p>",
"refs": {
"PutScalingPolicyRequest$TargetTrackingScalingPolicyConfiguration": "<p>A target tracking policy.</p> <p>This parameter is required if you are creating a policy and the policy type is <code>TargetTrackingScaling</code>.</p>",
"ScalingPolicy$TargetTrackingScalingPolicyConfiguration": "<p>A target tracking policy.</p>"
}
},
"TimestampType": {
"base": null,
"refs": {
"PutScheduledActionRequest$StartTime": "<p>The date and time for the scheduled action to start.</p>",
"PutScheduledActionRequest$EndTime": "<p>The date and time for the scheduled action to end.</p>",
"ScalableTarget$CreationTime": "<p>The Unix timestamp for when the scalable target was created.</p>",
"ScalingActivity$StartTime": "<p>The Unix timestamp for when the scaling activity began.</p>",
"ScalingActivity$EndTime": "<p>The Unix timestamp for when the scaling activity ended.</p>",
"ScalingPolicy$CreationTime": "<p>The Unix timestamp for when the scaling policy was created.</p>",
"ScheduledAction$StartTime": "<p>The date and time that the action is scheduled to begin.</p>",
"ScheduledAction$EndTime": "<p>The date and time that the action is scheduled to end.</p>",
"ScheduledAction$CreationTime": "<p>The date and time that the scheduled action was created.</p>"
}
},
"ValidationException": {
"base": "<p>An exception was thrown for a validation issue. Review the available parameters for the API request.</p>",
"refs": {
}
},
"XmlString": {
"base": null,
"refs": {
"DescribeScalableTargetsRequest$NextToken": "<p>The token for the next set of results.</p>",
"DescribeScalableTargetsResponse$NextToken": "<p>The token required to get the next set of results. This value is <code>null</code> if there are no more results to return.</p>",
"DescribeScalingActivitiesRequest$NextToken": "<p>The token for the next set of results.</p>",
"DescribeScalingActivitiesResponse$NextToken": "<p>The token required to get the next set of results. This value is <code>null</code> if there are no more results to return.</p>",
"DescribeScalingPoliciesRequest$NextToken": "<p>The token for the next set of results.</p>",
"DescribeScalingPoliciesResponse$NextToken": "<p>The token required to get the next set of results. This value is <code>null</code> if there are no more results to return.</p>",
"DescribeScheduledActionsRequest$NextToken": "<p>The token for the next set of results.</p>",
"DescribeScheduledActionsResponse$NextToken": "<p>The token required to get the next set of results. This value is <code>null</code> if there are no more results to return.</p>",
"ScalingActivity$Description": "<p>A simple description of what action the scaling activity intends to accomplish.</p>",
"ScalingActivity$Cause": "<p>A simple description of what caused the scaling activity to happen.</p>",
"ScalingActivity$StatusMessage": "<p>A simple message about the current status of the scaling activity.</p>",
"ScalingActivity$Details": "<p>The details about the scaling activity.</p>"
}
}
}
}

257
vendor/github.com/aws/aws-sdk-go/models/apis/application-autoscaling/2016-02-06/examples-1.json generated vendored Normal file
View File

@@ -0,0 +1,257 @@
{
"version": "1.0",
"examples": {
"DeleteScalingPolicy": [
{
"input": {
"PolicyName": "web-app-cpu-lt-25",
"ResourceId": "service/default/web-app",
"ScalableDimension": "ecs:service:DesiredCount",
"ServiceNamespace": "ecs"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes a scaling policy for the Amazon ECS service called web-app, which is running in the default cluster.",
"id": "to-delete-a-scaling-policy-1470863892689",
"title": "To delete a scaling policy"
}
],
"DeregisterScalableTarget": [
{
"input": {
"ResourceId": "service/default/web-app",
"ScalableDimension": "ecs:service:DesiredCount",
"ServiceNamespace": "ecs"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deregisters a scalable target for an Amazon ECS service called web-app that is running in the default cluster.",
"id": "to-deregister-a-scalable-target-1470864164895",
"title": "To deregister a scalable target"
}
],
"DescribeScalableTargets": [
{
"input": {
"ServiceNamespace": "ecs"
},
"output": {
"ScalableTargets": [
{
"CreationTime": "2016-05-06T11:21:46.199Z",
"MaxCapacity": 10,
"MinCapacity": 1,
"ResourceId": "service/default/web-app",
"RoleARN": "arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole",
"ScalableDimension": "ecs:service:DesiredCount",
"ServiceNamespace": "ecs"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes the scalable targets for the ecs service namespace.",
"id": "to-describe-scalable-targets-1470864286961",
"title": "To describe scalable targets"
}
],
"DescribeScalingActivities": [
{
"input": {
"ResourceId": "service/default/web-app",
"ScalableDimension": "ecs:service:DesiredCount",
"ServiceNamespace": "ecs"
},
"output": {
"ScalingActivities": [
{
"ActivityId": "e6c5f7d1-dbbb-4a3f-89b2-51f33e766399",
"Cause": "monitor alarm web-app-cpu-lt-25 in state ALARM triggered policy web-app-cpu-lt-25",
"Description": "Setting desired count to 1.",
"EndTime": "2016-05-06T16:04:32.111Z",
"ResourceId": "service/default/web-app",
"ScalableDimension": "ecs:service:DesiredCount",
"ServiceNamespace": "ecs",
"StartTime": "2016-05-06T16:03:58.171Z",
"StatusCode": "Successful",
"StatusMessage": "Successfully set desired count to 1. Change successfully fulfilled by ecs."
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes the scaling activities for an Amazon ECS service called web-app that is running in the default cluster.",
"id": "to-describe-scaling-activities-for-a-scalable-target-1470864398629",
"title": "To describe scaling activities for a scalable target"
}
],
"DescribeScalingPolicies": [
{
"input": {
"ServiceNamespace": "ecs"
},
"output": {
"NextToken": "",
"ScalingPolicies": [
{
"Alarms": [
{
"AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:web-app-cpu-gt-75",
"AlarmName": "web-app-cpu-gt-75"
}
],
"CreationTime": "2016-05-06T12:11:39.230Z",
"PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75",
"PolicyName": "web-app-cpu-gt-75",
"PolicyType": "StepScaling",
"ResourceId": "service/default/web-app",
"ScalableDimension": "ecs:service:DesiredCount",
"ServiceNamespace": "ecs",
"StepScalingPolicyConfiguration": {
"AdjustmentType": "PercentChangeInCapacity",
"Cooldown": 60,
"StepAdjustments": [
{
"MetricIntervalLowerBound": 0,
"ScalingAdjustment": 200
}
]
}
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes the scaling policies for the ecs service namespace.",
"id": "to-describe-scaling-policies-1470864609734",
"title": "To describe scaling policies"
}
],
"PutScalingPolicy": [
{
"input": {
"PolicyName": "web-app-cpu-gt-75",
"PolicyType": "StepScaling",
"ResourceId": "service/default/web-app",
"ScalableDimension": "ecs:service:DesiredCount",
"ServiceNamespace": "ecs",
"StepScalingPolicyConfiguration": {
"AdjustmentType": "PercentChangeInCapacity",
"Cooldown": 60,
"StepAdjustments": [
{
"MetricIntervalLowerBound": 0,
"ScalingAdjustment": 200
}
]
}
},
"output": {
"PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example applies a scaling policy to an Amazon ECS service called web-app in the default cluster. The policy increases the desired count of the service by 200%, with a cool down period of 60 seconds.",
"id": "to-apply-a-scaling-policy-to-an-amazon-ecs-service-1470864779862",
"title": "To apply a scaling policy to an Amazon ECS service"
},
{
"input": {
"PolicyName": "fleet-cpu-gt-75",
"PolicyType": "StepScaling",
"ResourceId": "spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3",
"ScalableDimension": "ec2:spot-fleet-request:TargetCapacity",
"ServiceNamespace": "ec2",
"StepScalingPolicyConfiguration": {
"AdjustmentType": "PercentChangeInCapacity",
"Cooldown": 180,
"StepAdjustments": [
{
"MetricIntervalLowerBound": 0,
"ScalingAdjustment": 200
}
]
}
},
"output": {
"PolicyARN": "arn:aws:autoscaling:us-east-1:012345678910:scalingPolicy:89406401-0cb7-4130-b770-d97cca0e446b:resource/ec2/spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3:policyName/fleet-cpu-gt-75"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example applies a scaling policy to an Amazon EC2 Spot fleet. The policy increases the target capacity of the spot fleet by 200%, with a cool down period of 180 seconds.\",\n ",
"id": "to-apply-a-scaling-policy-to-an-amazon-ec2-spot-fleet-1472073278469",
"title": "To apply a scaling policy to an Amazon EC2 Spot fleet"
}
],
"RegisterScalableTarget": [
{
"input": {
"MaxCapacity": 10,
"MinCapacity": 1,
"ResourceId": "service/default/web-app",
"RoleARN": "arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole",
"ScalableDimension": "ecs:service:DesiredCount",
"ServiceNamespace": "ecs"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example registers a scalable target from an Amazon ECS service called web-app that is running on the default cluster, with a minimum desired count of 1 task and a maximum desired count of 10 tasks.",
"id": "to-register-a-new-scalable-target-1470864910380",
"title": "To register an ECS service as a scalable target"
},
{
"input": {
"MaxCapacity": 10,
"MinCapacity": 1,
"ResourceId": "spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3",
"RoleARN": "arn:aws:iam::012345678910:role/ApplicationAutoscalingSpotRole",
"ScalableDimension": "ec2:spot-fleet-request:TargetCapacity",
"ServiceNamespace": "ec2"
},
"output": {
},
"comments": {
},
"description": "This example registers a scalable target from an Amazon EC2 Spot fleet with a minimum target capacity of 1 and a maximum of 10.",
"id": "to-register-an-ec2-spot-fleet-as-a-scalable-target-1472072899649",
"title": "To register an EC2 Spot fleet as a scalable target"
}
]
}
}

22
vendor/github.com/aws/aws-sdk-go/models/apis/application-autoscaling/2016-02-06/paginators-1.json generated vendored Normal file
View File

@@ -0,0 +1,22 @@
{
"pagination": {
"DescribeScalableTargets": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ScalableTargets"
},
"DescribeScalingActivities": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ScalingActivities"
},
"DescribeScalingPolicies": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "ScalingPolicies"
}
}
}

13
vendor/github.com/aws/aws-sdk-go/models/apis/application-autoscaling/2016-02-06/smoke.json generated vendored Normal file
View File

@@ -0,0 +1,13 @@
{
"version": 1,
"defaultRegion": "us-west-2",
"testCases": [
{
"operationName": "DescribeScalableTargets",
"input": {
"ServiceNamespace": "ec2"
},
"errorExpectedFromService": false
}
]
}

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

File diff suppressed because it is too large Load Diff

1084
vendor/github.com/aws/aws-sdk-go/models/apis/appstream/2016-12-01/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/appstream/2016-12-01/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/appstream/2016-12-01/paginators-1.json generated vendored Normal file
View File

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

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

@@ -0,0 +1,55 @@
{
"version": 2,
"waiters": {
"FleetStarted": {
"delay": 30,
"maxAttempts": 40,
"operation": "DescribeFleets",
"acceptors": [
{
"state": "success",
"matcher": "pathAll",
"argument": "Fleets[].State",
"expected": "ACTIVE"
},
{
"state": "failure",
"matcher": "pathAny",
"argument": "Fleets[].State",
"expected": "PENDING_DEACTIVATE"
},
{
"state": "failure",
"matcher": "pathAny",
"argument": "Fleets[].State",
"expected": "INACTIVE"
}
]
},
"FleetStopped": {
"delay": 30,
"maxAttempts": 40,
"operation": "DescribeFleets",
"acceptors": [
{
"state": "success",
"matcher": "pathAll",
"argument": "Fleets[].State",
"expected": "INACTIVE"
},
{
"state": "failure",
"matcher": "pathAny",
"argument": "Fleets[].State",
"expected": "PENDING_ACTIVATE"
},
{
"state": "failure",
"matcher": "pathAny",
"argument": "Fleets[].State",
"expected": "ACTIVE"
}
]
}
}
}

1417
vendor/github.com/aws/aws-sdk-go/models/apis/appsync/2017-07-25/api-2.json generated vendored Normal file
View File

File diff suppressed because it is too large Load Diff

677
vendor/github.com/aws/aws-sdk-go/models/apis/appsync/2017-07-25/docs-2.json generated vendored Normal file
View File

@@ -0,0 +1,677 @@
{
"version": "2.0",
"service": "<p>AWS AppSync provides API actions for creating and interacting with data sources using GraphQL from your application.</p>",
"operations": {
"CreateApiKey": "<p>Creates a unique key that you can distribute to clients who are executing your API.</p>",
"CreateDataSource": "<p>Creates a <code>DataSource</code> object.</p>",
"CreateGraphqlApi": "<p>Creates a <code>GraphqlApi</code> object.</p>",
"CreateResolver": "<p>Creates a <code>Resolver</code> object.</p> <p>A resolver converts incoming requests into a format that a data source can understand and converts the data source's responses into GraphQL.</p>",
"CreateType": "<p>Creates a <code>Type</code> object.</p>",
"DeleteApiKey": "<p>Deletes an API key.</p>",
"DeleteDataSource": "<p>Deletes a <code>DataSource</code> object.</p>",
"DeleteGraphqlApi": "<p>Deletes a <code>GraphqlApi</code> object.</p>",
"DeleteResolver": "<p>Deletes a <code>Resolver</code> object.</p>",
"DeleteType": "<p>Deletes a <code>Type</code> object.</p>",
"GetDataSource": "<p>Retrieves a <code>DataSource</code> object.</p>",
"GetGraphqlApi": "<p>Retrieves a <code>GraphqlApi</code> object.</p>",
"GetIntrospectionSchema": "<p>Retrieves the introspection schema for a GraphQL API.</p>",
"GetResolver": "<p>Retrieves a <code>Resolver</code> object.</p>",
"GetSchemaCreationStatus": "<p>Retrieves the current status of a schema creation operation.</p>",
"GetType": "<p>Retrieves a <code>Type</code> object.</p>",
"ListApiKeys": "<p>Lists the API keys for a given API.</p>",
"ListDataSources": "<p>Lists the data sources for a given API.</p>",
"ListGraphqlApis": "<p>Lists your GraphQL APIs.</p>",
"ListResolvers": "<p>Lists the resolvers for a given API and type.</p>",
"ListTypes": "<p>Lists the types for a given API.</p>",
"StartSchemaCreation": "<p>Adds a new schema to your GraphQL API.</p> <p>This operation is asynchronous. Use to determine when it has completed.</p>",
"UpdateApiKey": "<p>Updates an API key.</p>",
"UpdateDataSource": "<p>Updates a <code>DataSource</code> object.</p>",
"UpdateGraphqlApi": "<p>Updates a <code>GraphqlApi</code> object.</p>",
"UpdateResolver": "<p>Updates a <code>Resolver</code> object.</p>",
"UpdateType": "<p>Updates a <code>Type</code> object.</p>"
},
"shapes": {
"ApiKey": {
"base": "<p>Describes an API key.</p>",
"refs": {
"ApiKeys$member": null,
"CreateApiKeyResponse$apiKey": "<p>The API key.</p>",
"UpdateApiKeyResponse$apiKey": "<p>The API key.</p>"
}
},
"ApiKeyLimitExceededException": {
"base": "<p>The API key exceeded a limit. Try your request again.</p>",
"refs": {
}
},
"ApiKeyValidityOutOfBoundsException": {
"base": "<p>The API key expiration must be set to a value between 1 and 365 days.</p>",
"refs": {
}
},
"ApiKeys": {
"base": null,
"refs": {
"ListApiKeysResponse$apiKeys": "<p>The <code>ApiKey</code> objects.</p>"
}
},
"ApiLimitExceededException": {
"base": "<p>The GraphQL API exceeded a limit. Try your request again.</p>",
"refs": {
}
},
"AuthenticationType": {
"base": null,
"refs": {
"CreateGraphqlApiRequest$authenticationType": "<p>The authentication type: API key, IAM, or Amazon Cognito User Pools.</p>",
"GraphqlApi$authenticationType": "<p>The authentication type.</p>",
"UpdateGraphqlApiRequest$authenticationType": "<p>The new authentication type for the <code>GraphqlApi</code> object.</p>"
}
},
"BadRequestException": {
"base": "<p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again. </p>",
"refs": {
}
},
"Blob": {
"base": null,
"refs": {
"GetIntrospectionSchemaResponse$schema": "<p>The schema, in GraphQL Schema Definition Language (SDL) format.</p> <p>For more information, see the <a href=\"http://graphql.org/learn/schema/\">GraphQL SDL documentation</a>.</p>",
"StartSchemaCreationRequest$definition": "<p>The schema definition, in GraphQL schema language format.</p>"
}
},
"Boolean": {
"base": null,
"refs": {
"DynamodbDataSourceConfig$useCallerCredentials": "<p>Set to TRUE to use Amazon Cognito credentials with this data source.</p>"
}
},
"ConcurrentModificationException": {
"base": "<p>Another modification is being made. That modification must complete before you can make your change. </p>",
"refs": {
}
},
"CreateApiKeyRequest": {
"base": null,
"refs": {
}
},
"CreateApiKeyResponse": {
"base": null,
"refs": {
}
},
"CreateDataSourceRequest": {
"base": null,
"refs": {
}
},
"CreateDataSourceResponse": {
"base": null,
"refs": {
}
},
"CreateGraphqlApiRequest": {
"base": null,
"refs": {
}
},
"CreateGraphqlApiResponse": {
"base": null,
"refs": {
}
},
"CreateResolverRequest": {
"base": null,
"refs": {
}
},
"CreateResolverResponse": {
"base": null,
"refs": {
}
},
"CreateTypeRequest": {
"base": null,
"refs": {
}
},
"CreateTypeResponse": {
"base": null,
"refs": {
}
},
"DataSource": {
"base": "<p>Describes a data source.</p>",
"refs": {
"CreateDataSourceResponse$dataSource": "<p>The <code>DataSource</code> object.</p>",
"DataSources$member": null,
"GetDataSourceResponse$dataSource": "<p>The <code>DataSource</code> object.</p>",
"UpdateDataSourceResponse$dataSource": "<p>The updated <code>DataSource</code> object.</p>"
}
},
"DataSourceType": {
"base": null,
"refs": {
"CreateDataSourceRequest$type": "<p>The type of the <code>DataSource</code>.</p>",
"DataSource$type": "<p>The type of the data source.</p> <ul> <li> <p> <b>AMAZON_DYNAMODB</b>: The data source is an Amazon DynamoDB table.</p> </li> <li> <p> <b>AMAZON_ELASTICSEARCH</b>: The data source is an Amazon Elasticsearch Service domain.</p> </li> <li> <p> <b>AWS_LAMBDA</b>: The data source is an AWS Lambda function.</p> </li> <li> <p> <b>NONE</b>: There is no data source. This type is used when the required information can be computed on the fly without connecting to a back-end data source.</p> </li> </ul>",
"UpdateDataSourceRequest$type": "<p>The new data source type.</p>"
}
},
"DataSources": {
"base": null,
"refs": {
"ListDataSourcesResponse$dataSources": "<p>The <code>DataSource</code> objects.</p>"
}
},
"DefaultAction": {
"base": null,
"refs": {
"UserPoolConfig$defaultAction": "<p>The action that you want your GraphQL API to take when a request that uses Amazon Cognito User Pool authentication doesn't match the Amazon Cognito User Pool configuration.</p>"
}
},
"DeleteApiKeyRequest": {
"base": null,
"refs": {
}
},
"DeleteApiKeyResponse": {
"base": null,
"refs": {
}
},
"DeleteDataSourceRequest": {
"base": null,
"refs": {
}
},
"DeleteDataSourceResponse": {
"base": null,
"refs": {
}
},
"DeleteGraphqlApiRequest": {
"base": null,
"refs": {
}
},
"DeleteGraphqlApiResponse": {
"base": null,
"refs": {
}
},
"DeleteResolverRequest": {
"base": null,
"refs": {
}
},
"DeleteResolverResponse": {
"base": null,
"refs": {
}
},
"DeleteTypeRequest": {
"base": null,
"refs": {
}
},
"DeleteTypeResponse": {
"base": null,
"refs": {
}
},
"DynamodbDataSourceConfig": {
"base": "<p>Describes a DynamoDB data source configuration.</p>",
"refs": {
"CreateDataSourceRequest$dynamodbConfig": "<p>DynamoDB settings.</p>",
"DataSource$dynamodbConfig": "<p>DynamoDB settings.</p>",
"UpdateDataSourceRequest$dynamodbConfig": "<p>The new DynamoDB configuration.</p>"
}
},
"ElasticsearchDataSourceConfig": {
"base": "<p>Describes an Elasticsearch data source configuration.</p>",
"refs": {
"CreateDataSourceRequest$elasticsearchConfig": "<p>Amazon Elasticsearch settings.</p>",
"DataSource$elasticsearchConfig": "<p>Amazon Elasticsearch settings.</p>",
"UpdateDataSourceRequest$elasticsearchConfig": "<p>The new Elasticsearch configuration.</p>"
}
},
"ErrorMessage": {
"base": null,
"refs": {
"BadRequestException$message": null,
"ConcurrentModificationException$message": null,
"GraphQLSchemaException$message": null
}
},
"GetDataSourceRequest": {
"base": null,
"refs": {
}
},
"GetDataSourceResponse": {
"base": null,
"refs": {
}
},
"GetGraphqlApiRequest": {
"base": null,
"refs": {
}
},
"GetGraphqlApiResponse": {
"base": null,
"refs": {
}
},
"GetIntrospectionSchemaRequest": {
"base": null,
"refs": {
}
},
"GetIntrospectionSchemaResponse": {
"base": null,
"refs": {
}
},
"GetResolverRequest": {
"base": null,
"refs": {
}
},
"GetResolverResponse": {
"base": null,
"refs": {
}
},
"GetSchemaCreationStatusRequest": {
"base": null,
"refs": {
}
},
"GetSchemaCreationStatusResponse": {
"base": null,
"refs": {
}
},
"GetTypeRequest": {
"base": null,
"refs": {
}
},
"GetTypeResponse": {
"base": null,
"refs": {
}
},
"GraphQLSchemaException": {
"base": "<p>The GraphQL schema is not valid.</p>",
"refs": {
}
},
"GraphqlApi": {
"base": "<p>Describes a GraphQL API.</p>",
"refs": {
"CreateGraphqlApiResponse$graphqlApi": "<p>The <code>GraphqlApi</code>.</p>",
"GetGraphqlApiResponse$graphqlApi": "<p>The <code>GraphqlApi</code> object.</p>",
"GraphqlApis$member": null,
"UpdateGraphqlApiResponse$graphqlApi": "<p>The updated <code>GraphqlApi</code> object.</p>"
}
},
"GraphqlApis": {
"base": null,
"refs": {
"ListGraphqlApisResponse$graphqlApis": "<p>The <code>GraphqlApi</code> objects.</p>"
}
},
"InternalFailureException": {
"base": "<p>An internal AWS AppSync error occurred. Try your request again.</p>",
"refs": {
}
},
"LambdaDataSourceConfig": {
"base": "<p>Describes a Lambda data source configuration.</p>",
"refs": {
"CreateDataSourceRequest$lambdaConfig": "<p>AWS Lambda settings.</p>",
"DataSource$lambdaConfig": "<p>Lambda settings.</p>",
"UpdateDataSourceRequest$lambdaConfig": "<p>The new Lambda configuration.</p>"
}
},
"LimitExceededException": {
"base": "<p>The request exceeded a limit. Try your request again.</p>",
"refs": {
}
},
"ListApiKeysRequest": {
"base": null,
"refs": {
}
},
"ListApiKeysResponse": {
"base": null,
"refs": {
}
},
"ListDataSourcesRequest": {
"base": null,
"refs": {
}
},
"ListDataSourcesResponse": {
"base": null,
"refs": {
}
},
"ListGraphqlApisRequest": {
"base": null,
"refs": {
}
},
"ListGraphqlApisResponse": {
"base": null,
"refs": {
}
},
"ListResolversRequest": {
"base": null,
"refs": {
}
},
"ListResolversResponse": {
"base": null,
"refs": {
}
},
"ListTypesRequest": {
"base": null,
"refs": {
}
},
"ListTypesResponse": {
"base": null,
"refs": {
}
},
"Long": {
"base": null,
"refs": {
"ApiKey$expires": "<p>The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.</p>",
"CreateApiKeyRequest$expires": "<p>The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time.</p>",
"UpdateApiKeyRequest$expires": "<p>The time after which the API key expires. The date is represented as seconds since the epoch.</p>"
}
},
"MapOfStringToString": {
"base": null,
"refs": {
"GraphqlApi$uris": "<p>The URIs.</p>"
}
},
"MappingTemplate": {
"base": null,
"refs": {
"CreateResolverRequest$requestMappingTemplate": "<p>The mapping template to be used for requests.</p> <p>A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).</p>",
"CreateResolverRequest$responseMappingTemplate": "<p>The mapping template to be used for responses from the data source.</p>",
"Resolver$requestMappingTemplate": "<p>The request mapping template.</p>",
"Resolver$responseMappingTemplate": "<p>The response mapping template.</p>",
"UpdateResolverRequest$requestMappingTemplate": "<p>The new request mapping template.</p>",
"UpdateResolverRequest$responseMappingTemplate": "<p>The new response mapping template.</p>"
}
},
"MaxResults": {
"base": null,
"refs": {
"ListApiKeysRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>",
"ListDataSourcesRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>",
"ListGraphqlApisRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>",
"ListResolversRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>",
"ListTypesRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>"
}
},
"NotFoundException": {
"base": "<p>The resource specified in the request was not found. Check the resource and try again.</p>",
"refs": {
}
},
"OutputType": {
"base": null,
"refs": {
"GetIntrospectionSchemaRequest$format": "<p>The schema format: SDL or JSON.</p>"
}
},
"PaginationToken": {
"base": null,
"refs": {
"ListApiKeysRequest$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>",
"ListApiKeysResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>",
"ListDataSourcesRequest$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>",
"ListDataSourcesResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>",
"ListGraphqlApisRequest$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>",
"ListGraphqlApisResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>",
"ListResolversRequest$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>",
"ListResolversResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>",
"ListTypesRequest$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>",
"ListTypesResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>"
}
},
"Resolver": {
"base": "<p>Describes a resolver.</p>",
"refs": {
"CreateResolverResponse$resolver": "<p>The <code>Resolver</code> object.</p>",
"GetResolverResponse$resolver": "<p>The <code>Resolver</code> object.</p>",
"Resolvers$member": null,
"UpdateResolverResponse$resolver": "<p>The updated <code>Resolver</code> object.</p>"
}
},
"Resolvers": {
"base": null,
"refs": {
"ListResolversResponse$resolvers": "<p>The <code>Resolver</code> objects.</p>"
}
},
"ResourceName": {
"base": null,
"refs": {
"CreateDataSourceRequest$name": "<p>A user-supplied name for the <code>DataSource</code>.</p>",
"CreateResolverRequest$typeName": "<p>The name of the <code>Type</code>.</p>",
"CreateResolverRequest$fieldName": "<p>The name of the field to attach the resolver to.</p>",
"CreateResolverRequest$dataSourceName": "<p>The name of the data source for which the resolver is being created.</p>",
"DataSource$name": "<p>The name of the data source.</p>",
"DeleteDataSourceRequest$name": "<p>The name of the data source.</p>",
"DeleteResolverRequest$typeName": "<p>The name of the resolver type.</p>",
"DeleteResolverRequest$fieldName": "<p>The resolver field name.</p>",
"DeleteTypeRequest$typeName": "<p>The type name.</p>",
"GetDataSourceRequest$name": "<p>The name of the data source.</p>",
"GetResolverRequest$typeName": "<p>The resolver type name.</p>",
"GetResolverRequest$fieldName": "<p>The resolver field name.</p>",
"GetTypeRequest$typeName": "<p>The type name.</p>",
"GraphqlApi$name": "<p>The API name.</p>",
"Resolver$typeName": "<p>The resolver type name.</p>",
"Resolver$fieldName": "<p>The resolver field name.</p>",
"Resolver$dataSourceName": "<p>The resolver data source name.</p>",
"Type$name": "<p>The type name.</p>",
"UpdateDataSourceRequest$name": "<p>The new name for the data source.</p>",
"UpdateResolverRequest$typeName": "<p>The new type name.</p>",
"UpdateResolverRequest$fieldName": "<p>The new field name.</p>",
"UpdateResolverRequest$dataSourceName": "<p>The new data source name.</p>",
"UpdateTypeRequest$typeName": "<p>The new type name.</p>"
}
},
"SchemaStatus": {
"base": null,
"refs": {
"GetSchemaCreationStatusResponse$status": "<p>The current state of the schema (PROCESSING, ACTIVE, or DELETING). Once the schema is in the ACTIVE state, you can add data.</p>",
"StartSchemaCreationResponse$status": "<p>The current state of the schema (PROCESSING, ACTIVE, or DELETING). Once the schema is in the ACTIVE state, you can add data.</p>"
}
},
"StartSchemaCreationRequest": {
"base": null,
"refs": {
}
},
"StartSchemaCreationResponse": {
"base": null,
"refs": {
}
},
"String": {
"base": null,
"refs": {
"ApiKey$id": "<p>The API key ID.</p>",
"ApiKey$description": "<p>A description of the purpose of the API key.</p>",
"ApiKeyLimitExceededException$message": null,
"ApiKeyValidityOutOfBoundsException$message": null,
"ApiLimitExceededException$message": null,
"CreateApiKeyRequest$apiId": "<p>The ID for your GraphQL API.</p>",
"CreateApiKeyRequest$description": "<p>A description of the purpose of the API key.</p>",
"CreateDataSourceRequest$apiId": "<p>The API ID for the GraphQL API for the <code>DataSource</code>.</p>",
"CreateDataSourceRequest$description": "<p>A description of the <code>DataSource</code>.</p>",
"CreateDataSourceRequest$serviceRoleArn": "<p>The IAM service role ARN for the data source. The system assumes this role when accessing the data source.</p>",
"CreateGraphqlApiRequest$name": "<p>A user-supplied name for the <code>GraphqlApi</code>.</p>",
"CreateResolverRequest$apiId": "<p>The ID for the GraphQL API for which the resolver is being created.</p>",
"CreateTypeRequest$apiId": "<p>The API ID.</p>",
"CreateTypeRequest$definition": "<p>The type definition, in GraphQL Schema Definition Language (SDL) format.</p> <p>For more information, see the <a href=\"http://graphql.org/learn/schema/\">GraphQL SDL documentation</a>.</p>",
"DataSource$dataSourceArn": "<p>The data source ARN.</p>",
"DataSource$description": "<p>The description of the data source.</p>",
"DataSource$serviceRoleArn": "<p>The IAM service role ARN for the data source. The system assumes this role when accessing the data source.</p>",
"DeleteApiKeyRequest$apiId": "<p>The API ID.</p>",
"DeleteApiKeyRequest$id": "<p>The ID for the API key.</p>",
"DeleteDataSourceRequest$apiId": "<p>The API ID.</p>",
"DeleteGraphqlApiRequest$apiId": "<p>The API ID.</p>",
"DeleteResolverRequest$apiId": "<p>The API ID.</p>",
"DeleteTypeRequest$apiId": "<p>The API ID.</p>",
"DynamodbDataSourceConfig$tableName": "<p>The table name.</p>",
"DynamodbDataSourceConfig$awsRegion": "<p>The AWS region.</p>",
"ElasticsearchDataSourceConfig$endpoint": "<p>The endpoint.</p>",
"ElasticsearchDataSourceConfig$awsRegion": "<p>The AWS region.</p>",
"GetDataSourceRequest$apiId": "<p>The API ID.</p>",
"GetGraphqlApiRequest$apiId": "<p>The API ID for the GraphQL API.</p>",
"GetIntrospectionSchemaRequest$apiId": "<p>The API ID.</p>",
"GetResolverRequest$apiId": "<p>The API ID.</p>",
"GetSchemaCreationStatusRequest$apiId": "<p>The API ID.</p>",
"GetSchemaCreationStatusResponse$details": "<p>Detailed information about the status of the schema creation operation.</p>",
"GetTypeRequest$apiId": "<p>The API ID.</p>",
"GraphqlApi$apiId": "<p>The API ID.</p>",
"GraphqlApi$arn": "<p>The ARN.</p>",
"InternalFailureException$message": null,
"LambdaDataSourceConfig$lambdaFunctionArn": "<p>The ARN for the Lambda function.</p>",
"LimitExceededException$message": null,
"ListApiKeysRequest$apiId": "<p>The API ID.</p>",
"ListDataSourcesRequest$apiId": "<p>The API ID.</p>",
"ListResolversRequest$apiId": "<p>The API ID.</p>",
"ListResolversRequest$typeName": "<p>The type name.</p>",
"ListTypesRequest$apiId": "<p>The API ID.</p>",
"MapOfStringToString$key": null,
"MapOfStringToString$value": null,
"NotFoundException$message": null,
"Resolver$resolverArn": "<p>The resolver ARN.</p>",
"StartSchemaCreationRequest$apiId": "<p>The API ID.</p>",
"Type$description": "<p>The type description.</p>",
"Type$arn": "<p>The type ARN.</p>",
"Type$definition": "<p>The type definition.</p>",
"UnauthorizedException$message": null,
"UpdateApiKeyRequest$apiId": "<p>The ID for the GraphQL API</p>",
"UpdateApiKeyRequest$id": "<p>The API key ID.</p>",
"UpdateApiKeyRequest$description": "<p>A description of the purpose of the API key.</p>",
"UpdateDataSourceRequest$apiId": "<p>The API ID.</p>",
"UpdateDataSourceRequest$description": "<p>The new description for the data source.</p>",
"UpdateDataSourceRequest$serviceRoleArn": "<p>The new service role ARN for the data source.</p>",
"UpdateGraphqlApiRequest$apiId": "<p>The API ID.</p>",
"UpdateGraphqlApiRequest$name": "<p>The new name for the <code>GraphqlApi</code> object.</p>",
"UpdateResolverRequest$apiId": "<p>The API ID.</p>",
"UpdateTypeRequest$apiId": "<p>The API ID.</p>",
"UpdateTypeRequest$definition": "<p>The new definition.</p>",
"UserPoolConfig$userPoolId": "<p>The user pool ID.</p>",
"UserPoolConfig$awsRegion": "<p>The AWS region in which the user pool was created.</p>",
"UserPoolConfig$appIdClientRegex": "<p>A regular expression for validating the incoming Amazon Cognito User Pool app client ID.</p>"
}
},
"Type": {
"base": "<p>Describes a type.</p>",
"refs": {
"CreateTypeResponse$type": "<p>The <code>Type</code> object.</p>",
"GetTypeResponse$type": "<p>The <code>Type</code> object.</p>",
"TypeList$member": null,
"UpdateTypeResponse$type": "<p>The updated <code>Type</code> object.</p>"
}
},
"TypeDefinitionFormat": {
"base": null,
"refs": {
"CreateTypeRequest$format": "<p>The type format: SDL or JSON.</p>",
"GetTypeRequest$format": "<p>The type format: SDL or JSON.</p>",
"ListTypesRequest$format": "<p>The type format: SDL or JSON.</p>",
"Type$format": "<p>The type format: SDL or JSON.</p>",
"UpdateTypeRequest$format": "<p>The new type format: SDL or JSON.</p>"
}
},
"TypeList": {
"base": null,
"refs": {
"ListTypesResponse$types": "<p>The <code>Type</code> objects.</p>"
}
},
"UnauthorizedException": {
"base": "<p>You are not authorized to perform this operation.</p>",
"refs": {
}
},
"UpdateApiKeyRequest": {
"base": null,
"refs": {
}
},
"UpdateApiKeyResponse": {
"base": null,
"refs": {
}
},
"UpdateDataSourceRequest": {
"base": null,
"refs": {
}
},
"UpdateDataSourceResponse": {
"base": null,
"refs": {
}
},
"UpdateGraphqlApiRequest": {
"base": null,
"refs": {
}
},
"UpdateGraphqlApiResponse": {
"base": null,
"refs": {
}
},
"UpdateResolverRequest": {
"base": null,
"refs": {
}
},
"UpdateResolverResponse": {
"base": null,
"refs": {
}
},
"UpdateTypeRequest": {
"base": null,
"refs": {
}
},
"UpdateTypeResponse": {
"base": null,
"refs": {
}
},
"UserPoolConfig": {
"base": "<p>Describes an Amazon Cognito User Pool configuration.</p>",
"refs": {
"CreateGraphqlApiRequest$userPoolConfig": "<p>The Amazon Cognito User Pool configuration.</p>",
"GraphqlApi$userPoolConfig": "<p>The Amazon Cognito User Pool configuration.</p>",
"UpdateGraphqlApiRequest$userPoolConfig": "<p>The new Amazon Cognito User Pool configuration for the <code>GraphqlApi</code> object.</p>"
}
}
}
}

5
vendor/github.com/aws/aws-sdk-go/models/apis/appsync/2017-07-25/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/appsync/2017-07-25/paginators-1.json generated vendored Normal file
View File

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

615
vendor/github.com/aws/aws-sdk-go/models/apis/athena/2017-05-18/api-2.json generated vendored Normal file
View File

@@ -0,0 +1,615 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2017-05-18",
"endpointPrefix":"athena",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Amazon Athena",
"signatureVersion":"v4",
"targetPrefix":"AmazonAthena",
"uid":"athena-2017-05-18"
},
"operations":{
"BatchGetNamedQuery":{
"name":"BatchGetNamedQuery",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"BatchGetNamedQueryInput"},
"output":{"shape":"BatchGetNamedQueryOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
]
},
"BatchGetQueryExecution":{
"name":"BatchGetQueryExecution",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"BatchGetQueryExecutionInput"},
"output":{"shape":"BatchGetQueryExecutionOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
]
},
"CreateNamedQuery":{
"name":"CreateNamedQuery",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateNamedQueryInput"},
"output":{"shape":"CreateNamedQueryOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"idempotent":true
},
"DeleteNamedQuery":{
"name":"DeleteNamedQuery",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteNamedQueryInput"},
"output":{"shape":"DeleteNamedQueryOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"idempotent":true
},
"GetNamedQuery":{
"name":"GetNamedQuery",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetNamedQueryInput"},
"output":{"shape":"GetNamedQueryOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
]
},
"GetQueryExecution":{
"name":"GetQueryExecution",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetQueryExecutionInput"},
"output":{"shape":"GetQueryExecutionOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
]
},
"GetQueryResults":{
"name":"GetQueryResults",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetQueryResultsInput"},
"output":{"shape":"GetQueryResultsOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
]
},
"ListNamedQueries":{
"name":"ListNamedQueries",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListNamedQueriesInput"},
"output":{"shape":"ListNamedQueriesOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
]
},
"ListQueryExecutions":{
"name":"ListQueryExecutions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListQueryExecutionsInput"},
"output":{"shape":"ListQueryExecutionsOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
]
},
"StartQueryExecution":{
"name":"StartQueryExecution",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StartQueryExecutionInput"},
"output":{"shape":"StartQueryExecutionOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"},
{"shape":"TooManyRequestsException"}
],
"idempotent":true
},
"StopQueryExecution":{
"name":"StopQueryExecution",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopQueryExecutionInput"},
"output":{"shape":"StopQueryExecutionOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"idempotent":true
}
},
"shapes":{
"BatchGetNamedQueryInput":{
"type":"structure",
"required":["NamedQueryIds"],
"members":{
"NamedQueryIds":{"shape":"NamedQueryIdList"}
}
},
"BatchGetNamedQueryOutput":{
"type":"structure",
"members":{
"NamedQueries":{"shape":"NamedQueryList"},
"UnprocessedNamedQueryIds":{"shape":"UnprocessedNamedQueryIdList"}
}
},
"BatchGetQueryExecutionInput":{
"type":"structure",
"required":["QueryExecutionIds"],
"members":{
"QueryExecutionIds":{"shape":"QueryExecutionIdList"}
}
},
"BatchGetQueryExecutionOutput":{
"type":"structure",
"members":{
"QueryExecutions":{"shape":"QueryExecutionList"},
"UnprocessedQueryExecutionIds":{"shape":"UnprocessedQueryExecutionIdList"}
}
},
"Boolean":{"type":"boolean"},
"ColumnInfo":{
"type":"structure",
"required":[
"Name",
"Type"
],
"members":{
"CatalogName":{"shape":"String"},
"SchemaName":{"shape":"String"},
"TableName":{"shape":"String"},
"Name":{"shape":"String"},
"Label":{"shape":"String"},
"Type":{"shape":"String"},
"Precision":{"shape":"Integer"},
"Scale":{"shape":"Integer"},
"Nullable":{"shape":"ColumnNullable"},
"CaseSensitive":{"shape":"Boolean"}
}
},
"ColumnInfoList":{
"type":"list",
"member":{"shape":"ColumnInfo"}
},
"ColumnNullable":{
"type":"string",
"enum":[
"NOT_NULL",
"NULLABLE",
"UNKNOWN"
]
},
"CreateNamedQueryInput":{
"type":"structure",
"required":[
"Name",
"Database",
"QueryString"
],
"members":{
"Name":{"shape":"NameString"},
"Description":{"shape":"DescriptionString"},
"Database":{"shape":"DatabaseString"},
"QueryString":{"shape":"QueryString"},
"ClientRequestToken":{
"shape":"IdempotencyToken",
"idempotencyToken":true
}
}
},
"CreateNamedQueryOutput":{
"type":"structure",
"members":{
"NamedQueryId":{"shape":"NamedQueryId"}
}
},
"DatabaseString":{
"type":"string",
"max":32,
"min":1
},
"Date":{"type":"timestamp"},
"Datum":{
"type":"structure",
"members":{
"VarCharValue":{"shape":"datumString"}
}
},
"DeleteNamedQueryInput":{
"type":"structure",
"required":["NamedQueryId"],
"members":{
"NamedQueryId":{
"shape":"NamedQueryId",
"idempotencyToken":true
}
}
},
"DeleteNamedQueryOutput":{
"type":"structure",
"members":{
}
},
"DescriptionString":{
"type":"string",
"max":1024,
"min":1
},
"EncryptionConfiguration":{
"type":"structure",
"required":["EncryptionOption"],
"members":{
"EncryptionOption":{"shape":"EncryptionOption"},
"KmsKey":{"shape":"String"}
}
},
"EncryptionOption":{
"type":"string",
"enum":[
"SSE_S3",
"SSE_KMS",
"CSE_KMS"
]
},
"ErrorCode":{
"type":"string",
"max":256,
"min":1
},
"ErrorMessage":{"type":"string"},
"GetNamedQueryInput":{
"type":"structure",
"required":["NamedQueryId"],
"members":{
"NamedQueryId":{"shape":"NamedQueryId"}
}
},
"GetNamedQueryOutput":{
"type":"structure",
"members":{
"NamedQuery":{"shape":"NamedQuery"}
}
},
"GetQueryExecutionInput":{
"type":"structure",
"required":["QueryExecutionId"],
"members":{
"QueryExecutionId":{"shape":"QueryExecutionId"}
}
},
"GetQueryExecutionOutput":{
"type":"structure",
"members":{
"QueryExecution":{"shape":"QueryExecution"}
}
},
"GetQueryResultsInput":{
"type":"structure",
"required":["QueryExecutionId"],
"members":{
"QueryExecutionId":{"shape":"QueryExecutionId"},
"NextToken":{"shape":"Token"},
"MaxResults":{"shape":"MaxQueryResults"}
}
},
"GetQueryResultsOutput":{
"type":"structure",
"members":{
"ResultSet":{"shape":"ResultSet"},
"NextToken":{"shape":"Token"}
}
},
"IdempotencyToken":{
"type":"string",
"max":128,
"min":32
},
"Integer":{"type":"integer"},
"InternalServerException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true,
"fault":true
},
"InvalidRequestException":{
"type":"structure",
"members":{
"AthenaErrorCode":{"shape":"ErrorCode"},
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"ListNamedQueriesInput":{
"type":"structure",
"members":{
"NextToken":{"shape":"Token"},
"MaxResults":{"shape":"MaxNamedQueriesCount"}
}
},
"ListNamedQueriesOutput":{
"type":"structure",
"members":{
"NamedQueryIds":{"shape":"NamedQueryIdList"},
"NextToken":{"shape":"Token"}
}
},
"ListQueryExecutionsInput":{
"type":"structure",
"members":{
"NextToken":{"shape":"Token"},
"MaxResults":{"shape":"MaxQueryExecutionsCount"}
}
},
"ListQueryExecutionsOutput":{
"type":"structure",
"members":{
"QueryExecutionIds":{"shape":"QueryExecutionIdList"},
"NextToken":{"shape":"Token"}
}
},
"Long":{"type":"long"},
"MaxNamedQueriesCount":{
"type":"integer",
"box":true,
"max":50,
"min":0
},
"MaxQueryExecutionsCount":{
"type":"integer",
"box":true,
"max":50,
"min":0
},
"MaxQueryResults":{
"type":"integer",
"box":true,
"max":1000,
"min":0
},
"NameString":{
"type":"string",
"max":128,
"min":1
},
"NamedQuery":{
"type":"structure",
"required":[
"Name",
"Database",
"QueryString"
],
"members":{
"Name":{"shape":"NameString"},
"Description":{"shape":"DescriptionString"},
"Database":{"shape":"DatabaseString"},
"QueryString":{"shape":"QueryString"},
"NamedQueryId":{"shape":"NamedQueryId"}
}
},
"NamedQueryId":{"type":"string"},
"NamedQueryIdList":{
"type":"list",
"member":{"shape":"NamedQueryId"},
"max":50,
"min":1
},
"NamedQueryList":{
"type":"list",
"member":{"shape":"NamedQuery"}
},
"QueryExecution":{
"type":"structure",
"members":{
"QueryExecutionId":{"shape":"QueryExecutionId"},
"Query":{"shape":"QueryString"},
"ResultConfiguration":{"shape":"ResultConfiguration"},
"QueryExecutionContext":{"shape":"QueryExecutionContext"},
"Status":{"shape":"QueryExecutionStatus"},
"Statistics":{"shape":"QueryExecutionStatistics"}
}
},
"QueryExecutionContext":{
"type":"structure",
"members":{
"Database":{"shape":"DatabaseString"}
}
},
"QueryExecutionId":{"type":"string"},
"QueryExecutionIdList":{
"type":"list",
"member":{"shape":"QueryExecutionId"},
"max":50,
"min":1
},
"QueryExecutionList":{
"type":"list",
"member":{"shape":"QueryExecution"}
},
"QueryExecutionState":{
"type":"string",
"enum":[
"QUEUED",
"RUNNING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
]
},
"QueryExecutionStatistics":{
"type":"structure",
"members":{
"EngineExecutionTimeInMillis":{"shape":"Long"},
"DataScannedInBytes":{"shape":"Long"}
}
},
"QueryExecutionStatus":{
"type":"structure",
"members":{
"State":{"shape":"QueryExecutionState"},
"StateChangeReason":{"shape":"String"},
"SubmissionDateTime":{"shape":"Date"},
"CompletionDateTime":{"shape":"Date"}
}
},
"QueryString":{
"type":"string",
"max":262144,
"min":1
},
"ResultConfiguration":{
"type":"structure",
"required":["OutputLocation"],
"members":{
"OutputLocation":{"shape":"String"},
"EncryptionConfiguration":{"shape":"EncryptionConfiguration"}
}
},
"ResultSet":{
"type":"structure",
"members":{
"Rows":{"shape":"RowList"},
"ResultSetMetadata":{"shape":"ResultSetMetadata"}
}
},
"ResultSetMetadata":{
"type":"structure",
"members":{
"ColumnInfo":{"shape":"ColumnInfoList"}
}
},
"Row":{
"type":"structure",
"members":{
"Data":{"shape":"datumList"}
}
},
"RowList":{
"type":"list",
"member":{"shape":"Row"}
},
"StartQueryExecutionInput":{
"type":"structure",
"required":[
"QueryString",
"ResultConfiguration"
],
"members":{
"QueryString":{"shape":"QueryString"},
"ClientRequestToken":{
"shape":"IdempotencyToken",
"idempotencyToken":true
},
"QueryExecutionContext":{"shape":"QueryExecutionContext"},
"ResultConfiguration":{"shape":"ResultConfiguration"}
}
},
"StartQueryExecutionOutput":{
"type":"structure",
"members":{
"QueryExecutionId":{"shape":"QueryExecutionId"}
}
},
"StopQueryExecutionInput":{
"type":"structure",
"required":["QueryExecutionId"],
"members":{
"QueryExecutionId":{
"shape":"QueryExecutionId",
"idempotencyToken":true
}
}
},
"StopQueryExecutionOutput":{
"type":"structure",
"members":{
}
},
"String":{"type":"string"},
"ThrottleReason":{
"type":"string",
"enum":["CONCURRENT_QUERY_LIMIT_EXCEEDED"]
},
"Token":{"type":"string"},
"TooManyRequestsException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"},
"Reason":{"shape":"ThrottleReason"}
},
"exception":true
},
"UnprocessedNamedQueryId":{
"type":"structure",
"members":{
"NamedQueryId":{"shape":"NamedQueryId"},
"ErrorCode":{"shape":"ErrorCode"},
"ErrorMessage":{"shape":"ErrorMessage"}
}
},
"UnprocessedNamedQueryIdList":{
"type":"list",
"member":{"shape":"UnprocessedNamedQueryId"}
},
"UnprocessedQueryExecutionId":{
"type":"structure",
"members":{
"QueryExecutionId":{"shape":"QueryExecutionId"},
"ErrorCode":{"shape":"ErrorCode"},
"ErrorMessage":{"shape":"ErrorMessage"}
}
},
"UnprocessedQueryExecutionIdList":{
"type":"list",
"member":{"shape":"UnprocessedQueryExecutionId"}
},
"datumList":{
"type":"list",
"member":{"shape":"Datum"}
},
"datumString":{"type":"string"}
}
}

467
vendor/github.com/aws/aws-sdk-go/models/apis/athena/2017-05-18/docs-2.json generated vendored Normal file
View File

@@ -0,0 +1,467 @@
{
"version": "2.0",
"service": "<p>Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay only for the queries you run. Athena scales automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For more information, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/what-is.html\">What is Amazon Athena</a> in the <i>Amazon Athena User Guide</i>.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"operations": {
"BatchGetNamedQuery": "<p>Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Use <a>ListNamedQueries</a> to get the list of named query IDs. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under <a>UnprocessedNamedQueryId</a>. Named queries are different from executed queries. Use <a>BatchGetQueryExecution</a> to get details about each unique query execution, and <a>ListQueryExecutions</a> to get a list of query execution IDs.</p>",
"BatchGetQueryExecution": "<p>Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. To get a list of query execution IDs, use <a>ListQueryExecutions</a>. Query executions are different from named (saved) queries. Use <a>BatchGetNamedQuery</a> to get details about named queries.</p>",
"CreateNamedQuery": "<p>Creates a named query.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"DeleteNamedQuery": "<p>Deletes a named query.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"GetNamedQuery": "<p>Returns information about a single query.</p>",
"GetQueryExecution": "<p>Returns information about a single execution of a query. Each time a query executes, information about the query execution is saved with a unique ID.</p>",
"GetQueryResults": "<p>Returns the results of a single query execution specified by <code>QueryExecutionId</code>. This request does not execute the query but returns results. Use <a>StartQueryExecution</a> to run a query.</p>",
"ListNamedQueries": "<p>Provides a list of all available query IDs.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"ListQueryExecutions": "<p>Provides a list of all available query execution IDs.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"StartQueryExecution": "<p>Runs (executes) the SQL query statements contained in the <code>Query</code> string.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"StopQueryExecution": "<p>Stops a query execution.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>"
},
"shapes": {
"BatchGetNamedQueryInput": {
"base": null,
"refs": {
}
},
"BatchGetNamedQueryOutput": {
"base": null,
"refs": {
}
},
"BatchGetQueryExecutionInput": {
"base": null,
"refs": {
}
},
"BatchGetQueryExecutionOutput": {
"base": null,
"refs": {
}
},
"Boolean": {
"base": null,
"refs": {
"ColumnInfo$CaseSensitive": "<p>Indicates whether values in the column are case-sensitive.</p>"
}
},
"ColumnInfo": {
"base": "<p>Information about the columns in a query execution result.</p>",
"refs": {
"ColumnInfoList$member": null
}
},
"ColumnInfoList": {
"base": null,
"refs": {
"ResultSetMetadata$ColumnInfo": "<p>Information about the columns in a query execution result.</p>"
}
},
"ColumnNullable": {
"base": null,
"refs": {
"ColumnInfo$Nullable": "<p>Indicates the column's nullable status.</p>"
}
},
"CreateNamedQueryInput": {
"base": null,
"refs": {
}
},
"CreateNamedQueryOutput": {
"base": null,
"refs": {
}
},
"DatabaseString": {
"base": null,
"refs": {
"CreateNamedQueryInput$Database": "<p>The database to which the query belongs.</p>",
"NamedQuery$Database": "<p>The database to which the query belongs.</p>",
"QueryExecutionContext$Database": "<p>The name of the database.</p>"
}
},
"Date": {
"base": null,
"refs": {
"QueryExecutionStatus$SubmissionDateTime": "<p>The date and time that the query was submitted.</p>",
"QueryExecutionStatus$CompletionDateTime": "<p>The date and time that the query completed.</p>"
}
},
"Datum": {
"base": "<p>A piece of data (a field in the table).</p>",
"refs": {
"datumList$member": null
}
},
"DeleteNamedQueryInput": {
"base": null,
"refs": {
}
},
"DeleteNamedQueryOutput": {
"base": null,
"refs": {
}
},
"DescriptionString": {
"base": null,
"refs": {
"CreateNamedQueryInput$Description": "<p>A brief explanation of the query.</p>",
"NamedQuery$Description": "<p>A brief description of the query.</p>"
}
},
"EncryptionConfiguration": {
"base": "<p>If query results are encrypted in Amazon S3, indicates the Amazon S3 encryption option used.</p>",
"refs": {
"ResultConfiguration$EncryptionConfiguration": "<p>If query results are encrypted in S3, indicates the S3 encryption option used (for example, <code>SSE-KMS</code> or <code>CSE-KMS</code> and key information.</p>"
}
},
"EncryptionOption": {
"base": null,
"refs": {
"EncryptionConfiguration$EncryptionOption": "<p>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (<code>SSE-S3</code>), server-side encryption with KMS-managed keys (<code>SSE-KMS</code>), or client-side encryption with KMS-managed keys (CSE-KMS) is used.</p>"
}
},
"ErrorCode": {
"base": null,
"refs": {
"InvalidRequestException$AthenaErrorCode": null,
"UnprocessedNamedQueryId$ErrorCode": "<p>The error code returned when the processing request for the named query failed, if applicable.</p>",
"UnprocessedQueryExecutionId$ErrorCode": "<p>The error code returned when the query execution failed to process, if applicable.</p>"
}
},
"ErrorMessage": {
"base": null,
"refs": {
"InternalServerException$Message": null,
"InvalidRequestException$Message": null,
"TooManyRequestsException$Message": null,
"UnprocessedNamedQueryId$ErrorMessage": "<p>The error message returned when the processing request for the named query failed, if applicable.</p>",
"UnprocessedQueryExecutionId$ErrorMessage": "<p>The error message returned when the query execution failed to process, if applicable.</p>"
}
},
"GetNamedQueryInput": {
"base": null,
"refs": {
}
},
"GetNamedQueryOutput": {
"base": null,
"refs": {
}
},
"GetQueryExecutionInput": {
"base": null,
"refs": {
}
},
"GetQueryExecutionOutput": {
"base": null,
"refs": {
}
},
"GetQueryResultsInput": {
"base": null,
"refs": {
}
},
"GetQueryResultsOutput": {
"base": null,
"refs": {
}
},
"IdempotencyToken": {
"base": null,
"refs": {
"CreateNamedQueryInput$ClientRequestToken": "<p>A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another <code>CreateNamedQuery</code> request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the <code>QueryString</code>, an error is returned.</p> <important> <p>This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.</p> </important>",
"StartQueryExecutionInput$ClientRequestToken": "<p>A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another <code>StartQueryExecution</code> request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the <code>QueryString</code>, an error is returned.</p> <important> <p>This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.</p> </important>"
}
},
"Integer": {
"base": null,
"refs": {
"ColumnInfo$Precision": "<p>For <code>DECIMAL</code> data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits.</p>",
"ColumnInfo$Scale": "<p>For <code>DECIMAL</code> data types, specifies the total number of digits in the fractional part of the value. Defaults to 0.</p>"
}
},
"InternalServerException": {
"base": "<p>Indicates a platform issue, which may be due to a transient condition or outage.</p>",
"refs": {
}
},
"InvalidRequestException": {
"base": "<p>Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.</p>",
"refs": {
}
},
"ListNamedQueriesInput": {
"base": null,
"refs": {
}
},
"ListNamedQueriesOutput": {
"base": null,
"refs": {
}
},
"ListQueryExecutionsInput": {
"base": null,
"refs": {
}
},
"ListQueryExecutionsOutput": {
"base": null,
"refs": {
}
},
"Long": {
"base": null,
"refs": {
"QueryExecutionStatistics$EngineExecutionTimeInMillis": "<p>The number of milliseconds that the query took to execute.</p>",
"QueryExecutionStatistics$DataScannedInBytes": "<p>The number of bytes in the data that was queried.</p>"
}
},
"MaxNamedQueriesCount": {
"base": null,
"refs": {
"ListNamedQueriesInput$MaxResults": "<p>The maximum number of queries to return in this request.</p>"
}
},
"MaxQueryExecutionsCount": {
"base": null,
"refs": {
"ListQueryExecutionsInput$MaxResults": "<p>The maximum number of query executions to return in this request.</p>"
}
},
"MaxQueryResults": {
"base": null,
"refs": {
"GetQueryResultsInput$MaxResults": "<p>The maximum number of results (rows) to return in this request.</p>"
}
},
"NameString": {
"base": null,
"refs": {
"CreateNamedQueryInput$Name": "<p>The plain language name for the query.</p>",
"NamedQuery$Name": "<p>The plain-language name of the query.</p>"
}
},
"NamedQuery": {
"base": "<p>A query, where <code>QueryString</code> is the SQL query statements that comprise the query.</p>",
"refs": {
"GetNamedQueryOutput$NamedQuery": "<p>Information about the query.</p>",
"NamedQueryList$member": null
}
},
"NamedQueryId": {
"base": null,
"refs": {
"CreateNamedQueryOutput$NamedQueryId": "<p>The unique ID of the query.</p>",
"DeleteNamedQueryInput$NamedQueryId": "<p>The unique ID of the query to delete.</p>",
"GetNamedQueryInput$NamedQueryId": "<p>The unique ID of the query. Use <a>ListNamedQueries</a> to get query IDs.</p>",
"NamedQuery$NamedQueryId": "<p>The unique identifier of the query.</p>",
"NamedQueryIdList$member": null,
"UnprocessedNamedQueryId$NamedQueryId": "<p>The unique identifier of the named query.</p>"
}
},
"NamedQueryIdList": {
"base": null,
"refs": {
"BatchGetNamedQueryInput$NamedQueryIds": "<p>An array of query IDs.</p>",
"ListNamedQueriesOutput$NamedQueryIds": "<p>The list of unique query IDs.</p>"
}
},
"NamedQueryList": {
"base": null,
"refs": {
"BatchGetNamedQueryOutput$NamedQueries": "<p>Information about the named query IDs submitted.</p>"
}
},
"QueryExecution": {
"base": "<p>Information about a single instance of a query execution.</p>",
"refs": {
"GetQueryExecutionOutput$QueryExecution": "<p>Information about the query execution.</p>",
"QueryExecutionList$member": null
}
},
"QueryExecutionContext": {
"base": "<p>The database in which the query execution occurs.</p>",
"refs": {
"QueryExecution$QueryExecutionContext": "<p>The database in which the query execution occurred.</p>",
"StartQueryExecutionInput$QueryExecutionContext": "<p>The database within which the query executes.</p>"
}
},
"QueryExecutionId": {
"base": null,
"refs": {
"GetQueryExecutionInput$QueryExecutionId": "<p>The unique ID of the query execution.</p>",
"GetQueryResultsInput$QueryExecutionId": "<p>The unique ID of the query execution.</p>",
"QueryExecution$QueryExecutionId": "<p>The unique identifier for each query execution.</p>",
"QueryExecutionIdList$member": null,
"StartQueryExecutionOutput$QueryExecutionId": "<p>The unique ID of the query that ran as a result of this request.</p>",
"StopQueryExecutionInput$QueryExecutionId": "<p>The unique ID of the query execution to stop.</p>",
"UnprocessedQueryExecutionId$QueryExecutionId": "<p>The unique identifier of the query execution.</p>"
}
},
"QueryExecutionIdList": {
"base": null,
"refs": {
"BatchGetQueryExecutionInput$QueryExecutionIds": "<p>An array of query execution IDs.</p>",
"ListQueryExecutionsOutput$QueryExecutionIds": "<p>The unique IDs of each query execution as an array of strings.</p>"
}
},
"QueryExecutionList": {
"base": null,
"refs": {
"BatchGetQueryExecutionOutput$QueryExecutions": "<p>Information about a query execution.</p>"
}
},
"QueryExecutionState": {
"base": null,
"refs": {
"QueryExecutionStatus$State": "<p>The state of query execution. <code>SUBMITTED</code> indicates that the query is queued for execution. <code>RUNNING</code> indicates that the query is scanning data and returning results. <code>SUCCEEDED</code> indicates that the query completed without error. <code>FAILED</code> indicates that the query experienced an error and did not complete processing. <code>CANCELLED</code> indicates that user input interrupted query execution.</p>"
}
},
"QueryExecutionStatistics": {
"base": "<p>The amount of data scanned during the query execution and the amount of time that it took to execute.</p>",
"refs": {
"QueryExecution$Statistics": "<p>The amount of data scanned during the query execution and the amount of time that it took to execute.</p>"
}
},
"QueryExecutionStatus": {
"base": "<p>The completion date, current state, submission time, and state change reason (if applicable) for the query execution.</p>",
"refs": {
"QueryExecution$Status": "<p>The completion date, current state, submission time, and state change reason (if applicable) for the query execution.</p>"
}
},
"QueryString": {
"base": null,
"refs": {
"CreateNamedQueryInput$QueryString": "<p>The text of the query itself. In other words, all query statements.</p>",
"NamedQuery$QueryString": "<p>The SQL query statements that comprise the query.</p>",
"QueryExecution$Query": "<p>The SQL query statements which the query execution ran.</p>",
"StartQueryExecutionInput$QueryString": "<p>The SQL query statements to be executed.</p>"
}
},
"ResultConfiguration": {
"base": "<p>The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results.</p>",
"refs": {
"QueryExecution$ResultConfiguration": "<p>The location in Amazon S3 where query results were stored and the encryption option, if any, used for query results.</p>",
"StartQueryExecutionInput$ResultConfiguration": "<p>Specifies information about where and how to save the results of the query execution.</p>"
}
},
"ResultSet": {
"base": "<p>The metadata and rows that comprise a query result set. The metadata describes the column structure and data types.</p>",
"refs": {
"GetQueryResultsOutput$ResultSet": "<p>The results of the query execution.</p>"
}
},
"ResultSetMetadata": {
"base": "<p>The metadata that describes the column structure and data types of a table of query results.</p>",
"refs": {
"ResultSet$ResultSetMetadata": "<p>The metadata that describes the column structure and data types of a table of query results.</p>"
}
},
"Row": {
"base": "<p>The rows that comprise a query result table.</p>",
"refs": {
"RowList$member": null
}
},
"RowList": {
"base": null,
"refs": {
"ResultSet$Rows": "<p>The rows in the table.</p>"
}
},
"StartQueryExecutionInput": {
"base": null,
"refs": {
}
},
"StartQueryExecutionOutput": {
"base": null,
"refs": {
}
},
"StopQueryExecutionInput": {
"base": null,
"refs": {
}
},
"StopQueryExecutionOutput": {
"base": null,
"refs": {
}
},
"String": {
"base": null,
"refs": {
"ColumnInfo$CatalogName": "<p>The catalog to which the query results belong.</p>",
"ColumnInfo$SchemaName": "<p>The schema name (database name) to which the query results belong.</p>",
"ColumnInfo$TableName": "<p>The table name for the query results.</p>",
"ColumnInfo$Name": "<p>The name of the column.</p>",
"ColumnInfo$Label": "<p>A column label.</p>",
"ColumnInfo$Type": "<p>The data type of the column.</p>",
"EncryptionConfiguration$KmsKey": "<p>For <code>SSE-KMS</code> and <code>CSE-KMS</code>, this is the KMS key ARN or ID.</p>",
"QueryExecutionStatus$StateChangeReason": "<p>Further detail about the status of the query.</p>",
"ResultConfiguration$OutputLocation": "<p>The location in S3 where query results are stored.</p>"
}
},
"ThrottleReason": {
"base": null,
"refs": {
"TooManyRequestsException$Reason": null
}
},
"Token": {
"base": null,
"refs": {
"GetQueryResultsInput$NextToken": "<p>The token that specifies where to start pagination if a previous request was truncated.</p>",
"GetQueryResultsOutput$NextToken": "<p>A token to be used by the next request if this request is truncated.</p>",
"ListNamedQueriesInput$NextToken": "<p>The token that specifies where to start pagination if a previous request was truncated.</p>",
"ListNamedQueriesOutput$NextToken": "<p>A token to be used by the next request if this request is truncated.</p>",
"ListQueryExecutionsInput$NextToken": "<p>The token that specifies where to start pagination if a previous request was truncated.</p>",
"ListQueryExecutionsOutput$NextToken": "<p>A token to be used by the next request if this request is truncated.</p>"
}
},
"TooManyRequestsException": {
"base": "<p>Indicates that the request was throttled.</p>",
"refs": {
}
},
"UnprocessedNamedQueryId": {
"base": "<p>Information about a named query ID that could not be processed.</p>",
"refs": {
"UnprocessedNamedQueryIdList$member": null
}
},
"UnprocessedNamedQueryIdList": {
"base": null,
"refs": {
"BatchGetNamedQueryOutput$UnprocessedNamedQueryIds": "<p>Information about provided query IDs.</p>"
}
},
"UnprocessedQueryExecutionId": {
"base": "<p>Describes a query execution that failed to process.</p>",
"refs": {
"UnprocessedQueryExecutionIdList$member": null
}
},
"UnprocessedQueryExecutionIdList": {
"base": null,
"refs": {
"BatchGetQueryExecutionOutput$UnprocessedQueryExecutionIds": "<p>Information about the query executions that failed to run.</p>"
}
},
"datumList": {
"base": null,
"refs": {
"Row$Data": "<p>The data that populates a row in a query result table.</p>"
}
},
"datumString": {
"base": null,
"refs": {
"Datum$VarCharValue": "<p>The value of the datum.</p>"
}
}
}
}

5
vendor/github.com/aws/aws-sdk-go/models/apis/athena/2017-05-18/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/athena/2017-05-18/paginators-1.json generated vendored Normal file
View File

@@ -0,0 +1,19 @@
{
"pagination": {
"GetQueryResults": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListNamedQueries": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListQueryExecutions": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
}
}
}

529
vendor/github.com/aws/aws-sdk-go/models/apis/autoscaling-plans/2018-01-06/api-2.json generated vendored Normal file
View File

@@ -0,0 +1,529 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2018-01-06",
"endpointPrefix":"autoscaling",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS Auto Scaling Plans",
"serviceId":"Auto Scaling Plans",
"signatureVersion":"v4",
"signingName":"autoscaling-plans",
"targetPrefix":"AnyScaleScalingPlannerFrontendService",
"uid":"autoscaling-plans-2018-01-06"
},
"operations":{
"CreateScalingPlan":{
"name":"CreateScalingPlan",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateScalingPlanRequest"},
"output":{"shape":"CreateScalingPlanResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"LimitExceededException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
]
},
"DeleteScalingPlan":{
"name":"DeleteScalingPlan",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteScalingPlanRequest"},
"output":{"shape":"DeleteScalingPlanResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ObjectNotFoundException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
]
},
"DescribeScalingPlanResources":{
"name":"DescribeScalingPlanResources",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeScalingPlanResourcesRequest"},
"output":{"shape":"DescribeScalingPlanResourcesResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
]
},
"DescribeScalingPlans":{
"name":"DescribeScalingPlans",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeScalingPlansRequest"},
"output":{"shape":"DescribeScalingPlansResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"}
]
},
"UpdateScalingPlan":{
"name":"UpdateScalingPlan",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateScalingPlanRequest"},
"output":{"shape":"UpdateScalingPlanResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ConcurrentUpdateException"},
{"shape":"InternalServiceException"},
{"shape":"ObjectNotFoundException"}
]
}
},
"shapes":{
"ApplicationSource":{
"type":"structure",
"members":{
"CloudFormationStackARN":{"shape":"XmlString"},
"TagFilters":{"shape":"TagFilters"}
}
},
"ApplicationSources":{
"type":"list",
"member":{"shape":"ApplicationSource"}
},
"ConcurrentUpdateException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"Cooldown":{"type":"integer"},
"CreateScalingPlanRequest":{
"type":"structure",
"required":[
"ScalingPlanName",
"ApplicationSource",
"ScalingInstructions"
],
"members":{
"ScalingPlanName":{"shape":"ScalingPlanName"},
"ApplicationSource":{"shape":"ApplicationSource"},
"ScalingInstructions":{"shape":"ScalingInstructions"}
}
},
"CreateScalingPlanResponse":{
"type":"structure",
"required":["ScalingPlanVersion"],
"members":{
"ScalingPlanVersion":{"shape":"ScalingPlanVersion"}
}
},
"CustomizedScalingMetricSpecification":{
"type":"structure",
"required":[
"MetricName",
"Namespace",
"Statistic"
],
"members":{
"MetricName":{"shape":"MetricName"},
"Namespace":{"shape":"MetricNamespace"},
"Dimensions":{"shape":"MetricDimensions"},
"Statistic":{"shape":"MetricStatistic"},
"Unit":{"shape":"MetricUnit"}
}
},
"DeleteScalingPlanRequest":{
"type":"structure",
"required":[
"ScalingPlanName",
"ScalingPlanVersion"
],
"members":{
"ScalingPlanName":{"shape":"ScalingPlanName"},
"ScalingPlanVersion":{"shape":"ScalingPlanVersion"}
}
},
"DeleteScalingPlanResponse":{
"type":"structure",
"members":{
}
},
"DescribeScalingPlanResourcesRequest":{
"type":"structure",
"required":[
"ScalingPlanName",
"ScalingPlanVersion"
],
"members":{
"ScalingPlanName":{"shape":"ScalingPlanName"},
"ScalingPlanVersion":{"shape":"ScalingPlanVersion"},
"MaxResults":{"shape":"MaxResults"},
"NextToken":{"shape":"NextToken"}
}
},
"DescribeScalingPlanResourcesResponse":{
"type":"structure",
"members":{
"ScalingPlanResources":{"shape":"ScalingPlanResources"},
"NextToken":{"shape":"NextToken"}
}
},
"DescribeScalingPlansRequest":{
"type":"structure",
"members":{
"ScalingPlanNames":{"shape":"ScalingPlanNames"},
"ScalingPlanVersion":{"shape":"ScalingPlanVersion"},
"ApplicationSources":{"shape":"ApplicationSources"},
"MaxResults":{"shape":"MaxResults"},
"NextToken":{"shape":"NextToken"}
}
},
"DescribeScalingPlansResponse":{
"type":"structure",
"members":{
"ScalingPlans":{"shape":"ScalingPlans"},
"NextToken":{"shape":"NextToken"}
}
},
"DisableScaleIn":{"type":"boolean"},
"ErrorMessage":{"type":"string"},
"InternalServiceException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"InvalidNextTokenException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"MaxResults":{"type":"integer"},
"MetricDimension":{
"type":"structure",
"required":[
"Name",
"Value"
],
"members":{
"Name":{"shape":"MetricDimensionName"},
"Value":{"shape":"MetricDimensionValue"}
}
},
"MetricDimensionName":{"type":"string"},
"MetricDimensionValue":{"type":"string"},
"MetricDimensions":{
"type":"list",
"member":{"shape":"MetricDimension"}
},
"MetricName":{"type":"string"},
"MetricNamespace":{"type":"string"},
"MetricScale":{"type":"double"},
"MetricStatistic":{
"type":"string",
"enum":[
"Average",
"Minimum",
"Maximum",
"SampleCount",
"Sum"
]
},
"MetricUnit":{"type":"string"},
"NextToken":{"type":"string"},
"ObjectNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"PolicyName":{
"type":"string",
"max":256,
"min":1,
"pattern":"\\p{Print}+"
},
"PolicyType":{
"type":"string",
"enum":["TargetTrackingScaling"]
},
"PredefinedScalingMetricSpecification":{
"type":"structure",
"required":["PredefinedScalingMetricType"],
"members":{
"PredefinedScalingMetricType":{"shape":"ScalingMetricType"},
"ResourceLabel":{"shape":"ResourceLabel"}
}
},
"ResourceCapacity":{"type":"integer"},
"ResourceIdMaxLen1600":{
"type":"string",
"max":1600,
"min":1,
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
},
"ResourceLabel":{
"type":"string",
"max":1023,
"min":1
},
"ScalableDimension":{
"type":"string",
"enum":[
"autoscaling:autoScalingGroup:DesiredCapacity",
"ecs:service:DesiredCount",
"ec2:spot-fleet-request:TargetCapacity",
"rds:cluster:ReadReplicaCount",
"dynamodb:table:ReadCapacityUnits",
"dynamodb:table:WriteCapacityUnits",
"dynamodb:index:ReadCapacityUnits",
"dynamodb:index:WriteCapacityUnits"
]
},
"ScalingInstruction":{
"type":"structure",
"required":[
"ServiceNamespace",
"ResourceId",
"ScalableDimension",
"MinCapacity",
"MaxCapacity",
"TargetTrackingConfigurations"
],
"members":{
"ServiceNamespace":{"shape":"ServiceNamespace"},
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"},
"MinCapacity":{"shape":"ResourceCapacity"},
"MaxCapacity":{"shape":"ResourceCapacity"},
"TargetTrackingConfigurations":{"shape":"TargetTrackingConfigurations"}
}
},
"ScalingInstructions":{
"type":"list",
"member":{"shape":"ScalingInstruction"}
},
"ScalingMetricType":{
"type":"string",
"enum":[
"ASGAverageCPUUtilization",
"ASGAverageNetworkIn",
"ASGAverageNetworkOut",
"DynamoDBReadCapacityUtilization",
"DynamoDBWriteCapacityUtilization",
"ECSServiceAverageCPUUtilization",
"ECSServiceAverageMemoryUtilization",
"ALBRequestCountPerTarget",
"RDSReaderAverageCPUUtilization",
"RDSReaderAverageDatabaseConnections",
"EC2SpotFleetRequestAverageCPUUtilization",
"EC2SpotFleetRequestAverageNetworkIn",
"EC2SpotFleetRequestAverageNetworkOut"
]
},
"ScalingPlan":{
"type":"structure",
"required":[
"ScalingPlanName",
"ScalingPlanVersion",
"ApplicationSource",
"ScalingInstructions",
"StatusCode"
],
"members":{
"ScalingPlanName":{"shape":"ScalingPlanName"},
"ScalingPlanVersion":{"shape":"ScalingPlanVersion"},
"ApplicationSource":{"shape":"ApplicationSource"},
"ScalingInstructions":{"shape":"ScalingInstructions"},
"StatusCode":{"shape":"ScalingPlanStatusCode"},
"StatusMessage":{"shape":"XmlString"},
"StatusStartTime":{"shape":"TimestampType"},
"CreationTime":{"shape":"TimestampType"}
}
},
"ScalingPlanName":{
"type":"string",
"max":128,
"min":1,
"pattern":"[\\p{Print}&&[^|:/]]+"
},
"ScalingPlanNames":{
"type":"list",
"member":{"shape":"ScalingPlanName"}
},
"ScalingPlanResource":{
"type":"structure",
"required":[
"ScalingPlanName",
"ScalingPlanVersion",
"ServiceNamespace",
"ResourceId",
"ScalableDimension",
"ScalingStatusCode"
],
"members":{
"ScalingPlanName":{"shape":"ScalingPlanName"},
"ScalingPlanVersion":{"shape":"ScalingPlanVersion"},
"ServiceNamespace":{"shape":"ServiceNamespace"},
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
"ScalableDimension":{"shape":"ScalableDimension"},
"ScalingPolicies":{"shape":"ScalingPolicies"},
"ScalingStatusCode":{"shape":"ScalingStatusCode"},
"ScalingStatusMessage":{"shape":"XmlString"}
}
},
"ScalingPlanResources":{
"type":"list",
"member":{"shape":"ScalingPlanResource"}
},
"ScalingPlanStatusCode":{
"type":"string",
"enum":[
"Active",
"ActiveWithProblems",
"CreationInProgress",
"CreationFailed",
"DeletionInProgress",
"DeletionFailed",
"UpdateInProgress",
"UpdateFailed"
]
},
"ScalingPlanVersion":{"type":"long"},
"ScalingPlans":{
"type":"list",
"member":{"shape":"ScalingPlan"}
},
"ScalingPolicies":{
"type":"list",
"member":{"shape":"ScalingPolicy"}
},
"ScalingPolicy":{
"type":"structure",
"required":[
"PolicyName",
"PolicyType"
],
"members":{
"PolicyName":{"shape":"PolicyName"},
"PolicyType":{"shape":"PolicyType"},
"TargetTrackingConfiguration":{"shape":"TargetTrackingConfiguration"}
}
},
"ScalingStatusCode":{
"type":"string",
"enum":[
"Inactive",
"PartiallyActive",
"Active"
]
},
"ServiceNamespace":{
"type":"string",
"enum":[
"autoscaling",
"ecs",
"ec2",
"rds",
"dynamodb"
]
},
"TagFilter":{
"type":"structure",
"members":{
"Key":{"shape":"XmlStringMaxLen128"},
"Values":{"shape":"TagValues"}
}
},
"TagFilters":{
"type":"list",
"member":{"shape":"TagFilter"}
},
"TagValues":{
"type":"list",
"member":{"shape":"XmlStringMaxLen256"}
},
"TargetTrackingConfiguration":{
"type":"structure",
"required":["TargetValue"],
"members":{
"PredefinedScalingMetricSpecification":{"shape":"PredefinedScalingMetricSpecification"},
"CustomizedScalingMetricSpecification":{"shape":"CustomizedScalingMetricSpecification"},
"TargetValue":{"shape":"MetricScale"},
"DisableScaleIn":{"shape":"DisableScaleIn"},
"ScaleOutCooldown":{"shape":"Cooldown"},
"ScaleInCooldown":{"shape":"Cooldown"},
"EstimatedInstanceWarmup":{"shape":"Cooldown"}
}
},
"TargetTrackingConfigurations":{
"type":"list",
"member":{"shape":"TargetTrackingConfiguration"}
},
"TimestampType":{"type":"timestamp"},
"UpdateScalingPlanRequest":{
"type":"structure",
"required":[
"ScalingPlanName",
"ScalingPlanVersion"
],
"members":{
"ApplicationSource":{"shape":"ApplicationSource"},
"ScalingPlanName":{"shape":"ScalingPlanName"},
"ScalingInstructions":{"shape":"ScalingInstructions"},
"ScalingPlanVersion":{"shape":"ScalingPlanVersion"}
}
},
"UpdateScalingPlanResponse":{
"type":"structure",
"members":{
}
},
"ValidationException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"XmlString":{
"type":"string",
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
},
"XmlStringMaxLen128":{
"type":"string",
"max":128,
"min":1,
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
},
"XmlStringMaxLen256":{
"type":"string",
"max":256,
"min":1,
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
}
}
}

417
vendor/github.com/aws/aws-sdk-go/models/apis/autoscaling-plans/2018-01-06/docs-2.json generated vendored Normal file
View File

@@ -0,0 +1,417 @@
{
"version": "2.0",
"service": "<fullname>AWS Auto Scaling</fullname> <p>Use AWS Auto Scaling to quickly discover all the scalable AWS resources for your application and configure dynamic scaling for your scalable resources.</p> <p>To get started, create a scaling plan with a set of instructions used to configure dynamic scaling for the scalable resources in your application. AWS Auto Scaling creates target tracking scaling policies for the scalable resources in your scaling plan. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.</p>",
"operations": {
"CreateScalingPlan": "<p>Creates a scaling plan.</p> <p>A scaling plan contains a set of instructions used to configure dynamic scaling for the scalable resources in your application. AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions in your scaling plan.</p>",
"DeleteScalingPlan": "<p>Deletes the specified scaling plan.</p>",
"DescribeScalingPlanResources": "<p>Describes the scalable resources in the specified scaling plan.</p>",
"DescribeScalingPlans": "<p>Describes the specified scaling plans or all of your scaling plans.</p>",
"UpdateScalingPlan": "<p>Updates the scaling plan for the specified scaling plan.</p> <p>You cannot update a scaling plan if it is in the process of being created, updated, or deleted.</p>"
},
"shapes": {
"ApplicationSource": {
"base": "<p>Represents an application source.</p>",
"refs": {
"ApplicationSources$member": null,
"CreateScalingPlanRequest$ApplicationSource": "<p>A CloudFormation stack or set of tags. You can create one scaling plan per application source.</p>",
"ScalingPlan$ApplicationSource": "<p>The application source.</p>",
"UpdateScalingPlanRequest$ApplicationSource": "<p>A CloudFormation stack or set of tags.</p>"
}
},
"ApplicationSources": {
"base": null,
"refs": {
"DescribeScalingPlansRequest$ApplicationSources": "<p>The sources for the applications (up to 10). If you specify scaling plan names, you cannot specify application sources.</p>"
}
},
"ConcurrentUpdateException": {
"base": "<p>Concurrent updates caused an exception, for example, if you request an update to a scaling plan that already has a pending update.</p>",
"refs": {
}
},
"Cooldown": {
"base": null,
"refs": {
"TargetTrackingConfiguration$ScaleOutCooldown": "<p>The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. This value is not used if the scalable resource is an Auto Scaling group.</p> <p>While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.</p>",
"TargetTrackingConfiguration$ScaleInCooldown": "<p>The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group.</p> <p>The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, AWS Auto Scaling scales out your scalable target immediately.</p>",
"TargetTrackingConfiguration$EstimatedInstanceWarmup": "<p>The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.</p>"
}
},
"CreateScalingPlanRequest": {
"base": null,
"refs": {
}
},
"CreateScalingPlanResponse": {
"base": null,
"refs": {
}
},
"CustomizedScalingMetricSpecification": {
"base": "<p>Represents a customized metric for a target tracking policy.</p>",
"refs": {
"TargetTrackingConfiguration$CustomizedScalingMetricSpecification": "<p>A customized metric.</p>"
}
},
"DeleteScalingPlanRequest": {
"base": null,
"refs": {
}
},
"DeleteScalingPlanResponse": {
"base": null,
"refs": {
}
},
"DescribeScalingPlanResourcesRequest": {
"base": null,
"refs": {
}
},
"DescribeScalingPlanResourcesResponse": {
"base": null,
"refs": {
}
},
"DescribeScalingPlansRequest": {
"base": null,
"refs": {
}
},
"DescribeScalingPlansResponse": {
"base": null,
"refs": {
}
},
"DisableScaleIn": {
"base": null,
"refs": {
"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 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": {
"ConcurrentUpdateException$Message": null,
"InternalServiceException$Message": null,
"InvalidNextTokenException$Message": null,
"LimitExceededException$Message": null,
"ObjectNotFoundException$Message": null,
"ValidationException$Message": null
}
},
"InternalServiceException": {
"base": "<p>The service encountered an internal error.</p>",
"refs": {
}
},
"InvalidNextTokenException": {
"base": "<p>The token provided is not valid.</p>",
"refs": {
}
},
"LimitExceededException": {
"base": "<p>Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded.</p>",
"refs": {
}
},
"MaxResults": {
"base": null,
"refs": {
"DescribeScalingPlanResourcesRequest$MaxResults": "<p>The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.</p>",
"DescribeScalingPlansRequest$MaxResults": "<p>The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.</p>"
}
},
"MetricDimension": {
"base": "<p>Represents a dimension for a customized metric.</p>",
"refs": {
"MetricDimensions$member": null
}
},
"MetricDimensionName": {
"base": null,
"refs": {
"MetricDimension$Name": "<p>The name of the dimension.</p>"
}
},
"MetricDimensionValue": {
"base": null,
"refs": {
"MetricDimension$Value": "<p>The value of the dimension.</p>"
}
},
"MetricDimensions": {
"base": null,
"refs": {
"CustomizedScalingMetricSpecification$Dimensions": "<p>The dimensions of the metric.</p>"
}
},
"MetricName": {
"base": null,
"refs": {
"CustomizedScalingMetricSpecification$MetricName": "<p>The name of the metric.</p>"
}
},
"MetricNamespace": {
"base": null,
"refs": {
"CustomizedScalingMetricSpecification$Namespace": "<p>The namespace of the metric.</p>"
}
},
"MetricScale": {
"base": null,
"refs": {
"TargetTrackingConfiguration$TargetValue": "<p>The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).</p>"
}
},
"MetricStatistic": {
"base": null,
"refs": {
"CustomizedScalingMetricSpecification$Statistic": "<p>The statistic of the metric.</p>"
}
},
"MetricUnit": {
"base": null,
"refs": {
"CustomizedScalingMetricSpecification$Unit": "<p>The unit of the metric.</p>"
}
},
"NextToken": {
"base": null,
"refs": {
"DescribeScalingPlanResourcesRequest$NextToken": "<p>The token for the next set of results.</p>",
"DescribeScalingPlanResourcesResponse$NextToken": "<p>The token required to get the next set of results. This value is <code>null</code> if there are no more results to return.</p>",
"DescribeScalingPlansRequest$NextToken": "<p>The token for the next set of results.</p>",
"DescribeScalingPlansResponse$NextToken": "<p>The token required to get the next set of results. This value is <code>null</code> if there are no more results to return.</p>"
}
},
"ObjectNotFoundException": {
"base": "<p>The specified object could not be found.</p>",
"refs": {
}
},
"PolicyName": {
"base": null,
"refs": {
"ScalingPolicy$PolicyName": "<p>The name of the scaling policy.</p>"
}
},
"PolicyType": {
"base": null,
"refs": {
"ScalingPolicy$PolicyType": "<p>The type of scaling policy.</p>"
}
},
"PredefinedScalingMetricSpecification": {
"base": "<p>Represents a predefined metric for a target tracking policy.</p>",
"refs": {
"TargetTrackingConfiguration$PredefinedScalingMetricSpecification": "<p>A predefined metric.</p>"
}
},
"ResourceCapacity": {
"base": null,
"refs": {
"ScalingInstruction$MinCapacity": "<p>The minimum value to scale to in response to a scale in event.</p>",
"ScalingInstruction$MaxCapacity": "<p>The maximum value to scale to in response to a scale out event.</p>"
}
},
"ResourceIdMaxLen1600": {
"base": null,
"refs": {
"ScalingInstruction$ResourceId": "<p>The ID of the resource. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>Auto Scaling group - The resource type is <code>autoScalingGroup</code> and the unique identifier is the name of the Auto Scaling group. Example: <code>autoScalingGroup/my-asg</code>.</p> </li> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>",
"ScalingPlanResource$ResourceId": "<p>The ID of the resource. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>Auto Scaling group - The resource type is <code>autoScalingGroup</code> and the unique identifier is the name of the Auto Scaling group. Example: <code>autoScalingGroup/my-asg</code>.</p> </li> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>"
}
},
"ResourceLabel": {
"base": null,
"refs": {
"PredefinedScalingMetricSpecification$ResourceLabel": "<p>Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is <code>ALBRequestCountPerTarget</code> and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.</p> <p>The format is app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt;/targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt;, where:</p> <ul> <li> <p>app/&lt;load-balancer-name&gt;/&lt;load-balancer-id&gt; is the final portion of the load balancer ARN</p> </li> <li> <p>targetgroup/&lt;target-group-name&gt;/&lt;target-group-id&gt; is the final portion of the target group ARN.</p> </li> </ul>"
}
},
"ScalableDimension": {
"base": null,
"refs": {
"ScalingInstruction$ScalableDimension": "<p>The scalable dimension associated with the resource.</p> <ul> <li> <p> <code>autoscaling:autoScalingGroup:DesiredCapacity</code> - The desired capacity of an Auto Scaling group.</p> </li> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>",
"ScalingPlanResource$ScalableDimension": "<p>The scalable dimension for the resource.</p> <ul> <li> <p> <code>autoscaling:autoScalingGroup:DesiredCapacity</code> - The desired capacity of an Auto Scaling group.</p> </li> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>"
}
},
"ScalingInstruction": {
"base": "<p>Specifies the scaling configuration for a scalable resource.</p>",
"refs": {
"ScalingInstructions$member": null
}
},
"ScalingInstructions": {
"base": null,
"refs": {
"CreateScalingPlanRequest$ScalingInstructions": "<p>The scaling instructions.</p>",
"ScalingPlan$ScalingInstructions": "<p>The scaling instructions.</p>",
"UpdateScalingPlanRequest$ScalingInstructions": "<p>The scaling instructions.</p>"
}
},
"ScalingMetricType": {
"base": null,
"refs": {
"PredefinedScalingMetricSpecification$PredefinedScalingMetricType": "<p>The metric type. The <code>ALBRequestCountPerTarget</code> metric type applies only to Auto Scaling groups, Sport Fleet requests, and ECS services.</p>"
}
},
"ScalingPlan": {
"base": "<p>Represents a scaling plan.</p>",
"refs": {
"ScalingPlans$member": null
}
},
"ScalingPlanName": {
"base": null,
"refs": {
"CreateScalingPlanRequest$ScalingPlanName": "<p>The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.</p>",
"DeleteScalingPlanRequest$ScalingPlanName": "<p>The name of the scaling plan.</p>",
"DescribeScalingPlanResourcesRequest$ScalingPlanName": "<p>The name of the scaling plan.</p>",
"ScalingPlan$ScalingPlanName": "<p>The name of the scaling plan.</p>",
"ScalingPlanNames$member": null,
"ScalingPlanResource$ScalingPlanName": "<p>The name of the scaling plan.</p>",
"UpdateScalingPlanRequest$ScalingPlanName": "<p>The name of the scaling plan.</p>"
}
},
"ScalingPlanNames": {
"base": null,
"refs": {
"DescribeScalingPlansRequest$ScalingPlanNames": "<p>The names of the scaling plans (up to 10). If you specify application sources, you cannot specify scaling plan names.</p>"
}
},
"ScalingPlanResource": {
"base": "<p>Represents a scalable resource.</p>",
"refs": {
"ScalingPlanResources$member": null
}
},
"ScalingPlanResources": {
"base": null,
"refs": {
"DescribeScalingPlanResourcesResponse$ScalingPlanResources": "<p>Information about the scalable resources.</p>"
}
},
"ScalingPlanStatusCode": {
"base": null,
"refs": {
"ScalingPlan$StatusCode": "<p>The status of the scaling plan.</p> <ul> <li> <p> <code>Active</code> - The scaling plan is active.</p> </li> <li> <p> <code>ActiveWithProblems</code> - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.</p> </li> <li> <p> <code>CreationInProgress</code> - The scaling plan is being created.</p> </li> <li> <p> <code>CreationFailed</code> - The scaling plan could not be created.</p> </li> <li> <p> <code>DeletionInProgress</code> - The scaling plan is being deleted.</p> </li> <li> <p> <code>DeletionFailed</code> - The scaling plan could not be deleted.</p> </li> </ul>"
}
},
"ScalingPlanVersion": {
"base": null,
"refs": {
"CreateScalingPlanResponse$ScalingPlanVersion": "<p>The version of the scaling plan. This value is always 1.</p>",
"DeleteScalingPlanRequest$ScalingPlanVersion": "<p>The version of the scaling plan.</p>",
"DescribeScalingPlanResourcesRequest$ScalingPlanVersion": "<p>The version of the scaling plan.</p>",
"DescribeScalingPlansRequest$ScalingPlanVersion": "<p>The version of the scaling plan. If you specify a scaling plan version, you must also specify a scaling plan name.</p>",
"ScalingPlan$ScalingPlanVersion": "<p>The version of the scaling plan.</p>",
"ScalingPlanResource$ScalingPlanVersion": "<p>The version of the scaling plan.</p>",
"UpdateScalingPlanRequest$ScalingPlanVersion": "<p>The version number.</p>"
}
},
"ScalingPlans": {
"base": null,
"refs": {
"DescribeScalingPlansResponse$ScalingPlans": "<p>Information about the scaling plans.</p>"
}
},
"ScalingPolicies": {
"base": null,
"refs": {
"ScalingPlanResource$ScalingPolicies": "<p>The scaling policies.</p>"
}
},
"ScalingPolicy": {
"base": "<p>Represents a scaling policy.</p>",
"refs": {
"ScalingPolicies$member": null
}
},
"ScalingStatusCode": {
"base": null,
"refs": {
"ScalingPlanResource$ScalingStatusCode": "<p>The scaling status of the resource.</p> <ul> <li> <p> <code>Active</code> - The scaling configuration is active.</p> </li> <li> <p> <code>Inactive</code> - The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information.</p> </li> <li> <p> <code>PartiallyActive</code> - The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information.</p> </li> </ul>"
}
},
"ServiceNamespace": {
"base": null,
"refs": {
"ScalingInstruction$ServiceNamespace": "<p>The namespace of the AWS service.</p>",
"ScalingPlanResource$ServiceNamespace": "<p>The namespace of the AWS service.</p>"
}
},
"TagFilter": {
"base": "<p>Represents a tag.</p>",
"refs": {
"TagFilters$member": null
}
},
"TagFilters": {
"base": null,
"refs": {
"ApplicationSource$TagFilters": "<p>A set of tags (up to 50).</p>"
}
},
"TagValues": {
"base": null,
"refs": {
"TagFilter$Values": "<p>The tag values (0 to 20).</p>"
}
},
"TargetTrackingConfiguration": {
"base": "<p>Represents a target tracking scaling policy.</p>",
"refs": {
"ScalingPolicy$TargetTrackingConfiguration": "<p>The target tracking scaling policy.</p>",
"TargetTrackingConfigurations$member": null
}
},
"TargetTrackingConfigurations": {
"base": null,
"refs": {
"ScalingInstruction$TargetTrackingConfigurations": "<p>The target tracking scaling policies (up to 10).</p>"
}
},
"TimestampType": {
"base": null,
"refs": {
"ScalingPlan$StatusStartTime": "<p>The Unix timestamp when the scaling plan entered the current status.</p>",
"ScalingPlan$CreationTime": "<p>The Unix timestamp when the scaling plan was created.</p>"
}
},
"UpdateScalingPlanRequest": {
"base": null,
"refs": {
}
},
"UpdateScalingPlanResponse": {
"base": null,
"refs": {
}
},
"ValidationException": {
"base": "<p>An exception was thrown for a validation issue. Review the parameters provided.</p>",
"refs": {
}
},
"XmlString": {
"base": null,
"refs": {
"ApplicationSource$CloudFormationStackARN": "<p>The Amazon Resource Name (ARN) of a CloudFormation stack.</p>",
"ScalingPlan$StatusMessage": "<p>A simple message about the current status of the scaling plan.</p>",
"ScalingPlanResource$ScalingStatusMessage": "<p>A simple message about the current scaling status of the resource.</p>"
}
},
"XmlStringMaxLen128": {
"base": null,
"refs": {
"TagFilter$Key": "<p>The tag key.</p>"
}
},
"XmlStringMaxLen256": {
"base": null,
"refs": {
"TagValues$member": null
}
}
}
}

5
vendor/github.com/aws/aws-sdk-go/models/apis/autoscaling-plans/2018-01-06/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/autoscaling-plans/2018-01-06/paginators-1.json generated vendored Normal file
View File

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

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

1396
vendor/github.com/aws/aws-sdk-go/models/apis/autoscaling/2011-01-01/examples-1.json generated vendored Normal file
View File

File diff suppressed because it is too large Load Diff

52
vendor/github.com/aws/aws-sdk-go/models/apis/autoscaling/2011-01-01/paginators-1.json generated vendored Normal file
View File

@@ -0,0 +1,52 @@
{
"pagination": {
"DescribeAutoScalingGroups": {
"input_token": "NextToken",
"limit_key": "MaxRecords",
"output_token": "NextToken",
"result_key": "AutoScalingGroups"
},
"DescribeAutoScalingInstances": {
"input_token": "NextToken",
"limit_key": "MaxRecords",
"output_token": "NextToken",
"result_key": "AutoScalingInstances"
},
"DescribeLaunchConfigurations": {
"input_token": "NextToken",
"limit_key": "MaxRecords",
"output_token": "NextToken",
"result_key": "LaunchConfigurations"
},
"DescribeNotificationConfigurations": {
"input_token": "NextToken",
"limit_key": "MaxRecords",
"output_token": "NextToken",
"result_key": "NotificationConfigurations"
},
"DescribePolicies": {
"input_token": "NextToken",
"limit_key": "MaxRecords",
"output_token": "NextToken",
"result_key": "ScalingPolicies"
},
"DescribeScalingActivities": {
"input_token": "NextToken",
"limit_key": "MaxRecords",
"output_token": "NextToken",
"result_key": "Activities"
},
"DescribeScheduledActions": {
"input_token": "NextToken",
"limit_key": "MaxRecords",
"output_token": "NextToken",
"result_key": "ScheduledUpdateGroupActions"
},
"DescribeTags": {
"input_token": "NextToken",
"limit_key": "MaxRecords",
"output_token": "NextToken",
"result_key": "Tags"
}
}
}

62
vendor/github.com/aws/aws-sdk-go/models/apis/autoscaling/2011-01-01/waiters-2.json generated vendored Normal file
View File

@@ -0,0 +1,62 @@
{
"version": 2,
"waiters": {
"GroupExists": {
"acceptors": [
{
"argument": "length(AutoScalingGroups) > `0`",
"expected": true,
"matcher": "path",
"state": "success"
},
{
"argument": "length(AutoScalingGroups) > `0`",
"expected": false,
"matcher": "path",
"state": "retry"
}
],
"delay": 5,
"maxAttempts": 10,
"operation": "DescribeAutoScalingGroups"
},
"GroupInService": {
"acceptors": [
{
"argument": "contains(AutoScalingGroups[].[length(Instances[?LifecycleState=='InService']) >= MinSize][], `false`)",
"expected": false,
"matcher": "path",
"state": "success"
},
{
"argument": "contains(AutoScalingGroups[].[length(Instances[?LifecycleState=='InService']) >= MinSize][], `false`)",
"expected": true,
"matcher": "path",
"state": "retry"
}
],
"delay": 15,
"maxAttempts": 40,
"operation": "DescribeAutoScalingGroups"
},
"GroupNotExists": {
"acceptors": [
{
"argument": "length(AutoScalingGroups) > `0`",
"expected": false,
"matcher": "path",
"state": "success"
},
{
"argument": "length(AutoScalingGroups) > `0`",
"expected": true,
"matcher": "path",
"state": "retry"
}
],
"delay": 15,
"maxAttempts": 40,
"operation": "DescribeAutoScalingGroups"
}
}
}

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

@@ -0,0 +1,983 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2016-08-10",
"endpointPrefix":"batch",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceAbbreviation":"AWS Batch",
"serviceFullName":"AWS Batch",
"serviceId":"Batch",
"signatureVersion":"v4",
"uid":"batch-2016-08-10"
},
"operations":{
"CancelJob":{
"name":"CancelJob",
"http":{
"method":"POST",
"requestUri":"/v1/canceljob"
},
"input":{"shape":"CancelJobRequest"},
"output":{"shape":"CancelJobResponse"},
"errors":[
{"shape":"ClientException"},
{"shape":"ServerException"}
]
},
"CreateComputeEnvironment":{
"name":"CreateComputeEnvironment",
"http":{
"method":"POST",
"requestUri":"/v1/createcomputeenvironment"
},
"input":{"shape":"CreateComputeEnvironmentRequest"},
"output":{"shape":"CreateComputeEnvironmentResponse"},
"errors":[
{"shape":"ClientException"},
{"shape":"ServerException"}
]
},
"CreateJobQueue":{
"name":"CreateJobQueue",
"http":{
"method":"POST",
"requestUri":"/v1/createjobqueue"
},
"input":{"shape":"CreateJobQueueRequest"},
"output":{"shape":"CreateJobQueueResponse"},
"errors":[
{"shape":"ClientException"},
{"shape":"ServerException"}
]
},
"DeleteComputeEnvironment":{
"name":"DeleteComputeEnvironment",
"http":{
"method":"POST",
"requestUri":"/v1/deletecomputeenvironment"
},
"input":{"shape":"DeleteComputeEnvironmentRequest"},
"output":{"shape":"DeleteComputeEnvironmentResponse"},
"errors":[
{"shape":"ClientException"},
{"shape":"ServerException"}
]
},
"DeleteJobQueue":{
"name":"DeleteJobQueue",
"http":{
"method":"POST",
"requestUri":"/v1/deletejobqueue"
},
"input":{"shape":"DeleteJobQueueRequest"},
"output":{"shape":"DeleteJobQueueResponse"},
"errors":[
{"shape":"ClientException"},
{"shape":"ServerException"}
]
},
"DeregisterJobDefinition":{
"name":"DeregisterJobDefinition",
"http":{
"method":"POST",
"requestUri":"/v1/deregisterjobdefinition"
},
"input":{"shape":"DeregisterJobDefinitionRequest"},
"output":{"shape":"DeregisterJobDefinitionResponse"},
"errors":[
{"shape":"ClientException"},
{"shape":"ServerException"}
]
},
"DescribeComputeEnvironments":{
"name":"DescribeComputeEnvironments",
"http":{
"method":"POST",
"requestUri":"/v1/describecomputeenvironments"
},
"input":{"shape":"DescribeComputeEnvironmentsRequest"},
"output":{"shape":"DescribeComputeEnvironmentsResponse"},
"errors":[
{"shape":"ClientException"},
{"shape":"ServerException"}
]
},
"DescribeJobDefinitions":{
"name":"DescribeJobDefinitions",
"http":{
"method":"POST",
"requestUri":"/v1/describejobdefinitions"
},
"input":{"shape":"DescribeJobDefinitionsRequest"},
"output":{"shape":"DescribeJobDefinitionsResponse"},
"errors":[
{"shape":"ClientException"},
{"shape":"ServerException"}
]
},
"DescribeJobQueues":{
"name":"DescribeJobQueues",
"http":{
"method":"POST",
"requestUri":"/v1/describejobqueues"
},
"input":{"shape":"DescribeJobQueuesRequest"},
"output":{"shape":"DescribeJobQueuesResponse"},
"errors":[
{"shape":"ClientException"},
{"shape":"ServerException"}
]
},
"DescribeJobs":{
"name":"DescribeJobs",
"http":{
"method":"POST",
"requestUri":"/v1/describejobs"
},
"input":{"shape":"DescribeJobsRequest"},
"output":{"shape":"DescribeJobsResponse"},
"errors":[
{"shape":"ClientException"},
{"shape":"ServerException"}
]
},
"ListJobs":{
"name":"ListJobs",
"http":{
"method":"POST",
"requestUri":"/v1/listjobs"
},
"input":{"shape":"ListJobsRequest"},
"output":{"shape":"ListJobsResponse"},
"errors":[
{"shape":"ClientException"},
{"shape":"ServerException"}
]
},
"RegisterJobDefinition":{
"name":"RegisterJobDefinition",
"http":{
"method":"POST",
"requestUri":"/v1/registerjobdefinition"
},
"input":{"shape":"RegisterJobDefinitionRequest"},
"output":{"shape":"RegisterJobDefinitionResponse"},
"errors":[
{"shape":"ClientException"},
{"shape":"ServerException"}
]
},
"SubmitJob":{
"name":"SubmitJob",
"http":{
"method":"POST",
"requestUri":"/v1/submitjob"
},
"input":{"shape":"SubmitJobRequest"},
"output":{"shape":"SubmitJobResponse"},
"errors":[
{"shape":"ClientException"},
{"shape":"ServerException"}
]
},
"TerminateJob":{
"name":"TerminateJob",
"http":{
"method":"POST",
"requestUri":"/v1/terminatejob"
},
"input":{"shape":"TerminateJobRequest"},
"output":{"shape":"TerminateJobResponse"},
"errors":[
{"shape":"ClientException"},
{"shape":"ServerException"}
]
},
"UpdateComputeEnvironment":{
"name":"UpdateComputeEnvironment",
"http":{
"method":"POST",
"requestUri":"/v1/updatecomputeenvironment"
},
"input":{"shape":"UpdateComputeEnvironmentRequest"},
"output":{"shape":"UpdateComputeEnvironmentResponse"},
"errors":[
{"shape":"ClientException"},
{"shape":"ServerException"}
]
},
"UpdateJobQueue":{
"name":"UpdateJobQueue",
"http":{
"method":"POST",
"requestUri":"/v1/updatejobqueue"
},
"input":{"shape":"UpdateJobQueueRequest"},
"output":{"shape":"UpdateJobQueueResponse"},
"errors":[
{"shape":"ClientException"},
{"shape":"ServerException"}
]
}
},
"shapes":{
"ArrayJobDependency":{
"type":"string",
"enum":[
"N_TO_N",
"SEQUENTIAL"
]
},
"ArrayJobStatusSummary":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"Integer"}
},
"ArrayProperties":{
"type":"structure",
"members":{
"size":{"shape":"Integer"}
}
},
"ArrayPropertiesDetail":{
"type":"structure",
"members":{
"statusSummary":{"shape":"ArrayJobStatusSummary"},
"size":{"shape":"Integer"},
"index":{"shape":"Integer"}
}
},
"ArrayPropertiesSummary":{
"type":"structure",
"members":{
"size":{"shape":"Integer"},
"index":{"shape":"Integer"}
}
},
"AttemptContainerDetail":{
"type":"structure",
"members":{
"containerInstanceArn":{"shape":"String"},
"taskArn":{"shape":"String"},
"exitCode":{"shape":"Integer"},
"reason":{"shape":"String"},
"logStreamName":{"shape":"String"}
}
},
"AttemptDetail":{
"type":"structure",
"members":{
"container":{"shape":"AttemptContainerDetail"},
"startedAt":{"shape":"Long"},
"stoppedAt":{"shape":"Long"},
"statusReason":{"shape":"String"}
}
},
"AttemptDetails":{
"type":"list",
"member":{"shape":"AttemptDetail"}
},
"Boolean":{"type":"boolean"},
"CEState":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"CEStatus":{
"type":"string",
"enum":[
"CREATING",
"UPDATING",
"DELETING",
"DELETED",
"VALID",
"INVALID"
]
},
"CEType":{
"type":"string",
"enum":[
"MANAGED",
"UNMANAGED"
]
},
"CRType":{
"type":"string",
"enum":[
"EC2",
"SPOT"
]
},
"CancelJobRequest":{
"type":"structure",
"required":[
"jobId",
"reason"
],
"members":{
"jobId":{"shape":"String"},
"reason":{"shape":"String"}
}
},
"CancelJobResponse":{
"type":"structure",
"members":{
}
},
"ClientException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"error":{"httpStatusCode":400},
"exception":true
},
"ComputeEnvironmentDetail":{
"type":"structure",
"required":[
"computeEnvironmentName",
"computeEnvironmentArn",
"ecsClusterArn"
],
"members":{
"computeEnvironmentName":{"shape":"String"},
"computeEnvironmentArn":{"shape":"String"},
"ecsClusterArn":{"shape":"String"},
"type":{"shape":"CEType"},
"state":{"shape":"CEState"},
"status":{"shape":"CEStatus"},
"statusReason":{"shape":"String"},
"computeResources":{"shape":"ComputeResource"},
"serviceRole":{"shape":"String"}
}
},
"ComputeEnvironmentDetailList":{
"type":"list",
"member":{"shape":"ComputeEnvironmentDetail"}
},
"ComputeEnvironmentOrder":{
"type":"structure",
"required":[
"order",
"computeEnvironment"
],
"members":{
"order":{"shape":"Integer"},
"computeEnvironment":{"shape":"String"}
}
},
"ComputeEnvironmentOrders":{
"type":"list",
"member":{"shape":"ComputeEnvironmentOrder"}
},
"ComputeResource":{
"type":"structure",
"required":[
"type",
"minvCpus",
"maxvCpus",
"instanceTypes",
"subnets",
"securityGroupIds",
"instanceRole"
],
"members":{
"type":{"shape":"CRType"},
"minvCpus":{"shape":"Integer"},
"maxvCpus":{"shape":"Integer"},
"desiredvCpus":{"shape":"Integer"},
"instanceTypes":{"shape":"StringList"},
"imageId":{"shape":"String"},
"subnets":{"shape":"StringList"},
"securityGroupIds":{"shape":"StringList"},
"ec2KeyPair":{"shape":"String"},
"instanceRole":{"shape":"String"},
"tags":{"shape":"TagsMap"},
"bidPercentage":{"shape":"Integer"},
"spotIamFleetRole":{"shape":"String"}
}
},
"ComputeResourceUpdate":{
"type":"structure",
"members":{
"minvCpus":{"shape":"Integer"},
"maxvCpus":{"shape":"Integer"},
"desiredvCpus":{"shape":"Integer"}
}
},
"ContainerDetail":{
"type":"structure",
"members":{
"image":{"shape":"String"},
"vcpus":{"shape":"Integer"},
"memory":{"shape":"Integer"},
"command":{"shape":"StringList"},
"jobRoleArn":{"shape":"String"},
"volumes":{"shape":"Volumes"},
"environment":{"shape":"EnvironmentVariables"},
"mountPoints":{"shape":"MountPoints"},
"readonlyRootFilesystem":{"shape":"Boolean"},
"ulimits":{"shape":"Ulimits"},
"privileged":{"shape":"Boolean"},
"user":{"shape":"String"},
"exitCode":{"shape":"Integer"},
"reason":{"shape":"String"},
"containerInstanceArn":{"shape":"String"},
"taskArn":{"shape":"String"},
"logStreamName":{"shape":"String"}
}
},
"ContainerOverrides":{
"type":"structure",
"members":{
"vcpus":{"shape":"Integer"},
"memory":{"shape":"Integer"},
"command":{"shape":"StringList"},
"environment":{"shape":"EnvironmentVariables"}
}
},
"ContainerProperties":{
"type":"structure",
"required":[
"image",
"vcpus",
"memory"
],
"members":{
"image":{"shape":"String"},
"vcpus":{"shape":"Integer"},
"memory":{"shape":"Integer"},
"command":{"shape":"StringList"},
"jobRoleArn":{"shape":"String"},
"volumes":{"shape":"Volumes"},
"environment":{"shape":"EnvironmentVariables"},
"mountPoints":{"shape":"MountPoints"},
"readonlyRootFilesystem":{"shape":"Boolean"},
"privileged":{"shape":"Boolean"},
"ulimits":{"shape":"Ulimits"},
"user":{"shape":"String"}
}
},
"ContainerSummary":{
"type":"structure",
"members":{
"exitCode":{"shape":"Integer"},
"reason":{"shape":"String"}
}
},
"CreateComputeEnvironmentRequest":{
"type":"structure",
"required":[
"computeEnvironmentName",
"type",
"serviceRole"
],
"members":{
"computeEnvironmentName":{"shape":"String"},
"type":{"shape":"CEType"},
"state":{"shape":"CEState"},
"computeResources":{"shape":"ComputeResource"},
"serviceRole":{"shape":"String"}
}
},
"CreateComputeEnvironmentResponse":{
"type":"structure",
"members":{
"computeEnvironmentName":{"shape":"String"},
"computeEnvironmentArn":{"shape":"String"}
}
},
"CreateJobQueueRequest":{
"type":"structure",
"required":[
"jobQueueName",
"priority",
"computeEnvironmentOrder"
],
"members":{
"jobQueueName":{"shape":"String"},
"state":{"shape":"JQState"},
"priority":{"shape":"Integer"},
"computeEnvironmentOrder":{"shape":"ComputeEnvironmentOrders"}
}
},
"CreateJobQueueResponse":{
"type":"structure",
"required":[
"jobQueueName",
"jobQueueArn"
],
"members":{
"jobQueueName":{"shape":"String"},
"jobQueueArn":{"shape":"String"}
}
},
"DeleteComputeEnvironmentRequest":{
"type":"structure",
"required":["computeEnvironment"],
"members":{
"computeEnvironment":{"shape":"String"}
}
},
"DeleteComputeEnvironmentResponse":{
"type":"structure",
"members":{
}
},
"DeleteJobQueueRequest":{
"type":"structure",
"required":["jobQueue"],
"members":{
"jobQueue":{"shape":"String"}
}
},
"DeleteJobQueueResponse":{
"type":"structure",
"members":{
}
},
"DeregisterJobDefinitionRequest":{
"type":"structure",
"required":["jobDefinition"],
"members":{
"jobDefinition":{"shape":"String"}
}
},
"DeregisterJobDefinitionResponse":{
"type":"structure",
"members":{
}
},
"DescribeComputeEnvironmentsRequest":{
"type":"structure",
"members":{
"computeEnvironments":{"shape":"StringList"},
"maxResults":{"shape":"Integer"},
"nextToken":{"shape":"String"}
}
},
"DescribeComputeEnvironmentsResponse":{
"type":"structure",
"members":{
"computeEnvironments":{"shape":"ComputeEnvironmentDetailList"},
"nextToken":{"shape":"String"}
}
},
"DescribeJobDefinitionsRequest":{
"type":"structure",
"members":{
"jobDefinitions":{"shape":"StringList"},
"maxResults":{"shape":"Integer"},
"jobDefinitionName":{"shape":"String"},
"status":{"shape":"String"},
"nextToken":{"shape":"String"}
}
},
"DescribeJobDefinitionsResponse":{
"type":"structure",
"members":{
"jobDefinitions":{"shape":"JobDefinitionList"},
"nextToken":{"shape":"String"}
}
},
"DescribeJobQueuesRequest":{
"type":"structure",
"members":{
"jobQueues":{"shape":"StringList"},
"maxResults":{"shape":"Integer"},
"nextToken":{"shape":"String"}
}
},
"DescribeJobQueuesResponse":{
"type":"structure",
"members":{
"jobQueues":{"shape":"JobQueueDetailList"},
"nextToken":{"shape":"String"}
}
},
"DescribeJobsRequest":{
"type":"structure",
"required":["jobs"],
"members":{
"jobs":{"shape":"StringList"}
}
},
"DescribeJobsResponse":{
"type":"structure",
"members":{
"jobs":{"shape":"JobDetailList"}
}
},
"EnvironmentVariables":{
"type":"list",
"member":{"shape":"KeyValuePair"}
},
"Host":{
"type":"structure",
"members":{
"sourcePath":{"shape":"String"}
}
},
"Integer":{"type":"integer"},
"JQState":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"JQStatus":{
"type":"string",
"enum":[
"CREATING",
"UPDATING",
"DELETING",
"DELETED",
"VALID",
"INVALID"
]
},
"JobDefinition":{
"type":"structure",
"required":[
"jobDefinitionName",
"jobDefinitionArn",
"revision",
"type"
],
"members":{
"jobDefinitionName":{"shape":"String"},
"jobDefinitionArn":{"shape":"String"},
"revision":{"shape":"Integer"},
"status":{"shape":"String"},
"type":{"shape":"String"},
"parameters":{"shape":"ParametersMap"},
"retryStrategy":{"shape":"RetryStrategy"},
"containerProperties":{"shape":"ContainerProperties"},
"timeout":{"shape":"JobTimeout"}
}
},
"JobDefinitionList":{
"type":"list",
"member":{"shape":"JobDefinition"}
},
"JobDefinitionType":{
"type":"string",
"enum":["container"]
},
"JobDependency":{
"type":"structure",
"members":{
"jobId":{"shape":"String"},
"type":{"shape":"ArrayJobDependency"}
}
},
"JobDependencyList":{
"type":"list",
"member":{"shape":"JobDependency"}
},
"JobDetail":{
"type":"structure",
"required":[
"jobName",
"jobId",
"jobQueue",
"status",
"startedAt",
"jobDefinition"
],
"members":{
"jobName":{"shape":"String"},
"jobId":{"shape":"String"},
"jobQueue":{"shape":"String"},
"status":{"shape":"JobStatus"},
"attempts":{"shape":"AttemptDetails"},
"statusReason":{"shape":"String"},
"createdAt":{"shape":"Long"},
"retryStrategy":{"shape":"RetryStrategy"},
"startedAt":{"shape":"Long"},
"stoppedAt":{"shape":"Long"},
"dependsOn":{"shape":"JobDependencyList"},
"jobDefinition":{"shape":"String"},
"parameters":{"shape":"ParametersMap"},
"container":{"shape":"ContainerDetail"},
"arrayProperties":{"shape":"ArrayPropertiesDetail"},
"timeout":{"shape":"JobTimeout"}
}
},
"JobDetailList":{
"type":"list",
"member":{"shape":"JobDetail"}
},
"JobQueueDetail":{
"type":"structure",
"required":[
"jobQueueName",
"jobQueueArn",
"state",
"priority",
"computeEnvironmentOrder"
],
"members":{
"jobQueueName":{"shape":"String"},
"jobQueueArn":{"shape":"String"},
"state":{"shape":"JQState"},
"status":{"shape":"JQStatus"},
"statusReason":{"shape":"String"},
"priority":{"shape":"Integer"},
"computeEnvironmentOrder":{"shape":"ComputeEnvironmentOrders"}
}
},
"JobQueueDetailList":{
"type":"list",
"member":{"shape":"JobQueueDetail"}
},
"JobStatus":{
"type":"string",
"enum":[
"SUBMITTED",
"PENDING",
"RUNNABLE",
"STARTING",
"RUNNING",
"SUCCEEDED",
"FAILED"
]
},
"JobSummary":{
"type":"structure",
"required":[
"jobId",
"jobName"
],
"members":{
"jobId":{"shape":"String"},
"jobName":{"shape":"String"},
"createdAt":{"shape":"Long"},
"status":{"shape":"JobStatus"},
"statusReason":{"shape":"String"},
"startedAt":{"shape":"Long"},
"stoppedAt":{"shape":"Long"},
"container":{"shape":"ContainerSummary"},
"arrayProperties":{"shape":"ArrayPropertiesSummary"}
}
},
"JobSummaryList":{
"type":"list",
"member":{"shape":"JobSummary"}
},
"JobTimeout":{
"type":"structure",
"members":{
"attemptDurationSeconds":{"shape":"Integer"}
}
},
"KeyValuePair":{
"type":"structure",
"members":{
"name":{"shape":"String"},
"value":{"shape":"String"}
}
},
"ListJobsRequest":{
"type":"structure",
"members":{
"jobQueue":{"shape":"String"},
"arrayJobId":{"shape":"String"},
"jobStatus":{"shape":"JobStatus"},
"maxResults":{"shape":"Integer"},
"nextToken":{"shape":"String"}
}
},
"ListJobsResponse":{
"type":"structure",
"required":["jobSummaryList"],
"members":{
"jobSummaryList":{"shape":"JobSummaryList"},
"nextToken":{"shape":"String"}
}
},
"Long":{"type":"long"},
"MountPoint":{
"type":"structure",
"members":{
"containerPath":{"shape":"String"},
"readOnly":{"shape":"Boolean"},
"sourceVolume":{"shape":"String"}
}
},
"MountPoints":{
"type":"list",
"member":{"shape":"MountPoint"}
},
"ParametersMap":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"String"}
},
"RegisterJobDefinitionRequest":{
"type":"structure",
"required":[
"jobDefinitionName",
"type"
],
"members":{
"jobDefinitionName":{"shape":"String"},
"type":{"shape":"JobDefinitionType"},
"parameters":{"shape":"ParametersMap"},
"containerProperties":{"shape":"ContainerProperties"},
"retryStrategy":{"shape":"RetryStrategy"},
"timeout":{"shape":"JobTimeout"}
}
},
"RegisterJobDefinitionResponse":{
"type":"structure",
"required":[
"jobDefinitionName",
"jobDefinitionArn",
"revision"
],
"members":{
"jobDefinitionName":{"shape":"String"},
"jobDefinitionArn":{"shape":"String"},
"revision":{"shape":"Integer"}
}
},
"RetryStrategy":{
"type":"structure",
"members":{
"attempts":{"shape":"Integer"}
}
},
"ServerException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"error":{"httpStatusCode":500},
"exception":true,
"fault":true
},
"String":{"type":"string"},
"StringList":{
"type":"list",
"member":{"shape":"String"}
},
"SubmitJobRequest":{
"type":"structure",
"required":[
"jobName",
"jobQueue",
"jobDefinition"
],
"members":{
"jobName":{"shape":"String"},
"jobQueue":{"shape":"String"},
"arrayProperties":{"shape":"ArrayProperties"},
"dependsOn":{"shape":"JobDependencyList"},
"jobDefinition":{"shape":"String"},
"parameters":{"shape":"ParametersMap"},
"containerOverrides":{"shape":"ContainerOverrides"},
"retryStrategy":{"shape":"RetryStrategy"},
"timeout":{"shape":"JobTimeout"}
}
},
"SubmitJobResponse":{
"type":"structure",
"required":[
"jobName",
"jobId"
],
"members":{
"jobName":{"shape":"String"},
"jobId":{"shape":"String"}
}
},
"TagsMap":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"String"}
},
"TerminateJobRequest":{
"type":"structure",
"required":[
"jobId",
"reason"
],
"members":{
"jobId":{"shape":"String"},
"reason":{"shape":"String"}
}
},
"TerminateJobResponse":{
"type":"structure",
"members":{
}
},
"Ulimit":{
"type":"structure",
"required":[
"hardLimit",
"name",
"softLimit"
],
"members":{
"hardLimit":{"shape":"Integer"},
"name":{"shape":"String"},
"softLimit":{"shape":"Integer"}
}
},
"Ulimits":{
"type":"list",
"member":{"shape":"Ulimit"}
},
"UpdateComputeEnvironmentRequest":{
"type":"structure",
"required":["computeEnvironment"],
"members":{
"computeEnvironment":{"shape":"String"},
"state":{"shape":"CEState"},
"computeResources":{"shape":"ComputeResourceUpdate"},
"serviceRole":{"shape":"String"}
}
},
"UpdateComputeEnvironmentResponse":{
"type":"structure",
"members":{
"computeEnvironmentName":{"shape":"String"},
"computeEnvironmentArn":{"shape":"String"}
}
},
"UpdateJobQueueRequest":{
"type":"structure",
"required":["jobQueue"],
"members":{
"jobQueue":{"shape":"String"},
"state":{"shape":"JQState"},
"priority":{"shape":"Integer"},
"computeEnvironmentOrder":{"shape":"ComputeEnvironmentOrders"}
}
},
"UpdateJobQueueResponse":{
"type":"structure",
"members":{
"jobQueueName":{"shape":"String"},
"jobQueueArn":{"shape":"String"}
}
},
"Volume":{
"type":"structure",
"members":{
"host":{"shape":"Host"},
"name":{"shape":"String"}
}
},
"Volumes":{
"type":"list",
"member":{"shape":"Volume"}
}
}
}

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

@@ -0,0 +1,696 @@
{
"version": "2.0",
"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 a job 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 job is 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 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 Elastic 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 Elastic 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. 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. 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 a job 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>",
"UpdateComputeEnvironment": "<p>Updates an AWS Batch compute environment.</p>",
"UpdateJobQueue": "<p>Updates a job queue.</p>"
},
"shapes": {
"ArrayJobDependency": {
"base": null,
"refs": {
"JobDependency$type": "<p>The type of the job dependency.</p>"
}
},
"ArrayJobStatusSummary": {
"base": null,
"refs": {
"ArrayPropertiesDetail$statusSummary": "<p>A summary of the number of array job children in each available job status. This parameter is returned for parent array jobs.</p>"
}
},
"ArrayProperties": {
"base": "<p>An object representing an AWS Batch array job.</p>",
"refs": {
"SubmitJobRequest$arrayProperties": "<p>The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see <a href=\"http://docs.aws.amazon.com/batch/latest/userguide/array_jobs.html\">Array Jobs</a> in the <i>AWS Batch User Guide</i>.</p>"
}
},
"ArrayPropertiesDetail": {
"base": "<p>An object representing the array properties of a job.</p>",
"refs": {
"JobDetail$arrayProperties": "<p>The array properties of the job, if it is an array job.</p>"
}
},
"ArrayPropertiesSummary": {
"base": "<p>An object representing the array properties of a job.</p>",
"refs": {
"JobSummary$arrayProperties": "<p>The array properties of the job, if it is an array job.</p>"
}
},
"AttemptContainerDetail": {
"base": "<p>An object representing the details of a container that is part of a job attempt.</p>",
"refs": {
"AttemptDetail$container": "<p>Details about the container in this job attempt.</p>"
}
},
"AttemptDetail": {
"base": "<p>An object representing a job attempt.</p>",
"refs": {
"AttemptDetails$member": null
}
},
"AttemptDetails": {
"base": null,
"refs": {
"JobDetail$attempts": "<p>A list of job attempts associated with this job.</p>"
}
},
"Boolean": {
"base": null,
"refs": {
"ContainerDetail$readonlyRootFilesystem": "<p>When this parameter is true, the container is given read-only access to its root file system.</p>",
"ContainerDetail$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).</p>",
"ContainerProperties$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>",
"ContainerProperties$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>",
"MountPoint$readOnly": "<p>If this value is <code>true</code>, the container has read-only access to the volume; otherwise, the container can write to the volume. The default value is <code>false</code>.</p>"
}
},
"CEState": {
"base": null,
"refs": {
"ComputeEnvironmentDetail$state": "<p>The state of the compute environment. The valid values are <code>ENABLED</code> or <code>DISABLED</code>. An <code>ENABLED</code> state indicates that you can register instances with the compute environment and that the associated instances can accept jobs. </p>",
"CreateComputeEnvironmentRequest$state": "<p>The state of the compute environment. If the state is <code>ENABLED</code>, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.</p>",
"UpdateComputeEnvironmentRequest$state": "<p>The state of the compute environment. Compute environments in the <code>ENABLED</code> state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.</p>"
}
},
"CEStatus": {
"base": null,
"refs": {
"ComputeEnvironmentDetail$status": "<p>The current status of the compute environment (for example, <code>CREATING</code> or <code>VALID</code>).</p>"
}
},
"CEType": {
"base": null,
"refs": {
"ComputeEnvironmentDetail$type": "<p>The type of the compute environment.</p>",
"CreateComputeEnvironmentRequest$type": "<p>The type of the compute environment. </p>"
}
},
"CRType": {
"base": null,
"refs": {
"ComputeResource$type": "<p>The type of compute environment.</p>"
}
},
"CancelJobRequest": {
"base": null,
"refs": {
}
},
"CancelJobResponse": {
"base": null,
"refs": {
}
},
"ClientException": {
"base": "<p>These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is not valid. </p>",
"refs": {
}
},
"ComputeEnvironmentDetail": {
"base": "<p>An object representing an AWS Batch compute environment.</p>",
"refs": {
"ComputeEnvironmentDetailList$member": null
}
},
"ComputeEnvironmentDetailList": {
"base": null,
"refs": {
"DescribeComputeEnvironmentsResponse$computeEnvironments": "<p>The list of compute environments.</p>"
}
},
"ComputeEnvironmentOrder": {
"base": "<p>The order in which compute environments are tried for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.</p>",
"refs": {
"ComputeEnvironmentOrders$member": null
}
},
"ComputeEnvironmentOrders": {
"base": null,
"refs": {
"CreateJobQueueRequest$computeEnvironmentOrder": "<p>The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should execute a given job. Compute environments must be in the <code>VALID</code> state before you can associate them with a job queue. You can associate up to three compute environments with a job queue.</p>",
"JobQueueDetail$computeEnvironmentOrder": "<p>The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order.</p>",
"UpdateJobQueueRequest$computeEnvironmentOrder": "<p>Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment should execute a given job. </p>"
}
},
"ComputeResource": {
"base": "<p>An object representing an AWS Batch compute resource.</p>",
"refs": {
"ComputeEnvironmentDetail$computeResources": "<p>The compute resources defined for the compute environment. </p>",
"CreateComputeEnvironmentRequest$computeResources": "<p>Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments.</p>"
}
},
"ComputeResourceUpdate": {
"base": "<p>An object representing the attributes of a compute environment that can be updated.</p>",
"refs": {
"UpdateComputeEnvironmentRequest$computeResources": "<p>Details of the compute resources managed by the compute environment. Required for a managed compute environment.</p>"
}
},
"ContainerDetail": {
"base": "<p>An object representing the details of a container that is part of a job.</p>",
"refs": {
"JobDetail$container": "<p>An object representing the details of the container that is associated with the job.</p>"
}
},
"ContainerOverrides": {
"base": "<p>The overrides that should be sent to a container.</p>",
"refs": {
"SubmitJobRequest$containerOverrides": "<p>A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a <code>command</code> override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an <code>environment</code> override.</p>"
}
},
"ContainerProperties": {
"base": "<p>Container properties are used in job definitions to describe the container that is launched as part of a job.</p>",
"refs": {
"JobDefinition$containerProperties": "<p>An object with various properties specific to container-based jobs. </p>",
"RegisterJobDefinitionRequest$containerProperties": "<p>An object with various properties specific for container-based jobs. This parameter is required if the <code>type</code> parameter is <code>container</code>.</p>"
}
},
"ContainerSummary": {
"base": "<p>An object representing summary details of a container within a job.</p>",
"refs": {
"JobSummary$container": "<p>An object representing the details of the container that is associated with the job.</p>"
}
},
"CreateComputeEnvironmentRequest": {
"base": null,
"refs": {
}
},
"CreateComputeEnvironmentResponse": {
"base": null,
"refs": {
}
},
"CreateJobQueueRequest": {
"base": null,
"refs": {
}
},
"CreateJobQueueResponse": {
"base": null,
"refs": {
}
},
"DeleteComputeEnvironmentRequest": {
"base": null,
"refs": {
}
},
"DeleteComputeEnvironmentResponse": {
"base": null,
"refs": {
}
},
"DeleteJobQueueRequest": {
"base": null,
"refs": {
}
},
"DeleteJobQueueResponse": {
"base": null,
"refs": {
}
},
"DeregisterJobDefinitionRequest": {
"base": null,
"refs": {
}
},
"DeregisterJobDefinitionResponse": {
"base": null,
"refs": {
}
},
"DescribeComputeEnvironmentsRequest": {
"base": null,
"refs": {
}
},
"DescribeComputeEnvironmentsResponse": {
"base": null,
"refs": {
}
},
"DescribeJobDefinitionsRequest": {
"base": null,
"refs": {
}
},
"DescribeJobDefinitionsResponse": {
"base": null,
"refs": {
}
},
"DescribeJobQueuesRequest": {
"base": null,
"refs": {
}
},
"DescribeJobQueuesResponse": {
"base": null,
"refs": {
}
},
"DescribeJobsRequest": {
"base": null,
"refs": {
}
},
"DescribeJobsResponse": {
"base": null,
"refs": {
}
},
"EnvironmentVariables": {
"base": null,
"refs": {
"ContainerDetail$environment": "<p>The environment variables to pass to a container.</p> <note> <p>Environment variables must not start with <code>AWS_BATCH</code>; this naming convention is reserved for variables that are set by the AWS Batch service.</p> </note>",
"ContainerOverrides$environment": "<p>The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.</p> <note> <p>Environment variables must not start with <code>AWS_BATCH</code>; this naming convention is reserved for variables that are set by the AWS Batch service.</p> </note>",
"ContainerProperties$environment": "<p>The environment variables to pass to a container. This parameter maps to <code>Env</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.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>--env</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <important> <p>We do not recommend using plaintext environment variables for sensitive information, such as credential data.</p> </important> <note> <p>Environment variables must not start with <code>AWS_BATCH</code>; this naming convention is reserved for variables that are set by the AWS Batch service.</p> </note>"
}
},
"Host": {
"base": "<p>The contents of the <code>host</code> parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.</p>",
"refs": {
"Volume$host": "<p>The contents of the <code>host</code> parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.</p>"
}
},
"Integer": {
"base": null,
"refs": {
"ArrayJobStatusSummary$value": null,
"ArrayProperties$size": "<p>The size of the array job.</p>",
"ArrayPropertiesDetail$size": "<p>The size of the array job. This parameter is returned for parent array jobs.</p>",
"ArrayPropertiesDetail$index": "<p>The job index within the array that is associated with this job. This parameter is returned for array job children.</p>",
"ArrayPropertiesSummary$size": "<p>The size of the array job. This parameter is returned for parent array jobs.</p>",
"ArrayPropertiesSummary$index": "<p>The job index within the array that is associated with this job. This parameter is returned for children of array jobs.</p>",
"AttemptContainerDetail$exitCode": "<p>The exit code for the job attempt. A non-zero exit code is considered a failure.</p>",
"ComputeEnvironmentOrder$order": "<p>The order of the compute environment.</p>",
"ComputeResource$minvCpus": "<p>The minimum number of EC2 vCPUs that an environment should maintain. </p>",
"ComputeResource$maxvCpus": "<p>The maximum number of EC2 vCPUs that an environment can reach. </p>",
"ComputeResource$desiredvCpus": "<p>The desired number of EC2 vCPUS in the compute environment. </p>",
"ComputeResource$bidPercentage": "<p>The minimum percentage that a Spot Instance price must be when compared with the On-Demand price for that instance type before instances are launched. For example, if your bid percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance.</p>",
"ComputeResourceUpdate$minvCpus": "<p>The minimum number of EC2 vCPUs that an environment should maintain.</p>",
"ComputeResourceUpdate$maxvCpus": "<p>The maximum number of EC2 vCPUs that an environment can reach.</p>",
"ComputeResourceUpdate$desiredvCpus": "<p>The desired number of EC2 vCPUS in the compute environment.</p>",
"ContainerDetail$vcpus": "<p>The number of VCPUs allocated for the job. </p>",
"ContainerDetail$memory": "<p>The number of MiB of memory reserved for the job.</p>",
"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. You must specify at least one 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> <note> <p>If you are trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see <a href=\"http://docs.aws.amazon.com/batch/latest/userguide/memory-management.html\">Memory Management</a> in the <i>AWS Batch User Guide</i>.</p> </note>",
"ContainerSummary$exitCode": "<p>The exit code to return upon completion.</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>",
"JobDefinition$revision": "<p>The revision of the job definition.</p>",
"JobQueueDetail$priority": "<p>The priority of the job queue. </p>",
"JobTimeout$attemptDurationSeconds": "<p>The time duration in seconds (measured from the job attempt's <code>startedAt</code> timestamp) after which AWS Batch terminates your jobs if they have not finished.</p>",
"ListJobsRequest$maxResults": "<p>The maximum number of results returned by <code>ListJobs</code> in paginated output. When this parameter is used, <code>ListJobs</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>ListJobs</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>ListJobs</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
"RegisterJobDefinitionResponse$revision": "<p>The revision of the job definition.</p>",
"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 the value of <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 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": {
"base": null,
"refs": {
"CreateJobQueueRequest$state": "<p>The state of the job queue. If the job queue state is <code>ENABLED</code>, it is able to accept jobs.</p>",
"JobQueueDetail$state": "<p>Describes the ability of the queue to accept new jobs.</p>",
"UpdateJobQueueRequest$state": "<p>Describes the queue's ability to accept new jobs.</p>"
}
},
"JQStatus": {
"base": null,
"refs": {
"JobQueueDetail$status": "<p>The status of the job queue (for example, <code>CREATING</code> or <code>VALID</code>).</p>"
}
},
"JobDefinition": {
"base": "<p>An object representing an AWS Batch job definition.</p>",
"refs": {
"JobDefinitionList$member": null
}
},
"JobDefinitionList": {
"base": null,
"refs": {
"DescribeJobDefinitionsResponse$jobDefinitions": "<p>The list of job definitions. </p>"
}
},
"JobDefinitionType": {
"base": null,
"refs": {
"RegisterJobDefinitionRequest$type": "<p>The type of job definition.</p>"
}
},
"JobDependency": {
"base": "<p>An object representing an AWS Batch job dependency.</p>",
"refs": {
"JobDependencyList$member": null
}
},
"JobDependencyList": {
"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 dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a <code>SEQUENTIAL</code> type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an <code>N_TO_N</code> type dependency with a job ID for array jobs so that each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.</p>"
}
},
"JobDetail": {
"base": "<p>An object representing an AWS Batch job.</p>",
"refs": {
"JobDetailList$member": null
}
},
"JobDetailList": {
"base": null,
"refs": {
"DescribeJobsResponse$jobs": "<p>The list of jobs. </p>"
}
},
"JobQueueDetail": {
"base": "<p>An object representing the details of an AWS Batch job queue.</p>",
"refs": {
"JobQueueDetailList$member": null
}
},
"JobQueueDetailList": {
"base": null,
"refs": {
"DescribeJobQueuesResponse$jobQueues": "<p>The list of job queues. </p>"
}
},
"JobStatus": {
"base": null,
"refs": {
"JobDetail$status": "<p>The current status for the job.</p>",
"JobSummary$status": "<p>The current status for the job.</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": {
"base": "<p>An object representing summary details of a job.</p>",
"refs": {
"JobSummaryList$member": null
}
},
"JobSummaryList": {
"base": null,
"refs": {
"ListJobsResponse$jobSummaryList": "<p>A list of job summaries that match the request.</p>"
}
},
"JobTimeout": {
"base": "<p>An object representing a job timeout configuration.</p>",
"refs": {
"JobDefinition$timeout": "<p>The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished.</p>",
"JobDetail$timeout": "<p>The timeout configuration for the job. </p>",
"RegisterJobDefinitionRequest$timeout": "<p>The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that is specified during a <a>SubmitJob</a> operation overrides the timeout configuration defined here. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html\">Job Timeouts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>",
"SubmitJobRequest$timeout": "<p>The timeout configuration for this <a>SubmitJob</a> operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html\">Job Timeouts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"KeyValuePair": {
"base": "<p>A key-value pair object.</p>",
"refs": {
"EnvironmentVariables$member": null
}
},
"ListJobsRequest": {
"base": null,
"refs": {
}
},
"ListJobsResponse": {
"base": null,
"refs": {
}
},
"Long": {
"base": null,
"refs": {
"AttemptDetail$startedAt": "<p>The Unix time stamp (in seconds and milliseconds) for when the attempt was started (when the attempt transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>",
"AttemptDetail$stoppedAt": "<p>The Unix time stamp (in seconds and milliseconds) for when the attempt was stopped (when the attempt transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>).</p>",
"JobDetail$createdAt": "<p>The Unix time stamp (in seconds and milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the <code>SUBMITTED</code> state (at the time <a>SubmitJob</a> was called). For array child jobs, this is when the child job was spawned by its parent and entered the <code>PENDING</code> state.</p>",
"JobDetail$startedAt": "<p>The Unix time stamp (in seconds and milliseconds) for when the job was started (when the job transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>",
"JobDetail$stoppedAt": "<p>The Unix time stamp (in seconds and milliseconds) for when the job was stopped (when the job transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>).</p>",
"JobSummary$createdAt": "<p>The Unix time stamp for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the <code>SUBMITTED</code> state (at the time <a>SubmitJob</a> was called). For array child jobs, this is when the child job was spawned by its parent and entered the <code>PENDING</code> state.</p>",
"JobSummary$startedAt": "<p>The Unix time stamp for when the job was started (when the job transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>",
"JobSummary$stoppedAt": "<p>The Unix time stamp for when the job was stopped (when the job transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>).</p>"
}
},
"MountPoint": {
"base": "<p>Details on a Docker volume mount point that is used in a job's container properties.</p>",
"refs": {
"MountPoints$member": null
}
},
"MountPoints": {
"base": null,
"refs": {
"ContainerDetail$mountPoints": "<p>The mount points for data volumes in your container.</p>",
"ContainerProperties$mountPoints": "<p>The mount points for data volumes in your container. This parameter maps to <code>Volumes</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>--volume</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
}
},
"ParametersMap": {
"base": null,
"refs": {
"JobDefinition$parameters": "<p>Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a <code>SubmitJob</code> request override any corresponding parameter defaults from the job definition.</p>",
"JobDetail$parameters": "<p>Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition. </p>",
"RegisterJobDefinitionRequest$parameters": "<p>Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a <code>SubmitJob</code> request override any corresponding parameter defaults from the job definition.</p>",
"SubmitJobRequest$parameters": "<p>Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a <code>SubmitJob</code> request override any corresponding parameter defaults from the job definition.</p>"
}
},
"RegisterJobDefinitionRequest": {
"base": null,
"refs": {
}
},
"RegisterJobDefinitionResponse": {
"base": null,
"refs": {
}
},
"RetryStrategy": {
"base": "<p>The retry strategy associated with a job.</p>",
"refs": {
"JobDefinition$retryStrategy": "<p>The retry strategy to use for failed jobs that are submitted with this job definition.</p>",
"JobDetail$retryStrategy": "<p>The retry strategy to use for this job if an attempt fails.</p>",
"RegisterJobDefinitionRequest$retryStrategy": "<p>The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a <a>SubmitJob</a> operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it is not retried. </p>",
"SubmitJobRequest$retryStrategy": "<p>The retry strategy to use for failed jobs from this <a>SubmitJob</a> operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.</p>"
}
},
"ServerException": {
"base": "<p>These errors are usually caused by a server issue.</p>",
"refs": {
}
},
"String": {
"base": null,
"refs": {
"ArrayJobStatusSummary$key": null,
"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. Each container attempt receives a task ARN when they reach the <code>STARTING</code> status.</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>The AWS Batch job ID of the job to cancel.</p>",
"CancelJobRequest$reason": "<p>A message to attach to the job that explains the reason for canceling 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>",
"ClientException$message": null,
"ComputeEnvironmentDetail$computeEnvironmentName": "<p>The name of the compute environment. </p>",
"ComputeEnvironmentDetail$computeEnvironmentArn": "<p>The Amazon Resource Name (ARN) of the compute environment. </p>",
"ComputeEnvironmentDetail$ecsClusterArn": "<p>The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment. </p>",
"ComputeEnvironmentDetail$statusReason": "<p>A short, human-readable string to provide additional details about the current status of the compute environment.</p>",
"ComputeEnvironmentDetail$serviceRole": "<p>The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf.</p>",
"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 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>",
"ContainerDetail$user": "<p>The user name to use inside the container.</p>",
"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. Each container attempt receives a task ARN when they reach the <code>STARTING</code> status.</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>",
"ContainerSummary$reason": "<p>A short (255 max characters) human-readable string to provide additional details about a running or stopped container.</p>",
"CreateComputeEnvironmentRequest$computeEnvironmentName": "<p>The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, 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> <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>",
"CreateJobQueueResponse$jobQueueName": "<p>The name of the job queue.</p>",
"CreateJobQueueResponse$jobQueueArn": "<p>The Amazon Resource Name (ARN) of the job queue.</p>",
"DeleteComputeEnvironmentRequest$computeEnvironment": "<p>The name or Amazon Resource Name (ARN) of the compute environment to delete. </p>",
"DeleteJobQueueRequest$jobQueue": "<p>The short name or full Amazon Resource Name (ARN) of the queue to delete. </p>",
"DeregisterJobDefinitionRequest$jobDefinition": "<p>The name and revision (<code>name:revision</code>) or full Amazon Resource Name (ARN) of the job definition to deregister. </p>",
"DescribeComputeEnvironmentsRequest$nextToken": "<p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeComputeEnvironments</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>",
"DescribeComputeEnvironmentsResponse$nextToken": "<p>The <code>nextToken</code> value to include in a future <code>DescribeComputeEnvironments</code> request. When the results of a <code>DescribeJobDefinitions</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>",
"DescribeJobDefinitionsRequest$jobDefinitionName": "<p>The name of the job definition to describe.</p>",
"DescribeJobDefinitionsRequest$status": "<p>The status with which to filter job definitions.</p>",
"DescribeJobDefinitionsRequest$nextToken": "<p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeJobDefinitions</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>",
"DescribeJobDefinitionsResponse$nextToken": "<p>The <code>nextToken</code> value to include in a future <code>DescribeJobDefinitions</code> request. When the results of a <code>DescribeJobDefinitions</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>",
"DescribeJobQueuesRequest$nextToken": "<p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeJobQueues</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>",
"DescribeJobQueuesResponse$nextToken": "<p>The <code>nextToken</code> value to include in a future <code>DescribeJobQueues</code> request. When the results of a <code>DescribeJobQueues</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>",
"Host$sourcePath": "<p>The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the <code>host</code> parameter contains a <code>sourcePath</code> file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the <code>sourcePath</code> value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.</p>",
"JobDefinition$jobDefinitionName": "<p>The name of the job definition. </p>",
"JobDefinition$jobDefinitionArn": "<p>The Amazon Resource Name (ARN) for the job definition. </p>",
"JobDefinition$status": "<p>The status of the job definition.</p>",
"JobDefinition$type": "<p>The type of job definition.</p>",
"JobDependency$jobId": "<p>The job ID of the AWS Batch job associated with this dependency.</p>",
"JobDetail$jobName": "<p>The name of the job.</p>",
"JobDetail$jobId": "<p>The ID for the job.</p>",
"JobDetail$jobQueue": "<p>The Amazon Resource Name (ARN) of the job queue with which the job is associated.</p>",
"JobDetail$statusReason": "<p>A short, human-readable string to provide additional details about the current status of the job. </p>",
"JobDetail$jobDefinition": "<p>The job definition that is used by this job.</p>",
"JobQueueDetail$jobQueueName": "<p>The name of the job queue.</p>",
"JobQueueDetail$jobQueueArn": "<p>The Amazon Resource Name (ARN) of the job queue.</p>",
"JobQueueDetail$statusReason": "<p>A short, human-readable string to provide additional details about the current status of the job queue.</p>",
"JobSummary$jobId": "<p>The ID of the job.</p>",
"JobSummary$jobName": "<p>The name of the job.</p>",
"JobSummary$statusReason": "<p>A short, human-readable string to provide additional details about the current status of the job.</p>",
"KeyValuePair$name": "<p>The name of the key-value pair. For environment variables, this is the name of the environment variable.</p>",
"KeyValuePair$value": "<p>The value of the key-value pair. For environment variables, this is the value of the environment variable.</p>",
"ListJobsRequest$jobQueue": "<p>The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.</p>",
"ListJobsRequest$arrayJobId": "<p>The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.</p>",
"ListJobsRequest$nextToken": "<p>The <code>nextToken</code> value returned from a previous paginated <code>ListJobs</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>",
"ListJobsResponse$nextToken": "<p>The <code>nextToken</code> value to include in a future <code>ListJobs</code> request. When the results of a <code>ListJobs</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>",
"MountPoint$containerPath": "<p>The path on the container at which to mount the host volume.</p>",
"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. 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. 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 is 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>",
"SubmitJobResponse$jobId": "<p>The unique identifier for the job.</p>",
"TagsMap$key": null,
"TagsMap$value": null,
"TerminateJobRequest$jobId": "<p>The AWS Batch job ID of the job to terminate.</p>",
"TerminateJobRequest$reason": "<p>A message to attach to the job that explains the reason for canceling 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 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>",
"UpdateJobQueueResponse$jobQueueName": "<p>The name of the job queue.</p>",
"UpdateJobQueueResponse$jobQueueArn": "<p>The Amazon Resource Name (ARN) of the job queue.</p>",
"Volume$name": "<p>The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the <code>sourceVolume</code> parameter of container definition <code>mountPoints</code>.</p>"
}
},
"StringList": {
"base": null,
"refs": {
"ComputeResource$instanceTypes": "<p>The instances types that may be launched. You can specify instance families to launch any instance type within those families (for example, <code>c4</code> or <code>p3</code>), or you can specify specific sizes within a family (such as <code>c4.8xlarge</code>). You can also choose <code>optimal</code> to pick instance types (from the latest C, M, and R instance families) on the fly that match the demand of your job queues.</p>",
"ComputeResource$subnets": "<p>The VPC subnets into which the compute resources are launched. </p>",
"ComputeResource$securityGroupIds": "<p>The EC2 security group that is associated with instances launched in the compute environment. </p>",
"ContainerDetail$command": "<p>The command that is passed to the container. </p>",
"ContainerOverrides$command": "<p>The command to send to the container that overrides the default command from the Docker image or the job definition.</p>",
"ContainerProperties$command": "<p>The command that is passed to the container. This parameter maps to <code>Cmd</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.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>COMMAND</code> parameter to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. For more information, see <a href=\"https://docs.docker.com/engine/reference/builder/#cmd\">https://docs.docker.com/engine/reference/builder/#cmd</a>.</p>",
"DescribeComputeEnvironmentsRequest$computeEnvironments": "<p>A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries. </p>",
"DescribeJobDefinitionsRequest$jobDefinitions": "<p>A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.</p>",
"DescribeJobQueuesRequest$jobQueues": "<p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.</p>",
"DescribeJobsRequest$jobs": "<p>A space-separated list of up to 100 job IDs.</p>"
}
},
"SubmitJobRequest": {
"base": null,
"refs": {
}
},
"SubmitJobResponse": {
"base": null,
"refs": {
}
},
"TagsMap": {
"base": null,
"refs": {
"ComputeResource$tags": "<p>Key-value pair tags to be applied to resources that are launched in the compute environment. </p>"
}
},
"TerminateJobRequest": {
"base": null,
"refs": {
}
},
"TerminateJobResponse": {
"base": null,
"refs": {
}
},
"Ulimit": {
"base": "<p>The <code>ulimit</code> settings to pass to the container.</p>",
"refs": {
"Ulimits$member": null
}
},
"Ulimits": {
"base": null,
"refs": {
"ContainerDetail$ulimits": "<p>A list of <code>ulimit</code> values to set in the container.</p>",
"ContainerProperties$ulimits": "<p>A list of <code>ulimits</code> to set in the container. This parameter maps to <code>Ulimits</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.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>--ulimit</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
}
},
"UpdateComputeEnvironmentRequest": {
"base": null,
"refs": {
}
},
"UpdateComputeEnvironmentResponse": {
"base": null,
"refs": {
}
},
"UpdateJobQueueRequest": {
"base": null,
"refs": {
}
},
"UpdateJobQueueResponse": {
"base": null,
"refs": {
}
},
"Volume": {
"base": "<p>A data volume used in a job's container properties.</p>",
"refs": {
"Volumes$member": null
}
},
"Volumes": {
"base": null,
"refs": {
"ContainerDetail$volumes": "<p>A list of volumes associated with the job.</p>",
"ContainerProperties$volumes": "<p>A list of data volumes used in a job.</p>"
}
}
}
}

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

@@ -0,0 +1,589 @@
{
"version": "1.0",
"examples": {
"CancelJob": [
{
"input": {
"jobId": "1d828f65-7a4d-42e8-996d-3b900ed59dc4",
"reason": "Cancelling job."
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example cancels a job with the specified job ID.",
"id": "to-cancel-a-job-1481152314733",
"title": "To cancel a job"
}
],
"CreateComputeEnvironment": [
{
"input": {
"type": "MANAGED",
"computeEnvironmentName": "C4OnDemand",
"computeResources": {
"type": "EC2",
"desiredvCpus": 48,
"ec2KeyPair": "id_rsa",
"instanceRole": "ecsInstanceRole",
"instanceTypes": [
"c4.large",
"c4.xlarge",
"c4.2xlarge",
"c4.4xlarge",
"c4.8xlarge"
],
"maxvCpus": 128,
"minvCpus": 0,
"securityGroupIds": [
"sg-cf5093b2"
],
"subnets": [
"subnet-220c0e0a",
"subnet-1a95556d",
"subnet-978f6dce"
],
"tags": {
"Name": "Batch Instance - C4OnDemand"
}
},
"serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole",
"state": "ENABLED"
},
"output": {
"computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand",
"computeEnvironmentName": "C4OnDemand"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a managed compute environment with specific C4 instance types that are launched on demand. The compute environment is called C4OnDemand.",
"id": "to-create-a-managed-ec2-compute-environment-1481152600017",
"title": "To create a managed EC2 compute environment"
},
{
"input": {
"type": "MANAGED",
"computeEnvironmentName": "M4Spot",
"computeResources": {
"type": "SPOT",
"bidPercentage": 20,
"desiredvCpus": 4,
"ec2KeyPair": "id_rsa",
"instanceRole": "ecsInstanceRole",
"instanceTypes": [
"m4"
],
"maxvCpus": 128,
"minvCpus": 0,
"securityGroupIds": [
"sg-cf5093b2"
],
"spotIamFleetRole": "arn:aws:iam::012345678910:role/aws-ec2-spot-fleet-role",
"subnets": [
"subnet-220c0e0a",
"subnet-1a95556d",
"subnet-978f6dce"
],
"tags": {
"Name": "Batch Instance - M4Spot"
}
},
"serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole",
"state": "ENABLED"
},
"output": {
"computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/M4Spot",
"computeEnvironmentName": "M4Spot"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a managed compute environment with the M4 instance type that is launched when the Spot bid price is at or below 20% of the On-Demand price for the instance type. The compute environment is called M4Spot.",
"id": "to-create-a-managed-ec2-spot-compute-environment-1481152844190",
"title": "To create a managed EC2 Spot compute environment"
}
],
"CreateJobQueue": [
{
"input": {
"computeEnvironmentOrder": [
{
"computeEnvironment": "M4Spot",
"order": 1
}
],
"jobQueueName": "LowPriority",
"priority": 1,
"state": "ENABLED"
},
"output": {
"jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/LowPriority",
"jobQueueName": "LowPriority"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a job queue called LowPriority that uses the M4Spot compute environment.",
"id": "to-create-a-job-queue-with-a-single-compute-environment-1481152967946",
"title": "To create a job queue with a single compute environment"
},
{
"input": {
"computeEnvironmentOrder": [
{
"computeEnvironment": "C4OnDemand",
"order": 1
},
{
"computeEnvironment": "M4Spot",
"order": 2
}
],
"jobQueueName": "HighPriority",
"priority": 10,
"state": "ENABLED"
},
"output": {
"jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
"jobQueueName": "HighPriority"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example creates a job queue called HighPriority that uses the C4OnDemand compute environment with an order of 1 and the M4Spot compute environment with an order of 2.",
"id": "to-create-a-job-queue-with-multiple-compute-environments-1481153027051",
"title": "To create a job queue with multiple compute environments"
}
],
"DeleteComputeEnvironment": [
{
"input": {
"computeEnvironment": "P2OnDemand"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the P2OnDemand compute environment.",
"id": "to-delete-a-compute-environment-1481153105644",
"title": "To delete a compute environment"
}
],
"DeleteJobQueue": [
{
"input": {
"jobQueue": "GPGPU"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deletes the GPGPU job queue.",
"id": "to-delete-a-job-queue-1481153508134",
"title": "To delete a job queue"
}
],
"DeregisterJobDefinition": [
{
"input": {
"jobDefinition": "sleep10"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example deregisters a job definition called sleep10.",
"id": "to-deregister-a-job-definition-1481153579565",
"title": "To deregister a job definition"
}
],
"DescribeComputeEnvironments": [
{
"input": {
"computeEnvironments": [
"P2OnDemand"
]
},
"output": {
"computeEnvironments": [
{
"type": "MANAGED",
"computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand",
"computeEnvironmentName": "P2OnDemand",
"computeResources": {
"type": "EC2",
"desiredvCpus": 48,
"ec2KeyPair": "id_rsa",
"instanceRole": "ecsInstanceRole",
"instanceTypes": [
"p2"
],
"maxvCpus": 128,
"minvCpus": 0,
"securityGroupIds": [
"sg-cf5093b2"
],
"subnets": [
"subnet-220c0e0a",
"subnet-1a95556d",
"subnet-978f6dce"
],
"tags": {
"Name": "Batch Instance - P2OnDemand"
}
},
"ecsClusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/P2OnDemand_Batch_2c06f29d-d1fe-3a49-879d-42394c86effc",
"serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole",
"state": "ENABLED",
"status": "VALID",
"statusReason": "ComputeEnvironment Healthy"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes the P2OnDemand compute environment.",
"id": "to-describe-a-compute-environment-1481153713334",
"title": "To describe a compute environment"
}
],
"DescribeJobDefinitions": [
{
"input": {
"status": "ACTIVE"
},
"output": {
"jobDefinitions": [
{
"type": "container",
"containerProperties": {
"command": [
"sleep",
"60"
],
"environment": [
],
"image": "busybox",
"memory": 128,
"mountPoints": [
],
"ulimits": [
],
"vcpus": 1,
"volumes": [
]
},
"jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep60:1",
"jobDefinitionName": "sleep60",
"revision": 1,
"status": "ACTIVE"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes all of your active job definitions.",
"id": "to-describe-active-job-definitions-1481153895831",
"title": "To describe active job definitions"
}
],
"DescribeJobQueues": [
{
"input": {
"jobQueues": [
"HighPriority"
]
},
"output": {
"jobQueues": [
{
"computeEnvironmentOrder": [
{
"computeEnvironment": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand",
"order": 1
}
],
"jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
"jobQueueName": "HighPriority",
"priority": 1,
"state": "ENABLED",
"status": "VALID",
"statusReason": "JobQueue Healthy"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes the HighPriority job queue.",
"id": "to-describe-a-job-queue-1481153995804",
"title": "To describe a job queue"
}
],
"DescribeJobs": [
{
"input": {
"jobs": [
"24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9"
]
},
"output": {
"jobs": [
{
"container": {
"command": [
"sleep",
"60"
],
"containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/5406d7cd-58bd-4b8f-9936-48d7c6b1526c",
"environment": [
],
"exitCode": 0,
"image": "busybox",
"memory": 128,
"mountPoints": [
],
"ulimits": [
],
"vcpus": 1,
"volumes": [
]
},
"createdAt": 1480460782010,
"dependsOn": [
],
"jobDefinition": "sleep60",
"jobId": "24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9",
"jobName": "example",
"jobQueue": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
"parameters": {
},
"startedAt": 1480460816500,
"status": "SUCCEEDED",
"stoppedAt": 1480460880699
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example describes a job with the specified job ID.",
"id": "to-describe-a-specific-job-1481154090490",
"title": "To describe a specific job"
}
],
"ListJobs": [
{
"input": {
"jobQueue": "HighPriority"
},
"output": {
"jobSummaryList": [
{
"jobId": "e66ff5fd-a1ff-4640-b1a2-0b0a142f49bb",
"jobName": "example"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example lists the running jobs in the HighPriority job queue.",
"id": "to-list-running-jobs-1481154202164",
"title": "To list running jobs"
},
{
"input": {
"jobQueue": "HighPriority",
"jobStatus": "SUBMITTED"
},
"output": {
"jobSummaryList": [
{
"jobId": "68f0c163-fbd4-44e6-9fd1-25b14a434786",
"jobName": "example"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example lists jobs in the HighPriority job queue that are in the SUBMITTED job status.",
"id": "to-list-submitted-jobs-1481154251623",
"title": "To list submitted jobs"
}
],
"RegisterJobDefinition": [
{
"input": {
"type": "container",
"containerProperties": {
"command": [
"sleep",
"10"
],
"image": "busybox",
"memory": 128,
"vcpus": 1
},
"jobDefinitionName": "sleep10"
},
"output": {
"jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep10:1",
"jobDefinitionName": "sleep10",
"revision": 1
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example registers a job definition for a simple container job.",
"id": "to-register-a-job-definition-1481154325325",
"title": "To register a job definition"
}
],
"SubmitJob": [
{
"input": {
"jobDefinition": "sleep60",
"jobName": "example",
"jobQueue": "HighPriority"
},
"output": {
"jobId": "876da822-4198-45f2-a252-6cea32512ea8",
"jobName": "example"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example submits a simple container job called example to the HighPriority job queue.",
"id": "to-submit-a-job-to-a-queue-1481154481673",
"title": "To submit a job to a queue"
}
],
"TerminateJob": [
{
"input": {
"jobId": "61e743ed-35e4-48da-b2de-5c8333821c84",
"reason": "Terminating job."
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example terminates a job with the specified job ID.",
"id": "to-terminate-a-job-1481154558276",
"title": "To terminate a job"
}
],
"UpdateComputeEnvironment": [
{
"input": {
"computeEnvironment": "P2OnDemand",
"state": "DISABLED"
},
"output": {
"computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand",
"computeEnvironmentName": "P2OnDemand"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example disables the P2OnDemand compute environment so it can be deleted.",
"id": "to-update-a-compute-environment-1481154702731",
"title": "To update a compute environment"
}
],
"UpdateJobQueue": [
{
"input": {
"jobQueue": "GPGPU",
"state": "DISABLED"
},
"output": {
"jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/GPGPU",
"jobQueueName": "GPGPU"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "This example disables a job queue so that it can be deleted.",
"id": "to-update-a-job-queue-1481154806981",
"title": "To update a job queue"
}
]
}
}

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

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

11
vendor/github.com/aws/aws-sdk-go/models/apis/batch/2016-08-10/smoke.json generated vendored Normal file
View File

@@ -0,0 +1,11 @@
{
"version": 1,
"defaultRegion": "us-west-2",
"testCases": [
{
"operationName": "DescribeComputeEnvironments",
"input": {},
"errorExpectedFromService": false
}
]
}

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

@@ -0,0 +1,716 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2016-10-20",
"endpointPrefix":"budgets",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"AWSBudgets",
"serviceFullName":"AWS Budgets",
"signatureVersion":"v4",
"targetPrefix":"AWSBudgetServiceGateway",
"uid":"budgets-2016-10-20"
},
"operations":{
"CreateBudget":{
"name":"CreateBudget",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateBudgetRequest"},
"output":{"shape":"CreateBudgetResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"InternalErrorException"},
{"shape":"CreationLimitExceededException"},
{"shape":"DuplicateRecordException"}
]
},
"CreateNotification":{
"name":"CreateNotification",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateNotificationRequest"},
"output":{"shape":"CreateNotificationResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"},
{"shape":"CreationLimitExceededException"},
{"shape":"DuplicateRecordException"}
]
},
"CreateSubscriber":{
"name":"CreateSubscriber",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateSubscriberRequest"},
"output":{"shape":"CreateSubscriberResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"CreationLimitExceededException"},
{"shape":"DuplicateRecordException"},
{"shape":"NotFoundException"}
]
},
"DeleteBudget":{
"name":"DeleteBudget",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteBudgetRequest"},
"output":{"shape":"DeleteBudgetResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"}
]
},
"DeleteNotification":{
"name":"DeleteNotification",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteNotificationRequest"},
"output":{"shape":"DeleteNotificationResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"InternalErrorException"},
{"shape":"NotFoundException"}
]
},
"DeleteSubscriber":{
"name":"DeleteSubscriber",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteSubscriberRequest"},
"output":{"shape":"DeleteSubscriberResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"}
]
},
"DescribeBudget":{
"name":"DescribeBudget",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeBudgetRequest"},
"output":{"shape":"DescribeBudgetResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"}
]
},
"DescribeBudgets":{
"name":"DescribeBudgets",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeBudgetsRequest"},
"output":{"shape":"DescribeBudgetsResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ExpiredNextTokenException"}
]
},
"DescribeNotificationsForBudget":{
"name":"DescribeNotificationsForBudget",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeNotificationsForBudgetRequest"},
"output":{"shape":"DescribeNotificationsForBudgetResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ExpiredNextTokenException"}
]
},
"DescribeSubscribersForNotification":{
"name":"DescribeSubscribersForNotification",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeSubscribersForNotificationRequest"},
"output":{"shape":"DescribeSubscribersForNotificationResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"NotFoundException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ExpiredNextTokenException"}
]
},
"UpdateBudget":{
"name":"UpdateBudget",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateBudgetRequest"},
"output":{"shape":"UpdateBudgetResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"}
]
},
"UpdateNotification":{
"name":"UpdateNotification",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateNotificationRequest"},
"output":{"shape":"UpdateNotificationResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"},
{"shape":"DuplicateRecordException"}
]
},
"UpdateSubscriber":{
"name":"UpdateSubscriber",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateSubscriberRequest"},
"output":{"shape":"UpdateSubscriberResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"},
{"shape":"DuplicateRecordException"}
]
}
},
"shapes":{
"AccountId":{
"type":"string",
"max":12,
"min":12
},
"Budget":{
"type":"structure",
"required":[
"BudgetName",
"TimeUnit",
"BudgetType"
],
"members":{
"BudgetName":{"shape":"BudgetName"},
"BudgetLimit":{"shape":"Spend"},
"CostFilters":{"shape":"CostFilters"},
"CostTypes":{"shape":"CostTypes"},
"TimeUnit":{"shape":"TimeUnit"},
"TimePeriod":{"shape":"TimePeriod"},
"CalculatedSpend":{"shape":"CalculatedSpend"},
"BudgetType":{"shape":"BudgetType"}
}
},
"BudgetName":{
"type":"string",
"max":100,
"pattern":"[^:\\\\]+"
},
"BudgetType":{
"type":"string",
"enum":[
"USAGE",
"COST",
"RI_UTILIZATION"
]
},
"Budgets":{
"type":"list",
"member":{"shape":"Budget"}
},
"CalculatedSpend":{
"type":"structure",
"required":["ActualSpend"],
"members":{
"ActualSpend":{"shape":"Spend"},
"ForecastedSpend":{"shape":"Spend"}
}
},
"ComparisonOperator":{
"type":"string",
"enum":[
"GREATER_THAN",
"LESS_THAN",
"EQUAL_TO"
]
},
"CostFilters":{
"type":"map",
"key":{"shape":"GenericString"},
"value":{"shape":"DimensionValues"}
},
"CostTypes":{
"type":"structure",
"members":{
"IncludeTax":{"shape":"NullableBoolean"},
"IncludeSubscription":{"shape":"NullableBoolean"},
"UseBlended":{"shape":"NullableBoolean"},
"IncludeRefund":{"shape":"NullableBoolean"},
"IncludeCredit":{"shape":"NullableBoolean"},
"IncludeUpfront":{"shape":"NullableBoolean"},
"IncludeRecurring":{"shape":"NullableBoolean"},
"IncludeOtherSubscription":{"shape":"NullableBoolean"},
"IncludeSupport":{"shape":"NullableBoolean"},
"IncludeDiscount":{"shape":"NullableBoolean"},
"UseAmortized":{"shape":"NullableBoolean"}
}
},
"CreateBudgetRequest":{
"type":"structure",
"required":[
"AccountId",
"Budget"
],
"members":{
"AccountId":{"shape":"AccountId"},
"Budget":{"shape":"Budget"},
"NotificationsWithSubscribers":{"shape":"NotificationWithSubscribersList"}
}
},
"CreateBudgetResponse":{
"type":"structure",
"members":{
}
},
"CreateNotificationRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"Notification",
"Subscribers"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"Notification":{"shape":"Notification"},
"Subscribers":{"shape":"Subscribers"}
}
},
"CreateNotificationResponse":{
"type":"structure",
"members":{
}
},
"CreateSubscriberRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"Notification",
"Subscriber"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"Notification":{"shape":"Notification"},
"Subscriber":{"shape":"Subscriber"}
}
},
"CreateSubscriberResponse":{
"type":"structure",
"members":{
}
},
"CreationLimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"exception":true
},
"DeleteBudgetRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"}
}
},
"DeleteBudgetResponse":{
"type":"structure",
"members":{
}
},
"DeleteNotificationRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"Notification"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"Notification":{"shape":"Notification"}
}
},
"DeleteNotificationResponse":{
"type":"structure",
"members":{
}
},
"DeleteSubscriberRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"Notification",
"Subscriber"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"Notification":{"shape":"Notification"},
"Subscriber":{"shape":"Subscriber"}
}
},
"DeleteSubscriberResponse":{
"type":"structure",
"members":{
}
},
"DescribeBudgetRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"}
}
},
"DescribeBudgetResponse":{
"type":"structure",
"members":{
"Budget":{"shape":"Budget"}
}
},
"DescribeBudgetsRequest":{
"type":"structure",
"required":["AccountId"],
"members":{
"AccountId":{"shape":"AccountId"},
"MaxResults":{"shape":"MaxResults"},
"NextToken":{"shape":"GenericString"}
}
},
"DescribeBudgetsResponse":{
"type":"structure",
"members":{
"Budgets":{"shape":"Budgets"},
"NextToken":{"shape":"GenericString"}
}
},
"DescribeNotificationsForBudgetRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"MaxResults":{"shape":"MaxResults"},
"NextToken":{"shape":"GenericString"}
}
},
"DescribeNotificationsForBudgetResponse":{
"type":"structure",
"members":{
"Notifications":{"shape":"Notifications"},
"NextToken":{"shape":"GenericString"}
}
},
"DescribeSubscribersForNotificationRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"Notification"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"Notification":{"shape":"Notification"},
"MaxResults":{"shape":"MaxResults"},
"NextToken":{"shape":"GenericString"}
}
},
"DescribeSubscribersForNotificationResponse":{
"type":"structure",
"members":{
"Subscribers":{"shape":"Subscribers"},
"NextToken":{"shape":"GenericString"}
}
},
"DimensionValues":{
"type":"list",
"member":{"shape":"GenericString"}
},
"DuplicateRecordException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"exception":true
},
"ExpiredNextTokenException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"exception":true
},
"GenericString":{"type":"string"},
"GenericTimestamp":{"type":"timestamp"},
"InternalErrorException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"exception":true
},
"InvalidNextTokenException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"exception":true
},
"InvalidParameterException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"exception":true
},
"MaxResults":{
"type":"integer",
"box":true,
"max":100,
"min":1
},
"NotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"exception":true
},
"Notification":{
"type":"structure",
"required":[
"NotificationType",
"ComparisonOperator",
"Threshold"
],
"members":{
"NotificationType":{"shape":"NotificationType"},
"ComparisonOperator":{"shape":"ComparisonOperator"},
"Threshold":{"shape":"NotificationThreshold"},
"ThresholdType":{"shape":"ThresholdType"}
}
},
"NotificationThreshold":{
"type":"double",
"max":1000000000,
"min":0.1
},
"NotificationType":{
"type":"string",
"enum":[
"ACTUAL",
"FORECASTED"
]
},
"NotificationWithSubscribers":{
"type":"structure",
"required":[
"Notification",
"Subscribers"
],
"members":{
"Notification":{"shape":"Notification"},
"Subscribers":{"shape":"Subscribers"}
}
},
"NotificationWithSubscribersList":{
"type":"list",
"member":{"shape":"NotificationWithSubscribers"},
"max":5
},
"Notifications":{
"type":"list",
"member":{"shape":"Notification"}
},
"NullableBoolean":{
"type":"boolean",
"box":true
},
"NumericValue":{
"type":"string",
"pattern":"[0-9]*(\\.)?[0-9]+"
},
"Spend":{
"type":"structure",
"required":[
"Amount",
"Unit"
],
"members":{
"Amount":{"shape":"NumericValue"},
"Unit":{"shape":"UnitValue"}
}
},
"Subscriber":{
"type":"structure",
"required":[
"SubscriptionType",
"Address"
],
"members":{
"SubscriptionType":{"shape":"SubscriptionType"},
"Address":{"shape":"SubscriberAddress"}
}
},
"SubscriberAddress":{
"type":"string",
"min":1
},
"Subscribers":{
"type":"list",
"member":{"shape":"Subscriber"},
"max":11,
"min":1
},
"SubscriptionType":{
"type":"string",
"enum":[
"SNS",
"EMAIL"
]
},
"ThresholdType":{
"type":"string",
"enum":[
"PERCENTAGE",
"ABSOLUTE_VALUE"
]
},
"TimePeriod":{
"type":"structure",
"members":{
"Start":{"shape":"GenericTimestamp"},
"End":{"shape":"GenericTimestamp"}
}
},
"TimeUnit":{
"type":"string",
"enum":[
"DAILY",
"MONTHLY",
"QUARTERLY",
"ANNUALLY"
]
},
"UnitValue":{
"type":"string",
"min":1
},
"UpdateBudgetRequest":{
"type":"structure",
"required":[
"AccountId",
"NewBudget"
],
"members":{
"AccountId":{"shape":"AccountId"},
"NewBudget":{"shape":"Budget"}
}
},
"UpdateBudgetResponse":{
"type":"structure",
"members":{
}
},
"UpdateNotificationRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"OldNotification",
"NewNotification"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"OldNotification":{"shape":"Notification"},
"NewNotification":{"shape":"Notification"}
}
},
"UpdateNotificationResponse":{
"type":"structure",
"members":{
}
},
"UpdateSubscriberRequest":{
"type":"structure",
"required":[
"AccountId",
"BudgetName",
"Notification",
"OldSubscriber",
"NewSubscriber"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"Notification":{"shape":"Notification"},
"OldSubscriber":{"shape":"Subscriber"},
"NewSubscriber":{"shape":"Subscriber"}
}
},
"UpdateSubscriberResponse":{
"type":"structure",
"members":{
}
},
"errorMessage":{"type":"string"}
}
}

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

@@ -0,0 +1,440 @@
{
"version": "2.0",
"service": "<p>Budgets enable you to plan your service usage, service costs, and your RI utilization. You can also track how close your plan is to your budgeted amount or to the free tier limits. Budgets provide you with a quick way to see your usage-to-date and current estimated charges from AWS and to see how much your predicted usage accrues in charges by the end of the month. Budgets also compare current estimates and charges to the amount that you indicated you want to use or spend and lets you see how much of your budget has been used. AWS updates your budget status several times a day. Budgets track your unblended costs, subscriptions, and refunds. You can create the following types of budgets:</p> <ul> <li> <p>Cost budgets allow you to say how much you want to spend on a service.</p> </li> <li> <p>Usage budgets allow you to say how many hours you want to use for one or more services.</p> </li> <li> <p>RI utilization budgets allow you to define a utilization threshold and receive alerts when RIs are tracking below that threshold.</p> </li> </ul> <p>You can create up to 20,000 budgets per AWS master account. Your first two budgets are free of charge. Each additional budget costs $0.02 per day. You can set up optional notifications that warn you if you exceed, or are forecasted to exceed, your budgeted amount. You can have notifications sent to an Amazon SNS topic, to an email address, or to both. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-sns-policy.html\">Creating an Amazon SNS Topic for Budget Notifications</a>. AWS Free Tier usage alerts via AWS Budgets are provided for you, and do not count toward your budget limits.</p> <p>Service Endpoint</p> <p>The AWS Budgets API provides the following endpoint:</p> <ul> <li> <p>https://budgets.us-east-1.amazonaws.com</p> </li> </ul>",
"operations": {
"CreateBudget": "<p>Creates a budget and, if included, notifications and subscribers. </p>",
"CreateNotification": "<p>Creates a notification. You must create the budget before you create the associated notification.</p>",
"CreateSubscriber": "<p>Creates a subscriber. You must create the associated budget and notification before you create the subscriber.</p>",
"DeleteBudget": "<p>Deletes a budget. You can delete your budget at any time.</p> <p> <b>Deleting a budget also deletes the notifications and subscribers associated with that budget.</b> </p>",
"DeleteNotification": "<p>Deletes a notification.</p> <p> <b>Deleting a notification also deletes the subscribers associated with the notification.</b> </p>",
"DeleteSubscriber": "<p>Deletes a subscriber.</p> <p> <b>Deleting the last subscriber to a notification also deletes the notification.</b> </p>",
"DescribeBudget": "<p>Describes a budget.</p>",
"DescribeBudgets": "<p>Lists the budgets associated with an account.</p>",
"DescribeNotificationsForBudget": "<p>Lists the notifications associated with a budget.</p>",
"DescribeSubscribersForNotification": "<p>Lists the subscribers associated with a notification.</p>",
"UpdateBudget": "<p>Updates a budget. You can change every part of a budget except for the <code>budgetName</code> and the <code>calculatedSpend</code>. When a budget is modified, the <code>calculatedSpend</code> drops to zero until AWS has new usage data to use for forecasting.</p>",
"UpdateNotification": "<p>Updates a notification.</p>",
"UpdateSubscriber": "<p>Updates a subscriber.</p>"
},
"shapes": {
"AccountId": {
"base": "<p>The account ID of the customer. It should be a 12 digit number.</p>",
"refs": {
"CreateBudgetRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget.</p>",
"CreateNotificationRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget that you want to create a notification for.</p>",
"CreateSubscriberRequest$AccountId": "<p>The <code>accountId</code> associated with the budget that you want to create a subscriber for.</p>",
"DeleteBudgetRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget that you want to delete.</p>",
"DeleteNotificationRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget whose notification you want to delete.</p>",
"DeleteSubscriberRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget whose subscriber you want to delete.</p>",
"DescribeBudgetRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget that you want a description of.</p>",
"DescribeBudgetsRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budgets that you want descriptions of.</p>",
"DescribeNotificationsForBudgetRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget whose notifications you want descriptions of.</p>",
"DescribeSubscribersForNotificationRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget whose subscribers you want descriptions of.</p>",
"UpdateBudgetRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget that you want to update.</p>",
"UpdateNotificationRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget whose notification you want to update.</p>",
"UpdateSubscriberRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget whose subscriber you want to update.</p>"
}
},
"Budget": {
"base": "<p>Represents the output of the <code>CreateBudget</code> operation. The content consists of the detailed metadata and data file information, and the current status of the <code>budget</code>.</p> <p>The ARN pattern for a budget is: <code>arn:aws:budgetservice::AccountId:budget/budgetName</code> </p>",
"refs": {
"Budgets$member": null,
"CreateBudgetRequest$Budget": "<p>The budget object that you want to create.</p>",
"DescribeBudgetResponse$Budget": "<p>The description of the budget.</p>",
"UpdateBudgetRequest$NewBudget": "<p>The budget that you want to update your budget to.</p>"
}
},
"BudgetName": {
"base": "<p> A string represents the budget name. No \":\" and \"\\\" character is allowed.</p>",
"refs": {
"Budget$BudgetName": "<p>The name of a budget. Unique within accounts. <code>:</code> and <code>\\</code> characters are not allowed in the <code>BudgetName</code>.</p>",
"CreateNotificationRequest$BudgetName": "<p>The name of the budget that you want AWS to notified you about. Budget names must be unique within an account.</p>",
"CreateSubscriberRequest$BudgetName": "<p>The name of the budget that you want to subscribe to. Budget names must be unique within an account.</p>",
"DeleteBudgetRequest$BudgetName": "<p>The name of the budget that you want to delete.</p>",
"DeleteNotificationRequest$BudgetName": "<p>The name of the budget whose notification you want to delete.</p>",
"DeleteSubscriberRequest$BudgetName": "<p>The name of the budget whose subscriber you want to delete.</p>",
"DescribeBudgetRequest$BudgetName": "<p>The name of the budget that you want a description of.</p>",
"DescribeNotificationsForBudgetRequest$BudgetName": "<p>The name of the budget whose notifications you want descriptions of.</p>",
"DescribeSubscribersForNotificationRequest$BudgetName": "<p>The name of the budget whose subscribers you want descriptions of.</p>",
"UpdateNotificationRequest$BudgetName": "<p>The name of the budget whose notification you want to update.</p>",
"UpdateSubscriberRequest$BudgetName": "<p>The name of the budget whose subscriber you want to update.</p>"
}
},
"BudgetType": {
"base": "<p> The type of a budget. It should be COST, USAGE, or RI_UTILIZATION.</p>",
"refs": {
"Budget$BudgetType": "<p>Whether this budget tracks monetary costs, usage, or RI utilization.</p>"
}
},
"Budgets": {
"base": "<p> A list of budgets</p>",
"refs": {
"DescribeBudgetsResponse$Budgets": "<p>A list of budgets.</p>"
}
},
"CalculatedSpend": {
"base": "<p>The spend objects associated with this budget. The <code>actualSpend</code> tracks how much you've used, cost, usage, or RI units, and the <code>forecastedSpend</code> tracks how much you are predicted to spend if your current usage remains steady.</p> <p>For example, if it is the 20th of the month and you have spent <code>50</code> dollars on Amazon EC2, your <code>actualSpend</code> is <code>50 USD</code>, and your <code>forecastedSpend</code> is <code>75 USD</code>.</p>",
"refs": {
"Budget$CalculatedSpend": "<p>The actual and forecasted cost or usage being tracked by a budget.</p>"
}
},
"ComparisonOperator": {
"base": "<p> The comparison operator of a notification. Currently we support less than, equal to and greater than.</p>",
"refs": {
"Notification$ComparisonOperator": "<p>The comparison used for this notification.</p>"
}
},
"CostFilters": {
"base": "<p> A map that represents the cost filters applied to the budget.</p>",
"refs": {
"Budget$CostFilters": "<p>The cost filters applied to a budget, such as service or region.</p>"
}
},
"CostTypes": {
"base": "<p>The types of cost included in a budget, such as tax and subscriptions.</p>",
"refs": {
"Budget$CostTypes": "<p>The types of costs included in this budget.</p>"
}
},
"CreateBudgetRequest": {
"base": "<p> Request of CreateBudget </p>",
"refs": {
}
},
"CreateBudgetResponse": {
"base": "<p> Response of CreateBudget </p>",
"refs": {
}
},
"CreateNotificationRequest": {
"base": "<p> Request of CreateNotification </p>",
"refs": {
}
},
"CreateNotificationResponse": {
"base": "<p> Response of CreateNotification </p>",
"refs": {
}
},
"CreateSubscriberRequest": {
"base": "<p> Request of CreateSubscriber </p>",
"refs": {
}
},
"CreateSubscriberResponse": {
"base": "<p> Response of CreateSubscriber </p>",
"refs": {
}
},
"CreationLimitExceededException": {
"base": "<p>You've exceeded the notification or subscriber limit.</p>",
"refs": {
}
},
"DeleteBudgetRequest": {
"base": "<p> Request of DeleteBudget </p>",
"refs": {
}
},
"DeleteBudgetResponse": {
"base": "<p> Response of DeleteBudget </p>",
"refs": {
}
},
"DeleteNotificationRequest": {
"base": "<p> Request of DeleteNotification </p>",
"refs": {
}
},
"DeleteNotificationResponse": {
"base": "<p> Response of DeleteNotification </p>",
"refs": {
}
},
"DeleteSubscriberRequest": {
"base": "<p> Request of DeleteSubscriber </p>",
"refs": {
}
},
"DeleteSubscriberResponse": {
"base": "<p> Response of DeleteSubscriber </p>",
"refs": {
}
},
"DescribeBudgetRequest": {
"base": "<p> Request of DescribeBudget </p>",
"refs": {
}
},
"DescribeBudgetResponse": {
"base": "<p> Response of DescribeBudget </p>",
"refs": {
}
},
"DescribeBudgetsRequest": {
"base": "<p> Request of DescribeBudgets </p>",
"refs": {
}
},
"DescribeBudgetsResponse": {
"base": "<p> Response of DescribeBudgets </p>",
"refs": {
}
},
"DescribeNotificationsForBudgetRequest": {
"base": "<p> Request of DescribeNotificationsForBudget </p>",
"refs": {
}
},
"DescribeNotificationsForBudgetResponse": {
"base": "<p> Response of GetNotificationsForBudget </p>",
"refs": {
}
},
"DescribeSubscribersForNotificationRequest": {
"base": "<p> Request of DescribeSubscribersForNotification </p>",
"refs": {
}
},
"DescribeSubscribersForNotificationResponse": {
"base": "<p> Response of DescribeSubscribersForNotification </p>",
"refs": {
}
},
"DimensionValues": {
"base": null,
"refs": {
"CostFilters$value": null
}
},
"DuplicateRecordException": {
"base": "<p>The budget name already exists. Budget names must be unique within an account.</p>",
"refs": {
}
},
"ExpiredNextTokenException": {
"base": "<p>The pagination token expired.</p>",
"refs": {
}
},
"GenericString": {
"base": "<p> A generic String.</p>",
"refs": {
"CostFilters$key": null,
"DescribeBudgetsRequest$NextToken": "<p>The pagination token that indicates the next set of results to retrieve.</p>",
"DescribeBudgetsResponse$NextToken": "<p>The pagination token that indicates the next set of results that you can retrieve.</p>",
"DescribeNotificationsForBudgetRequest$NextToken": "<p>The pagination token that indicates the next set of results to retrieve.</p>",
"DescribeNotificationsForBudgetResponse$NextToken": "<p>The pagination token that indicates the next set of results that you can retrieve.</p>",
"DescribeSubscribersForNotificationRequest$NextToken": "<p>The pagination token that indicates the next set of results to retrieve.</p>",
"DescribeSubscribersForNotificationResponse$NextToken": "<p>The pagination token that indicates the next set of results that you can retrieve.</p>",
"DimensionValues$member": null
}
},
"GenericTimestamp": {
"base": "<p> A generic timestamp. In Java it is transformed to a Date object.</p>",
"refs": {
"TimePeriod$Start": "<p>The start date for a budget. If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (i.e. DAILY, MONTHLY, QUARTERLY, ANNUALLY). For example, if you created your budget on January 24th 2018, chose <code>DAILY</code>, and didn't set a start date, AWS set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, AWS set your start date to <code>01/01/18 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API.</p> <p>You can change your start date with the <code>UpdateBudget</code> operation.</p>",
"TimePeriod$End": "<p>The end date for a budget. If you didn't specify an end date, AWS set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API.</p> <p>After the end date, AWS deletes the budget and all associated notifications and subscribers. You can change your end date with the <code>UpdateBudget</code> operation.</p>"
}
},
"InternalErrorException": {
"base": "<p>An error on the server occurred during the processing of your request. Try again later.</p>",
"refs": {
}
},
"InvalidNextTokenException": {
"base": "<p>The pagination token is invalid.</p>",
"refs": {
}
},
"InvalidParameterException": {
"base": "<p>An error on the client occurred. Typically, the cause is an invalid input value.</p>",
"refs": {
}
},
"MaxResults": {
"base": "<p> An integer to represent how many entries a paginated response contains. Maximum is set to 100.</p>",
"refs": {
"DescribeBudgetsRequest$MaxResults": "<p>Optional integer. Specifies the maximum number of results to return in response.</p>",
"DescribeNotificationsForBudgetRequest$MaxResults": "<p>Optional integer. Specifies the maximum number of results to return in response.</p>",
"DescribeSubscribersForNotificationRequest$MaxResults": "<p>Optional integer. Specifies the maximum number of results to return in response.</p>"
}
},
"NotFoundException": {
"base": "<p>We can’t locate the resource that you specified.</p>",
"refs": {
}
},
"Notification": {
"base": "<p>A notification associated with a budget. A budget can have up to five notifications. </p> <p>Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to ten email subscribers, for a total of 11 subscribers.</p> <p>For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:</p> <ul> <li> <p>A notificationType of <code>ACTUAL</code> </p> </li> <li> <p>A comparisonOperator of <code>GREATER_THAN</code> </p> </li> <li> <p>A notification threshold of <code>80</code> </p> </li> </ul>",
"refs": {
"CreateNotificationRequest$Notification": "<p>The notification that you want to create.</p>",
"CreateSubscriberRequest$Notification": "<p>The notification that you want to create a subscriber for.</p>",
"DeleteNotificationRequest$Notification": "<p>The notification that you want to delete.</p>",
"DeleteSubscriberRequest$Notification": "<p>The notification whose subscriber you want to delete.</p>",
"DescribeSubscribersForNotificationRequest$Notification": "<p>The notification whose subscribers you want to list.</p>",
"NotificationWithSubscribers$Notification": "<p>The notification associated with a budget.</p>",
"Notifications$member": null,
"UpdateNotificationRequest$OldNotification": "<p>The previous notification associated with a budget.</p>",
"UpdateNotificationRequest$NewNotification": "<p>The updated notification to be associated with a budget.</p>",
"UpdateSubscriberRequest$Notification": "<p>The notification whose subscriber you want to update.</p>"
}
},
"NotificationThreshold": {
"base": "<p> The threshold of a notification. It should be a number between 0 and 1,000,000,000.</p>",
"refs": {
"Notification$Threshold": "<p>The threshold associated with a notification. Thresholds are always a percentage.</p>"
}
},
"NotificationType": {
"base": "<p> The type of a notification. It should be ACTUAL or FORECASTED.</p>",
"refs": {
"Notification$NotificationType": "<p>Whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much you are forecasted to spend (<code>FORECASTED</code>).</p>"
}
},
"NotificationWithSubscribers": {
"base": "<p>A notification with subscribers. A notification can have one SNS subscriber and up to ten email subscribers, for a total of 11 subscribers.</p>",
"refs": {
"NotificationWithSubscribersList$member": null
}
},
"NotificationWithSubscribersList": {
"base": "<p> A list of Notifications, each with a list of subscribers.</p>",
"refs": {
"CreateBudgetRequest$NotificationsWithSubscribers": "<p>A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to ten email subscribers. If you include notifications and subscribers in your <code>CreateBudget</code> call, AWS creates the notifications and subscribers for you.</p>"
}
},
"Notifications": {
"base": "<p> A list of notifications.</p>",
"refs": {
"DescribeNotificationsForBudgetResponse$Notifications": "<p>A list of notifications associated with a budget.</p>"
}
},
"NullableBoolean": {
"base": null,
"refs": {
"CostTypes$IncludeTax": "<p>Specifies whether a budget includes taxes.</p> <p>The default value is <code>true</code>.</p>",
"CostTypes$IncludeSubscription": "<p>Specifies whether a budget includes subscriptions.</p> <p>The default value is <code>true</code>.</p>",
"CostTypes$UseBlended": "<p>Specifies whether a budget uses blended rate.</p> <p>The default value is <code>false</code>.</p>",
"CostTypes$IncludeRefund": "<p>Specifies whether a budget includes refunds.</p> <p>The default value is <code>true</code>.</p>",
"CostTypes$IncludeCredit": "<p>Specifies whether a budget includes credits.</p> <p>The default value is <code>true</code>.</p>",
"CostTypes$IncludeUpfront": "<p>Specifies whether a budget includes upfront RI costs.</p> <p>The default value is <code>true</code>.</p>",
"CostTypes$IncludeRecurring": "<p>Specifies whether a budget includes recurring fees such as monthly RI fees.</p> <p>The default value is <code>true</code>.</p>",
"CostTypes$IncludeOtherSubscription": "<p>Specifies whether a budget includes non-RI subscription costs.</p> <p>The default value is <code>true</code>.</p>",
"CostTypes$IncludeSupport": "<p>Specifies whether a budget includes support subscription fees.</p> <p>The default value is <code>true</code>.</p>",
"CostTypes$IncludeDiscount": "<p>Specifies whether a budget includes discounts.</p> <p>The default value is <code>true</code>.</p>",
"CostTypes$UseAmortized": "<p>Specifies whether a budget uses the amortized rate.</p> <p>The default value is <code>false</code>.</p>"
}
},
"NumericValue": {
"base": "<p> A string to represent NumericValue.</p>",
"refs": {
"Spend$Amount": "<p>The cost or usage amount associated with a budget forecast, actual spend, or budget threshold.</p>"
}
},
"Spend": {
"base": "<p>The amount of cost or usage being measured for a budget.</p> <p>For example, a <code>Spend</code> for <code>3 GB</code> of S3 usage would have the following parameters:</p> <ul> <li> <p>An <code>Amount</code> of <code>3</code> </p> </li> <li> <p>A <code>unit</code> of <code>GB</code> </p> </li> </ul>",
"refs": {
"Budget$BudgetLimit": "<p>The total amount of cost, usage, or RI utilization that you want to track with your budget.</p> <p> <code>BudgetLimit</code> is required for cost or usage budgets, but optional for RI utilization budgets. RI utilization budgets default to the only valid value for RI utilization budgets, which is <code>100</code>.</p>",
"CalculatedSpend$ActualSpend": "<p>The amount of cost, usage, or RI units that you have used.</p>",
"CalculatedSpend$ForecastedSpend": "<p>The amount of cost, usage, or RI units that you are forecasted to use.</p>"
}
},
"Subscriber": {
"base": "<p>The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon Simple Notification Service topic or an email address.</p> <p>For example, an email subscriber would have the following parameters:</p> <ul> <li> <p>A <code>subscriptionType</code> of <code>EMAIL</code> </p> </li> <li> <p>An <code>address</code> of <code>example@example.com</code> </p> </li> </ul>",
"refs": {
"CreateSubscriberRequest$Subscriber": "<p>The subscriber that you want to associate with a budget notification.</p>",
"DeleteSubscriberRequest$Subscriber": "<p>The subscriber that you want to delete.</p>",
"Subscribers$member": null,
"UpdateSubscriberRequest$OldSubscriber": "<p>The previous subscriber associated with a budget notification.</p>",
"UpdateSubscriberRequest$NewSubscriber": "<p>The updated subscriber associated with a budget notification.</p>"
}
},
"SubscriberAddress": {
"base": "<p> String containing email or sns topic for the subscriber address.</p>",
"refs": {
"Subscriber$Address": "<p>The address that AWS sends budget notifications to, either an SNS topic or an email.</p>"
}
},
"Subscribers": {
"base": "<p> A list of subscribers.</p>",
"refs": {
"CreateNotificationRequest$Subscribers": "<p>A list of subscribers that you want to associate with the notification. Each notification can have one SNS subscriber and up to ten email subscribers.</p>",
"DescribeSubscribersForNotificationResponse$Subscribers": "<p>A list of subscribers associated with a notification.</p>",
"NotificationWithSubscribers$Subscribers": "<p>A list of subscribers who are subscribed to this notification.</p>"
}
},
"SubscriptionType": {
"base": "<p> The subscription type of the subscriber. It can be SMS or EMAIL.</p>",
"refs": {
"Subscriber$SubscriptionType": "<p>The type of notification that AWS sends to a subscriber.</p>"
}
},
"ThresholdType": {
"base": "<p> The type of threshold for a notification. It can be PERCENTAGE or ABSOLUTE_VALUE.</p>",
"refs": {
"Notification$ThresholdType": "<p>The type of threshold for a notification. For <code>ACTUAL</code> thresholds, AWS notifies you when you go over the threshold, and for <code>FORECASTED</code> thresholds AWS notifies you when you are forecasted to go over the threshold.</p>"
}
},
"TimePeriod": {
"base": "<p>The period of time covered by a budget. Has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date. </p>",
"refs": {
"Budget$TimePeriod": "<p>The period of time covered by a budget. Has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date. </p> <p>If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (i.e. DAILY, MONTHLY, QUARTERLY, ANNUALLY). For example, if you created your budget on January 24th 2018, chose <code>DAILY</code>, and didn't set a start date, AWS set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, AWS set your start date to <code>01/01/18 00:00 UTC</code>. If you didn't specify an end date, AWS set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API. </p> <p>You can change either date with the <code>UpdateBudget</code> operation.</p> <p>After the end date, AWS deletes the budget and all associated notifications and subscribers.</p>"
}
},
"TimeUnit": {
"base": "<p> The time unit of the budget. e.g. MONTHLY, QUARTERLY, etc.</p>",
"refs": {
"Budget$TimeUnit": "<p>The length of time until a budget resets the actual and forecasted spend.</p>"
}
},
"UnitValue": {
"base": "<p> A string to represent budget spend unit. It should be not null and not empty.</p>",
"refs": {
"Spend$Unit": "<p>The unit of measurement used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.</p>"
}
},
"UpdateBudgetRequest": {
"base": "<p> Request of UpdateBudget </p>",
"refs": {
}
},
"UpdateBudgetResponse": {
"base": "<p> Response of UpdateBudget </p>",
"refs": {
}
},
"UpdateNotificationRequest": {
"base": "<p> Request of UpdateNotification </p>",
"refs": {
}
},
"UpdateNotificationResponse": {
"base": "<p> Response of UpdateNotification </p>",
"refs": {
}
},
"UpdateSubscriberRequest": {
"base": "<p> Request of UpdateSubscriber </p>",
"refs": {
}
},
"UpdateSubscriberResponse": {
"base": "<p> Response of UpdateSubscriber </p>",
"refs": {
}
},
"errorMessage": {
"base": "<p>The error message the exception carries.</p>",
"refs": {
"CreationLimitExceededException$Message": null,
"DuplicateRecordException$Message": null,
"ExpiredNextTokenException$Message": null,
"InternalErrorException$Message": null,
"InvalidNextTokenException$Message": null,
"InvalidParameterException$Message": null,
"NotFoundException$Message": null
}
}
}
}

5
vendor/github.com/aws/aws-sdk-go/models/apis/budgets/2016-10-20/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/budgets/2016-10-20/paginators-1.json generated vendored Normal file
View File

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

687
vendor/github.com/aws/aws-sdk-go/models/apis/ce/2017-10-25/api-2.json generated vendored Normal file
View File

@@ -0,0 +1,687 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2017-10-25",
"endpointPrefix":"ce",
"jsonVersion":"1.1",
"protocol":"json",
"serviceAbbreviation":"AWS Cost Explorer",
"serviceFullName":"AWS Cost Explorer Service",
"serviceId":"Cost Explorer",
"signatureVersion":"v4",
"signingName":"ce",
"targetPrefix":"AWSInsightsIndexService",
"uid":"ce-2017-10-25"
},
"operations":{
"GetCostAndUsage":{
"name":"GetCostAndUsage",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetCostAndUsageRequest"},
"output":{"shape":"GetCostAndUsageResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"BillExpirationException"},
{"shape":"DataUnavailableException"},
{"shape":"InvalidNextTokenException"},
{"shape":"RequestChangedException"}
]
},
"GetDimensionValues":{
"name":"GetDimensionValues",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetDimensionValuesRequest"},
"output":{"shape":"GetDimensionValuesResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"BillExpirationException"},
{"shape":"DataUnavailableException"},
{"shape":"InvalidNextTokenException"},
{"shape":"RequestChangedException"}
]
},
"GetReservationCoverage":{
"name":"GetReservationCoverage",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetReservationCoverageRequest"},
"output":{"shape":"GetReservationCoverageResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"DataUnavailableException"},
{"shape":"InvalidNextTokenException"}
]
},
"GetReservationPurchaseRecommendation":{
"name":"GetReservationPurchaseRecommendation",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetReservationPurchaseRecommendationRequest"},
"output":{"shape":"GetReservationPurchaseRecommendationResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"DataUnavailableException"},
{"shape":"InvalidNextTokenException"}
]
},
"GetReservationUtilization":{
"name":"GetReservationUtilization",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetReservationUtilizationRequest"},
"output":{"shape":"GetReservationUtilizationResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"DataUnavailableException"},
{"shape":"InvalidNextTokenException"}
]
},
"GetTags":{
"name":"GetTags",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetTagsRequest"},
"output":{"shape":"GetTagsResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"BillExpirationException"},
{"shape":"DataUnavailableException"},
{"shape":"InvalidNextTokenException"},
{"shape":"RequestChangedException"}
]
}
},
"shapes":{
"AccountScope":{
"type":"string",
"enum":["PAYER"]
},
"AttributeType":{"type":"string"},
"AttributeValue":{"type":"string"},
"Attributes":{
"type":"map",
"key":{"shape":"AttributeType"},
"value":{"shape":"AttributeValue"}
},
"BillExpirationException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"Context":{
"type":"string",
"enum":[
"COST_AND_USAGE",
"RESERVATIONS"
]
},
"Coverage":{
"type":"structure",
"members":{
"CoverageHours":{"shape":"CoverageHours"}
}
},
"CoverageByTime":{
"type":"structure",
"members":{
"TimePeriod":{"shape":"DateInterval"},
"Groups":{"shape":"ReservationCoverageGroups"},
"Total":{"shape":"Coverage"}
}
},
"CoverageHours":{
"type":"structure",
"members":{
"OnDemandHours":{"shape":"OnDemandHours"},
"ReservedHours":{"shape":"ReservedHours"},
"TotalRunningHours":{"shape":"TotalRunningHours"},
"CoverageHoursPercentage":{"shape":"CoverageHoursPercentage"}
}
},
"CoverageHoursPercentage":{"type":"string"},
"CoveragesByTime":{
"type":"list",
"member":{"shape":"CoverageByTime"}
},
"DataUnavailableException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"DateInterval":{
"type":"structure",
"required":[
"Start",
"End"
],
"members":{
"Start":{"shape":"YearMonthDay"},
"End":{"shape":"YearMonthDay"}
}
},
"Dimension":{
"type":"string",
"enum":[
"AZ",
"INSTANCE_TYPE",
"LINKED_ACCOUNT",
"OPERATION",
"PURCHASE_TYPE",
"REGION",
"SERVICE",
"USAGE_TYPE",
"USAGE_TYPE_GROUP",
"RECORD_TYPE",
"OPERATING_SYSTEM",
"TENANCY",
"SCOPE",
"PLATFORM",
"SUBSCRIPTION_ID",
"LEGAL_ENTITY_NAME",
"DEPLOYMENT_OPTION",
"DATABASE_ENGINE",
"CACHE_ENGINE",
"INSTANCE_TYPE_FAMILY"
]
},
"DimensionValues":{
"type":"structure",
"members":{
"Key":{"shape":"Dimension"},
"Values":{"shape":"Values"}
}
},
"DimensionValuesWithAttributes":{
"type":"structure",
"members":{
"Value":{"shape":"Value"},
"Attributes":{"shape":"Attributes"}
}
},
"DimensionValuesWithAttributesList":{
"type":"list",
"member":{"shape":"DimensionValuesWithAttributes"}
},
"EC2InstanceDetails":{
"type":"structure",
"members":{
"Family":{"shape":"GenericString"},
"InstanceType":{"shape":"GenericString"},
"Region":{"shape":"GenericString"},
"AvailabilityZone":{"shape":"GenericString"},
"Platform":{"shape":"GenericString"},
"Tenancy":{"shape":"GenericString"},
"CurrentGeneration":{"shape":"GenericBoolean"},
"SizeFlexEligible":{"shape":"GenericBoolean"}
}
},
"EC2Specification":{
"type":"structure",
"members":{
"OfferingClass":{"shape":"OfferingClass"}
}
},
"Entity":{"type":"string"},
"ErrorMessage":{"type":"string"},
"Estimated":{"type":"boolean"},
"Expression":{
"type":"structure",
"members":{
"Or":{"shape":"Expressions"},
"And":{"shape":"Expressions"},
"Not":{"shape":"Expression"},
"Dimensions":{"shape":"DimensionValues"},
"Tags":{"shape":"TagValues"}
}
},
"Expressions":{
"type":"list",
"member":{"shape":"Expression"}
},
"GenericBoolean":{"type":"boolean"},
"GenericString":{"type":"string"},
"GetCostAndUsageRequest":{
"type":"structure",
"members":{
"TimePeriod":{"shape":"DateInterval"},
"Granularity":{"shape":"Granularity"},
"Filter":{"shape":"Expression"},
"Metrics":{"shape":"MetricNames"},
"GroupBy":{"shape":"GroupDefinitions"},
"NextPageToken":{"shape":"NextPageToken"}
}
},
"GetCostAndUsageResponse":{
"type":"structure",
"members":{
"NextPageToken":{"shape":"NextPageToken"},
"GroupDefinitions":{"shape":"GroupDefinitions"},
"ResultsByTime":{"shape":"ResultsByTime"}
}
},
"GetDimensionValuesRequest":{
"type":"structure",
"required":[
"TimePeriod",
"Dimension"
],
"members":{
"SearchString":{"shape":"SearchString"},
"TimePeriod":{"shape":"DateInterval"},
"Dimension":{"shape":"Dimension"},
"Context":{"shape":"Context"},
"NextPageToken":{"shape":"NextPageToken"}
}
},
"GetDimensionValuesResponse":{
"type":"structure",
"required":[
"DimensionValues",
"ReturnSize",
"TotalSize"
],
"members":{
"DimensionValues":{"shape":"DimensionValuesWithAttributesList"},
"ReturnSize":{"shape":"PageSize"},
"TotalSize":{"shape":"PageSize"},
"NextPageToken":{"shape":"NextPageToken"}
}
},
"GetReservationCoverageRequest":{
"type":"structure",
"required":["TimePeriod"],
"members":{
"TimePeriod":{"shape":"DateInterval"},
"GroupBy":{"shape":"GroupDefinitions"},
"Granularity":{"shape":"Granularity"},
"Filter":{"shape":"Expression"},
"NextPageToken":{"shape":"NextPageToken"}
}
},
"GetReservationCoverageResponse":{
"type":"structure",
"required":["CoveragesByTime"],
"members":{
"CoveragesByTime":{"shape":"CoveragesByTime"},
"Total":{"shape":"Coverage"},
"NextPageToken":{"shape":"NextPageToken"}
}
},
"GetReservationPurchaseRecommendationRequest":{
"type":"structure",
"required":["Service"],
"members":{
"AccountId":{"shape":"GenericString"},
"Service":{"shape":"GenericString"},
"AccountScope":{"shape":"AccountScope"},
"LookbackPeriodInDays":{"shape":"LookbackPeriodInDays"},
"TermInYears":{"shape":"TermInYears"},
"PaymentOption":{"shape":"PaymentOption"},
"ServiceSpecification":{"shape":"ServiceSpecification"},
"PageSize":{"shape":"NonNegativeInteger"},
"NextPageToken":{"shape":"NextPageToken"}
}
},
"GetReservationPurchaseRecommendationResponse":{
"type":"structure",
"members":{
"Metadata":{"shape":"ReservationPurchaseRecommendationMetadata"},
"Recommendations":{"shape":"ReservationPurchaseRecommendations"},
"NextPageToken":{"shape":"NextPageToken"}
}
},
"GetReservationUtilizationRequest":{
"type":"structure",
"required":["TimePeriod"],
"members":{
"TimePeriod":{"shape":"DateInterval"},
"GroupBy":{"shape":"GroupDefinitions"},
"Granularity":{"shape":"Granularity"},
"Filter":{"shape":"Expression"},
"NextPageToken":{"shape":"NextPageToken"}
}
},
"GetReservationUtilizationResponse":{
"type":"structure",
"required":["UtilizationsByTime"],
"members":{
"UtilizationsByTime":{"shape":"UtilizationsByTime"},
"Total":{"shape":"ReservationAggregates"},
"NextPageToken":{"shape":"NextPageToken"}
}
},
"GetTagsRequest":{
"type":"structure",
"required":["TimePeriod"],
"members":{
"SearchString":{"shape":"SearchString"},
"TimePeriod":{"shape":"DateInterval"},
"TagKey":{"shape":"TagKey"},
"NextPageToken":{"shape":"NextPageToken"}
}
},
"GetTagsResponse":{
"type":"structure",
"required":[
"Tags",
"ReturnSize",
"TotalSize"
],
"members":{
"NextPageToken":{"shape":"NextPageToken"},
"Tags":{"shape":"TagList"},
"ReturnSize":{"shape":"PageSize"},
"TotalSize":{"shape":"PageSize"}
}
},
"Granularity":{
"type":"string",
"enum":[
"DAILY",
"MONTHLY"
]
},
"Group":{
"type":"structure",
"members":{
"Keys":{"shape":"Keys"},
"Metrics":{"shape":"Metrics"}
}
},
"GroupDefinition":{
"type":"structure",
"members":{
"Type":{"shape":"GroupDefinitionType"},
"Key":{"shape":"GroupDefinitionKey"}
}
},
"GroupDefinitionKey":{"type":"string"},
"GroupDefinitionType":{
"type":"string",
"enum":[
"DIMENSION",
"TAG"
]
},
"GroupDefinitions":{
"type":"list",
"member":{"shape":"GroupDefinition"}
},
"Groups":{
"type":"list",
"member":{"shape":"Group"}
},
"InstanceDetails":{
"type":"structure",
"members":{
"EC2InstanceDetails":{"shape":"EC2InstanceDetails"},
"RDSInstanceDetails":{"shape":"RDSInstanceDetails"}
}
},
"InvalidNextTokenException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"Key":{"type":"string"},
"Keys":{
"type":"list",
"member":{"shape":"Key"}
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"LookbackPeriodInDays":{
"type":"string",
"enum":[
"SEVEN_DAYS",
"THIRTY_DAYS",
"SIXTY_DAYS"
]
},
"MetricAmount":{"type":"string"},
"MetricName":{"type":"string"},
"MetricNames":{
"type":"list",
"member":{"shape":"MetricName"}
},
"MetricUnit":{"type":"string"},
"MetricValue":{
"type":"structure",
"members":{
"Amount":{"shape":"MetricAmount"},
"Unit":{"shape":"MetricUnit"}
}
},
"Metrics":{
"type":"map",
"key":{"shape":"MetricName"},
"value":{"shape":"MetricValue"}
},
"NextPageToken":{"type":"string"},
"NonNegativeInteger":{
"type":"integer",
"min":0
},
"OfferingClass":{
"type":"string",
"enum":[
"STANDARD",
"CONVERTIBLE"
]
},
"OnDemandHours":{"type":"string"},
"PageSize":{"type":"integer"},
"PaymentOption":{
"type":"string",
"enum":[
"NO_UPFRONT",
"PARTIAL_UPFRONT",
"ALL_UPFRONT"
]
},
"PurchasedHours":{"type":"string"},
"RDSInstanceDetails":{
"type":"structure",
"members":{
"Family":{"shape":"GenericString"},
"InstanceType":{"shape":"GenericString"},
"Region":{"shape":"GenericString"},
"DatabaseEngine":{"shape":"GenericString"},
"DeploymentOption":{"shape":"GenericString"},
"LicenseModel":{"shape":"GenericString"},
"CurrentGeneration":{"shape":"GenericBoolean"},
"SizeFlexEligible":{"shape":"GenericBoolean"}
}
},
"RequestChangedException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"exception":true
},
"ReservationAggregates":{
"type":"structure",
"members":{
"UtilizationPercentage":{"shape":"UtilizationPercentage"},
"PurchasedHours":{"shape":"PurchasedHours"},
"TotalActualHours":{"shape":"TotalActualHours"},
"UnusedHours":{"shape":"UnusedHours"}
}
},
"ReservationCoverageGroup":{
"type":"structure",
"members":{
"Attributes":{"shape":"Attributes"},
"Coverage":{"shape":"Coverage"}
}
},
"ReservationCoverageGroups":{
"type":"list",
"member":{"shape":"ReservationCoverageGroup"}
},
"ReservationGroupKey":{"type":"string"},
"ReservationGroupValue":{"type":"string"},
"ReservationPurchaseRecommendation":{
"type":"structure",
"members":{
"AccountScope":{"shape":"AccountScope"},
"LookbackPeriodInDays":{"shape":"LookbackPeriodInDays"},
"TermInYears":{"shape":"TermInYears"},
"PaymentOption":{"shape":"PaymentOption"},
"ServiceSpecification":{"shape":"ServiceSpecification"},
"RecommendationDetails":{"shape":"ReservationPurchaseRecommendationDetails"},
"RecommendationSummary":{"shape":"ReservationPurchaseRecommendationSummary"}
}
},
"ReservationPurchaseRecommendationDetail":{
"type":"structure",
"members":{
"InstanceDetails":{"shape":"InstanceDetails"},
"RecommendedNumberOfInstancesToPurchase":{"shape":"GenericString"},
"RecommendedNormalizedUnitsToPurchase":{"shape":"GenericString"},
"MinimumNumberOfInstancesUsedPerHour":{"shape":"GenericString"},
"MinimumNormalizedUnitsUsedPerHour":{"shape":"GenericString"},
"MaximumNumberOfInstancesUsedPerHour":{"shape":"GenericString"},
"MaximumNormalizedUnitsUsedPerHour":{"shape":"GenericString"},
"AverageNumberOfInstancesUsedPerHour":{"shape":"GenericString"},
"AverageNormalizedUnitsUsedPerHour":{"shape":"GenericString"},
"AverageUtilization":{"shape":"GenericString"},
"EstimatedBreakEvenInMonths":{"shape":"GenericString"},
"CurrencyCode":{"shape":"GenericString"},
"EstimatedMonthlySavingsAmount":{"shape":"GenericString"},
"EstimatedMonthlySavingsPercentage":{"shape":"GenericString"},
"EstimatedMonthlyOnDemandCost":{"shape":"GenericString"},
"EstimatedReservationCostForLookbackPeriod":{"shape":"GenericString"},
"UpfrontCost":{"shape":"GenericString"},
"RecurringStandardMonthlyCost":{"shape":"GenericString"}
}
},
"ReservationPurchaseRecommendationDetails":{
"type":"list",
"member":{"shape":"ReservationPurchaseRecommendationDetail"}
},
"ReservationPurchaseRecommendationMetadata":{
"type":"structure",
"members":{
"RecommendationId":{"shape":"GenericString"},
"GenerationTimestamp":{"shape":"GenericString"}
}
},
"ReservationPurchaseRecommendationSummary":{
"type":"structure",
"members":{
"TotalEstimatedMonthlySavingsAmount":{"shape":"GenericString"},
"TotalEstimatedMonthlySavingsPercentage":{"shape":"GenericString"},
"CurrencyCode":{"shape":"GenericString"}
}
},
"ReservationPurchaseRecommendations":{
"type":"list",
"member":{"shape":"ReservationPurchaseRecommendation"}
},
"ReservationUtilizationGroup":{
"type":"structure",
"members":{
"Key":{"shape":"ReservationGroupKey"},
"Value":{"shape":"ReservationGroupValue"},
"Attributes":{"shape":"Attributes"},
"Utilization":{"shape":"ReservationAggregates"}
}
},
"ReservationUtilizationGroups":{
"type":"list",
"member":{"shape":"ReservationUtilizationGroup"}
},
"ReservedHours":{"type":"string"},
"ResultByTime":{
"type":"structure",
"members":{
"TimePeriod":{"shape":"DateInterval"},
"Total":{"shape":"Metrics"},
"Groups":{"shape":"Groups"},
"Estimated":{"shape":"Estimated"}
}
},
"ResultsByTime":{
"type":"list",
"member":{"shape":"ResultByTime"}
},
"SearchString":{"type":"string"},
"ServiceSpecification":{
"type":"structure",
"members":{
"EC2Specification":{"shape":"EC2Specification"}
}
},
"TagKey":{"type":"string"},
"TagList":{
"type":"list",
"member":{"shape":"Entity"}
},
"TagValues":{
"type":"structure",
"members":{
"Key":{"shape":"TagKey"},
"Values":{"shape":"Values"}
}
},
"TermInYears":{
"type":"string",
"enum":[
"ONE_YEAR",
"THREE_YEARS"
]
},
"TotalActualHours":{"type":"string"},
"TotalRunningHours":{"type":"string"},
"UnusedHours":{"type":"string"},
"UtilizationByTime":{
"type":"structure",
"members":{
"TimePeriod":{"shape":"DateInterval"},
"Groups":{"shape":"ReservationUtilizationGroups"},
"Total":{"shape":"ReservationAggregates"}
}
},
"UtilizationPercentage":{"type":"string"},
"UtilizationsByTime":{
"type":"list",
"member":{"shape":"UtilizationByTime"}
},
"Value":{"type":"string"},
"Values":{
"type":"list",
"member":{"shape":"Value"}
},
"YearMonthDay":{
"type":"string",
"pattern":"\\d{4}-\\d{2}-\\d{2}"
}
}
}

671
vendor/github.com/aws/aws-sdk-go/models/apis/ce/2017-10-25/docs-2.json generated vendored Normal file
View File

@@ -0,0 +1,671 @@
{
"version": "2.0",
"service": "<p>The Cost Explorer API allows you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for Amazon DynamoDB database tables in your production environment. </p> <p>Service Endpoint</p> <p>The Cost Explorer API provides the following endpoint:</p> <ul> <li> <p>https://ce.us-east-1.amazonaws.com</p> </li> </ul> <p>For information about costs associated with the Cost Explorer API, see <a href=\"https://aws.amazon.com/aws-cost-management/pricing/\">AWS Cost Management Pricing</a>.</p>",
"operations": {
"GetCostAndUsage": "<p>Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as <code>BlendedCosts</code> or <code>UsageQuantity</code>, that you want the request to return. You can also filter and group your data by various dimensions, such as <code>SERVICE</code> or <code>AZ</code>, in a specific time range. For a complete list of valid dimensions, see the <code> <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html\">GetDimensionValues</a> </code> operation. Master accounts in an organization in AWS Organizations have access to all member accounts.</p>",
"GetDimensionValues": "<p>Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string. </p>",
"GetReservationCoverage": "<p>Retrieves the reservation coverage for your account. This allows you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's master account can see the coverage of the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>TAG</p> </li> <li> <p>TENANCY</p> </li> </ul> <p>To determine valid values for a dimension, use the <code>GetDimensionValues</code> operation. </p>",
"GetReservationPurchaseRecommendation": "<p>Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.</p> <p>AWS generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After AWS has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings. </p> <p>For example, AWS automatically aggregates your EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for <code>c4.large</code>, because that is the smallest size instance in the c4 instance family.</p>",
"GetReservationUtilization": "<p>Retrieves the reservation utilization for your account. Master accounts in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use <code>GetDimensionValues</code> to determine the possible dimension values. Currently, you can group only by <code>SUBSCRIPTION_ID</code>. </p>",
"GetTags": "<p>Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string. </p>"
},
"shapes": {
"AccountScope": {
"base": null,
"refs": {
"GetReservationPurchaseRecommendationRequest$AccountScope": "<p>The account scope that you want recommendations for. The only valid value is <code>Payer</code>. This means that AWS includes the master account and any member accounts when it calculates its recommendations.</p>",
"ReservationPurchaseRecommendation$AccountScope": "<p>The account scope that AWS recommends that you purchase this instance for. For example, you can purchase this reservation for an entire organization in AWS Organizations.</p>"
}
},
"AttributeType": {
"base": null,
"refs": {
"Attributes$key": null
}
},
"AttributeValue": {
"base": null,
"refs": {
"Attributes$value": null
}
},
"Attributes": {
"base": null,
"refs": {
"DimensionValuesWithAttributes$Attributes": "<p>The attribute that applies to a specific <code>Dimension</code>.</p>",
"ReservationCoverageGroup$Attributes": "<p>The attributes for this group of reservations.</p>",
"ReservationUtilizationGroup$Attributes": "<p>The attributes for this group of RIs.</p>"
}
},
"BillExpirationException": {
"base": "<p>The requested report expired. Update the date interval and try again.</p>",
"refs": {
}
},
"Context": {
"base": null,
"refs": {
"GetDimensionValuesRequest$Context": "<p>The context for the call to <code>GetDimensionValues</code>. This can be <code>RESERVATIONS</code> or <code>COST_AND_USAGE</code>. The default value is <code>COST_AND_USAGE</code>. If the context is set to <code>RESERVATIONS</code>, the resulting dimension values can be used in the <code>GetReservationUtilization</code> operation. If the context is set to <code>COST_AND_USAGE</code> the resulting dimension values can be used in the <code>GetCostAndUsage</code> operation.</p> <p>If you set the context to <code>COST_AND_USAGE</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.</p> </li> <li> <p>INSTANCE_TYPE - The type of EC2 instance. An example is <code>m4.xlarge</code>.</p> </li> <li> <p>LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.</p> </li> <li> <p>OPERATION - The action performed. Examples include <code>RunInstance</code> and <code>CreateBucket</code>.</p> </li> <li> <p>PLATFORM - The EC2 operating system. Examples are Windows or Linux.</p> </li> <li> <p>PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.</p> </li> <li> <p>SERVICE - The AWS service such as Amazon DynamoDB.</p> </li> <li> <p>USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the <code>GetDimensionValues</code> operation includes a unit attribute. Examples include GB and Hrs.</p> </li> <li> <p>USAGE_TYPE_GROUP - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.</p> </li> <li> <p>RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.</p> </li> </ul> <p>If you set the context to <code>RESERVATIONS</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.</p> </li> <li> <p>DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are <code>SingleAZ</code> and <code>MultiAZ</code>.</p> </li> <li> <p>INSTANCE_TYPE - The type of EC2 instance. An example is <code>m4.xlarge</code>.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>PLATFORM - The EC2 operating system. Examples are Windows or Linux.</p> </li> <li> <p>REGION - The AWS Region.</p> </li> <li> <p>SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.</p> </li> <li> <p>TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).</p> </li> <li> <p>TENANCY - The tenancy of a resource. Examples are shared or dedicated.</p> </li> </ul>"
}
},
"Coverage": {
"base": "<p>The amount of instance usage that a reservation covered.</p>",
"refs": {
"CoverageByTime$Total": "<p>The total reservation coverage, in hours.</p>",
"GetReservationCoverageResponse$Total": "<p>The total amount of instance usage that is covered by a reservation.</p>",
"ReservationCoverageGroup$Coverage": "<p>How much instance usage this group of reservations covered.</p>"
}
},
"CoverageByTime": {
"base": "<p>Reservation coverage for a specified period, in hours.</p>",
"refs": {
"CoveragesByTime$member": null
}
},
"CoverageHours": {
"base": "<p>How long a running instance either used a reservation or was On-Demand.</p>",
"refs": {
"Coverage$CoverageHours": "<p>The amount of instance usage that a reservation covered, in hours.</p>"
}
},
"CoverageHoursPercentage": {
"base": null,
"refs": {
"CoverageHours$CoverageHoursPercentage": "<p>The percentage of instance hours that are covered by a reservation.</p>"
}
},
"CoveragesByTime": {
"base": null,
"refs": {
"GetReservationCoverageResponse$CoveragesByTime": "<p>The amount of time that your reservations covered.</p>"
}
},
"DataUnavailableException": {
"base": "<p>The requested data is unavailable.</p>",
"refs": {
}
},
"DateInterval": {
"base": "<p>The time period that you want the usage and costs for. </p>",
"refs": {
"CoverageByTime$TimePeriod": "<p>The period over which this coverage was used.</p>",
"GetCostAndUsageRequest$TimePeriod": "<p>Sets the start and end dates for retrieving AWS costs. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>.</p>",
"GetDimensionValuesRequest$TimePeriod": "<p>The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>.</p>",
"GetReservationCoverageRequest$TimePeriod": "<p>The start and end dates of the period for which you want to retrieve data about reservation coverage. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. </p>",
"GetReservationUtilizationRequest$TimePeriod": "<p>Sets the start and end dates for retrieving Reserved Instance (RI) utilization. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. </p>",
"GetTagsRequest$TimePeriod": "<p>The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>.</p>",
"ResultByTime$TimePeriod": "<p>The time period covered by a result.</p>",
"UtilizationByTime$TimePeriod": "<p>The period of time over which this utilization was used.</p>"
}
},
"Dimension": {
"base": null,
"refs": {
"DimensionValues$Key": "<p>The names of the metadata types that you can use to filter and group your results. For example, <code>AZ</code> returns a list of Availability Zones.</p>",
"GetDimensionValuesRequest$Dimension": "<p>The name of the dimension. Each <code>Dimension</code> is available for different a <code>Context</code>. For more information, see <code>Context</code>.</p>"
}
},
"DimensionValues": {
"base": "<p>The metadata that you can use to filter and group your results. You can use <code>GetDimensionValues</code> to find specific values.</p>",
"refs": {
"Expression$Dimensions": "<p>The specific <code>Dimension</code> to use for <code>Expression</code>.</p>"
}
},
"DimensionValuesWithAttributes": {
"base": "<p>The metadata of a specific type that you can use to filter and group your results. You can use <code>GetDimensionValues</code> to find specific values.</p>",
"refs": {
"DimensionValuesWithAttributesList$member": null
}
},
"DimensionValuesWithAttributesList": {
"base": null,
"refs": {
"GetDimensionValuesResponse$DimensionValues": "<p>The filters that you used to filter your request. Some dimensions are available only for a specific context:</p> <p>If you set the context to <code>COST_AND_USAGE</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.</p> </li> <li> <p>INSTANCE_TYPE - The type of EC2 instance. An example is <code>m4.xlarge</code>.</p> </li> <li> <p>LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.</p> </li> <li> <p>OPERATION - The action performed. Examples include <code>RunInstance</code> and <code>CreateBucket</code>.</p> </li> <li> <p>PLATFORM - The EC2 operating system. Examples are Windows or Linux.</p> </li> <li> <p>PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.</p> </li> <li> <p>SERVICE - The AWS service such as Amazon DynamoDB.</p> </li> <li> <p>USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the <code>GetDimensionValues</code> operation includes a unit attribute. Examples include GB and Hrs.</p> </li> <li> <p>USAGE_TYPE_GROUP - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.</p> </li> <li> <p>RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.</p> </li> </ul> <p>If you set the context to <code>RESERVATIONS</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.</p> </li> <li> <p>DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are <code>SingleAZ</code> and <code>MultiAZ</code>.</p> </li> <li> <p>INSTANCE_TYPE - The type of EC2 instance. An example is <code>m4.xlarge</code>.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>PLATFORM - The EC2 operating system. Examples are Windows or Linux.</p> </li> <li> <p>REGION - The AWS Region.</p> </li> <li> <p>SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.</p> </li> <li> <p>TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).</p> </li> <li> <p>TENANCY - The tenancy of a resource. Examples are shared or dedicated.</p> </li> </ul>"
}
},
"EC2InstanceDetails": {
"base": "<p>Details about the EC2 instances that AWS recommends that you purchase.</p>",
"refs": {
"InstanceDetails$EC2InstanceDetails": "<p>The EC2 instances that AWS recommends that you purchase.</p>"
}
},
"EC2Specification": {
"base": "<p>The EC2 hardware specifications that you want AWS to provide recommendations for.</p>",
"refs": {
"ServiceSpecification$EC2Specification": "<p>The EC2 hardware specifications that you want AWS to provide recommendations for.</p>"
}
},
"Entity": {
"base": null,
"refs": {
"TagList$member": null
}
},
"ErrorMessage": {
"base": null,
"refs": {
"BillExpirationException$Message": null,
"DataUnavailableException$Message": null,
"InvalidNextTokenException$Message": null,
"LimitExceededException$Message": null,
"RequestChangedException$Message": null
}
},
"Estimated": {
"base": null,
"refs": {
"ResultByTime$Estimated": "<p>Whether this result is estimated.</p>"
}
},
"Expression": {
"base": "<p>Use <code>Expression</code> to filter by cost or by usage. There are two patterns: </p> <ul> <li> <p>Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for <code>INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large</code>. The <code>Expression</code> for that looks like this:</p> <p> <code>{ \"Dimensions\": { \"Key\": \"INSTANCE_TYPE\", \"Values\": [ \"m4.xlarge\", “c4.large” ] } }</code> </p> <p>The list of dimension values are OR'd together to retrieve cost or usage data. You can create <code>Expression</code> and <code>DimensionValues</code> objects using either <code>with*</code> methods or <code>set*</code> methods in multiple lines. </p> </li> <li> <p>Compound dimension values with logical operations - You can use multiple <code>Expression</code> types and the logical operators <code>AND/OR/NOT</code> to create a list of one or more <code>Expression</code> objects. This allows you to filter on more advanced options. For example, you can filter on <code>((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)</code>. The <code>Expression</code> for that looks like this:</p> <p> <code>{ \"And\": [ {\"Or\": [ {\"Dimensions\": { \"Key\": \"INSTANCE_TYPE\", \"Values\": [ \"m4.x.large\", \"c4.large\" ] }}, {\"Tag\": { \"Key\": \"TagName\", \"Values\": [\"Value1\"] } } ]}, {\"Not\": {\"dimensions\": { \"Key\": \"USAGE_TYPE\", \"Values\": [\"DataTransfer\"] }}} ] } </code> </p> <note> <p>Because each <code>Expression</code> can have only one operator, the service returns an error if more than one is specified. The following example shows an <code>Expression</code> object that creates an error.</p> </note> <p> <code> { \"And\": [ ... ], \"DimensionValues\": { \"Dimension\": \"USAGE_TYPE\", \"Values\": [ \"DataTransfer\" ] } } </code> </p> </li> </ul>",
"refs": {
"Expression$Not": "<p>Return results that don't match a <code>Dimension</code> object.</p>",
"Expressions$member": null,
"GetCostAndUsageRequest$Filter": "<p>Filters AWS costs by different dimensions. For example, you can specify <code>SERVICE</code> and <code>LINKED_ACCOUNT</code> and get the costs that are associated with that account's usage of that service. You can nest <code>Expression</code> objects to define any combination of dimension filters. For more information, see <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a>. </p>",
"GetReservationCoverageRequest$Filter": "<p>Filters utilization data by dimensions. You can filter by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>TAG</p> </li> <li> <p>TENANCY</p> </li> </ul> <p> <code>GetReservationCoverage</code> uses the same <code> <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> </code> object as the other operations, but only <code>AND</code> is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.</p>",
"GetReservationUtilizationRequest$Filter": "<p>Filters utilization data by dimensions. You can filter by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>SCOPE</p> </li> <li> <p>TENANCY</p> </li> </ul> <p> <code>GetReservationUtilization</code> uses the same <code> <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> </code> object as the other operations, but only <code>AND</code> is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.</p>"
}
},
"Expressions": {
"base": null,
"refs": {
"Expression$Or": "<p>Return results that match either <code>Dimension</code> object.</p>",
"Expression$And": "<p>Return results that match both <code>Dimension</code> objects.</p>"
}
},
"GenericBoolean": {
"base": null,
"refs": {
"EC2InstanceDetails$CurrentGeneration": "<p>Whether the recommendation is for a current generation instance. </p>",
"EC2InstanceDetails$SizeFlexEligible": "<p>Whether the recommended reservation is size flexible.</p>",
"RDSInstanceDetails$CurrentGeneration": "<p>Whether the recommendation is for a current generation instance. </p>",
"RDSInstanceDetails$SizeFlexEligible": "<p>Whether the recommended reservation is size flexible.</p>"
}
},
"GenericString": {
"base": null,
"refs": {
"EC2InstanceDetails$Family": "<p>The instance family of the recommended reservation.</p>",
"EC2InstanceDetails$InstanceType": "<p>The type of instance that AWS recommends.</p>",
"EC2InstanceDetails$Region": "<p>The AWS Region of the recommended reservation.</p>",
"EC2InstanceDetails$AvailabilityZone": "<p>The Availability Zone of the recommended reservation.</p>",
"EC2InstanceDetails$Platform": "<p>The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.</p>",
"EC2InstanceDetails$Tenancy": "<p>Whether the recommended reservation is dedicated or shared.</p>",
"GetReservationPurchaseRecommendationRequest$AccountId": "<p>The account ID that is associated with the recommendation. </p>",
"GetReservationPurchaseRecommendationRequest$Service": "<p>The specific service that you want recommendations for.</p>",
"RDSInstanceDetails$Family": "<p>The instance family of the recommended reservation.</p>",
"RDSInstanceDetails$InstanceType": "<p>The type of instance that AWS recommends.</p>",
"RDSInstanceDetails$Region": "<p>The AWS Region of the recommended reservation.</p>",
"RDSInstanceDetails$DatabaseEngine": "<p>The database engine that the recommended reservation supports.</p>",
"RDSInstanceDetails$DeploymentOption": "<p>Whether the recommendation is for a reservation in a single availability zone or a reservation with a backup in a second availability zone.</p>",
"RDSInstanceDetails$LicenseModel": "<p>The license model that the recommended reservation supports.</p>",
"ReservationPurchaseRecommendationDetail$RecommendedNumberOfInstancesToPurchase": "<p>The number of instances that AWS recommends that you purchase.</p>",
"ReservationPurchaseRecommendationDetail$RecommendedNormalizedUnitsToPurchase": "<p>The number of normalized units that AWS recommends that you purchase.</p>",
"ReservationPurchaseRecommendationDetail$MinimumNumberOfInstancesUsedPerHour": "<p>The minimum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$MinimumNormalizedUnitsUsedPerHour": "<p>The minimum number of hours that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$MaximumNumberOfInstancesUsedPerHour": "<p>The maximum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$MaximumNormalizedUnitsUsedPerHour": "<p>The maximum number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$AverageNumberOfInstancesUsedPerHour": "<p>The average number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$AverageNormalizedUnitsUsedPerHour": "<p>The average number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$AverageUtilization": "<p>The average utilization of your instances. AWS uses this to calculate your recommended reservation purchases.</p>",
"ReservationPurchaseRecommendationDetail$EstimatedBreakEvenInMonths": "<p>How long AWS estimates that it takes for this instance to start saving you money, in months.</p>",
"ReservationPurchaseRecommendationDetail$CurrencyCode": "<p>The currency code that AWS used to calculate the costs for this instance.</p>",
"ReservationPurchaseRecommendationDetail$EstimatedMonthlySavingsAmount": "<p>How much AWS estimates that this specific recommendation could save you in a month.</p>",
"ReservationPurchaseRecommendationDetail$EstimatedMonthlySavingsPercentage": "<p>How much AWS estimates that this specific recommendation could save you in a month, as a percentage of your overall costs.</p>",
"ReservationPurchaseRecommendationDetail$EstimatedMonthlyOnDemandCost": "<p>How much AWS estimates that you spend on On-Demand Instances in a month.</p>",
"ReservationPurchaseRecommendationDetail$EstimatedReservationCostForLookbackPeriod": "<p>How much AWS estimates that you would have spent for all usage during the specified historical period if you had had a reservation.</p>",
"ReservationPurchaseRecommendationDetail$UpfrontCost": "<p>How much purchasing this instance costs you upfront.</p>",
"ReservationPurchaseRecommendationDetail$RecurringStandardMonthlyCost": "<p>How much purchasing this instance costs you on a monthly basis.</p>",
"ReservationPurchaseRecommendationMetadata$RecommendationId": "<p>The ID for this specific recommendation.</p>",
"ReservationPurchaseRecommendationMetadata$GenerationTimestamp": "<p>The time stamp for when AWS made this recommendation.</p>",
"ReservationPurchaseRecommendationSummary$TotalEstimatedMonthlySavingsAmount": "<p>The total amount that AWS estimates that this recommendation could save you in a month.</p>",
"ReservationPurchaseRecommendationSummary$TotalEstimatedMonthlySavingsPercentage": "<p>The total amount that AWS estimates that this recommendation could save you in a month, as a percentage of your costs.</p>",
"ReservationPurchaseRecommendationSummary$CurrencyCode": "<p>The currency code used for this recommendation.</p>"
}
},
"GetCostAndUsageRequest": {
"base": null,
"refs": {
}
},
"GetCostAndUsageResponse": {
"base": null,
"refs": {
}
},
"GetDimensionValuesRequest": {
"base": null,
"refs": {
}
},
"GetDimensionValuesResponse": {
"base": null,
"refs": {
}
},
"GetReservationCoverageRequest": {
"base": "<p>You can use the following request parameters to query for how much of your instance usage is covered by a reservation.</p>",
"refs": {
}
},
"GetReservationCoverageResponse": {
"base": null,
"refs": {
}
},
"GetReservationPurchaseRecommendationRequest": {
"base": null,
"refs": {
}
},
"GetReservationPurchaseRecommendationResponse": {
"base": null,
"refs": {
}
},
"GetReservationUtilizationRequest": {
"base": null,
"refs": {
}
},
"GetReservationUtilizationResponse": {
"base": null,
"refs": {
}
},
"GetTagsRequest": {
"base": null,
"refs": {
}
},
"GetTagsResponse": {
"base": null,
"refs": {
}
},
"Granularity": {
"base": null,
"refs": {
"GetCostAndUsageRequest$Granularity": "<p>Sets the AWS cost granularity to <code>MONTHLY</code> or <code>DAILY</code>. If <code>Granularity</code> isn't set, the response object doesn't include the <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>. </p>",
"GetReservationCoverageRequest$Granularity": "<p>The granularity of the AWS cost data for the reservation. Valid values are <code>MONTHLY</code> and <code>DAILY</code>.</p> <p>If <code>GroupBy</code> is set, <code>Granularity</code> can't be set. If <code>Granularity</code> isn't set, the response object doesn't include <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>.</p>",
"GetReservationUtilizationRequest$Granularity": "<p>If <code>GroupBy</code> is set, <code>Granularity</code> can't be set. If <code>Granularity</code> isn't set, the response object doesn't include <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>. If both <code>GroupBy</code> and <code>Granularity</code> aren't set, <code>GetReservationUtilization</code> defaults to <code>DAILY</code>.</p>"
}
},
"Group": {
"base": "<p>One level of grouped data within the results.</p>",
"refs": {
"Groups$member": null
}
},
"GroupDefinition": {
"base": "<p>Represents a group when you specify a group by criteria, or in the response to a query with a specific grouping.</p>",
"refs": {
"GroupDefinitions$member": null
}
},
"GroupDefinitionKey": {
"base": null,
"refs": {
"GroupDefinition$Key": "<p>The string that represents a key for a specified group.</p>"
}
},
"GroupDefinitionType": {
"base": null,
"refs": {
"GroupDefinition$Type": "<p>The string that represents the type of group.</p>"
}
},
"GroupDefinitions": {
"base": null,
"refs": {
"GetCostAndUsageRequest$GroupBy": "<p>You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.</p> <p>When you group by tag key, you get all tag values, including empty strings.</p> <p>Valid values are <code>AZ</code>, <code>INSTANCE_TYPE</code>, <code>LEGAL_ENTITY_NAME</code>, <code>LINKED_ACCOUNT</code>, <code>OPERATION</code>, <code>PLATFORM</code>, <code>PURCHASE_TYPE</code>, <code>SERVICE</code>, <code>TAGS</code>, <code>TENANCY</code>, and <code>USAGE_TYPE</code>.</p>",
"GetCostAndUsageResponse$GroupDefinitions": "<p>The groups that are specified by the <code>Filter</code> or <code>GroupBy</code> parameters in the request.</p>",
"GetReservationCoverageRequest$GroupBy": "<p>You can group the data by the following attributes:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>TAG</p> </li> <li> <p>TENANCY</p> </li> </ul>",
"GetReservationUtilizationRequest$GroupBy": "<p>Groups only by <code>SUBSCRIPTION_ID</code>. Metadata is included.</p>"
}
},
"Groups": {
"base": null,
"refs": {
"ResultByTime$Groups": "<p>The groups that are included in this time period.</p>"
}
},
"InstanceDetails": {
"base": "<p>Details about the instances that AWS recommends that you purchase.</p>",
"refs": {
"ReservationPurchaseRecommendationDetail$InstanceDetails": "<p>Details about the instances that AWS recommends that you purchase.</p>"
}
},
"InvalidNextTokenException": {
"base": "<p>The pagination token is invalid. Try again without a pagination token.</p>",
"refs": {
}
},
"Key": {
"base": null,
"refs": {
"Keys$member": null
}
},
"Keys": {
"base": null,
"refs": {
"Group$Keys": "<p>The keys that are included in this group.</p>"
}
},
"LimitExceededException": {
"base": "<p>You made too many calls in a short period of time. Try again later.</p>",
"refs": {
}
},
"LookbackPeriodInDays": {
"base": null,
"refs": {
"GetReservationPurchaseRecommendationRequest$LookbackPeriodInDays": "<p>The number of previous days that you want AWS to consider when it calculates your recommendations.</p>",
"ReservationPurchaseRecommendation$LookbackPeriodInDays": "<p>How many days of previous usage that AWS takes into consideration when making this recommendation.</p>"
}
},
"MetricAmount": {
"base": null,
"refs": {
"MetricValue$Amount": "<p>The actual number that represents the metric.</p>"
}
},
"MetricName": {
"base": null,
"refs": {
"MetricNames$member": null,
"Metrics$key": null
}
},
"MetricNames": {
"base": null,
"refs": {
"GetCostAndUsageRequest$Metrics": "<p>Which metrics are returned in the query. For more information about blended and unblended rates, see <a href=\"https://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/\">Why does the \"blended\" annotation appear on some line items in my bill?</a>. </p> <p>Valid values are <code>BlendedCost</code>, <code>UnblendedCost</code>, and <code>UsageQuantity</code>.</p> <note> <p>If you return the <code>UsageQuantity</code> metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate <code>usageQuantity</code> across all of EC2, the results aren't meaningful because EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful <code>UsageQuantity</code> metrics, filter by <code>UsageType</code> or <code>UsageTypeGroups</code>. </p> </note> <p> <code>Metrics</code> is required for <code>GetCostAndUsage</code> requests.</p>"
}
},
"MetricUnit": {
"base": null,
"refs": {
"MetricValue$Unit": "<p>The unit that the metric is given in.</p>"
}
},
"MetricValue": {
"base": "<p>The aggregated value for a metric.</p>",
"refs": {
"Metrics$value": null
}
},
"Metrics": {
"base": null,
"refs": {
"Group$Metrics": "<p>The metrics that are included in this group.</p>",
"ResultByTime$Total": "<p>The total amount of cost or usage accrued during the time period.</p>"
}
},
"NextPageToken": {
"base": null,
"refs": {
"GetCostAndUsageRequest$NextPageToken": "<p>The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetCostAndUsageResponse$NextPageToken": "<p>The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetDimensionValuesRequest$NextPageToken": "<p>The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetDimensionValuesResponse$NextPageToken": "<p>The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetReservationCoverageRequest$NextPageToken": "<p>The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetReservationCoverageResponse$NextPageToken": "<p>The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetReservationPurchaseRecommendationRequest$NextPageToken": "<p>The pagination token that indicates the next set of results that you want to retrieve.</p>",
"GetReservationPurchaseRecommendationResponse$NextPageToken": "<p>The pagination token for the next set of retrievable results.</p>",
"GetReservationUtilizationRequest$NextPageToken": "<p>The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetReservationUtilizationResponse$NextPageToken": "<p>The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetTagsRequest$NextPageToken": "<p>The token to retrieve the next set of results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>",
"GetTagsResponse$NextPageToken": "<p>The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.</p>"
}
},
"NonNegativeInteger": {
"base": null,
"refs": {
"GetReservationPurchaseRecommendationRequest$PageSize": "<p>The number of recommendations that you want returned in a single response object.</p>"
}
},
"OfferingClass": {
"base": null,
"refs": {
"EC2Specification$OfferingClass": "<p>Whether you want a recommendation for standard or convertible reservations.</p>"
}
},
"OnDemandHours": {
"base": null,
"refs": {
"CoverageHours$OnDemandHours": "<p>The number of instance running hours that are covered by On-Demand Instances.</p>"
}
},
"PageSize": {
"base": null,
"refs": {
"GetDimensionValuesResponse$ReturnSize": "<p>The number of results that AWS returned at one time.</p>",
"GetDimensionValuesResponse$TotalSize": "<p>The total number of search results.</p>",
"GetTagsResponse$ReturnSize": "<p>The number of query results that AWS returns at a time.</p>",
"GetTagsResponse$TotalSize": "<p>The total number of query results.</p>"
}
},
"PaymentOption": {
"base": null,
"refs": {
"GetReservationPurchaseRecommendationRequest$PaymentOption": "<p>The reservation purchase option that you want recommendations for.</p>",
"ReservationPurchaseRecommendation$PaymentOption": "<p>The payment option for the reservation. For example, <code>AllUpfront</code> or <code>NoUpfront</code>.</p>"
}
},
"PurchasedHours": {
"base": null,
"refs": {
"ReservationAggregates$PurchasedHours": "<p>How many RI hours that you purchased.</p>"
}
},
"RDSInstanceDetails": {
"base": "<p>Details about the RDS instances that AWS recommends that you purchase.</p>",
"refs": {
"InstanceDetails$RDSInstanceDetails": "<p>The RDS instances that AWS recommends that you purchase.</p>"
}
},
"RequestChangedException": {
"base": "<p>Your request parameters changed between pages. Try again with the old parameters or without a pagination token.</p>",
"refs": {
}
},
"ReservationAggregates": {
"base": "<p>The aggregated numbers for your RI usage.</p>",
"refs": {
"GetReservationUtilizationResponse$Total": "<p>The total amount of time that you utilized your RIs.</p>",
"ReservationUtilizationGroup$Utilization": "<p>How much you used this group of RIs.</p>",
"UtilizationByTime$Total": "<p>The total number of RI hours that were used.</p>"
}
},
"ReservationCoverageGroup": {
"base": "<p>A group of reservations that share a set of attributes.</p>",
"refs": {
"ReservationCoverageGroups$member": null
}
},
"ReservationCoverageGroups": {
"base": null,
"refs": {
"CoverageByTime$Groups": "<p>The groups of instances that are covered by a reservation.</p>"
}
},
"ReservationGroupKey": {
"base": null,
"refs": {
"ReservationUtilizationGroup$Key": "<p>The key for a specific RI attribute.</p>"
}
},
"ReservationGroupValue": {
"base": null,
"refs": {
"ReservationUtilizationGroup$Value": "<p>The value of a specific RI attribute.</p>"
}
},
"ReservationPurchaseRecommendation": {
"base": "<p>A specific reservation that AWS recommends for purchase.</p>",
"refs": {
"ReservationPurchaseRecommendations$member": null
}
},
"ReservationPurchaseRecommendationDetail": {
"base": "<p>Details about your recommended reservation purchase.</p>",
"refs": {
"ReservationPurchaseRecommendationDetails$member": null
}
},
"ReservationPurchaseRecommendationDetails": {
"base": null,
"refs": {
"ReservationPurchaseRecommendation$RecommendationDetails": "<p>Details about the recommended purchases.</p>"
}
},
"ReservationPurchaseRecommendationMetadata": {
"base": "<p>Information about this specific recommendation, such as the time stamp for when AWS made a specific recommendation.</p>",
"refs": {
"GetReservationPurchaseRecommendationResponse$Metadata": "<p>Information about this specific recommendation call, such as the time stamp for when Cost Explorer generated this recommendation.</p>"
}
},
"ReservationPurchaseRecommendationSummary": {
"base": "<p>A summary about this recommendation, such as the currency code, the amount that AWS estimates you could save, and the total amount of reservation to purchase.</p>",
"refs": {
"ReservationPurchaseRecommendation$RecommendationSummary": "<p>A summary about the recommended purchase.</p>"
}
},
"ReservationPurchaseRecommendations": {
"base": null,
"refs": {
"GetReservationPurchaseRecommendationResponse$Recommendations": "<p>Recommendations for reservations to purchase.</p>"
}
},
"ReservationUtilizationGroup": {
"base": "<p>A group of RIs that share a set of attributes.</p>",
"refs": {
"ReservationUtilizationGroups$member": null
}
},
"ReservationUtilizationGroups": {
"base": null,
"refs": {
"UtilizationByTime$Groups": "<p>The groups that are included in this utilization result.</p>"
}
},
"ReservedHours": {
"base": null,
"refs": {
"CoverageHours$ReservedHours": "<p>The number of instance running hours that are covered by reservations.</p>"
}
},
"ResultByTime": {
"base": "<p>The result that is associated with a time period.</p>",
"refs": {
"ResultsByTime$member": null
}
},
"ResultsByTime": {
"base": null,
"refs": {
"GetCostAndUsageResponse$ResultsByTime": "<p>The time period that is covered by the results in the response.</p>"
}
},
"SearchString": {
"base": null,
"refs": {
"GetDimensionValuesRequest$SearchString": "<p>The value that you want to search the filter values for.</p>",
"GetTagsRequest$SearchString": "<p>The value that you want to search for.</p>"
}
},
"ServiceSpecification": {
"base": "<p>Hardware specifications for the service that you want recommendations for.</p>",
"refs": {
"GetReservationPurchaseRecommendationRequest$ServiceSpecification": "<p>The hardware specifications for the service instances that you want recommendations for, such as standard or convertible EC2 instances.</p>",
"ReservationPurchaseRecommendation$ServiceSpecification": "<p>Hardware specifications for the service that you want recommendations for.</p>"
}
},
"TagKey": {
"base": null,
"refs": {
"GetTagsRequest$TagKey": "<p>The key of the tag that you want to return values for.</p>",
"TagValues$Key": "<p>The key for a tag.</p>"
}
},
"TagList": {
"base": null,
"refs": {
"GetTagsResponse$Tags": "<p>The tags that match your request.</p>"
}
},
"TagValues": {
"base": "<p>The values that are available for a tag.</p>",
"refs": {
"Expression$Tags": "<p>The specific <code>Tag</code> to use for <code>Expression</code>.</p>"
}
},
"TermInYears": {
"base": null,
"refs": {
"GetReservationPurchaseRecommendationRequest$TermInYears": "<p>The reservation term that you want recommendations for.</p>",
"ReservationPurchaseRecommendation$TermInYears": "<p>The term of the reservation that you want recommendations for, in years.</p>"
}
},
"TotalActualHours": {
"base": null,
"refs": {
"ReservationAggregates$TotalActualHours": "<p>The total number of RI hours that you used.</p>"
}
},
"TotalRunningHours": {
"base": null,
"refs": {
"CoverageHours$TotalRunningHours": "<p>The total instance usage, in hours.</p>"
}
},
"UnusedHours": {
"base": null,
"refs": {
"ReservationAggregates$UnusedHours": "<p>The number of RI hours that you didn't use.</p>"
}
},
"UtilizationByTime": {
"base": "<p>The amount of utilization, in hours.</p>",
"refs": {
"UtilizationsByTime$member": null
}
},
"UtilizationPercentage": {
"base": null,
"refs": {
"ReservationAggregates$UtilizationPercentage": "<p>The percentage of RI time that you used.</p>"
}
},
"UtilizationsByTime": {
"base": null,
"refs": {
"GetReservationUtilizationResponse$UtilizationsByTime": "<p>The amount of time that you utilized your RIs.</p>"
}
},
"Value": {
"base": null,
"refs": {
"DimensionValuesWithAttributes$Value": "<p>The value of a dimension with a specific attribute.</p>",
"Values$member": null
}
},
"Values": {
"base": null,
"refs": {
"DimensionValues$Values": "<p>The metadata values that you can use to filter and group your results. You can use <code>GetDimensionValues</code> to find specific values.</p>",
"TagValues$Values": "<p>The specific value of a tag.</p>"
}
},
"YearMonthDay": {
"base": null,
"refs": {
"DateInterval$Start": "<p>The beginning of the time period that you want the usage and costs for. The start date is inclusive. For example, if <code>start</code> is <code>2017-01-01</code>, AWS retrieves cost and usage data starting at <code>2017-01-01</code> up to the end date.</p>",
"DateInterval$End": "<p>The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if <code>end</code> is <code>2017-05-01</code>, AWS retrieves cost and usage data from the start date up to, but not including, <code>2017-05-01</code>.</p>"
}
}
}
}

5
vendor/github.com/aws/aws-sdk-go/models/apis/ce/2017-10-25/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/ce/2017-10-25/paginators-1.json generated vendored Normal file
View File

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

35
vendor/github.com/aws/aws-sdk-go/models/apis/check_collisions_test.go generated vendored Normal file
View File

@@ -0,0 +1,35 @@
// +build awsinclude
package apis
import (
"os/exec"
"strings"
"testing"
)
func TestCollidingFolders(t *testing.T) {
m := map[string]struct{}{}
folders, err := getFolderNames()
if err != nil {
t.Error(err)
}
for _, folder := range folders {
lcName := strings.ToLower(folder)
if _, ok := m[lcName]; ok {
t.Errorf("folder %q collision detected", folder)
}
m[lcName] = struct{}{}
}
}
func getFolderNames() ([]string, error) {
cmd := exec.Command("git", "ls-tree", "-d", "--name-only", "HEAD")
output, err := cmd.Output()
if err != nil {
return nil, err
}
return strings.Split(string(output), "\n"), nil
}

528
vendor/github.com/aws/aws-sdk-go/models/apis/cloud9/2017-09-23/api-2.json generated vendored Normal file
View File

@@ -0,0 +1,528 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2017-09-23",
"endpointPrefix":"cloud9",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS Cloud9",
"signatureVersion":"v4",
"targetPrefix":"AWSCloud9WorkspaceManagementService",
"uid":"cloud9-2017-09-23"
},
"operations":{
"CreateEnvironmentEC2":{
"name":"CreateEnvironmentEC2",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateEnvironmentEC2Request"},
"output":{"shape":"CreateEnvironmentEC2Result"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
],
"idempotent":true
},
"CreateEnvironmentMembership":{
"name":"CreateEnvironmentMembership",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateEnvironmentMembershipRequest"},
"output":{"shape":"CreateEnvironmentMembershipResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
],
"idempotent":true
},
"DeleteEnvironment":{
"name":"DeleteEnvironment",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteEnvironmentRequest"},
"output":{"shape":"DeleteEnvironmentResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
],
"idempotent":true
},
"DeleteEnvironmentMembership":{
"name":"DeleteEnvironmentMembership",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteEnvironmentMembershipRequest"},
"output":{"shape":"DeleteEnvironmentMembershipResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
],
"idempotent":true
},
"DescribeEnvironmentMemberships":{
"name":"DescribeEnvironmentMemberships",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEnvironmentMembershipsRequest"},
"output":{"shape":"DescribeEnvironmentMembershipsResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
]
},
"DescribeEnvironmentStatus":{
"name":"DescribeEnvironmentStatus",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEnvironmentStatusRequest"},
"output":{"shape":"DescribeEnvironmentStatusResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
]
},
"DescribeEnvironments":{
"name":"DescribeEnvironments",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeEnvironmentsRequest"},
"output":{"shape":"DescribeEnvironmentsResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
]
},
"ListEnvironments":{
"name":"ListEnvironments",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListEnvironmentsRequest"},
"output":{"shape":"ListEnvironmentsResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
]
},
"UpdateEnvironment":{
"name":"UpdateEnvironment",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateEnvironmentRequest"},
"output":{"shape":"UpdateEnvironmentResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
],
"idempotent":true
},
"UpdateEnvironmentMembership":{
"name":"UpdateEnvironmentMembership",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateEnvironmentMembershipRequest"},
"output":{"shape":"UpdateEnvironmentMembershipResult"},
"errors":[
{"shape":"BadRequestException"},
{"shape":"ConflictException"},
{"shape":"NotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"TooManyRequestsException"},
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
],
"idempotent":true
}
},
"shapes":{
"AutomaticStopTimeMinutes":{
"type":"integer",
"box":true,
"max":20160
},
"BadRequestException":{
"type":"structure",
"members":{
},
"exception":true
},
"BoundedEnvironmentIdList":{
"type":"list",
"member":{"shape":"EnvironmentId"},
"max":25,
"min":1
},
"ClientRequestToken":{
"type":"string",
"pattern":"[\\x20-\\x7E]{10,128}"
},
"ConflictException":{
"type":"structure",
"members":{
},
"exception":true
},
"CreateEnvironmentEC2Request":{
"type":"structure",
"required":[
"name",
"instanceType"
],
"members":{
"name":{"shape":"EnvironmentName"},
"description":{"shape":"EnvironmentDescription"},
"clientRequestToken":{"shape":"ClientRequestToken"},
"instanceType":{"shape":"InstanceType"},
"subnetId":{"shape":"SubnetId"},
"automaticStopTimeMinutes":{"shape":"AutomaticStopTimeMinutes"},
"ownerArn":{"shape":"UserArn"}
}
},
"CreateEnvironmentEC2Result":{
"type":"structure",
"members":{
"environmentId":{"shape":"EnvironmentId"}
}
},
"CreateEnvironmentMembershipRequest":{
"type":"structure",
"required":[
"environmentId",
"userArn",
"permissions"
],
"members":{
"environmentId":{"shape":"EnvironmentId"},
"userArn":{"shape":"UserArn"},
"permissions":{"shape":"MemberPermissions"}
}
},
"CreateEnvironmentMembershipResult":{
"type":"structure",
"members":{
"membership":{"shape":"EnvironmentMember"}
}
},
"DeleteEnvironmentMembershipRequest":{
"type":"structure",
"required":[
"environmentId",
"userArn"
],
"members":{
"environmentId":{"shape":"EnvironmentId"},
"userArn":{"shape":"UserArn"}
}
},
"DeleteEnvironmentMembershipResult":{
"type":"structure",
"members":{
}
},
"DeleteEnvironmentRequest":{
"type":"structure",
"required":["environmentId"],
"members":{
"environmentId":{"shape":"EnvironmentId"}
}
},
"DeleteEnvironmentResult":{
"type":"structure",
"members":{
}
},
"DescribeEnvironmentMembershipsRequest":{
"type":"structure",
"members":{
"userArn":{"shape":"UserArn"},
"environmentId":{"shape":"EnvironmentId"},
"permissions":{"shape":"PermissionsList"},
"nextToken":{"shape":"String"},
"maxResults":{"shape":"MaxResults"}
}
},
"DescribeEnvironmentMembershipsResult":{
"type":"structure",
"members":{
"memberships":{"shape":"EnvironmentMembersList"},
"nextToken":{"shape":"String"}
}
},
"DescribeEnvironmentStatusRequest":{
"type":"structure",
"required":["environmentId"],
"members":{
"environmentId":{"shape":"EnvironmentId"}
}
},
"DescribeEnvironmentStatusResult":{
"type":"structure",
"members":{
"status":{"shape":"EnvironmentStatus"},
"message":{"shape":"String"}
}
},
"DescribeEnvironmentsRequest":{
"type":"structure",
"required":["environmentIds"],
"members":{
"environmentIds":{"shape":"BoundedEnvironmentIdList"}
}
},
"DescribeEnvironmentsResult":{
"type":"structure",
"members":{
"environments":{"shape":"EnvironmentList"}
}
},
"Environment":{
"type":"structure",
"members":{
"id":{"shape":"EnvironmentId"},
"name":{"shape":"EnvironmentName"},
"description":{"shape":"EnvironmentDescription"},
"type":{"shape":"EnvironmentType"},
"arn":{"shape":"String"},
"ownerArn":{"shape":"String"}
}
},
"EnvironmentDescription":{
"type":"string",
"max":200
},
"EnvironmentId":{
"type":"string",
"pattern":"^[a-zA-Z0-9]{8,32}$"
},
"EnvironmentIdList":{
"type":"list",
"member":{"shape":"EnvironmentId"}
},
"EnvironmentList":{
"type":"list",
"member":{"shape":"Environment"}
},
"EnvironmentMember":{
"type":"structure",
"members":{
"permissions":{"shape":"Permissions"},
"userId":{"shape":"String"},
"userArn":{"shape":"UserArn"},
"environmentId":{"shape":"EnvironmentId"},
"lastAccess":{"shape":"Timestamp"}
}
},
"EnvironmentMembersList":{
"type":"list",
"member":{"shape":"EnvironmentMember"}
},
"EnvironmentName":{
"type":"string",
"max":60,
"min":1
},
"EnvironmentStatus":{
"type":"string",
"enum":[
"error",
"creating",
"connecting",
"ready",
"stopping",
"stopped",
"deleting"
]
},
"EnvironmentType":{
"type":"string",
"enum":[
"ssh",
"ec2"
]
},
"ForbiddenException":{
"type":"structure",
"members":{
},
"exception":true
},
"InstanceType":{
"type":"string",
"max":20,
"min":5,
"pattern":"^[a-z][1-9][.][a-z0-9]+$"
},
"InternalServerErrorException":{
"type":"structure",
"members":{
},
"exception":true,
"fault":true
},
"LimitExceededException":{
"type":"structure",
"members":{
},
"exception":true
},
"ListEnvironmentsRequest":{
"type":"structure",
"members":{
"nextToken":{"shape":"String"},
"maxResults":{"shape":"MaxResults"}
}
},
"ListEnvironmentsResult":{
"type":"structure",
"members":{
"nextToken":{"shape":"String"},
"environmentIds":{"shape":"EnvironmentIdList"}
}
},
"MaxResults":{
"type":"integer",
"box":true,
"max":25,
"min":0
},
"MemberPermissions":{
"type":"string",
"enum":[
"read-write",
"read-only"
]
},
"NotFoundException":{
"type":"structure",
"members":{
},
"exception":true
},
"Permissions":{
"type":"string",
"enum":[
"owner",
"read-write",
"read-only"
]
},
"PermissionsList":{
"type":"list",
"member":{"shape":"Permissions"}
},
"String":{"type":"string"},
"SubnetId":{
"type":"string",
"max":30,
"min":5
},
"Timestamp":{"type":"timestamp"},
"TooManyRequestsException":{
"type":"structure",
"members":{
},
"exception":true
},
"UpdateEnvironmentMembershipRequest":{
"type":"structure",
"required":[
"environmentId",
"userArn",
"permissions"
],
"members":{
"environmentId":{"shape":"EnvironmentId"},
"userArn":{"shape":"UserArn"},
"permissions":{"shape":"MemberPermissions"}
}
},
"UpdateEnvironmentMembershipResult":{
"type":"structure",
"members":{
"membership":{"shape":"EnvironmentMember"}
}
},
"UpdateEnvironmentRequest":{
"type":"structure",
"required":["environmentId"],
"members":{
"environmentId":{"shape":"EnvironmentId"},
"name":{"shape":"EnvironmentName"},
"description":{"shape":"EnvironmentDescription"}
}
},
"UpdateEnvironmentResult":{
"type":"structure",
"members":{
}
},
"UserArn":{
"type":"string",
"pattern":"arn:aws:(iam|sts)::\\d+:\\S+"
}
}
}

317
vendor/github.com/aws/aws-sdk-go/models/apis/cloud9/2017-09-23/docs-2.json generated vendored Normal file
View File

@@ -0,0 +1,317 @@
{
"version": "2.0",
"service": "<fullname>AWS Cloud9</fullname> <p>AWS Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.</p> <p>For more information about AWS Cloud9, see the <a href=\"https://docs.aws.amazon.com/cloud9/latest/user-guide\">AWS Cloud9 User Guide</a>.</p> <p>AWS Cloud9 supports these operations:</p> <ul> <li> <p> <code>CreateEnvironmentEC2</code>: Creates an AWS Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment.</p> </li> <li> <p> <code>CreateEnvironmentMembership</code>: Adds an environment member to an environment.</p> </li> <li> <p> <code>DeleteEnvironment</code>: Deletes an environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.</p> </li> <li> <p> <code>DeleteEnvironmentMembership</code>: Deletes an environment member from an environment.</p> </li> <li> <p> <code>DescribeEnvironmentMemberships</code>: Gets information about environment members for an environment.</p> </li> <li> <p> <code>DescribeEnvironments</code>: Gets information about environments.</p> </li> <li> <p> <code>DescribeEnvironmentStatus</code>: Gets status information for an environment.</p> </li> <li> <p> <code>ListEnvironments</code>: Gets a list of environment identifiers.</p> </li> <li> <p> <code>UpdateEnvironment</code>: Changes the settings of an existing environment.</p> </li> <li> <p> <code>UpdateEnvironmentMembership</code>: Changes the settings of an existing environment member for an environment.</p> </li> </ul>",
"operations": {
"CreateEnvironmentEC2": "<p>Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.</p>",
"CreateEnvironmentMembership": "<p>Adds an environment member to an AWS Cloud9 development environment.</p>",
"DeleteEnvironment": "<p>Deletes an AWS Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.</p>",
"DeleteEnvironmentMembership": "<p>Deletes an environment member from an AWS Cloud9 development environment.</p>",
"DescribeEnvironmentMemberships": "<p>Gets information about environment members for an AWS Cloud9 development environment.</p>",
"DescribeEnvironmentStatus": "<p>Gets status information for an AWS Cloud9 development environment.</p>",
"DescribeEnvironments": "<p>Gets information about AWS Cloud9 development environments.</p>",
"ListEnvironments": "<p>Gets a list of AWS Cloud9 development environment identifiers.</p>",
"UpdateEnvironment": "<p>Changes the settings of an existing AWS Cloud9 development environment.</p>",
"UpdateEnvironmentMembership": "<p>Changes the settings of an existing environment member for an AWS Cloud9 development environment.</p>"
},
"shapes": {
"AutomaticStopTimeMinutes": {
"base": null,
"refs": {
"CreateEnvironmentEC2Request$automaticStopTimeMinutes": "<p>The number of minutes until the running instance is shut down after the environment has last been used.</p>"
}
},
"BadRequestException": {
"base": "<p>The target request is invalid.</p>",
"refs": {
}
},
"BoundedEnvironmentIdList": {
"base": null,
"refs": {
"DescribeEnvironmentsRequest$environmentIds": "<p>The IDs of individual environments to get information about.</p>"
}
},
"ClientRequestToken": {
"base": null,
"refs": {
"CreateEnvironmentEC2Request$clientRequestToken": "<p>A unique, case-sensitive string that helps AWS Cloud9 to ensure this operation completes no more than one time.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html\">Client Tokens</a> in the <i>Amazon EC2 API Reference</i>.</p>"
}
},
"ConflictException": {
"base": "<p>A conflict occurred.</p>",
"refs": {
}
},
"CreateEnvironmentEC2Request": {
"base": null,
"refs": {
}
},
"CreateEnvironmentEC2Result": {
"base": null,
"refs": {
}
},
"CreateEnvironmentMembershipRequest": {
"base": null,
"refs": {
}
},
"CreateEnvironmentMembershipResult": {
"base": null,
"refs": {
}
},
"DeleteEnvironmentMembershipRequest": {
"base": null,
"refs": {
}
},
"DeleteEnvironmentMembershipResult": {
"base": null,
"refs": {
}
},
"DeleteEnvironmentRequest": {
"base": null,
"refs": {
}
},
"DeleteEnvironmentResult": {
"base": null,
"refs": {
}
},
"DescribeEnvironmentMembershipsRequest": {
"base": null,
"refs": {
}
},
"DescribeEnvironmentMembershipsResult": {
"base": null,
"refs": {
}
},
"DescribeEnvironmentStatusRequest": {
"base": null,
"refs": {
}
},
"DescribeEnvironmentStatusResult": {
"base": null,
"refs": {
}
},
"DescribeEnvironmentsRequest": {
"base": null,
"refs": {
}
},
"DescribeEnvironmentsResult": {
"base": null,
"refs": {
}
},
"Environment": {
"base": "<p>Information about an AWS Cloud9 development environment.</p>",
"refs": {
"EnvironmentList$member": null
}
},
"EnvironmentDescription": {
"base": null,
"refs": {
"CreateEnvironmentEC2Request$description": "<p>The description of the environment to create.</p>",
"Environment$description": "<p>The description for the environment.</p>",
"UpdateEnvironmentRequest$description": "<p>Any new or replacement description for the environment.</p>"
}
},
"EnvironmentId": {
"base": null,
"refs": {
"BoundedEnvironmentIdList$member": null,
"CreateEnvironmentEC2Result$environmentId": "<p>The ID of the environment that was created.</p>",
"CreateEnvironmentMembershipRequest$environmentId": "<p>The ID of the environment that contains the environment member you want to add.</p>",
"DeleteEnvironmentMembershipRequest$environmentId": "<p>The ID of the environment to delete the environment member from.</p>",
"DeleteEnvironmentRequest$environmentId": "<p>The ID of the environment to delete.</p>",
"DescribeEnvironmentMembershipsRequest$environmentId": "<p>The ID of the environment to get environment member information about.</p>",
"DescribeEnvironmentStatusRequest$environmentId": "<p>The ID of the environment to get status information about.</p>",
"Environment$id": "<p>The ID of the environment.</p>",
"EnvironmentIdList$member": null,
"EnvironmentMember$environmentId": "<p>The ID of the environment for the environment member.</p>",
"UpdateEnvironmentMembershipRequest$environmentId": "<p>The ID of the environment for the environment member whose settings you want to change.</p>",
"UpdateEnvironmentRequest$environmentId": "<p>The ID of the environment to change settings.</p>"
}
},
"EnvironmentIdList": {
"base": null,
"refs": {
"ListEnvironmentsResult$environmentIds": "<p>The list of environment identifiers.</p>"
}
},
"EnvironmentList": {
"base": null,
"refs": {
"DescribeEnvironmentsResult$environments": "<p>Information about the environments that are returned.</p>"
}
},
"EnvironmentMember": {
"base": "<p>Information about an environment member for an AWS Cloud9 development environment.</p>",
"refs": {
"CreateEnvironmentMembershipResult$membership": "<p>Information about the environment member that was added.</p>",
"EnvironmentMembersList$member": null,
"UpdateEnvironmentMembershipResult$membership": "<p>Information about the environment member whose settings were changed.</p>"
}
},
"EnvironmentMembersList": {
"base": null,
"refs": {
"DescribeEnvironmentMembershipsResult$memberships": "<p>Information about the environment members for the environment.</p>"
}
},
"EnvironmentName": {
"base": null,
"refs": {
"CreateEnvironmentEC2Request$name": "<p>The name of the environment to create.</p> <p>This name is visible to other AWS IAM users in the same AWS account.</p>",
"Environment$name": "<p>The name of the environment.</p>",
"UpdateEnvironmentRequest$name": "<p>A replacement name for the environment.</p>"
}
},
"EnvironmentStatus": {
"base": null,
"refs": {
"DescribeEnvironmentStatusResult$status": "<p>The status of the environment. Available values include:</p> <ul> <li> <p> <code>connecting</code>: The environment is connecting.</p> </li> <li> <p> <code>creating</code>: The environment is being created.</p> </li> <li> <p> <code>deleting</code>: The environment is being deleted.</p> </li> <li> <p> <code>error</code>: The environment is in an error state.</p> </li> <li> <p> <code>ready</code>: The environment is ready.</p> </li> <li> <p> <code>stopped</code>: The environment is stopped.</p> </li> <li> <p> <code>stopping</code>: The environment is stopping.</p> </li> </ul>"
}
},
"EnvironmentType": {
"base": null,
"refs": {
"Environment$type": "<p>The type of environment. Valid values include the following:</p> <ul> <li> <p> <code>ec2</code>: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment.</p> </li> <li> <p> <code>ssh</code>: Your own server connects to the environment.</p> </li> </ul>"
}
},
"ForbiddenException": {
"base": "<p>An access permissions issue occurred.</p>",
"refs": {
}
},
"InstanceType": {
"base": null,
"refs": {
"CreateEnvironmentEC2Request$instanceType": "<p>The type of instance to connect to the environment (for example, <code>t2.micro</code>).</p>"
}
},
"InternalServerErrorException": {
"base": "<p>An internal server error occurred.</p>",
"refs": {
}
},
"LimitExceededException": {
"base": "<p>A service limit was exceeded.</p>",
"refs": {
}
},
"ListEnvironmentsRequest": {
"base": null,
"refs": {
}
},
"ListEnvironmentsResult": {
"base": null,
"refs": {
}
},
"MaxResults": {
"base": null,
"refs": {
"DescribeEnvironmentMembershipsRequest$maxResults": "<p>The maximum number of environment members to get information about.</p>",
"ListEnvironmentsRequest$maxResults": "<p>The maximum number of environments to get identifiers for.</p>"
}
},
"MemberPermissions": {
"base": null,
"refs": {
"CreateEnvironmentMembershipRequest$permissions": "<p>The type of environment member permissions you want to associate with this environment member. Available values include:</p> <ul> <li> <p> <code>read-only</code>: Has read-only access to the environment.</p> </li> <li> <p> <code>read-write</code>: Has read-write access to the environment.</p> </li> </ul>",
"UpdateEnvironmentMembershipRequest$permissions": "<p>The replacement type of environment member permissions you want to associate with this environment member. Available values include:</p> <ul> <li> <p> <code>read-only</code>: Has read-only access to the environment.</p> </li> <li> <p> <code>read-write</code>: Has read-write access to the environment.</p> </li> </ul>"
}
},
"NotFoundException": {
"base": "<p>The target resource cannot be found.</p>",
"refs": {
}
},
"Permissions": {
"base": null,
"refs": {
"EnvironmentMember$permissions": "<p>The type of environment member permissions associated with this environment member. Available values include:</p> <ul> <li> <p> <code>owner</code>: Owns the environment.</p> </li> <li> <p> <code>read-only</code>: Has read-only access to the environment.</p> </li> <li> <p> <code>read-write</code>: Has read-write access to the environment.</p> </li> </ul>",
"PermissionsList$member": null
}
},
"PermissionsList": {
"base": null,
"refs": {
"DescribeEnvironmentMembershipsRequest$permissions": "<p>The type of environment member permissions to get information about. Available values include:</p> <ul> <li> <p> <code>owner</code>: Owns the environment.</p> </li> <li> <p> <code>read-only</code>: Has read-only access to the environment.</p> </li> <li> <p> <code>read-write</code>: Has read-write access to the environment.</p> </li> </ul> <p>If no value is specified, information about all environment members are returned.</p>"
}
},
"String": {
"base": null,
"refs": {
"DescribeEnvironmentMembershipsRequest$nextToken": "<p>During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a <i>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.</p>",
"DescribeEnvironmentMembershipsResult$nextToken": "<p>If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a <i>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call.</p>",
"DescribeEnvironmentStatusResult$message": "<p>Any informational message about the status of the environment.</p>",
"Environment$arn": "<p>The Amazon Resource Name (ARN) of the environment.</p>",
"Environment$ownerArn": "<p>The Amazon Resource Name (ARN) of the environment owner.</p>",
"EnvironmentMember$userId": "<p>The user ID in AWS Identity and Access Management (AWS IAM) of the environment member.</p>",
"ListEnvironmentsRequest$nextToken": "<p>During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a <i>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.</p>",
"ListEnvironmentsResult$nextToken": "<p>If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a <i>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call.</p>"
}
},
"SubnetId": {
"base": null,
"refs": {
"CreateEnvironmentEC2Request$subnetId": "<p>The ID of the subnet in Amazon VPC that AWS Cloud9 will use to communicate with the Amazon EC2 instance.</p>"
}
},
"Timestamp": {
"base": null,
"refs": {
"EnvironmentMember$lastAccess": "<p>The time, expressed in epoch time format, when the environment member last opened the environment.</p>"
}
},
"TooManyRequestsException": {
"base": "<p>Too many service requests were made over the given time period.</p>",
"refs": {
}
},
"UpdateEnvironmentMembershipRequest": {
"base": null,
"refs": {
}
},
"UpdateEnvironmentMembershipResult": {
"base": null,
"refs": {
}
},
"UpdateEnvironmentRequest": {
"base": null,
"refs": {
}
},
"UpdateEnvironmentResult": {
"base": null,
"refs": {
}
},
"UserArn": {
"base": null,
"refs": {
"CreateEnvironmentEC2Request$ownerArn": "<p>The Amazon Resource Name (ARN) of the environment owner. This ARN can be the ARN of any AWS IAM principal. If this value is not specified, the ARN defaults to this environment's creator.</p>",
"CreateEnvironmentMembershipRequest$userArn": "<p>The Amazon Resource Name (ARN) of the environment member you want to add.</p>",
"DeleteEnvironmentMembershipRequest$userArn": "<p>The Amazon Resource Name (ARN) of the environment member to delete from the environment.</p>",
"DescribeEnvironmentMembershipsRequest$userArn": "<p>The Amazon Resource Name (ARN) of an individual environment member to get information about. If no value is specified, information about all environment members are returned.</p>",
"EnvironmentMember$userArn": "<p>The Amazon Resource Name (ARN) of the environment member.</p>",
"UpdateEnvironmentMembershipRequest$userArn": "<p>The Amazon Resource Name (ARN) of the environment member whose settings you want to change.</p>"
}
}
}
}

308
vendor/github.com/aws/aws-sdk-go/models/apis/cloud9/2017-09-23/examples-1.json generated vendored Normal file
View File

@@ -0,0 +1,308 @@
{
"version": "1.0",
"examples": {
"CreateEnvironmentEC2": [
{
"input": {
"name": "my-demo-environment",
"automaticStopTimeMinutes": 60,
"description": "This is my demonstration environment.",
"instanceType": "t2.micro",
"ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser",
"subnetId": "subnet-1fab8aEX"
},
"output": {
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "",
"id": "createenvironmentec2-1516821730547",
"title": "CreateEnvironmentEC2"
}
],
"CreateEnvironmentMembership": [
{
"input": {
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
"permissions": "read-write",
"userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser"
},
"output": {
"membership": {
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
"permissions": "read-write",
"userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser",
"userId": "AIDAJ3BA6O2FMJWCWXHEX"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "",
"id": "createenvironmentmembership-1516822583452",
"title": "CreateEnvironmentMembership"
}
],
"DeleteEnvironment": [
{
"input": {
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "",
"id": "deleteenvironment-1516822903149",
"title": "DeleteEnvironment"
}
],
"DeleteEnvironmentMembership": [
{
"input": {
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
"userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "",
"id": "deleteenvironmentmembership-1516822975655",
"title": "DeleteEnvironmentMembership"
}
],
"DescribeEnvironmentMemberships": [
{
"input": {
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX"
},
"output": {
"memberships": [
{
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
"permissions": "read-write",
"userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser",
"userId": "AIDAJ3BA6O2FMJWCWXHEX"
},
{
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
"permissions": "owner",
"userArn": "arn:aws:iam::123456789012:user/MyDemoUser",
"userId": "AIDAJNUEDQAQWFELJDLEX"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example gets information about all of the environment members for the specified AWS Cloud9 development environment.",
"id": "describeenvironmentmemberships1-1516823070453",
"title": "DescribeEnvironmentMemberships1"
},
{
"input": {
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
"permissions": [
"owner"
]
},
"output": {
"memberships": [
{
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
"permissions": "owner",
"userArn": "arn:aws:iam::123456789012:user/MyDemoUser",
"userId": "AIDAJNUEDQAQWFELJDLEX"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example gets information about the owner of the specified AWS Cloud9 development environment.",
"id": "describeenvironmentmemberships2-1516823191355",
"title": "DescribeEnvironmentMemberships2"
},
{
"input": {
"userArn": "arn:aws:iam::123456789012:user/MyDemoUser"
},
"output": {
"memberships": [
{
"environmentId": "10a75714bd494714929e7f5ec4125aEX",
"lastAccess": "2018-01-19T11:06:13Z",
"permissions": "owner",
"userArn": "arn:aws:iam::123456789012:user/MyDemoUser",
"userId": "AIDAJNUEDQAQWFELJDLEX"
},
{
"environmentId": "12bfc3cd537f41cb9776f8af5525c9EX",
"lastAccess": "2018-01-19T11:39:19Z",
"permissions": "owner",
"userArn": "arn:aws:iam::123456789012:user/MyDemoUser",
"userId": "AIDAJNUEDQAQWFELJDLEX"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "The following example gets AWS Cloud9 development environment membership information for the specified user.",
"id": "describeenvironmentmemberships3-1516823268793",
"title": "DescribeEnvironmentMemberships3"
}
],
"DescribeEnvironmentStatus": [
{
"input": {
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX"
},
"output": {
"message": "Environment is ready to use",
"status": "ready"
},
"comments": {
"input": {
},
"output": {
}
},
"description": "",
"id": "describeenvironmentstatus-1516823462133",
"title": "DescribeEnvironmentStatus"
}
],
"DescribeEnvironments": [
{
"input": {
"environmentIds": [
"8d9967e2f0624182b74e7690ad69ebEX",
"349c86d4579e4e7298d500ff57a6b2EX"
]
},
"output": {
"environments": [
{
"name": "my-demo-environment",
"type": "ec2",
"arn": "arn:aws:cloud9:us-east-2:123456789012:environment:8d9967e2f0624182b74e7690ad69ebEX",
"description": "This is my demonstration environment.",
"id": "8d9967e2f0624182b74e7690ad69ebEX",
"ownerArn": "arn:aws:iam::123456789012:user/MyDemoUser"
},
{
"name": "another-demo-environment",
"type": "ssh",
"arn": "arn:aws:cloud9:us-east-2:123456789012:environment:349c86d4579e4e7298d500ff57a6b2EX",
"id": "349c86d4579e4e7298d500ff57a6b2EX",
"ownerArn": "arn:aws:sts::123456789012:assumed-role/AnotherDemoUser/AnotherDemoUser"
}
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "",
"id": "describeenvironments-1516823568291",
"title": "DescribeEnvironments"
}
],
"ListEnvironments": [
{
"input": {
},
"output": {
"environmentIds": [
"349c86d4579e4e7298d500ff57a6b2EX",
"45a3da47af0840f2b0c0824f5ee232EX"
]
},
"comments": {
"input": {
},
"output": {
}
},
"description": "",
"id": "listenvironments-1516823687205",
"title": "ListEnvironments"
}
],
"UpdateEnvironment": [
{
"input": {
"name": "my-changed-demo-environment",
"description": "This is my changed demonstration environment.",
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX"
},
"output": {
},
"comments": {
"input": {
},
"output": {
}
},
"description": "",
"id": "updateenvironment-1516823781910",
"title": "UpdateEnvironment"
}
],
"UpdateEnvironmentMembership": [
{
"input": {
"environmentId": "8d9967e2f0624182b74e7690ad69ebEX",
"permissions": "read-only",
"userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser"
},
"output": {
"membership": {
"environmentId": "8d9967e2f0624182b74e7690ad69eb31",
"permissions": "read-only",
"userArn": "arn:aws:iam::123456789012:user/AnotherDemoUser",
"userId": "AIDAJ3BA6O2FMJWCWXHEX"
}
},
"comments": {
"input": {
},
"output": {
}
},
"description": "",
"id": "updateenvironmentmembership-1516823876645",
"title": "UpdateEnvironmentMembership"
}
]
}
}

14
vendor/github.com/aws/aws-sdk-go/models/apis/cloud9/2017-09-23/paginators-1.json generated vendored Normal file
View File

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

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

File diff suppressed because it is too large Load Diff

2261
vendor/github.com/aws/aws-sdk-go/models/apis/clouddirectory/2016-05-10/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/clouddirectory/2016-05-10/examples-1.json generated vendored Normal file
View File

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

94
vendor/github.com/aws/aws-sdk-go/models/apis/clouddirectory/2016-05-10/paginators-1.json generated vendored Normal file
View File

@@ -0,0 +1,94 @@
{
"pagination": {
"ListAppliedSchemaArns": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListAttachedIndices": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListDevelopmentSchemaArns": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListDirectories": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListFacetAttributes": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListFacetNames": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListIndex": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListObjectAttributes": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListObjectChildren": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListObjectParentPaths": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListObjectParents": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListObjectPolicies": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListPolicyAttachments": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListPublishedSchemaArns": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListTagsForResource": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListTypedLinkFacetAttributes": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"ListTypedLinkFacetNames": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
},
"LookupPolicy": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults"
}
}
}

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

File diff suppressed because it is too large Load Diff

1773
vendor/github.com/aws/aws-sdk-go/models/apis/cloudformation/2010-05-15/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/cloudformation/2010-05-15/examples-1.json generated vendored Normal file
View File

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

37
vendor/github.com/aws/aws-sdk-go/models/apis/cloudformation/2010-05-15/paginators-1.json generated vendored Normal file
View File

@@ -0,0 +1,37 @@
{
"pagination": {
"DescribeStackEvents": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "StackEvents"
},
"DescribeStackResources": {
"result_key": "StackResources"
},
"DescribeStacks": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "Stacks"
},
"ListExports": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "Exports"
},
"ListImports": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "Imports"
},
"ListStackResources": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "StackResourceSummaries"
},
"ListStacks": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "StackSummaries"
}
}
}

182
vendor/github.com/aws/aws-sdk-go/models/apis/cloudformation/2010-05-15/waiters-2.json generated vendored Normal file
View File

@@ -0,0 +1,182 @@
{
"version": 2,
"waiters": {
"StackExists": {
"delay": 5,
"operation": "DescribeStacks",
"maxAttempts": 20,
"acceptors": [
{
"matcher": "status",
"expected": 200,
"state": "success"
},
{
"matcher": "error",
"expected": "ValidationError",
"state": "retry"
}
]
},
"StackCreateComplete": {
"delay": 30,
"operation": "DescribeStacks",
"maxAttempts": 120,
"description": "Wait until stack status is CREATE_COMPLETE.",
"acceptors": [
{
"argument": "Stacks[].StackStatus",
"expected": "CREATE_COMPLETE",
"matcher": "pathAll",
"state": "success"
},
{
"argument": "Stacks[].StackStatus",
"expected": "CREATE_FAILED",
"matcher": "pathAny",
"state": "failure"
},
{
"argument": "Stacks[].StackStatus",
"expected": "DELETE_COMPLETE",
"matcher": "pathAny",
"state": "failure"
},
{
"argument": "Stacks[].StackStatus",
"expected": "DELETE_FAILED",
"matcher": "pathAny",
"state": "failure"
},
{
"argument": "Stacks[].StackStatus",
"expected": "ROLLBACK_FAILED",
"matcher": "pathAny",
"state": "failure"
},
{
"argument": "Stacks[].StackStatus",
"expected": "ROLLBACK_COMPLETE",
"matcher": "pathAny",
"state": "failure"
},
{
"expected": "ValidationError",
"matcher": "error",
"state": "failure"
}
]
},
"StackDeleteComplete": {
"delay": 30,
"operation": "DescribeStacks",
"maxAttempts": 120,
"description": "Wait until stack status is DELETE_COMPLETE.",
"acceptors": [
{
"argument": "Stacks[].StackStatus",
"expected": "DELETE_COMPLETE",
"matcher": "pathAll",
"state": "success"
},
{
"expected": "ValidationError",
"matcher": "error",
"state": "success"
},
{
"argument": "Stacks[].StackStatus",
"expected": "DELETE_FAILED",
"matcher": "pathAny",
"state": "failure"
},
{
"argument": "Stacks[].StackStatus",
"expected": "CREATE_FAILED",
"matcher": "pathAny",
"state": "failure"
},
{
"argument": "Stacks[].StackStatus",
"expected": "ROLLBACK_FAILED",
"matcher": "pathAny",
"state": "failure"
},
{
"argument": "Stacks[].StackStatus",
"expected": "UPDATE_ROLLBACK_FAILED",
"matcher": "pathAny",
"state": "failure"
},
{
"argument": "Stacks[].StackStatus",
"expected": "UPDATE_ROLLBACK_IN_PROGRESS",
"matcher": "pathAny",
"state": "failure"
}
]
},
"StackUpdateComplete": {
"delay": 30,
"maxAttempts": 120,
"operation": "DescribeStacks",
"description": "Wait until stack status is UPDATE_COMPLETE.",
"acceptors": [
{
"argument": "Stacks[].StackStatus",
"expected": "UPDATE_COMPLETE",
"matcher": "pathAll",
"state": "success"
},
{
"expected": "UPDATE_FAILED",
"matcher": "pathAny",
"state": "failure",
"argument": "Stacks[].StackStatus"
},
{
"argument": "Stacks[].StackStatus",
"expected": "UPDATE_ROLLBACK_FAILED",
"matcher": "pathAny",
"state": "failure"
},
{
"expected": "UPDATE_ROLLBACK_COMPLETE",
"matcher": "pathAny",
"state": "failure",
"argument": "Stacks[].StackStatus"
},
{
"expected": "ValidationError",
"matcher": "error",
"state": "failure"
}
]
},
"ChangeSetCreateComplete": {
"delay": 30,
"operation": "DescribeChangeSet",
"maxAttempts": 120,
"description": "Wait until change set status is CREATE_COMPLETE.",
"acceptors": [
{
"argument": "Status",
"expected": "CREATE_COMPLETE",
"matcher": "path",
"state": "success"
},
{
"argument": "Status",
"expected": "FAILED",
"matcher": "path",
"state": "failure"
},
{
"expected": "ValidationError",
"matcher": "error",
"state": "failure"
}
]
}
}
}

2651
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2015-04-17/api-2.json generated vendored Normal file
View File

File diff suppressed because it is too large Load Diff

1141
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2015-04-17/docs-2.json generated vendored Normal file
View File

File diff suppressed because it is too large Load Diff

32
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2015-04-17/paginators-1.json generated vendored Normal file
View File

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

47
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2015-04-17/waiters-2.json generated vendored Normal file
View File

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

2721
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2015-07-27/api-2.json generated vendored Normal file
View File

File diff suppressed because it is too large Load Diff

1164
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2015-07-27/docs-2.json generated vendored Normal file
View File

File diff suppressed because it is too large Load Diff

32
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2015-07-27/paginators-1.json generated vendored Normal file
View File

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

47
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2015-07-27/waiters-2.json generated vendored Normal file
View File

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

2150
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2015-09-17/api-2.json generated vendored Normal file
View File

File diff suppressed because it is too large Load Diff

1173
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2015-09-17/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/cloudfront/2015-09-17/examples-1.json generated vendored Normal file
View File

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

32
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2015-09-17/paginators-1.json generated vendored Normal file
View File

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

47
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2015-09-17/waiters-2.json generated vendored Normal file
View File

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

2216
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2016-01-13/api-2.json generated vendored Normal file
View File

File diff suppressed because it is too large Load Diff

1219
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2016-01-13/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/cloudfront/2016-01-13/examples-1.json generated vendored Normal file
View File

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

32
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2016-01-13/paginators-1.json generated vendored Normal file
View File

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

47
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2016-01-13/waiters-2.json generated vendored Normal file
View File

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

2219
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2016-01-28/api-2.json generated vendored Normal file
View File

File diff suppressed because it is too large Load Diff

1220
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2016-01-28/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/cloudfront/2016-01-28/examples-1.json generated vendored Normal file
View File

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

32
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2016-01-28/paginators-1.json generated vendored Normal file
View File

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

47
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2016-01-28/waiters-2.json generated vendored Normal file
View File

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

2548
vendor/github.com/aws/aws-sdk-go/models/apis/cloudfront/2016-08-01/api-2.json generated vendored Normal file
View File

File diff suppressed because it is too large Load Diff

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