mirror of
https://github.com/aptly-dev/aptly.git
synced 2026-07-17 12:17:39 +00:00
New upstream version 1.3.0
This commit is contained in:
Generated
Vendored
+1
-2
@@ -774,8 +774,7 @@
|
||||
"VM_NAME",
|
||||
"VM_PATH",
|
||||
"BIOS_ID",
|
||||
"MOTHERBOARD_SERIAL_NUMBER",
|
||||
"LABEL"
|
||||
"MOTHERBOARD_SERIAL_NUMBER"
|
||||
]
|
||||
},
|
||||
"ResourceAttributeValue":{
|
||||
Generated
Vendored
+8
-8
@@ -1,11 +1,11 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<p/>",
|
||||
"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 be doing the actual delete of the stream and all of its resources (tasks, associated resources, resource attributes, created artifacts).</p> </li> <li> <p>If the stream takes time to be deleted, it might still show up on a <code>ListProgressUpdateStreams</code> call.</p> </li> <li> <p> <code>CreateProgressUpdateStream</code>, <code>ImportMigrationTask</code>, <code>NotifyMigrationTaskState</code>, and all Associate[*] APIs realted to the tasks belonging to the stream will throw \"InvalidInputException\" if the stream of the same name is in the process of being deleted.</p> </li> <li> <p>Once the stream and all of its resources are deleted, <code>CreateProgressUpdateStream</code> for a stream of the same name will succeed, and that stream will be an entirely new logical resource (without any resources associated with the old stream).</p> </li> </ul>",
|
||||
"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>",
|
||||
@@ -17,11 +17,11 @@
|
||||
"ListProgressUpdateStreams": "<p>Lists progress update streams associated with the user account making this call.</p>",
|
||||
"NotifyApplicationState": "<p>Sets the migration state of an application. For a given application identified by the value passed to <code>ApplicationId</code>, its status is set or updated by passing one of three values to <code>Status</code>: <code>NOT_STARTED | IN_PROGRESS | COMPLETED</code>.</p>",
|
||||
"NotifyMigrationTaskState": "<p>Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits:</p> <ul> <li> <p>Migration tools will call the <code>NotifyMigrationTaskState</code> API to share the latest progress and status.</p> </li> <li> <p> <code>MigrationTaskName</code> is used for addressing updates to the correct target.</p> </li> <li> <p> <code>ProgressUpdateStream</code> is used for access control and to provide a namespace for each migration tool.</p> </li> </ul>",
|
||||
"PutResourceAttributes": "<p>Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service (ADS)'s repository. This association occurs asynchronously after <code>PutResourceAttributes</code> returns.</p> <important> <p>Keep in mind that subsequent calls to PutResourceAttributes will override previously stored attributes. For example, if it is first called with a MAC address, but later, it is desired to <i>add</i> an IP address, it will then be required to call it with <i>both</i> the IP and MAC addresses to prevent overiding the MAC address.</p> </important> <note> <p>Because this is an asynchronous call, it will always return 200, whether an association occurs or not. To confirm if an association was found based on the provided details, call <code>ListAssociatedResource</code>.</p> </note>"
|
||||
"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>Exception raised when the account making the call is not whitelisted or there are other authentication errors.</p>",
|
||||
"base": "<p>You do not have sufficient access to perform this action.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -351,7 +351,7 @@
|
||||
}
|
||||
},
|
||||
"PolicyErrorException": {
|
||||
"base": "<p>Exception raised when there are problems accessing ADS (Application Discovery Service); most likely due to a misconfigured policy or the <code>ADSCaller</code> role is missing or not configured correctly.</p>",
|
||||
"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": {
|
||||
}
|
||||
},
|
||||
@@ -405,7 +405,7 @@
|
||||
}
|
||||
},
|
||||
"ResourceAttribute": {
|
||||
"base": "<p>Attribute associated with a resource.</p>",
|
||||
"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>^[^<>{}\\\\\\\\/?,=\\\\p{Cntrl}]{1,256}$</code> </p> </dd> </dl>",
|
||||
"refs": {
|
||||
"LatestResourceAttributeList$member": null,
|
||||
"ResourceAttributeList$member": null
|
||||
@@ -414,7 +414,7 @@
|
||||
"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>"
|
||||
"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": {
|
||||
@@ -441,7 +441,7 @@
|
||||
}
|
||||
},
|
||||
"ServiceUnavailableException": {
|
||||
"base": "<p>Exception raised when the service encounters throttled communication with upstream dependencies or is overloaded with requests.</p>",
|
||||
"base": "<p>Exception raised when there is an internal, configuration, or dependency error encountered.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
Generated
Vendored
Generated
Vendored
+905
@@ -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
@@ -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>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
Generated
Vendored
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"pagination": {
|
||||
}
|
||||
}
|
||||
+220
-7
@@ -7,6 +7,7 @@
|
||||
"protocol":"json",
|
||||
"serviceAbbreviation":"ACM",
|
||||
"serviceFullName":"AWS Certificate Manager",
|
||||
"serviceId":"ACM",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"CertificateManager",
|
||||
"uid":"acm-2015-12-08"
|
||||
@@ -52,6 +53,20 @@
|
||||
{"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":{
|
||||
@@ -124,7 +139,8 @@
|
||||
"output":{"shape":"RequestCertificateResponse"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidDomainValidationOptionsException"}
|
||||
{"shape":"InvalidDomainValidationOptionsException"},
|
||||
{"shape":"InvalidArnException"}
|
||||
]
|
||||
},
|
||||
"ResendValidationEmail":{
|
||||
@@ -140,6 +156,20 @@
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"InvalidDomainValidationOptionsException"}
|
||||
]
|
||||
},
|
||||
"UpdateCertificateOptions":{
|
||||
"name":"UpdateCertificateOptions",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateCertificateOptionsRequest"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidStateException"},
|
||||
{"shape":"InvalidArnException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
@@ -158,7 +188,7 @@
|
||||
"type":"string",
|
||||
"max":2048,
|
||||
"min":20,
|
||||
"pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=/,.@-]+)*"
|
||||
"pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*"
|
||||
},
|
||||
"CertificateBody":{
|
||||
"type":"string",
|
||||
@@ -205,7 +235,18 @@
|
||||
"InUseBy":{"shape":"InUseList"},
|
||||
"FailureReason":{"shape":"FailureReason"},
|
||||
"Type":{"shape":"CertificateType"},
|
||||
"RenewalSummary":{"shape":"RenewalSummary"}
|
||||
"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":{
|
||||
@@ -235,11 +276,19 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"CertificateSummary"}
|
||||
},
|
||||
"CertificateTransparencyLoggingPreference":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ENABLED",
|
||||
"DISABLED"
|
||||
]
|
||||
},
|
||||
"CertificateType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"IMPORTED",
|
||||
"AMAZON_ISSUED"
|
||||
"AMAZON_ISSUED",
|
||||
"PRIVATE"
|
||||
]
|
||||
},
|
||||
"DeleteCertificateRequest":{
|
||||
@@ -289,7 +338,9 @@
|
||||
"DomainName":{"shape":"DomainNameString"},
|
||||
"ValidationEmails":{"shape":"ValidationEmailList"},
|
||||
"ValidationDomain":{"shape":"DomainNameString"},
|
||||
"ValidationStatus":{"shape":"DomainStatus"}
|
||||
"ValidationStatus":{"shape":"DomainStatus"},
|
||||
"ResourceRecord":{"shape":"ResourceRecord"},
|
||||
"ValidationMethod":{"shape":"ValidationMethod"}
|
||||
}
|
||||
},
|
||||
"DomainValidationList":{
|
||||
@@ -315,6 +366,57 @@
|
||||
"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":[
|
||||
@@ -322,9 +424,24 @@
|
||||
"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"],
|
||||
@@ -401,7 +518,44 @@
|
||||
"enum":[
|
||||
"RSA_2048",
|
||||
"RSA_1024",
|
||||
"EC_prime256v1"
|
||||
"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":{
|
||||
@@ -415,6 +569,7 @@
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CertificateStatuses":{"shape":"CertificateStatuses"},
|
||||
"Includes":{"shape":"Filters"},
|
||||
"NextToken":{"shape":"NextToken"},
|
||||
"MaxItems":{"shape":"MaxItems"}
|
||||
}
|
||||
@@ -450,12 +605,29 @@
|
||||
"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":[
|
||||
@@ -467,6 +639,13 @@
|
||||
"Tags":{"shape":"TagList"}
|
||||
}
|
||||
},
|
||||
"RenewalEligibility":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ELIGIBLE",
|
||||
"INELIGIBLE"
|
||||
]
|
||||
},
|
||||
"RenewalStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
@@ -492,9 +671,12 @@
|
||||
"required":["DomainName"],
|
||||
"members":{
|
||||
"DomainName":{"shape":"DomainNameString"},
|
||||
"ValidationMethod":{"shape":"ValidationMethod"},
|
||||
"SubjectAlternativeNames":{"shape":"DomainList"},
|
||||
"IdempotencyToken":{"shape":"IdempotencyToken"},
|
||||
"DomainValidationOptions":{"shape":"DomainValidationOptionList"}
|
||||
"DomainValidationOptions":{"shape":"DomainValidationOptionList"},
|
||||
"Options":{"shape":"CertificateOptions"},
|
||||
"CertificateAuthorityArn":{"shape":"Arn"}
|
||||
}
|
||||
},
|
||||
"RequestCertificateResponse":{
|
||||
@@ -537,6 +719,19 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ResourceRecord":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Name",
|
||||
"Type",
|
||||
"Value"
|
||||
],
|
||||
"members":{
|
||||
"Name":{"shape":"String"},
|
||||
"Type":{"shape":"RecordType"},
|
||||
"Value":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"RevocationReason":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
@@ -587,9 +782,27 @@
|
||||
},
|
||||
"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"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+191
-51
@@ -1,17 +1,19 @@
|
||||
{
|
||||
"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/acm/latest/userguide/\"> <i>AWS Certificate Manager User Guide</i> </a>.</p>",
|
||||
"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/acm/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 an ACM Certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list of ACM Certificates 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 other AWS services.</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>",
|
||||
"GetCertificate": "<p>Retrieves an ACM Certificate and certificate chain for the certificate specified by an ARN. The chain is an ordered list of certificates that contains the root certificate, intermediate certificates of subordinate CAs, and the ACM Certificate. The certificate and certificate chain are base64 encoded. If you want to decode the certificate chain to see the individual certificate fields, you can use OpenSSL.</p> <note> <p>Currently, ACM Certificates can be used only with Elastic Load Balancing and Amazon CloudFront.</p> </note>",
|
||||
"ImportCertificate": "<p>Imports an SSL/TLS certificate into AWS Certificate Manager (ACM) to use with <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-services.html\">ACM's integrated AWS services</a>.</p> <note> <p>ACM does not provide <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html\">managed renewal</a> for certificates that you import.</p> </note> <p>For more information about importing certificates into ACM, including the differences between certificates that you import and those that ACM provides, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>.</p> <p>To import a certificate, you must provide the certificate and the matching private key. When the certificate is not self-signed, you must also provide a certificate chain. You can omit the certificate chain when importing a self-signed certificate.</p> <p>The certificate, private key, and certificate chain must be PEM-encoded. For more information about converting these items to PEM format, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html#import-certificate-troubleshooting\">Importing Certificates Troubleshooting</a> in the <i>AWS Certificate Manager User Guide</i>.</p> <p>To import a new certificate, omit the <code>CertificateArn</code> field. Include this field only when you want to replace a previously imported certificate.</p> <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 ACM Certificates and the domain name for each. You can optionally filter the list to return only the certificates that match the specified status.</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. You can also specify additional FQDNs if users can reach your site by using other names. For each domain name you specify, email is sent to the domain owner to request approval to issue the certificate. After receiving approval from the domain owner, the ACM Certificate is issued. For more information, see the <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/\">AWS Certificate Manager User Guide</a>.</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/acm/latest/userguide/setup-email.html\">Configure Email for your Domain</a>. </p>"
|
||||
"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": {
|
||||
@@ -22,50 +24,64 @@
|
||||
"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>",
|
||||
"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>",
|
||||
"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>",
|
||||
"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>",
|
||||
"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 has 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>",
|
||||
"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.</p> <p>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>"
|
||||
"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": {
|
||||
"GetCertificateResponse$Certificate": "<p>String that contains the ACM Certificate represented by the ARN specified at input.</p>"
|
||||
"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. It must meet the following requirements:</p> <ul> <li> <p>Must be PEM-encoded.</p> </li> <li> <p>Must contain a 1024-bit or 2048-bit RSA public key.</p> </li> <li> <p>Must be valid at the time of import. You cannot import a certificate before its validity period begins (the certificate's <code>NotBefore</code> date) or after it expires (the certificate's <code>NotAfter</code> date).</p> </li> </ul>"
|
||||
"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 certificate chain. It must be PEM-encoded.</p>"
|
||||
"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>",
|
||||
"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": {
|
||||
@@ -76,11 +92,11 @@
|
||||
"CertificateStatuses": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListCertificatesRequest$CertificateStatuses": "<p>The status or statuses on which to filter the list of ACM Certificates.</p>"
|
||||
"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>",
|
||||
"base": "<p>This structure is returned in the response object of <a>ListCertificates</a> action. </p>",
|
||||
"refs": {
|
||||
"CertificateSummaryList$member": null
|
||||
}
|
||||
@@ -88,13 +104,19 @@
|
||||
"CertificateSummaryList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListCertificatesResponse$CertificateSummaryList": "<p>A list of ACM Certificates.</p>"
|
||||
"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/acm/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/acm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>.</p>"
|
||||
"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": {
|
||||
@@ -115,8 +137,8 @@
|
||||
"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/acm/latest/userguide/acm-limits.html\">Limits</a>.</p>"
|
||||
"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": {
|
||||
@@ -125,11 +147,11 @@
|
||||
"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$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 maximum length of a 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> <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> <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> <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>",
|
||||
"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>"
|
||||
}
|
||||
@@ -137,7 +159,7 @@
|
||||
"DomainStatus": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DomainValidation$ValidationStatus": "<p>The validation status of the domain name.</p>"
|
||||
"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": {
|
||||
@@ -149,12 +171,12 @@
|
||||
"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/acm/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>"
|
||||
"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 to validate your ownership of the domain.</p>",
|
||||
"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
|
||||
}
|
||||
@@ -162,13 +184,54 @@
|
||||
"DomainValidationOptionList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"RequestCertificateRequest$DomainValidationOptions": "<p>The domain name that you want ACM to use to send you emails to validate your ownership of the domain.</p>"
|
||||
"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/acm/latest/userguide/troubleshooting.html#troubleshooting-failed\">Certificate Request Failed</a> in the <i>AWS Certificate Manager User Guide</i>.</p>"
|
||||
"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": {
|
||||
@@ -200,7 +263,7 @@
|
||||
"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>"
|
||||
"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": {
|
||||
@@ -214,7 +277,7 @@
|
||||
}
|
||||
},
|
||||
"InvalidStateException": {
|
||||
"base": "<p>Processing has reached an invalid state. For example, this exception can occur if the specified domain is not using email validation, or the current certificate status does not permit the requested operation. See the exception message returned by ACM to determine which state is not valid.</p>",
|
||||
"base": "<p>Processing has reached an invalid state.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -226,11 +289,43 @@
|
||||
"KeyAlgorithm": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CertificateDetail$KeyAlgorithm": "<p>The algorithm that was used to generate the key pair (the public and private key).</p>"
|
||||
"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. For example, you may have input more domains than are allowed or you've requested too many certificates for your account. See the exception message returned by ACM to determine which limit you have violated. For more information about ACM limits, see the <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html\">Limits</a> topic.</p>",
|
||||
"base": "<p>An ACM limit has been exceeded.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -267,10 +362,28 @@
|
||||
"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. It must meet the following requirements:</p> <ul> <li> <p>Must be PEM-encoded.</p> </li> <li> <p>Must be unencrypted. You cannot import a private key that is protected by a password or passphrase.</p> </li> </ul>"
|
||||
"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": {
|
||||
@@ -278,16 +391,22 @@
|
||||
"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/acm/latest/userguide/acm-renewal.html\">managed renewal</a> of the certificate.</p>"
|
||||
"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/acm/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>",
|
||||
"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/acm/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>"
|
||||
"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": {
|
||||
@@ -316,14 +435,20 @@
|
||||
}
|
||||
},
|
||||
"ResourceNotFoundException": {
|
||||
"base": "<p>The specified certificate cannot be found in the caller's account, or the caller's account cannot be found.</p>",
|
||||
"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>"
|
||||
"CertificateDetail$RevocationReason": "<p>The reason the certificate was revoked. This value exists only when the certificate status is <code>REVOKED</code>. </p>"
|
||||
}
|
||||
},
|
||||
"String": {
|
||||
@@ -333,6 +458,7 @@
|
||||
"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,
|
||||
@@ -342,6 +468,8 @@
|
||||
"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
|
||||
}
|
||||
@@ -349,10 +477,10 @@
|
||||
"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$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>"
|
||||
}
|
||||
@@ -388,11 +516,23 @@
|
||||
"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>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+18
@@ -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
|
||||
}
|
||||
]
|
||||
}
|
||||
Generated
Vendored
+1860
File diff suppressed because it is too large
Load Diff
Generated
Vendored
+1288
File diff suppressed because it is too large
Load Diff
Generated
Vendored
Generated
Vendored
+49
@@ -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"
|
||||
}
|
||||
}
|
||||
}
|
||||
+387
-9
@@ -5,6 +5,7 @@
|
||||
"endpointPrefix":"apigateway",
|
||||
"protocol":"rest-json",
|
||||
"serviceFullName":"Amazon API Gateway",
|
||||
"serviceId":"API Gateway",
|
||||
"signatureVersion":"v4",
|
||||
"uid":"apigateway-2015-07-09"
|
||||
},
|
||||
@@ -254,6 +255,21 @@
|
||||
{"shape":"TooManyRequestsException"}
|
||||
]
|
||||
},
|
||||
"CreateVpcLink":{
|
||||
"name":"CreateVpcLink",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/vpclinks",
|
||||
"responseCode":202
|
||||
},
|
||||
"input":{"shape":"CreateVpcLinkRequest"},
|
||||
"output":{"shape":"VpcLink"},
|
||||
"errors":[
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"TooManyRequestsException"}
|
||||
]
|
||||
},
|
||||
"DeleteApiKey":{
|
||||
"name":"DeleteApiKey",
|
||||
"http":{
|
||||
@@ -563,6 +579,21 @@
|
||||
{"shape":"TooManyRequestsException"}
|
||||
]
|
||||
},
|
||||
"DeleteVpcLink":{
|
||||
"name":"DeleteVpcLink",
|
||||
"http":{
|
||||
"method":"DELETE",
|
||||
"requestUri":"/vpclinks/{vpclink_id}",
|
||||
"responseCode":202
|
||||
},
|
||||
"input":{"shape":"DeleteVpcLinkRequest"},
|
||||
"errors":[
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"BadRequestException"}
|
||||
]
|
||||
},
|
||||
"FlushStageAuthorizersCache":{
|
||||
"name":"FlushStageAuthorizersCache",
|
||||
"http":{
|
||||
@@ -1156,6 +1187,22 @@
|
||||
{"shape":"TooManyRequestsException"}
|
||||
]
|
||||
},
|
||||
"GetTags":{
|
||||
"name":"GetTags",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/tags/{resource_arn}"
|
||||
},
|
||||
"input":{"shape":"GetTagsRequest"},
|
||||
"output":{"shape":"Tags"},
|
||||
"errors":[
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
]
|
||||
},
|
||||
"GetUsage":{
|
||||
"name":"GetUsage",
|
||||
"http":{
|
||||
@@ -1233,6 +1280,34 @@
|
||||
{"shape":"NotFoundException"}
|
||||
]
|
||||
},
|
||||
"GetVpcLink":{
|
||||
"name":"GetVpcLink",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/vpclinks/{vpclink_id}"
|
||||
},
|
||||
"input":{"shape":"GetVpcLinkRequest"},
|
||||
"output":{"shape":"VpcLink"},
|
||||
"errors":[
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"TooManyRequestsException"}
|
||||
]
|
||||
},
|
||||
"GetVpcLinks":{
|
||||
"name":"GetVpcLinks",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/vpclinks"
|
||||
},
|
||||
"input":{"shape":"GetVpcLinksRequest"},
|
||||
"output":{"shape":"VpcLinks"},
|
||||
"errors":[
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"TooManyRequestsException"}
|
||||
]
|
||||
},
|
||||
"ImportApiKeys":{
|
||||
"name":"ImportApiKeys",
|
||||
"http":{
|
||||
@@ -1389,6 +1464,23 @@
|
||||
{"shape":"ConflictException"}
|
||||
]
|
||||
},
|
||||
"TagResource":{
|
||||
"name":"TagResource",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/tags/{resource_arn}",
|
||||
"responseCode":204
|
||||
},
|
||||
"input":{"shape":"TagResourceRequest"},
|
||||
"errors":[
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ConflictException"}
|
||||
]
|
||||
},
|
||||
"TestInvokeAuthorizer":{
|
||||
"name":"TestInvokeAuthorizer",
|
||||
"http":{
|
||||
@@ -1419,6 +1511,22 @@
|
||||
{"shape":"TooManyRequestsException"}
|
||||
]
|
||||
},
|
||||
"UntagResource":{
|
||||
"name":"UntagResource",
|
||||
"http":{
|
||||
"method":"DELETE",
|
||||
"requestUri":"/tags/{resource_arn}",
|
||||
"responseCode":204
|
||||
},
|
||||
"input":{"shape":"UntagResourceRequest"},
|
||||
"errors":[
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"ConflictException"}
|
||||
]
|
||||
},
|
||||
"UpdateAccount":{
|
||||
"name":"UpdateAccount",
|
||||
"http":{
|
||||
@@ -1751,9 +1859,32 @@
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"ConflictException"}
|
||||
]
|
||||
},
|
||||
"UpdateVpcLink":{
|
||||
"name":"UpdateVpcLink",
|
||||
"http":{
|
||||
"method":"PATCH",
|
||||
"requestUri":"/vpclinks/{vpclink_id}"
|
||||
},
|
||||
"input":{"shape":"UpdateVpcLinkRequest"},
|
||||
"output":{"shape":"VpcLink"},
|
||||
"errors":[
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"ConflictException"},
|
||||
{"shape":"TooManyRequestsException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AccessLogSettings":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"format":{"shape":"String"},
|
||||
"destinationArn":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"Account":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1784,6 +1915,13 @@
|
||||
"warnings":{"shape":"ListOfString"}
|
||||
}
|
||||
},
|
||||
"ApiKeySourceType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"HEADER",
|
||||
"AUTHORIZER"
|
||||
]
|
||||
},
|
||||
"ApiKeys":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1890,6 +2028,15 @@
|
||||
"FLUSH_IN_PROGRESS"
|
||||
]
|
||||
},
|
||||
"CanarySettings":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"percentTraffic":{"shape":"Double"},
|
||||
"deploymentId":{"shape":"String"},
|
||||
"stageVariableOverrides":{"shape":"MapOfStringToString"},
|
||||
"useStageCache":{"shape":"Boolean"}
|
||||
}
|
||||
},
|
||||
"ClientCertificate":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1918,6 +2065,13 @@
|
||||
"error":{"httpStatusCode":409},
|
||||
"exception":true
|
||||
},
|
||||
"ConnectionType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"INTERNET",
|
||||
"VPC_LINK"
|
||||
]
|
||||
},
|
||||
"ContentHandlingStrategy":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
@@ -1992,7 +2146,8 @@
|
||||
"description":{"shape":"String"},
|
||||
"cacheClusterEnabled":{"shape":"NullableBoolean"},
|
||||
"cacheClusterSize":{"shape":"CacheClusterSize"},
|
||||
"variables":{"shape":"MapOfStringToString"}
|
||||
"variables":{"shape":"MapOfStringToString"},
|
||||
"canarySettings":{"shape":"DeploymentCanarySettings"}
|
||||
}
|
||||
},
|
||||
"CreateDocumentationPartRequest":{
|
||||
@@ -2038,7 +2193,10 @@
|
||||
"certificateBody":{"shape":"String"},
|
||||
"certificatePrivateKey":{"shape":"String"},
|
||||
"certificateChain":{"shape":"String"},
|
||||
"certificateArn":{"shape":"String"}
|
||||
"certificateArn":{"shape":"String"},
|
||||
"regionalCertificateName":{"shape":"String"},
|
||||
"regionalCertificateArn":{"shape":"String"},
|
||||
"endpointConfiguration":{"shape":"EndpointConfiguration"}
|
||||
}
|
||||
},
|
||||
"CreateModelRequest":{
|
||||
@@ -2103,7 +2261,11 @@
|
||||
"description":{"shape":"String"},
|
||||
"version":{"shape":"String"},
|
||||
"cloneFrom":{"shape":"String"},
|
||||
"binaryMediaTypes":{"shape":"ListOfString"}
|
||||
"binaryMediaTypes":{"shape":"ListOfString"},
|
||||
"minimumCompressionSize":{"shape":"NullableInteger"},
|
||||
"apiKeySource":{"shape":"ApiKeySourceType"},
|
||||
"endpointConfiguration":{"shape":"EndpointConfiguration"},
|
||||
"policy":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"CreateStageRequest":{
|
||||
@@ -2125,7 +2287,9 @@
|
||||
"cacheClusterEnabled":{"shape":"Boolean"},
|
||||
"cacheClusterSize":{"shape":"CacheClusterSize"},
|
||||
"variables":{"shape":"MapOfStringToString"},
|
||||
"documentationVersion":{"shape":"String"}
|
||||
"documentationVersion":{"shape":"String"},
|
||||
"canarySettings":{"shape":"CanarySettings"},
|
||||
"tags":{"shape":"MapOfStringToString"}
|
||||
}
|
||||
},
|
||||
"CreateUsagePlanKeyRequest":{
|
||||
@@ -2156,6 +2320,18 @@
|
||||
"quota":{"shape":"QuotaSettings"}
|
||||
}
|
||||
},
|
||||
"CreateVpcLinkRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"name",
|
||||
"targetArns"
|
||||
],
|
||||
"members":{
|
||||
"name":{"shape":"String"},
|
||||
"description":{"shape":"String"},
|
||||
"targetArns":{"shape":"ListOfString"}
|
||||
}
|
||||
},
|
||||
"DeleteApiKeyRequest":{
|
||||
"type":"structure",
|
||||
"required":["apiKey"],
|
||||
@@ -2532,6 +2708,17 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteVpcLinkRequest":{
|
||||
"type":"structure",
|
||||
"required":["vpcLinkId"],
|
||||
"members":{
|
||||
"vpcLinkId":{
|
||||
"shape":"String",
|
||||
"location":"uri",
|
||||
"locationName":"vpclink_id"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Deployment":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -2541,6 +2728,14 @@
|
||||
"apiSummary":{"shape":"PathToMapOfMethodSnapshot"}
|
||||
}
|
||||
},
|
||||
"DeploymentCanarySettings":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"percentTraffic":{"shape":"Double"},
|
||||
"stageVariableOverrides":{"shape":"MapOfStringToString"},
|
||||
"useStageCache":{"shape":"Boolean"}
|
||||
}
|
||||
},
|
||||
"Deployments":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -2633,7 +2828,13 @@
|
||||
"certificateName":{"shape":"String"},
|
||||
"certificateArn":{"shape":"String"},
|
||||
"certificateUploadDate":{"shape":"Timestamp"},
|
||||
"distributionDomainName":{"shape":"String"}
|
||||
"regionalDomainName":{"shape":"String"},
|
||||
"regionalHostedZoneId":{"shape":"String"},
|
||||
"regionalCertificateName":{"shape":"String"},
|
||||
"regionalCertificateArn":{"shape":"String"},
|
||||
"distributionDomainName":{"shape":"String"},
|
||||
"distributionHostedZoneId":{"shape":"String"},
|
||||
"endpointConfiguration":{"shape":"EndpointConfiguration"}
|
||||
}
|
||||
},
|
||||
"DomainNames":{
|
||||
@@ -2647,6 +2848,19 @@
|
||||
}
|
||||
},
|
||||
"Double":{"type":"double"},
|
||||
"EndpointConfiguration":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"types":{"shape":"ListOfEndpointType"}
|
||||
}
|
||||
},
|
||||
"EndpointType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"REGIONAL",
|
||||
"EDGE"
|
||||
]
|
||||
},
|
||||
"ExportResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -3007,6 +3221,11 @@
|
||||
"shape":"NullableInteger",
|
||||
"location":"querystring",
|
||||
"locationName":"limit"
|
||||
},
|
||||
"locationStatus":{
|
||||
"shape":"LocationStatusType",
|
||||
"location":"querystring",
|
||||
"locationName":"locationStatus"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -3532,6 +3751,27 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetTagsRequest":{
|
||||
"type":"structure",
|
||||
"required":["resourceArn"],
|
||||
"members":{
|
||||
"resourceArn":{
|
||||
"shape":"String",
|
||||
"location":"uri",
|
||||
"locationName":"resource_arn"
|
||||
},
|
||||
"position":{
|
||||
"shape":"String",
|
||||
"location":"querystring",
|
||||
"locationName":"position"
|
||||
},
|
||||
"limit":{
|
||||
"shape":"NullableInteger",
|
||||
"location":"querystring",
|
||||
"locationName":"limit"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetUsagePlanKeyRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -3648,6 +3888,32 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetVpcLinkRequest":{
|
||||
"type":"structure",
|
||||
"required":["vpcLinkId"],
|
||||
"members":{
|
||||
"vpcLinkId":{
|
||||
"shape":"String",
|
||||
"location":"uri",
|
||||
"locationName":"vpclink_id"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetVpcLinksRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"position":{
|
||||
"shape":"String",
|
||||
"location":"querystring",
|
||||
"locationName":"position"
|
||||
},
|
||||
"limit":{
|
||||
"shape":"NullableInteger",
|
||||
"location":"querystring",
|
||||
"locationName":"limit"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ImportApiKeysRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -3719,11 +3985,14 @@
|
||||
"type":{"shape":"IntegrationType"},
|
||||
"httpMethod":{"shape":"String"},
|
||||
"uri":{"shape":"String"},
|
||||
"connectionType":{"shape":"ConnectionType"},
|
||||
"connectionId":{"shape":"String"},
|
||||
"credentials":{"shape":"String"},
|
||||
"requestParameters":{"shape":"MapOfStringToString"},
|
||||
"requestTemplates":{"shape":"MapOfStringToString"},
|
||||
"passthroughBehavior":{"shape":"String"},
|
||||
"contentHandling":{"shape":"ContentHandlingStrategy"},
|
||||
"timeoutInMillis":{"shape":"Integer"},
|
||||
"cacheNamespace":{"shape":"String"},
|
||||
"cacheKeyParameters":{"shape":"ListOfString"},
|
||||
"integrationResponses":{"shape":"MapOfIntegrationResponse"}
|
||||
@@ -3802,6 +4071,10 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"DomainName"}
|
||||
},
|
||||
"ListOfEndpointType":{
|
||||
"type":"list",
|
||||
"member":{"shape":"EndpointType"}
|
||||
},
|
||||
"ListOfGatewayResponse":{
|
||||
"type":"list",
|
||||
"member":{"shape":"GatewayResponse"}
|
||||
@@ -3862,6 +4135,17 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"UsagePlanKey"}
|
||||
},
|
||||
"ListOfVpcLink":{
|
||||
"type":"list",
|
||||
"member":{"shape":"VpcLink"}
|
||||
},
|
||||
"LocationStatusType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"DOCUMENTED",
|
||||
"UNDOCUMENTED"
|
||||
]
|
||||
},
|
||||
"Long":{"type":"long"},
|
||||
"MapOfHeaderValues":{
|
||||
"type":"map",
|
||||
@@ -3925,7 +4209,8 @@
|
||||
"requestParameters":{"shape":"MapOfStringToBoolean"},
|
||||
"requestModels":{"shape":"MapOfStringToString"},
|
||||
"methodResponses":{"shape":"MapOfMethodResponse"},
|
||||
"methodIntegration":{"shape":"Integration"}
|
||||
"methodIntegration":{"shape":"Integration"},
|
||||
"authorizationScopes":{"shape":"ListOfString"}
|
||||
}
|
||||
},
|
||||
"MethodResponse":{
|
||||
@@ -4066,13 +4351,16 @@
|
||||
"locationName":"httpMethod"
|
||||
},
|
||||
"uri":{"shape":"String"},
|
||||
"connectionType":{"shape":"ConnectionType"},
|
||||
"connectionId":{"shape":"String"},
|
||||
"credentials":{"shape":"String"},
|
||||
"requestParameters":{"shape":"MapOfStringToString"},
|
||||
"requestTemplates":{"shape":"MapOfStringToString"},
|
||||
"passthroughBehavior":{"shape":"String"},
|
||||
"cacheNamespace":{"shape":"String"},
|
||||
"cacheKeyParameters":{"shape":"ListOfString"},
|
||||
"contentHandling":{"shape":"ContentHandlingStrategy"}
|
||||
"contentHandling":{"shape":"ContentHandlingStrategy"},
|
||||
"timeoutInMillis":{"shape":"NullableInteger"}
|
||||
}
|
||||
},
|
||||
"PutIntegrationResponseRequest":{
|
||||
@@ -4140,7 +4428,8 @@
|
||||
"operationName":{"shape":"String"},
|
||||
"requestParameters":{"shape":"MapOfStringToBoolean"},
|
||||
"requestModels":{"shape":"MapOfStringToString"},
|
||||
"requestValidatorId":{"shape":"String"}
|
||||
"requestValidatorId":{"shape":"String"},
|
||||
"authorizationScopes":{"shape":"ListOfString"}
|
||||
}
|
||||
},
|
||||
"PutMethodResponseRequest":{
|
||||
@@ -4277,7 +4566,11 @@
|
||||
"createdDate":{"shape":"Timestamp"},
|
||||
"version":{"shape":"String"},
|
||||
"warnings":{"shape":"ListOfString"},
|
||||
"binaryMediaTypes":{"shape":"ListOfString"}
|
||||
"binaryMediaTypes":{"shape":"ListOfString"},
|
||||
"minimumCompressionSize":{"shape":"NullableInteger"},
|
||||
"apiKeySource":{"shape":"ApiKeySourceType"},
|
||||
"endpointConfiguration":{"shape":"EndpointConfiguration"},
|
||||
"policy":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"RestApis":{
|
||||
@@ -4363,6 +4656,9 @@
|
||||
"methodSettings":{"shape":"MapOfMethodSettings"},
|
||||
"variables":{"shape":"MapOfStringToString"},
|
||||
"documentationVersion":{"shape":"String"},
|
||||
"accessLogSettings":{"shape":"AccessLogSettings"},
|
||||
"canarySettings":{"shape":"CanarySettings"},
|
||||
"tags":{"shape":"MapOfStringToString"},
|
||||
"createdDate":{"shape":"Timestamp"},
|
||||
"lastUpdatedDate":{"shape":"Timestamp"}
|
||||
}
|
||||
@@ -4385,6 +4681,27 @@
|
||||
"pattern":"[1-5]\\d\\d"
|
||||
},
|
||||
"String":{"type":"string"},
|
||||
"TagResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"resourceArn",
|
||||
"tags"
|
||||
],
|
||||
"members":{
|
||||
"resourceArn":{
|
||||
"shape":"String",
|
||||
"location":"uri",
|
||||
"locationName":"resource_arn"
|
||||
},
|
||||
"tags":{"shape":"MapOfStringToString"}
|
||||
}
|
||||
},
|
||||
"Tags":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"tags":{"shape":"MapOfStringToString"}
|
||||
}
|
||||
},
|
||||
"Template":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -4504,6 +4821,25 @@
|
||||
"error":{"httpStatusCode":401},
|
||||
"exception":true
|
||||
},
|
||||
"UntagResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"resourceArn",
|
||||
"tagKeys"
|
||||
],
|
||||
"members":{
|
||||
"resourceArn":{
|
||||
"shape":"String",
|
||||
"location":"uri",
|
||||
"locationName":"resource_arn"
|
||||
},
|
||||
"tagKeys":{
|
||||
"shape":"ListOfString",
|
||||
"location":"querystring",
|
||||
"locationName":"tagKeys"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateAccountRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -4906,6 +5242,18 @@
|
||||
"patchOperations":{"shape":"ListOfPatchOperation"}
|
||||
}
|
||||
},
|
||||
"UpdateVpcLinkRequest":{
|
||||
"type":"structure",
|
||||
"required":["vpcLinkId"],
|
||||
"members":{
|
||||
"vpcLinkId":{
|
||||
"shape":"String",
|
||||
"location":"uri",
|
||||
"locationName":"vpclink_id"
|
||||
},
|
||||
"patchOperations":{"shape":"ListOfPatchOperation"}
|
||||
}
|
||||
},
|
||||
"Usage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -4959,6 +5307,36 @@
|
||||
"locationName":"item"
|
||||
}
|
||||
}
|
||||
},
|
||||
"VpcLink":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"id":{"shape":"String"},
|
||||
"name":{"shape":"String"},
|
||||
"description":{"shape":"String"},
|
||||
"targetArns":{"shape":"ListOfString"},
|
||||
"status":{"shape":"VpcLinkStatus"},
|
||||
"statusMessage":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"VpcLinkStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"AVAILABLE",
|
||||
"PENDING",
|
||||
"DELETING",
|
||||
"FAILED"
|
||||
]
|
||||
},
|
||||
"VpcLinks":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"position":{"shape":"String"},
|
||||
"items":{
|
||||
"shape":"ListOfVpcLink",
|
||||
"locationName":"item"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+454
-267
File diff suppressed because one or more lines are too long
Generated
Vendored
+6
@@ -65,6 +65,12 @@
|
||||
"limit_key": "limit",
|
||||
"output_token": "position",
|
||||
"result_key": "items"
|
||||
},
|
||||
"GetVpcLinks": {
|
||||
"input_token": "position",
|
||||
"limit_key": "limit",
|
||||
"output_token": "position",
|
||||
"result_key": "items"
|
||||
}
|
||||
}
|
||||
}
|
||||
+20
@@ -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
|
||||
}
|
||||
]
|
||||
}
|
||||
Generated
Vendored
+164
-3
@@ -6,6 +6,7 @@
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceFullName":"Application Auto Scaling",
|
||||
"serviceId":"Application Auto Scaling",
|
||||
"signatureVersion":"v4",
|
||||
"signingName":"application-autoscaling",
|
||||
"targetPrefix":"AnyScaleFrontendService",
|
||||
@@ -27,6 +28,21 @@
|
||||
{"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":{
|
||||
@@ -88,6 +104,21 @@
|
||||
{"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":{
|
||||
@@ -105,6 +136,22 @@
|
||||
{"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":{
|
||||
@@ -188,6 +235,25 @@
|
||||
"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":[
|
||||
@@ -261,6 +327,25 @@
|
||||
"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":{
|
||||
@@ -334,7 +419,16 @@
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"DynamoDBReadCapacityUtilization",
|
||||
"DynamoDBWriteCapacityUtilization"
|
||||
"DynamoDBWriteCapacityUtilization",
|
||||
"ALBRequestCountPerTarget",
|
||||
"RDSReaderAverageCPUUtilization",
|
||||
"RDSReaderAverageDatabaseConnections",
|
||||
"EC2SpotFleetRequestAverageCPUUtilization",
|
||||
"EC2SpotFleetRequestAverageNetworkIn",
|
||||
"EC2SpotFleetRequestAverageNetworkOut",
|
||||
"SageMakerVariantInvocationsPerInstance",
|
||||
"ECSServiceAverageCPUUtilization",
|
||||
"ECSServiceAverageMemoryUtilization"
|
||||
]
|
||||
},
|
||||
"MetricUnit":{"type":"string"},
|
||||
@@ -393,6 +487,29 @@
|
||||
"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":[
|
||||
@@ -444,7 +561,9 @@
|
||||
"dynamodb:table:ReadCapacityUnits",
|
||||
"dynamodb:table:WriteCapacityUnits",
|
||||
"dynamodb:index:ReadCapacityUnits",
|
||||
"dynamodb:index:WriteCapacityUnits"
|
||||
"dynamodb:index:WriteCapacityUnits",
|
||||
"rds:cluster:ReadReplicaCount",
|
||||
"sagemaker:variant:DesiredInstanceCount"
|
||||
]
|
||||
},
|
||||
"ScalableTarget":{
|
||||
@@ -468,6 +587,13 @@
|
||||
"CreationTime":{"shape":"TimestampType"}
|
||||
}
|
||||
},
|
||||
"ScalableTargetAction":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"MinCapacity":{"shape":"ResourceCapacity"},
|
||||
"MaxCapacity":{"shape":"ResourceCapacity"}
|
||||
}
|
||||
},
|
||||
"ScalableTargets":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ScalableTarget"}
|
||||
@@ -542,6 +668,39 @@
|
||||
"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":[
|
||||
@@ -549,7 +708,9 @@
|
||||
"elasticmapreduce",
|
||||
"ec2",
|
||||
"appstream",
|
||||
"dynamodb"
|
||||
"dynamodb",
|
||||
"rds",
|
||||
"sagemaker"
|
||||
]
|
||||
},
|
||||
"StepAdjustment":{
|
||||
|
||||
Generated
Vendored
+131
-45
@@ -1,14 +1,17 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<p>With Application Auto Scaling, you can automatically scale your AWS resources. The experience similar to that of <a href=\"https://aws.amazon.com/autoscaling/\">Auto Scaling</a>. You can use Application Auto Scaling to accomplish the following tasks:</p> <ul> <li> <p>Define scaling policies to automatically scale your AWS resources</p> </li> <li> <p>Scale your resources in response to CloudWatch alarms</p> </li> <li> <p>View the history of your scaling events</p> </li> </ul> <p>Application Auto Scaling can scale the following AWS resources:</p> <ul> <li> <p>Amazon ECS services. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html\">Service Auto Scaling</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p> </li> <li> <p>Amazon EC2 Spot fleets. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-auto-scaling.html\">Automatic Scaling for Spot Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p> </li> <li> <p>Amazon EMR clusters. For more information, see <a href=\"http://docs.aws.amazon.com/ElasticMapReduce/latest/ManagementGuide/emr-automatic-scaling.html\">Using Automatic Scaling in Amazon EMR</a> in the <i>Amazon EMR Management Guide</i>.</p> </li> <li> <p>AppStream 2.0 fleets. For more information, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/autoscaling.html\">Fleet Auto Scaling for Amazon AppStream 2.0</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p> </li> <li> <p>Provisioned read and write capacity for Amazon DynamoDB tables and global secondary indexes. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/AutoScaling.html\">Managing Throughput Capacity Automatically with DynamoDB Auto Scaling</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> </li> </ul> <p>For a list of supported regions, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#as-app_region\">AWS Regions and Endpoints: Application Auto Scaling</a> in the <i>AWS General Reference</i>.</p>",
|
||||
"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>Provides descriptive 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>",
|
||||
"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>Provides descriptive information about the scaling policies in the specified 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>",
|
||||
"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 without first registering a 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>",
|
||||
"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 your 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 are no longer using a scalable target, you can deregister it using <a>DeregisterScalableTarget</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": {
|
||||
@@ -46,7 +49,7 @@
|
||||
"CustomizedMetricSpecification": {
|
||||
"base": "<p>Configures a customized metric for a target tracking policy.</p>",
|
||||
"refs": {
|
||||
"TargetTrackingScalingPolicyConfiguration$CustomizedMetricSpecification": "<p>Reserved for future use.</p>"
|
||||
"TargetTrackingScalingPolicyConfiguration$CustomizedMetricSpecification": "<p>A customized metric.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteScalingPolicyRequest": {
|
||||
@@ -59,6 +62,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteScheduledActionRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteScheduledActionResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeregisterScalableTargetRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -99,6 +112,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeScheduledActionsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeScheduledActionsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DisableScaleIn": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -118,7 +141,7 @@
|
||||
}
|
||||
},
|
||||
"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> API operation on behalf of your account.</p>",
|
||||
"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": {
|
||||
}
|
||||
},
|
||||
@@ -133,16 +156,17 @@
|
||||
}
|
||||
},
|
||||
"LimitExceededException": {
|
||||
"base": "<p>Your account exceeded a limit. This exception is thrown when a per-account resource limit is exceeded. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_as-app\">Application Auto Scaling Limits</a>.</p>",
|
||||
"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 target 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>",
|
||||
"DescribeScalingActivitiesRequest$MaxResults": "<p>The maximum number of scalable target 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>",
|
||||
"DescribeScalingPoliciesRequest$MaxResults": "<p>The maximum number of scalable target 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>"
|
||||
"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": {
|
||||
@@ -204,7 +228,7 @@
|
||||
"MetricType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PredefinedMetricSpecification$PredefinedMetricType": "<p>The metric type.</p>"
|
||||
"PredefinedMetricSpecification$PredefinedMetricType": "<p>The metric type. The <code>ALBRequestCountPerTarget</code> metric type applies only to Spot fleet requests and ECS services.</p>"
|
||||
}
|
||||
},
|
||||
"MetricUnit": {
|
||||
@@ -220,7 +244,7 @@
|
||||
}
|
||||
},
|
||||
"ObjectNotFoundException": {
|
||||
"base": "<p>The specified object could not be found. For any <code>Put</code> or <code>Register</code> API operation, which 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 <code>Delete</code> or <code>Deregister</code> API operation, this exception is thrown if the resource that is to be deleted or deregistered cannot be found.</p>",
|
||||
"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": {
|
||||
}
|
||||
},
|
||||
@@ -234,7 +258,7 @@
|
||||
"PolicyType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PutScalingPolicyRequest$PolicyType": "<p>The policy type. If you are creating a new policy, this parameter is required. If you are updating a policy, this parameter is not required.</p> <p>For DynamoDB, only <code>TargetTrackingScaling</code> is supported. For any other service, only <code>StepScaling</code> is supported.</p>",
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
@@ -254,6 +278,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"PutScheduledActionRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"PutScheduledActionResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"RegisterScalableTargetRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -267,10 +301,12 @@
|
||||
"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 and optional if you are updating one.</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 and optional if you are updating one.</p>",
|
||||
"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>"
|
||||
"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": {
|
||||
@@ -285,48 +321,61 @@
|
||||
"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> </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> </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> </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> </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> </ul>",
|
||||
"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>",
|
||||
"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> </ul>",
|
||||
"RegisterScalableTargetRequest$RoleARN": "<p>The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf. This parameter is required when you register a scalable target and optional when you update one.</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> </ul>",
|
||||
"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> </ul>",
|
||||
"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> </ul>"
|
||||
"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> </ul>",
|
||||
"DescribeScalingPoliciesRequest$PolicyNames": "<p>The names of the scaling policies to describe.</p>"
|
||||
"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>Reserved for future use.</p>"
|
||||
"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/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:</p> <ul> <li> <p>app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN</p> </li> <li> <p>targetgroup/<target-group-name>/<target-group-id> 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> </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> </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> </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> </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> </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> </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> </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> </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> </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> </ul>"
|
||||
"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": {
|
||||
@@ -335,10 +384,17 @@
|
||||
"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 list of scalable targets that matches the request parameters.</p>"
|
||||
"DescribeScalableTargetsResponse$ScalableTargets": "<p>The scalable targets that match the request parameters.</p>"
|
||||
}
|
||||
},
|
||||
"ScalingActivities": {
|
||||
@@ -368,7 +424,7 @@
|
||||
"ScalingPolicies": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeScalingPoliciesResponse$ScalingPolicies": "<p>A list of scaling policy objects.</p>"
|
||||
"DescribeScalingPoliciesResponse$ScalingPolicies": "<p>Information about the scaling policies.</p>"
|
||||
}
|
||||
},
|
||||
"ScalingPolicy": {
|
||||
@@ -377,19 +433,42 @@
|
||||
"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>"
|
||||
"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": {
|
||||
@@ -414,17 +493,22 @@
|
||||
"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 new policy and the policy type is <code>TargetTrackingScaling</code>.</p>",
|
||||
"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>"
|
||||
"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": {
|
||||
@@ -441,6 +525,8 @@
|
||||
"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>",
|
||||
|
||||
Generated
Vendored
+13
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"version": 1,
|
||||
"defaultRegion": "us-west-2",
|
||||
"testCases": [
|
||||
{
|
||||
"operationName": "DescribeScalableTargets",
|
||||
"input": {
|
||||
"ServiceNamespace": "ec2"
|
||||
},
|
||||
"errorExpectedFromService": false
|
||||
}
|
||||
]
|
||||
}
|
||||
+486
-5
@@ -6,6 +6,7 @@
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceFullName":"Amazon AppStream",
|
||||
"serviceId":"AppStream",
|
||||
"signatureVersion":"v4",
|
||||
"signingName":"appstream",
|
||||
"targetPrefix":"PhotonAdminProxyService",
|
||||
@@ -22,12 +23,30 @@
|
||||
"output":{"shape":"AssociateFleetResult"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidAccountStatusException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"IncompatibleImageException"},
|
||||
{"shape":"OperationNotPermittedException"}
|
||||
]
|
||||
},
|
||||
"CopyImage":{
|
||||
"name":"CopyImage",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CopyImageRequest"},
|
||||
"output":{"shape":"CopyImageResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceAlreadyExistsException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ResourceNotAvailableException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidAccountStatusException"},
|
||||
{"shape":"IncompatibleImageException"}
|
||||
]
|
||||
},
|
||||
"CreateDirectoryConfig":{
|
||||
"name":"CreateDirectoryConfig",
|
||||
"http":{
|
||||
@@ -38,7 +57,8 @@
|
||||
"output":{"shape":"CreateDirectoryConfigResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceAlreadyExistsException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidAccountStatusException"}
|
||||
]
|
||||
},
|
||||
"CreateFleet":{
|
||||
@@ -54,12 +74,46 @@
|
||||
{"shape":"ResourceNotAvailableException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidAccountStatusException"},
|
||||
{"shape":"InvalidRoleException"},
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"InvalidParameterCombinationException"},
|
||||
{"shape":"IncompatibleImageException"}
|
||||
]
|
||||
},
|
||||
"CreateImageBuilder":{
|
||||
"name":"CreateImageBuilder",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateImageBuilderRequest"},
|
||||
"output":{"shape":"CreateImageBuilderResult"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidAccountStatusException"},
|
||||
{"shape":"ResourceAlreadyExistsException"},
|
||||
{"shape":"ResourceNotAvailableException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidRoleException"},
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"InvalidParameterCombinationException"},
|
||||
{"shape":"IncompatibleImageException"}
|
||||
]
|
||||
},
|
||||
"CreateImageBuilderStreamingURL":{
|
||||
"name":"CreateImageBuilderStreamingURL",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateImageBuilderStreamingURLRequest"},
|
||||
"output":{"shape":"CreateImageBuilderStreamingURLResult"},
|
||||
"errors":[
|
||||
{"shape":"OperationNotPermittedException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"CreateStack":{
|
||||
"name":"CreateStack",
|
||||
"http":{
|
||||
@@ -70,6 +124,7 @@
|
||||
"output":{"shape":"CreateStackResult"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidAccountStatusException"},
|
||||
{"shape":"ResourceAlreadyExistsException"},
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"InvalidRoleException"},
|
||||
@@ -119,6 +174,35 @@
|
||||
{"shape":"ConcurrentModificationException"}
|
||||
]
|
||||
},
|
||||
"DeleteImage":{
|
||||
"name":"DeleteImage",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteImageRequest"},
|
||||
"output":{"shape":"DeleteImageResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceInUseException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"OperationNotPermittedException"},
|
||||
{"shape":"ConcurrentModificationException"}
|
||||
]
|
||||
},
|
||||
"DeleteImageBuilder":{
|
||||
"name":"DeleteImageBuilder",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteImageBuilderRequest"},
|
||||
"output":{"shape":"DeleteImageBuilderResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"OperationNotPermittedException"},
|
||||
{"shape":"ConcurrentModificationException"}
|
||||
]
|
||||
},
|
||||
"DeleteStack":{
|
||||
"name":"DeleteStack",
|
||||
"http":{
|
||||
@@ -157,6 +241,18 @@
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"DescribeImageBuilders":{
|
||||
"name":"DescribeImageBuilders",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeImageBuildersRequest"},
|
||||
"output":{"shape":"DescribeImageBuildersResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"DescribeImages":{
|
||||
"name":"DescribeImages",
|
||||
"http":{
|
||||
@@ -234,6 +330,18 @@
|
||||
"input":{"shape":"ListAssociatedStacksRequest"},
|
||||
"output":{"shape":"ListAssociatedStacksResult"}
|
||||
},
|
||||
"ListTagsForResource":{
|
||||
"name":"ListTagsForResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListTagsForResourceRequest"},
|
||||
"output":{"shape":"ListTagsForResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"StartFleet":{
|
||||
"name":"StartFleet",
|
||||
"http":{
|
||||
@@ -246,9 +354,26 @@
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"OperationNotPermittedException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidAccountStatusException"},
|
||||
{"shape":"ConcurrentModificationException"}
|
||||
]
|
||||
},
|
||||
"StartImageBuilder":{
|
||||
"name":"StartImageBuilder",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StartImageBuilderRequest"},
|
||||
"output":{"shape":"StartImageBuilderResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotAvailableException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"InvalidAccountStatusException"},
|
||||
{"shape":"IncompatibleImageException"}
|
||||
]
|
||||
},
|
||||
"StopFleet":{
|
||||
"name":"StopFleet",
|
||||
"http":{
|
||||
@@ -262,6 +387,46 @@
|
||||
{"shape":"ConcurrentModificationException"}
|
||||
]
|
||||
},
|
||||
"StopImageBuilder":{
|
||||
"name":"StopImageBuilder",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StopImageBuilderRequest"},
|
||||
"output":{"shape":"StopImageBuilderResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"OperationNotPermittedException"},
|
||||
{"shape":"ConcurrentModificationException"}
|
||||
]
|
||||
},
|
||||
"TagResource":{
|
||||
"name":"TagResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"TagResourceRequest"},
|
||||
"output":{"shape":"TagResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidAccountStatusException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"UntagResource":{
|
||||
"name":"UntagResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UntagResourceRequest"},
|
||||
"output":{"shape":"UntagResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"UpdateDirectoryConfig":{
|
||||
"name":"UpdateDirectoryConfig",
|
||||
"http":{
|
||||
@@ -287,6 +452,7 @@
|
||||
"errors":[
|
||||
{"shape":"ResourceInUseException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidAccountStatusException"},
|
||||
{"shape":"InvalidRoleException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ResourceNotAvailableException"},
|
||||
@@ -310,6 +476,7 @@
|
||||
{"shape":"InvalidRoleException"},
|
||||
{"shape":"InvalidParameterCombinationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidAccountStatusException"},
|
||||
{"shape":"IncompatibleImageException"}
|
||||
]
|
||||
}
|
||||
@@ -342,6 +509,11 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"Application"}
|
||||
},
|
||||
"AppstreamAgentVersion":{
|
||||
"type":"string",
|
||||
"max":100,
|
||||
"min":1
|
||||
},
|
||||
"Arn":{
|
||||
"type":"string",
|
||||
"pattern":"^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$"
|
||||
@@ -396,6 +568,26 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"CopyImageRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"SourceImageName",
|
||||
"DestinationImageName",
|
||||
"DestinationRegion"
|
||||
],
|
||||
"members":{
|
||||
"SourceImageName":{"shape":"Name"},
|
||||
"DestinationImageName":{"shape":"Name"},
|
||||
"DestinationRegion":{"shape":"RegionName"},
|
||||
"DestinationImageDescription":{"shape":"Description"}
|
||||
}
|
||||
},
|
||||
"CopyImageResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DestinationImageName":{"shape":"Name"}
|
||||
}
|
||||
},
|
||||
"CreateDirectoryConfigRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -444,6 +636,46 @@
|
||||
"Fleet":{"shape":"Fleet"}
|
||||
}
|
||||
},
|
||||
"CreateImageBuilderRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Name",
|
||||
"ImageName",
|
||||
"InstanceType"
|
||||
],
|
||||
"members":{
|
||||
"Name":{"shape":"Name"},
|
||||
"ImageName":{"shape":"String"},
|
||||
"InstanceType":{"shape":"String"},
|
||||
"Description":{"shape":"Description"},
|
||||
"DisplayName":{"shape":"DisplayName"},
|
||||
"VpcConfig":{"shape":"VpcConfig"},
|
||||
"EnableDefaultInternetAccess":{"shape":"BooleanObject"},
|
||||
"DomainJoinInfo":{"shape":"DomainJoinInfo"},
|
||||
"AppstreamAgentVersion":{"shape":"AppstreamAgentVersion"}
|
||||
}
|
||||
},
|
||||
"CreateImageBuilderResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ImageBuilder":{"shape":"ImageBuilder"}
|
||||
}
|
||||
},
|
||||
"CreateImageBuilderStreamingURLRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{"shape":"String"},
|
||||
"Validity":{"shape":"Long"}
|
||||
}
|
||||
},
|
||||
"CreateImageBuilderStreamingURLResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"StreamingURL":{"shape":"String"},
|
||||
"Expires":{"shape":"Timestamp"}
|
||||
}
|
||||
},
|
||||
"CreateStackRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
@@ -451,7 +683,9 @@
|
||||
"Name":{"shape":"String"},
|
||||
"Description":{"shape":"Description"},
|
||||
"DisplayName":{"shape":"DisplayName"},
|
||||
"StorageConnectors":{"shape":"StorageConnectorList"}
|
||||
"StorageConnectors":{"shape":"StorageConnectorList"},
|
||||
"RedirectURL":{"shape":"RedirectURL"},
|
||||
"FeedbackURL":{"shape":"FeedbackURL"}
|
||||
}
|
||||
},
|
||||
"CreateStackResult":{
|
||||
@@ -507,6 +741,32 @@
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteImageBuilderRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{"shape":"Name"}
|
||||
}
|
||||
},
|
||||
"DeleteImageBuilderResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ImageBuilder":{"shape":"ImageBuilder"}
|
||||
}
|
||||
},
|
||||
"DeleteImageRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{"shape":"Name"}
|
||||
}
|
||||
},
|
||||
"DeleteImageResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Image":{"shape":"Image"}
|
||||
}
|
||||
},
|
||||
"DeleteStackRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
@@ -548,6 +808,21 @@
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeImageBuildersRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Names":{"shape":"StringList"},
|
||||
"MaxResults":{"shape":"Integer"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeImageBuildersResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ImageBuilders":{"shape":"ImageBuilderList"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeImagesRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -659,6 +934,10 @@
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"FeedbackURL":{
|
||||
"type":"string",
|
||||
"max":1000
|
||||
},
|
||||
"Fleet":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -778,9 +1057,63 @@
|
||||
"StateChangeReason":{"shape":"ImageStateChangeReason"},
|
||||
"Applications":{"shape":"Applications"},
|
||||
"CreatedTime":{"shape":"Timestamp"},
|
||||
"PublicBaseImageReleasedDate":{"shape":"Timestamp"}
|
||||
"PublicBaseImageReleasedDate":{"shape":"Timestamp"},
|
||||
"AppstreamAgentVersion":{"shape":"AppstreamAgentVersion"}
|
||||
}
|
||||
},
|
||||
"ImageBuilder":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{"shape":"String"},
|
||||
"Arn":{"shape":"Arn"},
|
||||
"ImageArn":{"shape":"Arn"},
|
||||
"Description":{"shape":"String"},
|
||||
"DisplayName":{"shape":"String"},
|
||||
"VpcConfig":{"shape":"VpcConfig"},
|
||||
"InstanceType":{"shape":"String"},
|
||||
"Platform":{"shape":"PlatformType"},
|
||||
"State":{"shape":"ImageBuilderState"},
|
||||
"StateChangeReason":{"shape":"ImageBuilderStateChangeReason"},
|
||||
"CreatedTime":{"shape":"Timestamp"},
|
||||
"EnableDefaultInternetAccess":{"shape":"BooleanObject"},
|
||||
"DomainJoinInfo":{"shape":"DomainJoinInfo"},
|
||||
"ImageBuilderErrors":{"shape":"ResourceErrors"},
|
||||
"AppstreamAgentVersion":{"shape":"AppstreamAgentVersion"}
|
||||
}
|
||||
},
|
||||
"ImageBuilderList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ImageBuilder"}
|
||||
},
|
||||
"ImageBuilderState":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"PENDING",
|
||||
"UPDATING_AGENT",
|
||||
"RUNNING",
|
||||
"STOPPING",
|
||||
"STOPPED",
|
||||
"REBOOTING",
|
||||
"SNAPSHOTTING",
|
||||
"DELETING",
|
||||
"FAILED"
|
||||
]
|
||||
},
|
||||
"ImageBuilderStateChangeReason":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Code":{"shape":"ImageBuilderStateChangeReasonCode"},
|
||||
"Message":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ImageBuilderStateChangeReasonCode":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"INTERNAL_ERROR",
|
||||
"IMAGE_UNAVAILABLE"
|
||||
]
|
||||
},
|
||||
"ImageList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Image"}
|
||||
@@ -791,6 +1124,7 @@
|
||||
"PENDING",
|
||||
"AVAILABLE",
|
||||
"FAILED",
|
||||
"COPYING",
|
||||
"DELETING"
|
||||
]
|
||||
},
|
||||
@@ -805,7 +1139,8 @@
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"INTERNAL_ERROR",
|
||||
"IMAGE_BUILDER_NOT_AVAILABLE"
|
||||
"IMAGE_BUILDER_NOT_AVAILABLE",
|
||||
"IMAGE_COPY_FAILURE"
|
||||
]
|
||||
},
|
||||
"IncompatibleImageException":{
|
||||
@@ -816,6 +1151,13 @@
|
||||
"exception":true
|
||||
},
|
||||
"Integer":{"type":"integer"},
|
||||
"InvalidAccountStatusException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidParameterCombinationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -867,6 +1209,19 @@
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":["ResourceArn"],
|
||||
"members":{
|
||||
"ResourceArn":{"shape":"Arn"}
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Tags":{"shape":"Tags"}
|
||||
}
|
||||
},
|
||||
"Long":{"type":"long"},
|
||||
"Metadata":{
|
||||
"type":"map",
|
||||
@@ -896,6 +1251,15 @@
|
||||
"type":"string",
|
||||
"enum":["WINDOWS"]
|
||||
},
|
||||
"RedirectURL":{
|
||||
"type":"string",
|
||||
"max":1000
|
||||
},
|
||||
"RegionName":{
|
||||
"type":"string",
|
||||
"max":32,
|
||||
"min":1
|
||||
},
|
||||
"ResourceAlreadyExistsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -903,6 +1267,18 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ResourceError":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ErrorCode":{"shape":"FleetErrorCode"},
|
||||
"ErrorMessage":{"shape":"String"},
|
||||
"ErrorTimestamp":{"shape":"Timestamp"}
|
||||
}
|
||||
},
|
||||
"ResourceErrors":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ResourceError"}
|
||||
},
|
||||
"ResourceIdentifier":{
|
||||
"type":"string",
|
||||
"min":1
|
||||
@@ -984,9 +1360,24 @@
|
||||
"DisplayName":{"shape":"String"},
|
||||
"CreatedTime":{"shape":"Timestamp"},
|
||||
"StorageConnectors":{"shape":"StorageConnectorList"},
|
||||
"RedirectURL":{"shape":"RedirectURL"},
|
||||
"FeedbackURL":{"shape":"FeedbackURL"},
|
||||
"StackErrors":{"shape":"StackErrors"}
|
||||
}
|
||||
},
|
||||
"StackAttribute":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"STORAGE_CONNECTORS",
|
||||
"REDIRECT_URL",
|
||||
"FEEDBACK_URL",
|
||||
"THEME_NAME"
|
||||
]
|
||||
},
|
||||
"StackAttributes":{
|
||||
"type":"list",
|
||||
"member":{"shape":"StackAttribute"}
|
||||
},
|
||||
"StackError":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1021,6 +1412,20 @@
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"StartImageBuilderRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{"shape":"String"},
|
||||
"AppstreamAgentVersion":{"shape":"AppstreamAgentVersion"}
|
||||
}
|
||||
},
|
||||
"StartImageBuilderResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ImageBuilder":{"shape":"ImageBuilder"}
|
||||
}
|
||||
},
|
||||
"StopFleetRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
@@ -1033,6 +1438,19 @@
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"StopImageBuilderRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"StopImageBuilderResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ImageBuilder":{"shape":"ImageBuilder"}
|
||||
}
|
||||
},
|
||||
"StorageConnector":{
|
||||
"type":"structure",
|
||||
"required":["ConnectorType"],
|
||||
@@ -1067,7 +1485,64 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"TagKey":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":1,
|
||||
"pattern":"^(^(?!aws:).[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
|
||||
},
|
||||
"TagKeyList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"TagKey"},
|
||||
"max":50,
|
||||
"min":1
|
||||
},
|
||||
"TagResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResourceArn",
|
||||
"Tags"
|
||||
],
|
||||
"members":{
|
||||
"ResourceArn":{"shape":"Arn"},
|
||||
"Tags":{"shape":"Tags"}
|
||||
}
|
||||
},
|
||||
"TagResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"TagValue":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":0,
|
||||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
|
||||
},
|
||||
"Tags":{
|
||||
"type":"map",
|
||||
"key":{"shape":"TagKey"},
|
||||
"value":{"shape":"TagValue"},
|
||||
"max":50,
|
||||
"min":1
|
||||
},
|
||||
"Timestamp":{"type":"timestamp"},
|
||||
"UntagResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResourceArn",
|
||||
"TagKeys"
|
||||
],
|
||||
"members":{
|
||||
"ResourceArn":{"shape":"Arn"},
|
||||
"TagKeys":{"shape":"TagKeyList"}
|
||||
}
|
||||
},
|
||||
"UntagResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"UpdateDirectoryConfigRequest":{
|
||||
"type":"structure",
|
||||
"required":["DirectoryName"],
|
||||
@@ -1119,7 +1594,13 @@
|
||||
"Description":{"shape":"Description"},
|
||||
"Name":{"shape":"String"},
|
||||
"StorageConnectors":{"shape":"StorageConnectorList"},
|
||||
"DeleteStorageConnectors":{"shape":"Boolean"}
|
||||
"DeleteStorageConnectors":{
|
||||
"shape":"Boolean",
|
||||
"deprecated":true
|
||||
},
|
||||
"RedirectURL":{"shape":"RedirectURL"},
|
||||
"FeedbackURL":{"shape":"FeedbackURL"},
|
||||
"AttributesToDelete":{"shape":"StackAttributes"}
|
||||
}
|
||||
},
|
||||
"UpdateStackResult":{
|
||||
|
||||
+470
-185
File diff suppressed because it is too large
Load Diff
+1417
File diff suppressed because it is too large
Load Diff
+677
@@ -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
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"pagination": {
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+465
@@ -0,0 +1,465 @@
|
||||
{
|
||||
"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"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"ApplicationSource":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CloudFormationStackARN":{"shape":"XmlString"}
|
||||
}
|
||||
},
|
||||
"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"},
|
||||
"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"
|
||||
]
|
||||
},
|
||||
"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"
|
||||
]
|
||||
},
|
||||
"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"},
|
||||
"ValidationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"XmlString":{
|
||||
"type":"string",
|
||||
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+371
@@ -0,0 +1,371 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<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>"
|
||||
},
|
||||
"shapes": {
|
||||
"ApplicationSource": {
|
||||
"base": "<p>Represents an application source.</p>",
|
||||
"refs": {
|
||||
"ApplicationSources$member": null,
|
||||
"CreateScalingPlanRequest$ApplicationSource": "<p>The source for the application.</p>",
|
||||
"ScalingPlan$ApplicationSource": "<p>The application source.</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 attached to the Auto Scaling group, Spot Fleet request, or ECS service.</p> <p>The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:</p> <ul> <li> <p>app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN</p> </li> <li> <p>targetgroup/<target-group-name>/<target-group-id> 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>"
|
||||
}
|
||||
},
|
||||
"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.</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>"
|
||||
}
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"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$CreationTime": "<p>The Unix timestamp when the scaling plan was created.</p>"
|
||||
}
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+5
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"pagination": {
|
||||
}
|
||||
}
|
||||
+59
-15
@@ -18,7 +18,8 @@
|
||||
},
|
||||
"input":{"shape":"AttachInstancesQuery"},
|
||||
"errors":[
|
||||
{"shape":"ResourceContentionFault"}
|
||||
{"shape":"ResourceContentionFault"},
|
||||
{"shape":"ServiceLinkedRoleFailure"}
|
||||
]
|
||||
},
|
||||
"AttachLoadBalancerTargetGroups":{
|
||||
@@ -33,7 +34,8 @@
|
||||
"resultWrapper":"AttachLoadBalancerTargetGroupsResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"ResourceContentionFault"}
|
||||
{"shape":"ResourceContentionFault"},
|
||||
{"shape":"ServiceLinkedRoleFailure"}
|
||||
]
|
||||
},
|
||||
"AttachLoadBalancers":{
|
||||
@@ -48,7 +50,8 @@
|
||||
"resultWrapper":"AttachLoadBalancersResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"ResourceContentionFault"}
|
||||
{"shape":"ResourceContentionFault"},
|
||||
{"shape":"ServiceLinkedRoleFailure"}
|
||||
]
|
||||
},
|
||||
"CompleteLifecycleAction":{
|
||||
@@ -76,7 +79,8 @@
|
||||
"errors":[
|
||||
{"shape":"AlreadyExistsFault"},
|
||||
{"shape":"LimitExceededFault"},
|
||||
{"shape":"ResourceContentionFault"}
|
||||
{"shape":"ResourceContentionFault"},
|
||||
{"shape":"ServiceLinkedRoleFailure"}
|
||||
]
|
||||
},
|
||||
"CreateLaunchConfiguration":{
|
||||
@@ -165,7 +169,8 @@
|
||||
},
|
||||
"input":{"shape":"DeletePolicyType"},
|
||||
"errors":[
|
||||
{"shape":"ResourceContentionFault"}
|
||||
{"shape":"ResourceContentionFault"},
|
||||
{"shape":"ServiceLinkedRoleFailure"}
|
||||
]
|
||||
},
|
||||
"DeleteScheduledAction":{
|
||||
@@ -383,7 +388,8 @@
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"InvalidNextToken"},
|
||||
{"shape":"ResourceContentionFault"}
|
||||
{"shape":"ResourceContentionFault"},
|
||||
{"shape":"ServiceLinkedRoleFailure"}
|
||||
]
|
||||
},
|
||||
"DescribeScalingActivities":{
|
||||
@@ -596,7 +602,8 @@
|
||||
"input":{"shape":"PutNotificationConfigurationType"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededFault"},
|
||||
{"shape":"ResourceContentionFault"}
|
||||
{"shape":"ResourceContentionFault"},
|
||||
{"shape":"ServiceLinkedRoleFailure"}
|
||||
]
|
||||
},
|
||||
"PutScalingPolicy":{
|
||||
@@ -612,7 +619,8 @@
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededFault"},
|
||||
{"shape":"ResourceContentionFault"}
|
||||
{"shape":"ResourceContentionFault"},
|
||||
{"shape":"ServiceLinkedRoleFailure"}
|
||||
]
|
||||
},
|
||||
"PutScheduledUpdateGroupAction":{
|
||||
@@ -731,7 +739,8 @@
|
||||
"input":{"shape":"UpdateAutoScalingGroupType"},
|
||||
"errors":[
|
||||
{"shape":"ScalingActivityInProgressFault"},
|
||||
{"shape":"ResourceContentionFault"}
|
||||
{"shape":"ResourceContentionFault"},
|
||||
{"shape":"ServiceLinkedRoleFailure"}
|
||||
]
|
||||
}
|
||||
},
|
||||
@@ -876,6 +885,7 @@
|
||||
"AutoScalingGroupName":{"shape":"XmlStringMaxLen255"},
|
||||
"AutoScalingGroupARN":{"shape":"ResourceName"},
|
||||
"LaunchConfigurationName":{"shape":"XmlStringMaxLen255"},
|
||||
"LaunchTemplate":{"shape":"LaunchTemplateSpecification"},
|
||||
"MinSize":{"shape":"AutoScalingGroupMinSize"},
|
||||
"MaxSize":{"shape":"AutoScalingGroupMaxSize"},
|
||||
"DesiredCapacity":{"shape":"AutoScalingGroupDesiredCapacity"},
|
||||
@@ -894,7 +904,8 @@
|
||||
"Status":{"shape":"XmlStringMaxLen255"},
|
||||
"Tags":{"shape":"TagDescriptionList"},
|
||||
"TerminationPolicies":{"shape":"TerminationPolicies"},
|
||||
"NewInstancesProtectedFromScaleIn":{"shape":"InstanceProtected"}
|
||||
"NewInstancesProtectedFromScaleIn":{"shape":"InstanceProtected"},
|
||||
"ServiceLinkedRoleARN":{"shape":"ResourceName"}
|
||||
}
|
||||
},
|
||||
"AutoScalingGroupDesiredCapacity":{"type":"integer"},
|
||||
@@ -932,7 +943,6 @@
|
||||
"AvailabilityZone",
|
||||
"LifecycleState",
|
||||
"HealthStatus",
|
||||
"LaunchConfigurationName",
|
||||
"ProtectedFromScaleIn"
|
||||
],
|
||||
"members":{
|
||||
@@ -942,6 +952,7 @@
|
||||
"LifecycleState":{"shape":"XmlStringMaxLen32"},
|
||||
"HealthStatus":{"shape":"XmlStringMaxLen32"},
|
||||
"LaunchConfigurationName":{"shape":"XmlStringMaxLen255"},
|
||||
"LaunchTemplate":{"shape":"LaunchTemplateSpecification"},
|
||||
"ProtectedFromScaleIn":{"shape":"InstanceProtected"}
|
||||
}
|
||||
},
|
||||
@@ -1031,6 +1042,7 @@
|
||||
"members":{
|
||||
"AutoScalingGroupName":{"shape":"XmlStringMaxLen255"},
|
||||
"LaunchConfigurationName":{"shape":"ResourceName"},
|
||||
"LaunchTemplate":{"shape":"LaunchTemplateSpecification"},
|
||||
"InstanceId":{"shape":"XmlStringMaxLen19"},
|
||||
"MinSize":{"shape":"AutoScalingGroupMinSize"},
|
||||
"MaxSize":{"shape":"AutoScalingGroupMaxSize"},
|
||||
@@ -1046,7 +1058,8 @@
|
||||
"TerminationPolicies":{"shape":"TerminationPolicies"},
|
||||
"NewInstancesProtectedFromScaleIn":{"shape":"InstanceProtected"},
|
||||
"LifecycleHookSpecificationList":{"shape":"LifecycleHookSpecifications"},
|
||||
"Tags":{"shape":"Tags"}
|
||||
"Tags":{"shape":"Tags"},
|
||||
"ServiceLinkedRoleARN":{"shape":"ResourceName"}
|
||||
}
|
||||
},
|
||||
"CreateLaunchConfigurationType":{
|
||||
@@ -1465,7 +1478,6 @@
|
||||
"AvailabilityZone",
|
||||
"LifecycleState",
|
||||
"HealthStatus",
|
||||
"LaunchConfigurationName",
|
||||
"ProtectedFromScaleIn"
|
||||
],
|
||||
"members":{
|
||||
@@ -1474,6 +1486,7 @@
|
||||
"LifecycleState":{"shape":"LifecycleState"},
|
||||
"HealthStatus":{"shape":"XmlStringMaxLen32"},
|
||||
"LaunchConfigurationName":{"shape":"XmlStringMaxLen255"},
|
||||
"LaunchTemplate":{"shape":"LaunchTemplateSpecification"},
|
||||
"ProtectedFromScaleIn":{"shape":"InstanceProtected"}
|
||||
}
|
||||
},
|
||||
@@ -1565,6 +1578,20 @@
|
||||
"NextToken":{"shape":"XmlString"}
|
||||
}
|
||||
},
|
||||
"LaunchTemplateName":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":3,
|
||||
"pattern":"[a-zA-Z0-9\\(\\)\\.-/_]+"
|
||||
},
|
||||
"LaunchTemplateSpecification":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"LaunchTemplateId":{"shape":"XmlStringMaxLen255"},
|
||||
"LaunchTemplateName":{"shape":"LaunchTemplateName"},
|
||||
"Version":{"shape":"XmlStringMaxLen255"}
|
||||
}
|
||||
},
|
||||
"LifecycleActionResult":{"type":"string"},
|
||||
"LifecycleActionToken":{
|
||||
"type":"string",
|
||||
@@ -1592,7 +1619,10 @@
|
||||
},
|
||||
"LifecycleHookSpecification":{
|
||||
"type":"structure",
|
||||
"required":["LifecycleHookName"],
|
||||
"required":[
|
||||
"LifecycleHookName",
|
||||
"LifecycleTransition"
|
||||
],
|
||||
"members":{
|
||||
"LifecycleHookName":{"shape":"AsciiStringMaxLen255"},
|
||||
"LifecycleTransition":{"shape":"LifecycleTransition"},
|
||||
@@ -2033,6 +2063,18 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"XmlString"}
|
||||
},
|
||||
"ServiceLinkedRoleFailure":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"XmlStringMaxLen255"}
|
||||
},
|
||||
"error":{
|
||||
"code":"ServiceLinkedRoleFailure",
|
||||
"httpStatusCode":500,
|
||||
"senderFault":true
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"SetDesiredCapacityType":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -2190,6 +2232,7 @@
|
||||
"members":{
|
||||
"AutoScalingGroupName":{"shape":"ResourceName"},
|
||||
"LaunchConfigurationName":{"shape":"ResourceName"},
|
||||
"LaunchTemplate":{"shape":"LaunchTemplateSpecification"},
|
||||
"MinSize":{"shape":"AutoScalingGroupMinSize"},
|
||||
"MaxSize":{"shape":"AutoScalingGroupMaxSize"},
|
||||
"DesiredCapacity":{"shape":"AutoScalingGroupDesiredCapacity"},
|
||||
@@ -2200,7 +2243,8 @@
|
||||
"PlacementGroup":{"shape":"XmlStringMaxLen255"},
|
||||
"VPCZoneIdentifier":{"shape":"XmlStringMaxLen2047"},
|
||||
"TerminationPolicies":{"shape":"TerminationPolicies"},
|
||||
"NewInstancesProtectedFromScaleIn":{"shape":"InstanceProtected"}
|
||||
"NewInstancesProtectedFromScaleIn":{"shape":"InstanceProtected"},
|
||||
"ServiceLinkedRoleARN":{"shape":"ResourceName"}
|
||||
}
|
||||
},
|
||||
"Values":{
|
||||
|
||||
+86
-59
@@ -1,13 +1,13 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<fullname>Auto Scaling</fullname> <p>Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service in conjunction with the Amazon CloudWatch and Elastic Load Balancing services.</p>",
|
||||
"service": "<fullname>Amazon EC2 Auto Scaling</fullname> <p>Amazon EC2 Auto Scaling is designed to automatically launch or terminate EC2 instances based on user-defined policies, schedules, and health checks. Use this service in conjunction with the AWS Auto Scaling, Amazon CloudWatch, and Elastic Load Balancing services.</p>",
|
||||
"operations": {
|
||||
"AttachInstances": "<p>Attaches one or more EC2 instances to the specified Auto Scaling group.</p> <p>When you attach instances, Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.</p> <p>If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-instance-asg.html\">Attach EC2 Instances to Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>",
|
||||
"AttachLoadBalancerTargetGroups": "<p>Attaches one or more target groups to the specified Auto Scaling group.</p> <p>To describe the target groups for an Auto Scaling group, use <a>DescribeLoadBalancerTargetGroups</a>. To detach the target group from the Auto Scaling group, use <a>DetachLoadBalancerTargetGroups</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-load-balancer-asg.html\">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>",
|
||||
"AttachLoadBalancers": "<p>Attaches one or more Classic Load Balancers to the specified Auto Scaling group.</p> <p>To attach an Application Load Balancer instead, see <a>AttachLoadBalancerTargetGroups</a>.</p> <p>To describe the load balancers for an Auto Scaling group, use <a>DescribeLoadBalancers</a>. To detach the load balancer from the Auto Scaling group, use <a>DetachLoadBalancers</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-load-balancer-asg.html\">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>",
|
||||
"CompleteLifecycleAction": "<p>Completes the lifecycle action for the specified token or instance with the specified result.</p> <p>This step is a part of the procedure for adding a lifecycle hook to an Auto Scaling group:</p> <ol> <li> <p>(Optional) Create a Lambda function and a rule that allows CloudWatch Events to invoke your Lambda function when Auto Scaling launches or terminates instances.</p> </li> <li> <p>(Optional) Create a notification target and an IAM role. The target can be either an Amazon SQS queue or an Amazon SNS topic. The role allows Auto Scaling to publish lifecycle notifications to the target.</p> </li> <li> <p>Create the lifecycle hook. Specify whether the hook is used when the instances launch or terminate.</p> </li> <li> <p>If you need more time, record the lifecycle action heartbeat to keep the instance in a pending state.</p> </li> <li> <p> <b>If you finish before the timeout period ends, complete the lifecycle action.</b> </p> </li> </ol> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>",
|
||||
"CreateAutoScalingGroup": "<p>Creates an Auto Scaling group with the specified name and attributes.</p> <p>If you exceed your maximum limit of Auto Scaling groups, which by default is 20 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroup.html\">Auto Scaling Groups</a> in the <i>Auto Scaling User Guide</i>.</p>",
|
||||
"CreateLaunchConfiguration": "<p>Creates a launch configuration.</p> <p>If you exceed your maximum limit of launch configurations, which by default is 100 per region, the call fails. For information about viewing and updating this limit, see <a>DescribeAccountLimits</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/LaunchConfiguration.html\">Launch Configurations</a> in the <i>Auto Scaling User Guide</i>.</p>",
|
||||
"CreateAutoScalingGroup": "<p>Creates an Auto Scaling group with the specified name and attributes.</p> <p>If you exceed your maximum limit of Auto Scaling groups, the call fails. For information about viewing this limit, see <a>DescribeAccountLimits</a>. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-account-limits.html\">Auto Scaling Limits</a> in the <i>Auto Scaling User Guide</i>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroup.html\">Auto Scaling Groups</a> in the <i>Auto Scaling User Guide</i>.</p>",
|
||||
"CreateLaunchConfiguration": "<p>Creates a launch configuration.</p> <p>If you exceed your maximum limit of launch configurations, the call fails. For information about viewing this limit, see <a>DescribeAccountLimits</a>. For information about updating this limit, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-account-limits.html\">Auto Scaling Limits</a> in the <i>Auto Scaling User Guide</i>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/LaunchConfiguration.html\">Launch Configurations</a> in the <i>Auto Scaling User Guide</i>.</p>",
|
||||
"CreateOrUpdateTags": "<p>Creates or updates tags for the specified Auto Scaling group.</p> <p>When you specify a tag with a key that already exists, the operation overwrites the previous tag definition, and you do not get an error message.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/autoscaling-tagging.html\">Tagging Auto Scaling Groups and Instances</a> in the <i>Auto Scaling User Guide</i>.</p>",
|
||||
"DeleteAutoScalingGroup": "<p>Deletes the specified Auto Scaling group.</p> <p>If the group has instances or scaling activities in progress, you must specify the option to force the deletion in order for it to succeed.</p> <p>If the group has policies, deleting the group deletes the policies, the underlying alarm actions, and any alarm that no longer has an associated action.</p> <p>To remove instances from the Auto Scaling group before deleting it, call <a>DetachInstances</a> with the list of instances and the option to decrement the desired capacity so that Auto Scaling does not launch replacement instances.</p> <p>To terminate all instances before deleting the Auto Scaling group, call <a>UpdateAutoScalingGroup</a> and set the minimum size and desired capacity of the Auto Scaling group to zero.</p>",
|
||||
"DeleteLaunchConfiguration": "<p>Deletes the specified launch configuration.</p> <p>The launch configuration must not be attached to an Auto Scaling group. When this call completes, the launch configuration is no longer available for use.</p>",
|
||||
@@ -16,7 +16,7 @@
|
||||
"DeletePolicy": "<p>Deletes the specified Auto Scaling policy.</p> <p>Deleting a policy deletes the underlying alarm action, but does not delete the alarm, even if it no longer has an associated action.</p>",
|
||||
"DeleteScheduledAction": "<p>Deletes the specified scheduled action.</p>",
|
||||
"DeleteTags": "<p>Deletes the specified tags.</p>",
|
||||
"DescribeAccountLimits": "<p>Describes the current Auto Scaling resource limits for your AWS account.</p> <p>For information about requesting an increase in these limits, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">AWS Service Limits</a> in the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"DescribeAccountLimits": "<p>Describes the current Auto Scaling resource limits for your AWS account.</p> <p>For information about requesting an increase in these limits, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-account-limits.html\">Auto Scaling Limits</a> in the <i>Auto Scaling User Guide</i>.</p>",
|
||||
"DescribeAdjustmentTypes": "<p>Describes the policy adjustment types for use with <a>PutScalingPolicy</a>.</p>",
|
||||
"DescribeAutoScalingGroups": "<p>Describes one or more Auto Scaling groups.</p>",
|
||||
"DescribeAutoScalingInstances": "<p>Describes one or more Auto Scaling instances.</p>",
|
||||
@@ -133,7 +133,7 @@
|
||||
"AssociatePublicIpAddress": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateLaunchConfigurationType$AssociatePublicIpAddress": "<p>Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Auto Scaling User Guide</i>.</p> <p>If you specify this parameter, be sure to specify at least one subnet when you create your group.</p> <p>Default: If the instance is launched into a default subnet, the default is <code>true</code>. If the instance is launched into a nondefault subnet, the default is <code>false</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html\">Supported Platforms</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
|
||||
"CreateLaunchConfigurationType$AssociatePublicIpAddress": "<p>Used for groups that launch instances into a virtual private cloud (VPC). Specifies whether to assign a public IP address to each instance. For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Auto Scaling User Guide</i>.</p> <p>If you specify this parameter, be sure to specify at least one subnet when you create your group.</p> <p>Default: If the instance is launched into a default subnet, the default is to assign a public IP address. If the instance is launched into a nondefault subnet, the default is not to assign a public IP address.</p>",
|
||||
"LaunchConfiguration$AssociatePublicIpAddress": "<p>[EC2-VPC] Indicates whether to assign a public IP address to each instance.</p>"
|
||||
}
|
||||
},
|
||||
@@ -202,8 +202,8 @@
|
||||
"AutoScalingGroupNames": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AutoScalingGroupNamesType$AutoScalingGroupNames": "<p>The group names. If you omit this parameter, all Auto Scaling groups are described.</p>",
|
||||
"DescribeNotificationConfigurationsType$AutoScalingGroupNames": "<p>The name of the group.</p>"
|
||||
"AutoScalingGroupNamesType$AutoScalingGroupNames": "<p>The names of the Auto Scaling groups. If you omit this parameter, all Auto Scaling groups are described.</p>",
|
||||
"DescribeNotificationConfigurationsType$AutoScalingGroupNames": "<p>The name of the Auto Scaling group.</p>"
|
||||
}
|
||||
},
|
||||
"AutoScalingGroupNamesType": {
|
||||
@@ -258,7 +258,7 @@
|
||||
"BlockDeviceEbsDeleteOnTermination": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Ebs$DeleteOnTermination": "<p>Indicates whether the volume is deleted on instance termination.</p> <p>Default: <code>true</code> </p>"
|
||||
"Ebs$DeleteOnTermination": "<p>Indicates whether the volume is deleted on instance termination. The default is <code>true</code>.</p>"
|
||||
}
|
||||
},
|
||||
"BlockDeviceEbsEncrypted": {
|
||||
@@ -514,7 +514,7 @@
|
||||
"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 instances from the Auto Scaling group. Otherwise, scale in is enabled and the target tracking policy can remove instances from the Auto Scaling group. The default value is <code>false</code>.</p>"
|
||||
"TargetTrackingConfiguration$DisableScaleIn": "<p>Indicates whether scale in by the target tracking policy is disabled. If scale in is disabled, the target tracking policy won't remove instances from the Auto Scaling group. Otherwise, the target tracking policy can remove instances from the Auto Scaling group. The default is disabled.</p>"
|
||||
}
|
||||
},
|
||||
"Ebs": {
|
||||
@@ -622,8 +622,8 @@
|
||||
"HonorCooldown": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ExecutePolicyType$HonorCooldown": "<p>If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy. Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to complete.</p> <p>This parameter is not supported if the policy type is <code>StepScaling</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html\">Auto Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.</p>",
|
||||
"SetDesiredCapacityType$HonorCooldown": "<p>By default, <code>SetDesiredCapacity</code> overrides any cooldown period associated with the Auto Scaling group. Specify <code>True</code> to make Auto Scaling to wait for the cool-down period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity.</p>"
|
||||
"ExecutePolicyType$HonorCooldown": "<p>Indicates whether Auto Scaling waits for the cooldown period to complete before executing the policy.</p> <p>This parameter is not supported if the policy type is <code>StepScaling</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/Cooldown.html\">Auto Scaling Cooldowns</a> in the <i>Auto Scaling User Guide</i>.</p>",
|
||||
"SetDesiredCapacityType$HonorCooldown": "<p>Indicates whether Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Auto Scaling does not honor the cooldown period during manual scaling activities.</p>"
|
||||
}
|
||||
},
|
||||
"Instance": {
|
||||
@@ -635,11 +635,11 @@
|
||||
"InstanceIds": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AttachInstancesQuery$InstanceIds": "<p>One or more instance IDs.</p>",
|
||||
"AttachInstancesQuery$InstanceIds": "<p>The IDs of the instances. You can specify up to 20 instances.</p>",
|
||||
"DescribeAutoScalingInstancesType$InstanceIds": "<p>The instances to describe; up to 50 instance IDs. If you omit this parameter, all Auto Scaling instances are described. If you specify an ID that does not exist, it is ignored with no error.</p>",
|
||||
"DetachInstancesQuery$InstanceIds": "<p>One or more instance IDs.</p>",
|
||||
"EnterStandbyQuery$InstanceIds": "<p>One or more instances to move into <code>Standby</code> mode. You must specify at least one instance ID.</p>",
|
||||
"ExitStandbyQuery$InstanceIds": "<p>One or more instance IDs. You must specify at least one instance ID.</p>",
|
||||
"DetachInstancesQuery$InstanceIds": "<p>The IDs of the instances. You can specify up to 20 instances.</p>",
|
||||
"EnterStandbyQuery$InstanceIds": "<p>The IDs of the instances. You can specify up to 20 instances.</p>",
|
||||
"ExitStandbyQuery$InstanceIds": "<p>The IDs of the instances. You can specify up to 20 instances.</p>",
|
||||
"SetInstanceProtectionQuery$InstanceIds": "<p>One or more instance IDs.</p>"
|
||||
}
|
||||
},
|
||||
@@ -704,12 +704,28 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"LaunchTemplateName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"LaunchTemplateSpecification$LaunchTemplateName": "<p>The name of the launch template. You must specify either a template name or a template ID.</p>"
|
||||
}
|
||||
},
|
||||
"LaunchTemplateSpecification": {
|
||||
"base": "<p>Describes a launch template.</p>",
|
||||
"refs": {
|
||||
"AutoScalingGroup$LaunchTemplate": "<p>The launch template for the group.</p>",
|
||||
"AutoScalingInstanceDetails$LaunchTemplate": "<p>The launch template for the instance.</p>",
|
||||
"CreateAutoScalingGroupType$LaunchTemplate": "<p>The launch template to use to launch instances. You must specify one of the following: a launch template, a launch configuration, or an EC2 instance.</p>",
|
||||
"Instance$LaunchTemplate": "<p>The launch template for the instance.</p>",
|
||||
"UpdateAutoScalingGroupType$LaunchTemplate": "<p>The launch template to use to specify the updates. If you specify a launch template, you can't specify a launch configuration.</p>"
|
||||
}
|
||||
},
|
||||
"LifecycleActionResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CompleteLifecycleActionType$LifecycleActionResult": "<p>The action for the group to take. This parameter can be either <code>CONTINUE</code> or <code>ABANDON</code>.</p>",
|
||||
"LifecycleHook$DefaultResult": "<p>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are <code>CONTINUE</code> and <code>ABANDON</code>. The default value is <code>CONTINUE</code>.</p>",
|
||||
"LifecycleHookSpecification$DefaultResult": "<p>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are <code>CONTINUE</code> and <code>ABANDON</code>. The default value is <code>CONTINUE</code>.</p>",
|
||||
"LifecycleHookSpecification$DefaultResult": "<p>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. The valid values are <code>CONTINUE</code> and <code>ABANDON</code>.</p>",
|
||||
"PutLifecycleHookType$DefaultResult": "<p>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either <code>CONTINUE</code> or <code>ABANDON</code>. The default value is <code>ABANDON</code>.</p>"
|
||||
}
|
||||
},
|
||||
@@ -772,10 +788,10 @@
|
||||
"LoadBalancerNames": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AttachLoadBalancersType$LoadBalancerNames": "<p>One or more load balancer names.</p>",
|
||||
"AttachLoadBalancersType$LoadBalancerNames": "<p>The names of the load balancers. You can specify up to 10 load balancers.</p>",
|
||||
"AutoScalingGroup$LoadBalancerNames": "<p>One or more load balancers associated with the group.</p>",
|
||||
"CreateAutoScalingGroupType$LoadBalancerNames": "<p>One or more Classic Load Balancers. To specify an Application Load Balancer, use <code>TargetGroupARNs</code> instead.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-asg-from-instance.html\">Using a Load Balancer With an Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>",
|
||||
"DetachLoadBalancersType$LoadBalancerNames": "<p>One or more load balancer names.</p>"
|
||||
"DetachLoadBalancersType$LoadBalancerNames": "<p>The names of the load balancers. You can specify up to 10 load balancers.</p>"
|
||||
}
|
||||
},
|
||||
"LoadBalancerState": {
|
||||
@@ -818,12 +834,12 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AutoScalingGroupNamesType$MaxRecords": "<p>The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.</p>",
|
||||
"DescribeAutoScalingInstancesType$MaxRecords": "<p>The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.</p>",
|
||||
"DescribeLoadBalancerTargetGroupsRequest$MaxRecords": "<p>The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.</p>",
|
||||
"DescribeLoadBalancersRequest$MaxRecords": "<p>The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.</p>",
|
||||
"DescribeAutoScalingInstancesType$MaxRecords": "<p>The maximum number of items to return with this call. The default value is 50 and the maximum value is 50.</p>",
|
||||
"DescribeLoadBalancerTargetGroupsRequest$MaxRecords": "<p>The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.</p>",
|
||||
"DescribeLoadBalancersRequest$MaxRecords": "<p>The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.</p>",
|
||||
"DescribeNotificationConfigurationsType$MaxRecords": "<p>The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.</p>",
|
||||
"DescribePoliciesType$MaxRecords": "<p>The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.</p>",
|
||||
"DescribeScalingActivitiesType$MaxRecords": "<p>The maximum number of items to return with this call. The default value is 100.</p>",
|
||||
"DescribeScalingActivitiesType$MaxRecords": "<p>The maximum number of items to return with this call. The default value is 100 and the maximum value is 100.</p>",
|
||||
"DescribeScheduledActionsType$MaxRecords": "<p>The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.</p>",
|
||||
"DescribeTagsType$MaxRecords": "<p>The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.</p>",
|
||||
"LaunchConfigurationNamesType$MaxRecords": "<p>The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.</p>"
|
||||
@@ -1002,7 +1018,7 @@
|
||||
"PolicyNames": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribePoliciesType$PolicyNames": "<p>One or more policy names or policy ARNs to be described. If you omit this parameter, all policy names are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.</p>"
|
||||
"DescribePoliciesType$PolicyNames": "<p>The names of one or more policies. If you omit this parameter, all policies are described. If an group name is provided, the results are limited to that group. This list is limited to 50 items. If you specify an unknown policy name, it is ignored with no error.</p>"
|
||||
}
|
||||
},
|
||||
"PolicyTypes": {
|
||||
@@ -1108,34 +1124,36 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Alarm$AlarmARN": "<p>The Amazon Resource Name (ARN) of the alarm.</p>",
|
||||
"AttachInstancesQuery$AutoScalingGroupName": "<p>The name of the group.</p>",
|
||||
"AttachInstancesQuery$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"AttachLoadBalancerTargetGroupsType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"AttachLoadBalancersType$AutoScalingGroupName": "<p>The name of the group.</p>",
|
||||
"AutoScalingGroup$AutoScalingGroupARN": "<p>The Amazon Resource Name (ARN) of the group.</p>",
|
||||
"AttachLoadBalancersType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"AutoScalingGroup$AutoScalingGroupARN": "<p>The Amazon Resource Name (ARN) of the Auto Scaling group.</p>",
|
||||
"AutoScalingGroup$ServiceLinkedRoleARN": "<p>The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.</p>",
|
||||
"AutoScalingGroupNames$member": null,
|
||||
"CompleteLifecycleActionType$AutoScalingGroupName": "<p>The name of the group for the lifecycle hook.</p>",
|
||||
"CreateAutoScalingGroupType$LaunchConfigurationName": "<p>The name of the launch configuration. Alternatively, specify an EC2 instance instead of a launch configuration.</p>",
|
||||
"DeleteAutoScalingGroupType$AutoScalingGroupName": "<p>The name of the group to delete.</p>",
|
||||
"DeleteLifecycleHookType$AutoScalingGroupName": "<p>The name of the Auto Scaling group for the lifecycle hook.</p>",
|
||||
"CompleteLifecycleActionType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"CreateAutoScalingGroupType$LaunchConfigurationName": "<p>The name of the launch configuration. You must specify one of the following: a launch configuration, a launch template, or an EC2 instance.</p>",
|
||||
"CreateAutoScalingGroupType$ServiceLinkedRoleARN": "<p>The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf. By default, Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling, which it creates if it does not exist.</p>",
|
||||
"DeleteAutoScalingGroupType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"DeleteLifecycleHookType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"DeleteNotificationConfigurationType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"DeleteNotificationConfigurationType$TopicARN": "<p>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.</p>",
|
||||
"DeletePolicyType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"DeletePolicyType$PolicyName": "<p>The name or Amazon Resource Name (ARN) of the policy.</p>",
|
||||
"DeleteScheduledActionType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"DeleteScheduledActionType$ScheduledActionName": "<p>The name of the action to delete.</p>",
|
||||
"DescribeLifecycleHooksType$AutoScalingGroupName": "<p>The name of the group.</p>",
|
||||
"DescribeLifecycleHooksType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"DescribeLoadBalancerTargetGroupsRequest$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"DescribeLoadBalancersRequest$AutoScalingGroupName": "<p>The name of the group.</p>",
|
||||
"DescribePoliciesType$AutoScalingGroupName": "<p>The name of the group.</p>",
|
||||
"DescribeScalingActivitiesType$AutoScalingGroupName": "<p>The name of the group.</p>",
|
||||
"DescribeScheduledActionsType$AutoScalingGroupName": "<p>The name of the group.</p>",
|
||||
"DetachInstancesQuery$AutoScalingGroupName": "<p>The name of the group.</p>",
|
||||
"DescribeLoadBalancersRequest$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"DescribePoliciesType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"DescribeScalingActivitiesType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"DescribeScheduledActionsType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"DetachInstancesQuery$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"DetachLoadBalancerTargetGroupsType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"DetachLoadBalancersType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"DisableMetricsCollectionQuery$AutoScalingGroupName": "<p>The name or Amazon Resource Name (ARN) of the group.</p>",
|
||||
"EnableMetricsCollectionQuery$AutoScalingGroupName": "<p>The name or ARN of the Auto Scaling group.</p>",
|
||||
"DisableMetricsCollectionQuery$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"EnableMetricsCollectionQuery$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"EnterStandbyQuery$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"ExecutePolicyType$AutoScalingGroupName": "<p>The name or Amazon Resource Name (ARN) of the Auto Scaling group.</p>",
|
||||
"ExecutePolicyType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"ExecutePolicyType$PolicyName": "<p>The name or ARN of the policy.</p>",
|
||||
"ExitStandbyQuery$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"LaunchConfiguration$LaunchConfigurationARN": "<p>The Amazon Resource Name (ARN) of the launch configuration.</p>",
|
||||
@@ -1145,25 +1163,26 @@
|
||||
"LifecycleHook$NotificationTargetARN": "<p>The ARN of the target that Auto Scaling sends notifications to when an instance is in the transition state for the lifecycle hook. The notification target can be either an SQS queue or an SNS topic.</p>",
|
||||
"LifecycleHook$RoleARN": "<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.</p>",
|
||||
"LifecycleHookSpecification$RoleARN": "<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.</p>",
|
||||
"NotificationConfiguration$AutoScalingGroupName": "<p>The name of the group.</p>",
|
||||
"NotificationConfiguration$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"NotificationConfiguration$TopicARN": "<p>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.</p>",
|
||||
"PolicyARNType$PolicyARN": "<p>The Amazon Resource Name (ARN) of the policy.</p>",
|
||||
"PolicyNames$member": null,
|
||||
"PutLifecycleHookType$AutoScalingGroupName": "<p>The name of the Auto Scaling group to which you want to assign the lifecycle hook.</p>",
|
||||
"PutLifecycleHookType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"PutLifecycleHookType$RoleARN": "<p>The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target.</p> <p>This parameter is required for new lifecycle hooks, but optional when updating existing hooks.</p>",
|
||||
"PutNotificationConfigurationType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"PutNotificationConfigurationType$TopicARN": "<p>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.</p>",
|
||||
"PutScalingPolicyType$AutoScalingGroupName": "<p>The name or ARN of the group.</p>",
|
||||
"PutScheduledUpdateGroupActionType$AutoScalingGroupName": "<p>The name or Amazon Resource Name (ARN) of the Auto Scaling group.</p>",
|
||||
"RecordLifecycleActionHeartbeatType$AutoScalingGroupName": "<p>The name of the Auto Scaling group for the hook.</p>",
|
||||
"PutScalingPolicyType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"PutScheduledUpdateGroupActionType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"RecordLifecycleActionHeartbeatType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"ScalingPolicy$PolicyARN": "<p>The Amazon Resource Name (ARN) of the policy.</p>",
|
||||
"ScalingProcessQuery$AutoScalingGroupName": "<p>The name or Amazon Resource Name (ARN) of the Auto Scaling group.</p>",
|
||||
"ScalingProcessQuery$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"ScheduledActionNames$member": null,
|
||||
"ScheduledUpdateGroupAction$ScheduledActionARN": "<p>The Amazon Resource Name (ARN) of the scheduled action.</p>",
|
||||
"SetDesiredCapacityType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"SetInstanceProtectionQuery$AutoScalingGroupName": "<p>The name of the group.</p>",
|
||||
"SetInstanceProtectionQuery$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"UpdateAutoScalingGroupType$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"UpdateAutoScalingGroupType$LaunchConfigurationName": "<p>The name of the launch configuration.</p>"
|
||||
"UpdateAutoScalingGroupType$LaunchConfigurationName": "<p>The name of the launch configuration. If you specify a launch configuration, you can't specify a launch template.</p>",
|
||||
"UpdateAutoScalingGroupType$ServiceLinkedRoleARN": "<p>The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS services on your behalf.</p>"
|
||||
}
|
||||
},
|
||||
"ScalingActivityInProgressFault": {
|
||||
@@ -1224,6 +1243,11 @@
|
||||
"LaunchConfiguration$SecurityGroups": "<p>The security groups to associate with the instances.</p>"
|
||||
}
|
||||
},
|
||||
"ServiceLinkedRoleFailure": {
|
||||
"base": "<p>The service-linked role is not yet ready for use.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"SetDesiredCapacityType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -1247,9 +1271,9 @@
|
||||
"ShouldDecrementDesiredCapacity": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DetachInstancesQuery$ShouldDecrementDesiredCapacity": "<p>If <code>True</code>, the Auto Scaling group decrements the desired capacity value by the number of instances detached.</p>",
|
||||
"EnterStandbyQuery$ShouldDecrementDesiredCapacity": "<p>Specifies whether the instances moved to <code>Standby</code> mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to <code>Standby</code> mode.</p>",
|
||||
"TerminateInstanceInAutoScalingGroupType$ShouldDecrementDesiredCapacity": "<p>If <code>true</code>, terminating the instance also decrements the size of the Auto Scaling group.</p>"
|
||||
"DetachInstancesQuery$ShouldDecrementDesiredCapacity": "<p>Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances detached.</p>",
|
||||
"EnterStandbyQuery$ShouldDecrementDesiredCapacity": "<p>Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of instances moved to <code>Standby</code> mode.</p>",
|
||||
"TerminateInstanceInAutoScalingGroupType$ShouldDecrementDesiredCapacity": "<p>Indicates whether terminating the instance also decrements the size of the Auto Scaling group.</p>"
|
||||
}
|
||||
},
|
||||
"ShouldRespectGracePeriod": {
|
||||
@@ -1339,10 +1363,10 @@
|
||||
"TargetGroupARNs": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AttachLoadBalancerTargetGroupsType$TargetGroupARNs": "<p>The Amazon Resource Names (ARN) of the target groups.</p>",
|
||||
"AttachLoadBalancerTargetGroupsType$TargetGroupARNs": "<p>The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.</p>",
|
||||
"AutoScalingGroup$TargetGroupARNs": "<p>The Amazon Resource Names (ARN) of the target groups for your load balancer.</p>",
|
||||
"CreateAutoScalingGroupType$TargetGroupARNs": "<p>The Amazon Resource Names (ARN) of the target groups.</p>",
|
||||
"DetachLoadBalancerTargetGroupsType$TargetGroupARNs": "<p>The Amazon Resource Names (ARN) of the target groups.</p>"
|
||||
"DetachLoadBalancerTargetGroupsType$TargetGroupARNs": "<p>The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target groups.</p>"
|
||||
}
|
||||
},
|
||||
"TargetTrackingConfiguration": {
|
||||
@@ -1436,7 +1460,7 @@
|
||||
"Activity$Cause": "<p>The reason the activity began.</p>",
|
||||
"LifecycleHook$NotificationMetadata": "<p>Additional information that you want to include any time Auto Scaling sends a message to the notification target.</p>",
|
||||
"LifecycleHookSpecification$NotificationMetadata": "<p>Additional information that you want to include any time Auto Scaling sends a message to the notification target.</p>",
|
||||
"PredefinedMetricSpecification$ResourceLabel": "<p>Identifies the resource associated with the metric type. The following predefined metrics are available:</p> <ul> <li> <p> <code>ASGAverageCPUUtilization</code> - average CPU utilization of the Auto Scaling group</p> </li> <li> <p> <code>ASGAverageNetworkIn</code> - average number of bytes received on all network interfaces by the Auto Scaling group</p> </li> <li> <p> <code>ASGAverageNetworkOut</code> - average number of bytes sent out on all network interfaces by the Auto Scaling group</p> </li> <li> <p> <code>ALBRequestCountPerTarget</code> - number of requests completed per target in an Application Load Balancer target group</p> </li> </ul> <p>For predefined metric types <code>ASGAverageCPUUtilization</code>, <code>ASGAverageNetworkIn</code> and <code>ASGAverageNetworkOut</code>, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type <code>ALBRequestCountPerTarget</code>, the parameter must be specified in the format: <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i>/targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code>, where <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i> </code> is the final portion of the load balancer ARN, and <code>targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code> is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.</p>",
|
||||
"PredefinedMetricSpecification$ResourceLabel": "<p>Identifies the resource associated with the metric type. The following predefined metrics are available:</p> <ul> <li> <p> <code>ASGAverageCPUUtilization</code> - average CPU utilization of the Auto Scaling group</p> </li> <li> <p> <code>ASGAverageNetworkIn</code> - average number of bytes received on all network interfaces by the Auto Scaling group</p> </li> <li> <p> <code>ASGAverageNetworkOut</code> - average number of bytes sent out on all network interfaces by the Auto Scaling group</p> </li> <li> <p> <code>ALBRequestCountPerTarget</code> - number of requests completed per target in an Application Load Balancer target group</p> </li> </ul> <p>For predefined metric types <code>ASGAverageCPUUtilization</code>, <code>ASGAverageNetworkIn</code>, and <code>ASGAverageNetworkOut</code>, the parameter must not be specified as the resource associated with the metric type is the Auto Scaling group. For predefined metric type <code>ALBRequestCountPerTarget</code>, the parameter must be specified in the format: <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i>/targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code>, where <code>app/<i>load-balancer-name</i>/<i>load-balancer-id</i> </code> is the final portion of the load balancer ARN, and <code>targetgroup/<i>target-group-name</i>/<i>target-group-id</i> </code> is the final portion of the target group ARN. The target group must be attached to the Auto Scaling group.</p>",
|
||||
"PutLifecycleHookType$NotificationMetadata": "<p>Contains additional information that you want to include any time Auto Scaling sends a message to the notification target.</p>"
|
||||
}
|
||||
},
|
||||
@@ -1453,7 +1477,7 @@
|
||||
"refs": {
|
||||
"AutoScalingInstanceDetails$InstanceId": "<p>The ID of the instance.</p>",
|
||||
"CompleteLifecycleActionType$InstanceId": "<p>The ID of the instance.</p>",
|
||||
"CreateAutoScalingGroupType$InstanceId": "<p>The ID of the instance used to create a launch configuration for the group. Alternatively, specify a launch configuration instead of an EC2 instance.</p> <p>When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-asg-from-instance.html\">Create an Auto Scaling Group Using an EC2 Instance</a> in the <i>Auto Scaling User Guide</i>.</p>",
|
||||
"CreateAutoScalingGroupType$InstanceId": "<p>The ID of the instance used to create a launch configuration for the group. You must specify one of the following: an EC2 instance, a launch configuration, or a launch template.</p> <p>When you specify an ID of an instance, Auto Scaling creates a new launch configuration and associates it with the group. This launch configuration derives its attributes from the specified instance, with the exception of the block device mapping.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-asg-from-instance.html\">Create an Auto Scaling Group Using an EC2 Instance</a> in the <i>Auto Scaling User Guide</i>.</p>",
|
||||
"CreateLaunchConfigurationType$InstanceId": "<p>The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, with the exception of the block device mapping.</p> <p>If you do not specify <code>InstanceId</code>, you must specify both <code>ImageId</code> and <code>InstanceType</code>.</p> <p>To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-lc-with-instanceID.html\">Create a Launch Configuration Using an EC2 Instance</a> in the <i>Auto Scaling User Guide</i>.</p>",
|
||||
"Instance$InstanceId": "<p>The ID of the instance.</p>",
|
||||
"InstanceIds$member": null,
|
||||
@@ -1478,11 +1502,11 @@
|
||||
"AdjustmentType$AdjustmentType": "<p>The policy adjustment type. The valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>",
|
||||
"Alarm$AlarmName": "<p>The name of the alarm.</p>",
|
||||
"AlreadyExistsFault$message": "<p/>",
|
||||
"AutoScalingGroup$AutoScalingGroupName": "<p>The name of the group.</p>",
|
||||
"AutoScalingGroup$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"AutoScalingGroup$LaunchConfigurationName": "<p>The name of the associated launch configuration.</p>",
|
||||
"AutoScalingGroup$PlacementGroup": "<p>The name of the placement group into which you'll launch your instances, if any. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html\">Placement Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
|
||||
"AutoScalingGroup$Status": "<p>The current state of the group when <a>DeleteAutoScalingGroup</a> is in progress.</p>",
|
||||
"AutoScalingInstanceDetails$AutoScalingGroupName": "<p>The name of the Auto Scaling group associated with the instance.</p>",
|
||||
"AutoScalingInstanceDetails$AutoScalingGroupName": "<p>The name of the Auto Scaling group for the instance.</p>",
|
||||
"AutoScalingInstanceDetails$AvailabilityZone": "<p>The Availability Zone for the instance.</p>",
|
||||
"AutoScalingInstanceDetails$LaunchConfigurationName": "<p>The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.</p>",
|
||||
"AutoScalingNotificationTypes$member": null,
|
||||
@@ -1490,7 +1514,7 @@
|
||||
"BlockDeviceMapping$VirtualName": "<p>The name of the virtual device (for example, <code>ephemeral0</code>).</p>",
|
||||
"BlockDeviceMapping$DeviceName": "<p>The device name exposed to the EC2 instance (for example, <code>/dev/sdh</code> or <code>xvdh</code>).</p>",
|
||||
"ClassicLinkVPCSecurityGroups$member": null,
|
||||
"CreateAutoScalingGroupType$AutoScalingGroupName": "<p>The name of the group. This name must be unique within the scope of your AWS account.</p>",
|
||||
"CreateAutoScalingGroupType$AutoScalingGroupName": "<p>The name of the Auto Scaling group. This name must be unique within the scope of your AWS account.</p>",
|
||||
"CreateAutoScalingGroupType$PlacementGroup": "<p>The name of the placement group into which you'll launch your instances, if any. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html\">Placement Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
|
||||
"CreateLaunchConfigurationType$LaunchConfigurationName": "<p>The name of the launch configuration. This name must be unique within the scope of your AWS account.</p>",
|
||||
"CreateLaunchConfigurationType$ImageId": "<p>The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.</p> <p>If you do not specify <code>InstanceId</code>, you must specify <code>ImageId</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html\">Finding an AMI</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>",
|
||||
@@ -1513,6 +1537,8 @@
|
||||
"LaunchConfiguration$InstanceType": "<p>The instance type for the instances.</p>",
|
||||
"LaunchConfiguration$KernelId": "<p>The ID of the kernel associated with the AMI.</p>",
|
||||
"LaunchConfiguration$RamdiskId": "<p>The ID of the RAM disk associated with the AMI.</p>",
|
||||
"LaunchTemplateSpecification$LaunchTemplateId": "<p>The ID of the launch template. You must specify either a template ID or a template name.</p>",
|
||||
"LaunchTemplateSpecification$Version": "<p>The version number, <code>$Latest</code>, or <code>$Default</code>. If the value is <code>$Latest</code>, Auto Scaling selects the latest version of the launch template when launching instances. If the value is <code>$Default</code>, Auto Scaling selects the default version of the launch template when launching instances. The default value is <code>$Default</code>.</p>",
|
||||
"LimitExceededFault$message": "<p/>",
|
||||
"LoadBalancerNames$member": null,
|
||||
"LoadBalancerState$LoadBalancerName": "<p>The name of the load balancer.</p>",
|
||||
@@ -1531,12 +1557,13 @@
|
||||
"ResourceContentionFault$message": "<p/>",
|
||||
"ResourceInUseFault$message": "<p/>",
|
||||
"ScalingActivityInProgressFault$message": "<p/>",
|
||||
"ScalingPolicy$AutoScalingGroupName": "<p>The name of the Auto Scaling group associated with this scaling policy.</p>",
|
||||
"ScalingPolicy$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"ScalingPolicy$PolicyName": "<p>The name of the scaling policy.</p>",
|
||||
"ScalingPolicy$AdjustmentType": "<p>The adjustment type, which specifies how <code>ScalingAdjustment</code> is interpreted. Valid values are <code>ChangeInCapacity</code>, <code>ExactCapacity</code>, and <code>PercentChangeInCapacity</code>.</p>",
|
||||
"ScheduledUpdateGroupAction$AutoScalingGroupName": "<p>The name of the group.</p>",
|
||||
"ScheduledUpdateGroupAction$AutoScalingGroupName": "<p>The name of the Auto Scaling group.</p>",
|
||||
"ScheduledUpdateGroupAction$ScheduledActionName": "<p>The name of the scheduled action.</p>",
|
||||
"ScheduledUpdateGroupAction$Recurrence": "<p>The recurring schedule for the action.</p>",
|
||||
"ServiceLinkedRoleFailure$message": null,
|
||||
"SuspendedProcess$ProcessName": "<p>The name of the suspended process.</p>",
|
||||
"SuspendedProcess$SuspensionReason": "<p>The reason that the process was suspended.</p>",
|
||||
"UpdateAutoScalingGroupType$PlacementGroup": "<p>The name of the placement group into which you'll launch your instances, if any. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html\">Placement Groups</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
|
||||
|
||||
+68
-7
@@ -7,6 +7,7 @@
|
||||
"protocol":"rest-json",
|
||||
"serviceAbbreviation":"AWS Batch",
|
||||
"serviceFullName":"AWS Batch",
|
||||
"serviceId":"Batch",
|
||||
"signatureVersion":"v4",
|
||||
"uid":"batch-2016-08-10"
|
||||
},
|
||||
@@ -221,6 +222,39 @@
|
||||
}
|
||||
},
|
||||
"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":{
|
||||
@@ -427,6 +461,13 @@
|
||||
"user":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ContainerSummary":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"exitCode":{"shape":"Integer"},
|
||||
"reason":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"CreateComputeEnvironmentRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -615,7 +656,8 @@
|
||||
"type":{"shape":"String"},
|
||||
"parameters":{"shape":"ParametersMap"},
|
||||
"retryStrategy":{"shape":"RetryStrategy"},
|
||||
"containerProperties":{"shape":"ContainerProperties"}
|
||||
"containerProperties":{"shape":"ContainerProperties"},
|
||||
"timeout":{"shape":"JobTimeout"}
|
||||
}
|
||||
},
|
||||
"JobDefinitionList":{
|
||||
@@ -629,7 +671,8 @@
|
||||
"JobDependency":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"jobId":{"shape":"String"}
|
||||
"jobId":{"shape":"String"},
|
||||
"type":{"shape":"ArrayJobDependency"}
|
||||
}
|
||||
},
|
||||
"JobDependencyList":{
|
||||
@@ -660,7 +703,9 @@
|
||||
"dependsOn":{"shape":"JobDependencyList"},
|
||||
"jobDefinition":{"shape":"String"},
|
||||
"parameters":{"shape":"ParametersMap"},
|
||||
"container":{"shape":"ContainerDetail"}
|
||||
"container":{"shape":"ContainerDetail"},
|
||||
"arrayProperties":{"shape":"ArrayPropertiesDetail"},
|
||||
"timeout":{"shape":"JobTimeout"}
|
||||
}
|
||||
},
|
||||
"JobDetailList":{
|
||||
@@ -710,13 +755,26 @@
|
||||
],
|
||||
"members":{
|
||||
"jobId":{"shape":"String"},
|
||||
"jobName":{"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":{
|
||||
@@ -726,9 +784,9 @@
|
||||
},
|
||||
"ListJobsRequest":{
|
||||
"type":"structure",
|
||||
"required":["jobQueue"],
|
||||
"members":{
|
||||
"jobQueue":{"shape":"String"},
|
||||
"arrayJobId":{"shape":"String"},
|
||||
"jobStatus":{"shape":"JobStatus"},
|
||||
"maxResults":{"shape":"Integer"},
|
||||
"nextToken":{"shape":"String"}
|
||||
@@ -771,7 +829,8 @@
|
||||
"type":{"shape":"JobDefinitionType"},
|
||||
"parameters":{"shape":"ParametersMap"},
|
||||
"containerProperties":{"shape":"ContainerProperties"},
|
||||
"retryStrategy":{"shape":"RetryStrategy"}
|
||||
"retryStrategy":{"shape":"RetryStrategy"},
|
||||
"timeout":{"shape":"JobTimeout"}
|
||||
}
|
||||
},
|
||||
"RegisterJobDefinitionResponse":{
|
||||
@@ -817,11 +876,13 @@
|
||||
"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"}
|
||||
"retryStrategy":{"shape":"RetryStrategy"},
|
||||
"timeout":{"shape":"JobTimeout"}
|
||||
}
|
||||
},
|
||||
"SubmitJobResponse":{
|
||||
|
||||
+91
-30
@@ -2,8 +2,8 @@
|
||||
"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 jobs in an AWS Batch job queue. Jobs that are in the <code>SUBMITTED</code>, <code>PENDING</code>, or <code>RUNNABLE</code> state are cancelled. Jobs that have progressed to <code>STARTING</code> or <code>RUNNING</code> are not cancelled (but the API operation still succeeds, even if no jobs are cancelled); these jobs must be terminated with the <a>TerminateJob</a> operation.</p>",
|
||||
"CreateComputeEnvironment": "<p>Creates an AWS Batch compute environment. You can create <code>MANAGED</code> or <code>UNMANAGED</code> compute environments.</p> <p>In a managed compute environment, AWS Batch manages the compute resources within the environment, based on the compute resources that you specify. Instances launched into a managed compute environment use a recent, approved version of the Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand instances in your managed compute environment, or you can use Amazon EC2 Spot instances that only launch when the Spot bid price is below a specified percentage of the On-Demand price.</p> <p>In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html\">Container Instance AMIs</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. After you have created your unmanaged compute environment, you can use the <a>DescribeComputeEnvironments</a> operation to find the Amazon ECS cluster that is associated with it and then manually launch your container instances into that Amazon ECS cluster. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html\">Launching an Amazon ECS Container Instance</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p>",
|
||||
"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>",
|
||||
@@ -15,11 +15,41 @@
|
||||
"ListJobs": "<p>Returns a list of task jobs for a specified job queue. You can filter the results by job status with the <code>jobStatus</code> parameter. If you do not specify a status, only <code>RUNNING</code> jobs are returned.</p>",
|
||||
"RegisterJobDefinition": "<p>Registers an AWS Batch job definition. </p>",
|
||||
"SubmitJob": "<p>Submits an AWS Batch job from a job definition. Parameters specified during <a>SubmitJob</a> override parameters defined in the job definition. </p>",
|
||||
"TerminateJob": "<p>Terminates jobs in a job queue. Jobs that are in the <code>STARTING</code> or <code>RUNNING</code> state are terminated, which causes them to transition to <code>FAILED</code>. Jobs that have not progressed to the <code>STARTING</code> state are cancelled.</p>",
|
||||
"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": {
|
||||
@@ -86,7 +116,7 @@
|
||||
}
|
||||
},
|
||||
"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 permission to use the action or resource, or specifying an identifier that is not valid. </p>",
|
||||
"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": {
|
||||
}
|
||||
},
|
||||
@@ -111,7 +141,7 @@
|
||||
"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 3 compute environments with a job queue.</p>",
|
||||
"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>"
|
||||
}
|
||||
@@ -148,6 +178,12 @@
|
||||
"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": {
|
||||
@@ -241,20 +277,26 @@
|
||||
"EnvironmentVariables": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ContainerDetail$environment": "<p>The environment variables to pass to a container.</p>",
|
||||
"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>",
|
||||
"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 plain text environment variables for sensitive information, such as credential data.</p> </important>"
|
||||
"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, but the data is not guaranteed to persist after the containers associated with it stop running.</p>"
|
||||
"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>",
|
||||
@@ -269,17 +311,19 @@
|
||||
"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 1 vCPU.</p>",
|
||||
"ContainerProperties$memory": "<p>The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. You must specify at least 4 MiB of memory for a job.</p>",
|
||||
"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 <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>",
|
||||
"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>"
|
||||
@@ -327,7 +371,7 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"JobDetail$dependsOn": "<p>A list of job names or IDs on which this job depends.</p>",
|
||||
"SubmitJobRequest$dependsOn": "<p>A list of job IDs on which this job depends. A job can depend upon a maximum of 20 jobs. </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": {
|
||||
@@ -358,6 +402,7 @@
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
@@ -373,6 +418,15 @@
|
||||
"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": {
|
||||
@@ -392,11 +446,14 @@
|
||||
"Long": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AttemptDetail$startedAt": "<p>The Unix timestamp for when the attempt was started (when the task transitioned from the <code>PENDING</code> state to the <code>RUNNING</code> state).</p>",
|
||||
"AttemptDetail$stoppedAt": "<p>The Unix timestamp for when the attempt was stopped (when the task transitioned from the <code>RUNNING</code> state to the <code>STOPPED</code> state).</p>",
|
||||
"JobDetail$createdAt": "<p>The Unix timestamp for when the job was created (when the task entered the <code>PENDING</code> state). </p>",
|
||||
"JobDetail$startedAt": "<p>The Unix timestamp for when the job was started (when the task transitioned from the <code>PENDING</code> state to the <code>RUNNING</code> state). </p>",
|
||||
"JobDetail$stoppedAt": "<p>The Unix timestamp for when the job was stopped (when the task transitioned from the <code>RUNNING</code> state to the <code>STOPPED</code> state).</p>"
|
||||
"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": {
|
||||
@@ -436,7 +493,7 @@
|
||||
"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.</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>"
|
||||
}
|
||||
},
|
||||
@@ -448,13 +505,14 @@
|
||||
"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.</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>A list of up to 100 job IDs to cancel.</p>",
|
||||
"CancelJobRequest$reason": "<p>A message to attach to the job that explains the reason for cancelling it. This message is returned by future <a>DescribeJobs</a> operations on the job. This message is also recorded in the AWS Batch activity logs. </p>",
|
||||
"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>",
|
||||
@@ -471,12 +529,13 @@
|
||||
"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.</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.<region-name>.amazonaws.com/<repository-name></code>). </p> </li> <li> <p>Images in official repositories on Docker Hub use a single name (for example, <code>ubuntu</code> or <code>mongo</code>).</p> </li> <li> <p>Images in other repositories on Docker Hub are qualified with an organization name (for example, <code>amazon/amazon-ecs-agent</code>).</p> </li> <li> <p>Images in other online repositories are qualified further by a domain name (for example, <code>quay.io/assemblyline/ubuntu</code>).</p> </li> </ul>",
|
||||
"ContainerProperties$jobRoleArn": "<p>The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.</p>",
|
||||
"ContainerProperties$user": "<p>The user name to use inside the container. This parameter maps to <code>User</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--user</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>",
|
||||
"CreateComputeEnvironmentRequest$computeEnvironmentName": "<p>The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, and underscores are allowed.</p>",
|
||||
"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>",
|
||||
@@ -510,9 +569,11 @@
|
||||
"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>",
|
||||
"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>",
|
||||
"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>",
|
||||
@@ -525,14 +586,14 @@
|
||||
"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 will be submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue. </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>Job IDs to be terminated. Up to 100 jobs can be specified.</p>",
|
||||
"TerminateJobRequest$reason": "<p>A message to attach to the job that explains the reason for cancelling it. This message is returned by future <a>DescribeJobs</a> operations on the job. This message is also recorded in the AWS Batch activity logs. </p>",
|
||||
"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>",
|
||||
@@ -547,7 +608,7 @@
|
||||
"StringList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ComputeResource$instanceTypes": "<p>The instances types that may launched.</p>",
|
||||
"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>",
|
||||
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"version": 1,
|
||||
"defaultRegion": "us-west-2",
|
||||
"testCases": [
|
||||
{
|
||||
"operationName": "DescribeComputeEnvironments",
|
||||
"input": {},
|
||||
"errorExpectedFromService": false
|
||||
}
|
||||
]
|
||||
}
|
||||
+20
-17
@@ -218,10 +218,7 @@
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"BudgetName",
|
||||
"BudgetLimit",
|
||||
"CostTypes",
|
||||
"TimeUnit",
|
||||
"TimePeriod",
|
||||
"BudgetType"
|
||||
],
|
||||
"members":{
|
||||
@@ -275,15 +272,18 @@
|
||||
},
|
||||
"CostTypes":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"IncludeTax",
|
||||
"IncludeSubscription",
|
||||
"UseBlended"
|
||||
],
|
||||
"members":{
|
||||
"IncludeTax":{"shape":"GenericBoolean"},
|
||||
"IncludeSubscription":{"shape":"GenericBoolean"},
|
||||
"UseBlended":{"shape":"GenericBoolean"}
|
||||
"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":{
|
||||
@@ -497,7 +497,6 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"GenericBoolean":{"type":"boolean"},
|
||||
"GenericString":{"type":"string"},
|
||||
"GenericTimestamp":{"type":"timestamp"},
|
||||
"InternalErrorException":{
|
||||
@@ -580,6 +579,10 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"Notification"}
|
||||
},
|
||||
"NullableBoolean":{
|
||||
"type":"boolean",
|
||||
"box":true
|
||||
},
|
||||
"NumericValue":{
|
||||
"type":"string",
|
||||
"pattern":"[0-9]*(\\.)?[0-9]+"
|
||||
@@ -603,9 +606,13 @@
|
||||
],
|
||||
"members":{
|
||||
"SubscriptionType":{"shape":"SubscriptionType"},
|
||||
"Address":{"shape":"GenericString"}
|
||||
"Address":{"shape":"SubscriberAddress"}
|
||||
}
|
||||
},
|
||||
"SubscriberAddress":{
|
||||
"type":"string",
|
||||
"min":1
|
||||
},
|
||||
"Subscribers":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Subscriber"},
|
||||
@@ -628,10 +635,6 @@
|
||||
},
|
||||
"TimePeriod":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Start",
|
||||
"End"
|
||||
],
|
||||
"members":{
|
||||
"Start":{"shape":"GenericTimestamp"},
|
||||
"End":{"shape":"GenericTimestamp"}
|
||||
|
||||
+171
-158
@@ -1,203 +1,203 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "All public APIs for AWS Budgets",
|
||||
"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": "Create a new budget",
|
||||
"CreateNotification": "Create a new Notification with subscribers for a budget",
|
||||
"CreateSubscriber": "Create a new Subscriber for a notification",
|
||||
"DeleteBudget": "Delete a budget and related notifications",
|
||||
"DeleteNotification": "Delete a notification and related subscribers",
|
||||
"DeleteSubscriber": "Delete a Subscriber for a notification",
|
||||
"DescribeBudget": "Get a single budget",
|
||||
"DescribeBudgets": "Get all budgets for an account",
|
||||
"DescribeNotificationsForBudget": "Get notifications of a budget",
|
||||
"DescribeSubscribersForNotification": "Get subscribers of a notification",
|
||||
"UpdateBudget": "Update the information of a budget already created",
|
||||
"UpdateNotification": "Update the information about a notification already created",
|
||||
"UpdateSubscriber": "Update a subscriber"
|
||||
"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": "Account Id of the customer. It should be a 12 digit number.",
|
||||
"base": "<p>The account ID of the customer. It should be a 12 digit number.</p>",
|
||||
"refs": {
|
||||
"CreateBudgetRequest$AccountId": null,
|
||||
"CreateNotificationRequest$AccountId": null,
|
||||
"CreateSubscriberRequest$AccountId": null,
|
||||
"DeleteBudgetRequest$AccountId": null,
|
||||
"DeleteNotificationRequest$AccountId": null,
|
||||
"DeleteSubscriberRequest$AccountId": null,
|
||||
"DescribeBudgetRequest$AccountId": null,
|
||||
"DescribeBudgetsRequest$AccountId": null,
|
||||
"DescribeNotificationsForBudgetRequest$AccountId": null,
|
||||
"DescribeSubscribersForNotificationRequest$AccountId": null,
|
||||
"UpdateBudgetRequest$AccountId": null,
|
||||
"UpdateNotificationRequest$AccountId": null,
|
||||
"UpdateSubscriberRequest$AccountId": null
|
||||
"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": "AWS Budget model",
|
||||
"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": null,
|
||||
"DescribeBudgetResponse$Budget": null,
|
||||
"UpdateBudgetRequest$NewBudget": 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": "A string represents the budget name. No \":\" and \"\\\" character is allowed.",
|
||||
"base": "<p> A string represents the budget name. No \":\" and \"\\\" character is allowed.</p>",
|
||||
"refs": {
|
||||
"Budget$BudgetName": null,
|
||||
"CreateNotificationRequest$BudgetName": null,
|
||||
"CreateSubscriberRequest$BudgetName": null,
|
||||
"DeleteBudgetRequest$BudgetName": null,
|
||||
"DeleteNotificationRequest$BudgetName": null,
|
||||
"DeleteSubscriberRequest$BudgetName": null,
|
||||
"DescribeBudgetRequest$BudgetName": null,
|
||||
"DescribeNotificationsForBudgetRequest$BudgetName": null,
|
||||
"DescribeSubscribersForNotificationRequest$BudgetName": null,
|
||||
"UpdateNotificationRequest$BudgetName": null,
|
||||
"UpdateSubscriberRequest$BudgetName": null
|
||||
"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": "The type of a budget. It should be COST, USAGE, or RI_UTILIZATION.",
|
||||
"base": "<p> The type of a budget. It should be COST, USAGE, or RI_UTILIZATION.</p>",
|
||||
"refs": {
|
||||
"Budget$BudgetType": null
|
||||
"Budget$BudgetType": "<p>Whether this budget tracks monetary costs, usage, or RI utilization.</p>"
|
||||
}
|
||||
},
|
||||
"Budgets": {
|
||||
"base": "A list of budgets",
|
||||
"base": "<p> A list of budgets</p>",
|
||||
"refs": {
|
||||
"DescribeBudgetsResponse$Budgets": null
|
||||
"DescribeBudgetsResponse$Budgets": "<p>A list of budgets.</p>"
|
||||
}
|
||||
},
|
||||
"CalculatedSpend": {
|
||||
"base": "A structure that holds the actual and forecasted spend for a budget.",
|
||||
"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": null
|
||||
"Budget$CalculatedSpend": "<p>The actual and forecasted cost or usage being tracked by a budget.</p>"
|
||||
}
|
||||
},
|
||||
"ComparisonOperator": {
|
||||
"base": "The comparison operator of a notification. Currently we support less than, equal to and greater than.",
|
||||
"base": "<p> The comparison operator of a notification. Currently we support less than, equal to and greater than.</p>",
|
||||
"refs": {
|
||||
"Notification$ComparisonOperator": null
|
||||
"Notification$ComparisonOperator": "<p>The comparison used for this notification.</p>"
|
||||
}
|
||||
},
|
||||
"CostFilters": {
|
||||
"base": "A map that represents the cost filters applied to the budget.",
|
||||
"base": "<p> A map that represents the cost filters applied to the budget.</p>",
|
||||
"refs": {
|
||||
"Budget$CostFilters": null
|
||||
"Budget$CostFilters": "<p>The cost filters applied to a budget, such as service or region.</p>"
|
||||
}
|
||||
},
|
||||
"CostTypes": {
|
||||
"base": "This includes the options for getting the cost of a budget.",
|
||||
"base": "<p>The types of cost included in a budget, such as tax and subscriptions.</p>",
|
||||
"refs": {
|
||||
"Budget$CostTypes": null
|
||||
"Budget$CostTypes": "<p>The types of costs included in this budget.</p>"
|
||||
}
|
||||
},
|
||||
"CreateBudgetRequest": {
|
||||
"base": "Request of CreateBudget",
|
||||
"base": "<p> Request of CreateBudget </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateBudgetResponse": {
|
||||
"base": "Response of CreateBudget",
|
||||
"base": "<p> Response of CreateBudget </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateNotificationRequest": {
|
||||
"base": "Request of CreateNotification",
|
||||
"base": "<p> Request of CreateNotification </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateNotificationResponse": {
|
||||
"base": "Response of CreateNotification",
|
||||
"base": "<p> Response of CreateNotification </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateSubscriberRequest": {
|
||||
"base": "Request of CreateSubscriber",
|
||||
"base": "<p> Request of CreateSubscriber </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateSubscriberResponse": {
|
||||
"base": "Response of CreateSubscriber",
|
||||
"base": "<p> Response of CreateSubscriber </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreationLimitExceededException": {
|
||||
"base": "The exception is thrown when customer tries to create a record (e.g. budget), but the number this record already exceeds the limitation.",
|
||||
"base": "<p>You've exceeded the notification or subscriber limit.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteBudgetRequest": {
|
||||
"base": "Request of DeleteBudget",
|
||||
"base": "<p> Request of DeleteBudget </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteBudgetResponse": {
|
||||
"base": "Response of DeleteBudget",
|
||||
"base": "<p> Response of DeleteBudget </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteNotificationRequest": {
|
||||
"base": "Request of DeleteNotification",
|
||||
"base": "<p> Request of DeleteNotification </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteNotificationResponse": {
|
||||
"base": "Response of DeleteNotification",
|
||||
"base": "<p> Response of DeleteNotification </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteSubscriberRequest": {
|
||||
"base": "Request of DeleteSubscriber",
|
||||
"base": "<p> Request of DeleteSubscriber </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteSubscriberResponse": {
|
||||
"base": "Response of DeleteSubscriber",
|
||||
"base": "<p> Response of DeleteSubscriber </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeBudgetRequest": {
|
||||
"base": "Request of DescribeBudget",
|
||||
"base": "<p> Request of DescribeBudget </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeBudgetResponse": {
|
||||
"base": "Response of DescribeBudget",
|
||||
"base": "<p> Response of DescribeBudget </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeBudgetsRequest": {
|
||||
"base": "Request of DescribeBudgets",
|
||||
"base": "<p> Request of DescribeBudgets </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeBudgetsResponse": {
|
||||
"base": "Response of DescribeBudgets",
|
||||
"base": "<p> Response of DescribeBudgets </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeNotificationsForBudgetRequest": {
|
||||
"base": "Request of DescribeNotificationsForBudget",
|
||||
"base": "<p> Request of DescribeNotificationsForBudget </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeNotificationsForBudgetResponse": {
|
||||
"base": "Response of GetNotificationsForBudget",
|
||||
"base": "<p> Response of GetNotificationsForBudget </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeSubscribersForNotificationRequest": {
|
||||
"base": "Request of DescribeSubscribersForNotification",
|
||||
"base": "<p> Request of DescribeSubscribersForNotification </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeSubscribersForNotificationResponse": {
|
||||
"base": "Response of DescribeSubscribersForNotification",
|
||||
"base": "<p> Response of DescribeSubscribersForNotification </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -208,211 +208,224 @@
|
||||
}
|
||||
},
|
||||
"DuplicateRecordException": {
|
||||
"base": "The exception is thrown when customer tries to create a record (e.g. budget) that already exists.",
|
||||
"base": "<p>The budget name already exists. Budget names must be unique within an account.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ExpiredNextTokenException": {
|
||||
"base": "This exception is thrown if the paging token is expired - past its TTL",
|
||||
"base": "<p>The pagination token expired.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GenericBoolean": {
|
||||
"base": "A generic boolean value.",
|
||||
"refs": {
|
||||
"CostTypes$IncludeTax": null,
|
||||
"CostTypes$IncludeSubscription": null,
|
||||
"CostTypes$UseBlended": null
|
||||
}
|
||||
},
|
||||
"GenericString": {
|
||||
"base": "A generic String.",
|
||||
"base": "<p> A generic String.</p>",
|
||||
"refs": {
|
||||
"CostFilters$key": null,
|
||||
"DescribeBudgetsRequest$NextToken": null,
|
||||
"DescribeBudgetsResponse$NextToken": null,
|
||||
"DescribeNotificationsForBudgetRequest$NextToken": null,
|
||||
"DescribeNotificationsForBudgetResponse$NextToken": null,
|
||||
"DescribeSubscribersForNotificationRequest$NextToken": null,
|
||||
"DescribeSubscribersForNotificationResponse$NextToken": null,
|
||||
"DimensionValues$member": null,
|
||||
"Subscriber$Address": 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": "A generic timestamp. In Java it is transformed to a Date object.",
|
||||
"base": "<p> A generic timestamp. In Java it is transformed to a Date object.</p>",
|
||||
"refs": {
|
||||
"TimePeriod$Start": null,
|
||||
"TimePeriod$End": null
|
||||
"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": "This exception is thrown on an unknown internal failure.",
|
||||
"base": "<p>An error on the server occurred during the processing of your request. Try again later.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidNextTokenException": {
|
||||
"base": "This exception is thrown if paging token signature didn't match the token, or the paging token isn't for this request",
|
||||
"base": "<p>The pagination token is invalid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidParameterException": {
|
||||
"base": "This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.",
|
||||
"base": "<p>An error on the client occurred. Typically, the cause is an invalid input value.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
"base": "An integer to represent how many entries a paginated response contains. Maximum is set to 100.",
|
||||
"base": "<p> An integer to represent how many entries a paginated response contains. Maximum is set to 100.</p>",
|
||||
"refs": {
|
||||
"DescribeBudgetsRequest$MaxResults": null,
|
||||
"DescribeNotificationsForBudgetRequest$MaxResults": null,
|
||||
"DescribeSubscribersForNotificationRequest$MaxResults": null
|
||||
"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": "This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.",
|
||||
"base": "<p>We can’t locate the resource that you specified.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Notification": {
|
||||
"base": "Notification model. Each budget may contain multiple notifications with different settings.",
|
||||
"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": null,
|
||||
"CreateSubscriberRequest$Notification": null,
|
||||
"DeleteNotificationRequest$Notification": null,
|
||||
"DeleteSubscriberRequest$Notification": null,
|
||||
"DescribeSubscribersForNotificationRequest$Notification": null,
|
||||
"NotificationWithSubscribers$Notification": null,
|
||||
"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": null,
|
||||
"UpdateNotificationRequest$NewNotification": null,
|
||||
"UpdateSubscriberRequest$Notification": 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": "The threshold of a notification. It should be a number between 0 and 1,000,000,000.",
|
||||
"base": "<p> The threshold of a notification. It should be a number between 0 and 1,000,000,000.</p>",
|
||||
"refs": {
|
||||
"Notification$Threshold": null
|
||||
"Notification$Threshold": "<p>The threshold associated with a notification. Thresholds are always a percentage.</p>"
|
||||
}
|
||||
},
|
||||
"NotificationType": {
|
||||
"base": "The type of a notification. It should be ACTUAL or FORECASTED.",
|
||||
"base": "<p> The type of a notification. It should be ACTUAL or FORECASTED.</p>",
|
||||
"refs": {
|
||||
"Notification$NotificationType": null
|
||||
"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": "A structure to relate notification and a list of subscribers who belong to the notification.",
|
||||
"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": "A list of Notifications, each with a list of subscribers.",
|
||||
"base": "<p> A list of Notifications, each with a list of subscribers.</p>",
|
||||
"refs": {
|
||||
"CreateBudgetRequest$NotificationsWithSubscribers": null
|
||||
"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": "A list of notifications.",
|
||||
"base": "<p> A list of notifications.</p>",
|
||||
"refs": {
|
||||
"DescribeNotificationsForBudgetResponse$Notifications": null
|
||||
"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": "A string to represent NumericValue.",
|
||||
"base": "<p> A string to represent NumericValue.</p>",
|
||||
"refs": {
|
||||
"Spend$Amount": null
|
||||
"Spend$Amount": "<p>The cost or usage amount associated with a budget forecast, actual spend, or budget threshold.</p>"
|
||||
}
|
||||
},
|
||||
"Spend": {
|
||||
"base": "A structure that represents either a cost spend or usage spend. Contains an amount and a unit.",
|
||||
"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": null,
|
||||
"CalculatedSpend$ActualSpend": null,
|
||||
"CalculatedSpend$ForecastedSpend": null
|
||||
"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": "Subscriber model. Each notification may contain multiple subscribers with different addresses.",
|
||||
"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": null,
|
||||
"DeleteSubscriberRequest$Subscriber": null,
|
||||
"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": null,
|
||||
"UpdateSubscriberRequest$NewSubscriber": 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": "A list of subscribers.",
|
||||
"base": "<p> A list of subscribers.</p>",
|
||||
"refs": {
|
||||
"CreateNotificationRequest$Subscribers": null,
|
||||
"DescribeSubscribersForNotificationResponse$Subscribers": null,
|
||||
"NotificationWithSubscribers$Subscribers": null
|
||||
"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": "The subscription type of the subscriber. It can be SMS or EMAIL.",
|
||||
"base": "<p> The subscription type of the subscriber. It can be SMS or EMAIL.</p>",
|
||||
"refs": {
|
||||
"Subscriber$SubscriptionType": null
|
||||
"Subscriber$SubscriptionType": "<p>The type of notification that AWS sends to a subscriber.</p>"
|
||||
}
|
||||
},
|
||||
"ThresholdType": {
|
||||
"base": "The type of threshold for a notification. It can be PERCENTAGE or ABSOLUTE_VALUE.",
|
||||
"base": "<p> The type of threshold for a notification. It can be PERCENTAGE or ABSOLUTE_VALUE.</p>",
|
||||
"refs": {
|
||||
"Notification$ThresholdType": null
|
||||
"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": "A time period indicating the start date and end date of a budget.",
|
||||
"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": null
|
||||
"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": "The time unit of the budget. e.g. MONTHLY, QUARTERLY, etc.",
|
||||
"base": "<p> The time unit of the budget. e.g. MONTHLY, QUARTERLY, etc.</p>",
|
||||
"refs": {
|
||||
"Budget$TimeUnit": null
|
||||
"Budget$TimeUnit": "<p>The length of time until a budget resets the actual and forecasted spend.</p>"
|
||||
}
|
||||
},
|
||||
"UnitValue": {
|
||||
"base": "A string to represent budget spend unit. It should be not null and not empty.",
|
||||
"base": "<p> A string to represent budget spend unit. It should be not null and not empty.</p>",
|
||||
"refs": {
|
||||
"Spend$Unit": null
|
||||
"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": "Request of UpdateBudget",
|
||||
"base": "<p> Request of UpdateBudget </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateBudgetResponse": {
|
||||
"base": "Response of UpdateBudget",
|
||||
"base": "<p> Response of UpdateBudget </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateNotificationRequest": {
|
||||
"base": "Request of UpdateNotification",
|
||||
"base": "<p> Request of UpdateNotification </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateNotificationResponse": {
|
||||
"base": "Response of UpdateNotification",
|
||||
"base": "<p> Response of UpdateNotification </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateSubscriberRequest": {
|
||||
"base": "Request of UpdateSubscriber",
|
||||
"base": "<p> Request of UpdateSubscriber </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateSubscriberResponse": {
|
||||
"base": "Response of UpdateSubscriber",
|
||||
"base": "<p> Response of UpdateSubscriber </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"errorMessage": {
|
||||
"base": "The error message the exception carries.",
|
||||
"base": "<p>The error message the exception carries.</p>",
|
||||
"refs": {
|
||||
"CreationLimitExceededException$Message": null,
|
||||
"DuplicateRecordException$Message": null,
|
||||
|
||||
+661
@@ -0,0 +1,661 @@
|
||||
{
|
||||
"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"}
|
||||
]
|
||||
},
|
||||
"GetDimensionValues":{
|
||||
"name":"GetDimensionValues",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetDimensionValuesRequest"},
|
||||
"output":{"shape":"GetDimensionValuesResponse"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"BillExpirationException"},
|
||||
{"shape":"InvalidNextTokenException"}
|
||||
]
|
||||
},
|
||||
"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":"InvalidNextTokenException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"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"}
|
||||
}
|
||||
},
|
||||
"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"},
|
||||
"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}"
|
||||
}
|
||||
}
|
||||
}
|
||||
+651
@@ -0,0 +1,651 @@
|
||||
{
|
||||
"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 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>",
|
||||
"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 specific 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>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</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>You can retrieve the reservation utilization for your account. Master accounts in an organization in AWS Organizations have access to their associated 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>You can query 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>CostAndUsage</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>INSTANCE_TYPE - The type of instance. An example is an EC2 <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>OPERATION - The action performed. Examples include <code>RunInstance</code> and <code>CreateBucket</code>.</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 DynamoDB.</p> </li> <li> <p>USAGE_TYPE - The type of usage. An example is <code>DataTransfer-In-Bytes</code>. The response for the <code>GetDimensionValues</code> operation includes a unit attribute, examples of which 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>INSTANCE_TYPE - The type of instance. An example is an EC2 <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 specific combination of operating system, license model, and software on an instance. For example, a Windows instance with SQL Server Web and no license, or a Red Hat Enterprise Linux instance.</p> </li> <li> <p>REGION - The AWS Region.</p> </li> <li> <p>SCOPE - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.</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 reserve 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>CostAndUsage</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>INSTANCE_TYPE - The type of instance. An example is an EC2 <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>OPERATION - The action performed. Examples include <code>RunInstance</code> and <code>CreateBucket</code>.</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 DynamoDB.</p> </li> <li> <p>USAGE_TYPE - The type of usage. An example is <code>DataTransfer-In-Bytes</code>. The response for the <code>GetDimensionValues</code> operation includes a unit attribute, examples of which 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>INSTANCE_TYPE - The type of instance. An example is an EC2 <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 specific combination of operating system, license model, and software on an instance. For example, a Windows instance with SQL Server Web and no license, or a Red Hat Enterprise Linux instance.</p> </li> <li> <p>REGION - The AWS Region.</p> </li> <li> <p>SCOPE - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.</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
|
||||
}
|
||||
},
|
||||
"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>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</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 using different dimensions. <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 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>"
|
||||
}
|
||||
},
|
||||
"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>",
|
||||
"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 spent on Reserved Instances during the specified historical period.</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 the <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 the <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>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</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>"
|
||||
}
|
||||
},
|
||||
"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 specific service, such as EC2, that you want recommendations for.</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
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"pagination": {
|
||||
}
|
||||
}
|
||||
+35
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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"
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+204
-16
@@ -92,7 +92,6 @@
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"DirectoryNotEnabledException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"NotPolicyException"}
|
||||
]
|
||||
@@ -114,6 +113,7 @@
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"DirectoryNotEnabledException"},
|
||||
{"shape":"InvalidAttachmentException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"LinkNameAlreadyInUseException"},
|
||||
{"shape":"IndexedAttributeMissingException"},
|
||||
@@ -199,7 +199,6 @@
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"DirectoryAlreadyExistsException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
@@ -265,7 +264,6 @@
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"DirectoryNotEnabledException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"FacetValidationException"},
|
||||
{"shape":"LinkNameAlreadyInUseException"},
|
||||
@@ -456,7 +454,8 @@
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"DirectoryNotEnabledException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"NotNodeException"}
|
||||
]
|
||||
},
|
||||
"DetachPolicy":{
|
||||
@@ -476,7 +475,6 @@
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"DirectoryNotEnabledException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"NotPolicyException"}
|
||||
]
|
||||
@@ -541,6 +539,25 @@
|
||||
{"shape":"InvalidArnException"}
|
||||
]
|
||||
},
|
||||
"GetAppliedSchemaVersion":{
|
||||
"name":"GetAppliedSchemaVersion",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/amazonclouddirectory/2017-01-11/schema/getappliedschema",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"GetAppliedSchemaVersionRequest"},
|
||||
"output":{"shape":"GetAppliedSchemaVersionResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"GetDirectory":{
|
||||
"name":"GetDirectory",
|
||||
"http":{
|
||||
@@ -579,6 +596,27 @@
|
||||
{"shape":"FacetNotFoundException"}
|
||||
]
|
||||
},
|
||||
"GetObjectAttributes":{
|
||||
"name":"GetObjectAttributes",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/amazonclouddirectory/2017-01-11/object/attributes/get",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"GetObjectAttributesRequest"},
|
||||
"output":{"shape":"GetObjectAttributesResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"DirectoryNotEnabledException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"FacetValidationException"}
|
||||
]
|
||||
},
|
||||
"GetObjectInformation":{
|
||||
"name":"GetObjectInformation",
|
||||
"http":{
|
||||
@@ -795,10 +833,12 @@
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"FacetValidationException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"DirectoryNotEnabledException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"NotIndexException"}
|
||||
]
|
||||
@@ -820,7 +860,6 @@
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"DirectoryNotEnabledException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"FacetValidationException"}
|
||||
@@ -843,7 +882,6 @@
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"DirectoryNotEnabledException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"NotNodeException"}
|
||||
@@ -887,7 +925,6 @@
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"DirectoryNotEnabledException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"CannotListParentOfRootException"}
|
||||
@@ -953,7 +990,6 @@
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"DirectoryNotEnabledException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"NotPolicyException"}
|
||||
@@ -1057,7 +1093,6 @@
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"DirectoryNotEnabledException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
@@ -1247,6 +1282,47 @@
|
||||
{"shape":"FacetNotFoundException"},
|
||||
{"shape":"InvalidRuleException"}
|
||||
]
|
||||
},
|
||||
"UpgradeAppliedSchema":{
|
||||
"name":"UpgradeAppliedSchema",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/amazonclouddirectory/2017-01-11/schema/upgradeapplied",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"UpgradeAppliedSchemaRequest"},
|
||||
"output":{"shape":"UpgradeAppliedSchemaResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"IncompatibleSchemaException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidAttachmentException"}
|
||||
]
|
||||
},
|
||||
"UpgradePublishedSchema":{
|
||||
"name":"UpgradePublishedSchema",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/amazonclouddirectory/2017-01-11/schema/upgradepublished",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"UpgradePublishedSchemaRequest"},
|
||||
"output":{"shape":"UpgradePublishedSchemaResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"IncompatibleSchemaException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidAttachmentException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
@@ -1336,6 +1412,7 @@
|
||||
"AttachPolicyRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DirectoryArn",
|
||||
"PolicyReference",
|
||||
"ObjectReference"
|
||||
],
|
||||
@@ -1576,10 +1653,7 @@
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"SchemaFacet",
|
||||
"ObjectAttributeList",
|
||||
"ParentReference",
|
||||
"LinkName",
|
||||
"BatchReferenceName"
|
||||
"ObjectAttributeList"
|
||||
],
|
||||
"members":{
|
||||
"SchemaFacet":{"shape":"SchemaFacetList"},
|
||||
@@ -1628,8 +1702,7 @@
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ParentReference",
|
||||
"LinkName",
|
||||
"BatchReferenceName"
|
||||
"LinkName"
|
||||
],
|
||||
"members":{
|
||||
"ParentReference":{"shape":"ObjectReference"},
|
||||
@@ -1671,6 +1744,25 @@
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"BatchGetObjectAttributes":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ObjectReference",
|
||||
"SchemaFacet",
|
||||
"AttributeNames"
|
||||
],
|
||||
"members":{
|
||||
"ObjectReference":{"shape":"ObjectReference"},
|
||||
"SchemaFacet":{"shape":"SchemaFacet"},
|
||||
"AttributeNames":{"shape":"AttributeNameList"}
|
||||
}
|
||||
},
|
||||
"BatchGetObjectAttributesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Attributes":{"shape":"AttributeKeyAndValueList"}
|
||||
}
|
||||
},
|
||||
"BatchGetObjectInformation":{
|
||||
"type":"structure",
|
||||
"required":["ObjectReference"],
|
||||
@@ -1885,6 +1977,7 @@
|
||||
"ListAttachedIndices":{"shape":"BatchListAttachedIndices"},
|
||||
"ListObjectParentPaths":{"shape":"BatchListObjectParentPaths"},
|
||||
"GetObjectInformation":{"shape":"BatchGetObjectInformation"},
|
||||
"GetObjectAttributes":{"shape":"BatchGetObjectAttributes"},
|
||||
"ListObjectPolicies":{"shape":"BatchListObjectPolicies"},
|
||||
"ListPolicyAttachments":{"shape":"BatchListPolicyAttachments"},
|
||||
"LookupPolicy":{"shape":"BatchLookupPolicy"},
|
||||
@@ -1940,6 +2033,7 @@
|
||||
"ListObjectAttributes":{"shape":"BatchListObjectAttributesResponse"},
|
||||
"ListObjectChildren":{"shape":"BatchListObjectChildrenResponse"},
|
||||
"GetObjectInformation":{"shape":"BatchGetObjectInformationResponse"},
|
||||
"GetObjectAttributes":{"shape":"BatchGetObjectAttributesResponse"},
|
||||
"ListAttachedIndices":{"shape":"BatchListAttachedIndicesResponse"},
|
||||
"ListObjectParentPaths":{"shape":"BatchListObjectParentPathsResponse"},
|
||||
"ListObjectPolicies":{"shape":"BatchListObjectPoliciesResponse"},
|
||||
@@ -2007,6 +2101,7 @@
|
||||
"AccessDeniedException",
|
||||
"InvalidAttachmentException",
|
||||
"NotIndexException",
|
||||
"NotNodeException",
|
||||
"IndexedAttributeMissingException",
|
||||
"ObjectAlreadyDetachedException",
|
||||
"NotPolicyException",
|
||||
@@ -2617,6 +2712,19 @@
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"GetAppliedSchemaVersionRequest":{
|
||||
"type":"structure",
|
||||
"required":["SchemaArn"],
|
||||
"members":{
|
||||
"SchemaArn":{"shape":"Arn"}
|
||||
}
|
||||
},
|
||||
"GetAppliedSchemaVersionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AppliedSchemaArn":{"shape":"Arn"}
|
||||
}
|
||||
},
|
||||
"GetDirectoryRequest":{
|
||||
"type":"structure",
|
||||
"required":["DirectoryArn"],
|
||||
@@ -2656,6 +2764,36 @@
|
||||
"Facet":{"shape":"Facet"}
|
||||
}
|
||||
},
|
||||
"GetObjectAttributesRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DirectoryArn",
|
||||
"ObjectReference",
|
||||
"SchemaFacet",
|
||||
"AttributeNames"
|
||||
],
|
||||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"ObjectReference":{"shape":"ObjectReference"},
|
||||
"ConsistencyLevel":{
|
||||
"shape":"ConsistencyLevel",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-consistency-level"
|
||||
},
|
||||
"SchemaFacet":{"shape":"SchemaFacet"},
|
||||
"AttributeNames":{"shape":"AttributeNameList"}
|
||||
}
|
||||
},
|
||||
"GetObjectAttributesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Attributes":{"shape":"AttributeKeyAndValueList"}
|
||||
}
|
||||
},
|
||||
"GetObjectInformationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -2722,6 +2860,14 @@
|
||||
"IdentityAttributeOrder":{"shape":"AttributeNameList"}
|
||||
}
|
||||
},
|
||||
"IncompatibleSchemaException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"IndexAttachment":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -2837,6 +2983,7 @@
|
||||
"required":["DirectoryArn"],
|
||||
"members":{
|
||||
"DirectoryArn":{"shape":"Arn"},
|
||||
"SchemaArn":{"shape":"Arn"},
|
||||
"NextToken":{"shape":"NextToken"},
|
||||
"MaxResults":{"shape":"NumberResults"}
|
||||
}
|
||||
@@ -3208,6 +3355,7 @@
|
||||
"ListPublishedSchemaArnsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SchemaArn":{"shape":"Arn"},
|
||||
"NextToken":{"shape":"NextToken"},
|
||||
"MaxResults":{"shape":"NumberResults"}
|
||||
}
|
||||
@@ -3452,6 +3600,7 @@
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"Version":{"shape":"Version"},
|
||||
"MinorVersion":{"shape":"Version"},
|
||||
"Name":{"shape":"SchemaName"}
|
||||
}
|
||||
},
|
||||
@@ -3894,6 +4043,45 @@
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"UpgradeAppliedSchemaRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"PublishedSchemaArn",
|
||||
"DirectoryArn"
|
||||
],
|
||||
"members":{
|
||||
"PublishedSchemaArn":{"shape":"Arn"},
|
||||
"DirectoryArn":{"shape":"Arn"},
|
||||
"DryRun":{"shape":"Bool"}
|
||||
}
|
||||
},
|
||||
"UpgradeAppliedSchemaResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"UpgradedSchemaArn":{"shape":"Arn"},
|
||||
"DirectoryArn":{"shape":"Arn"}
|
||||
}
|
||||
},
|
||||
"UpgradePublishedSchemaRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DevelopmentSchemaArn",
|
||||
"PublishedSchemaArn",
|
||||
"MinorVersion"
|
||||
],
|
||||
"members":{
|
||||
"DevelopmentSchemaArn":{"shape":"Arn"},
|
||||
"PublishedSchemaArn":{"shape":"Arn"},
|
||||
"MinorVersion":{"shape":"Version"},
|
||||
"DryRun":{"shape":"Bool"}
|
||||
}
|
||||
},
|
||||
"UpgradePublishedSchemaResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"UpgradedSchemaArn":{"shape":"Arn"}
|
||||
}
|
||||
},
|
||||
"ValidationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
||||
Generated
Vendored
+109
-22
@@ -2,14 +2,14 @@
|
||||
"version": "2.0",
|
||||
"service": "<fullname>Amazon Cloud Directory</fullname> <p>Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see <a href=\"https://aws.amazon.com/directoryservice/\">AWS Directory Service</a> and the <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html\">AWS Directory Service Administration Guide</a>.</p>",
|
||||
"operations": {
|
||||
"AddFacetToObject": "<p>Adds a new <a>Facet</a> to an object.</p>",
|
||||
"ApplySchema": "<p>Copies the input published schema into the <a>Directory</a> with the same name and version as that of the published schema .</p>",
|
||||
"AddFacetToObject": "<p>Adds a new <a>Facet</a> to an object. An object can have more than one facet applied on it.</p>",
|
||||
"ApplySchema": "<p>Copies the input published schema, at the specified version, into the <a>Directory</a> with the same name and version as that of the published schema.</p>",
|
||||
"AttachObject": "<p>Attaches an existing object to another object. An object can be accessed in two ways:</p> <ol> <li> <p>Using the path</p> </li> <li> <p>Using <code>ObjectIdentifier</code> </p> </li> </ol>",
|
||||
"AttachPolicy": "<p>Attaches a policy object to a regular object. An object can have a limited number of attached policies.</p>",
|
||||
"AttachToIndex": "<p>Attaches the specified object to the specified index.</p>",
|
||||
"AttachTypedLink": "<p>Attaches a typed link to a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
|
||||
"BatchRead": "<p>Performs all the read operations in a batch. </p>",
|
||||
"BatchWrite": "<p>Performs all the write operations in a batch. Either all the operations succeed or none. Batch writes supports only object-related operations.</p>",
|
||||
"BatchWrite": "<p>Performs all the write operations in a batch. Either all the operations succeed or none.</p>",
|
||||
"CreateDirectory": "<p>Creates a <a>Directory</a> by copying the published schema into the directory. A directory cannot be created without a schema.</p>",
|
||||
"CreateFacet": "<p>Creates a new <a>Facet</a> in a schema. Facet creation is allowed only in development or applied schemas.</p>",
|
||||
"CreateIndex": "<p>Creates an index object. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_indexing.html\">Indexing</a> for more information.</p>",
|
||||
@@ -27,13 +27,15 @@
|
||||
"DetachTypedLink": "<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
|
||||
"DisableDirectory": "<p>Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.</p>",
|
||||
"EnableDirectory": "<p>Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.</p>",
|
||||
"GetAppliedSchemaVersion": "<p>Returns current applied schema version ARN, including the minor version in use.</p>",
|
||||
"GetDirectory": "<p>Retrieves metadata about a directory.</p>",
|
||||
"GetFacet": "<p>Gets details of the <a>Facet</a>, such as facet name, attributes, <a>Rule</a>s, or <code>ObjectType</code>. You can call this on all kinds of schema facets -- published, development, or applied.</p>",
|
||||
"GetObjectAttributes": "<p>Retrieves attributes within a facet that are associated with an object.</p>",
|
||||
"GetObjectInformation": "<p>Retrieves metadata about an object.</p>",
|
||||
"GetSchemaAsJson": "<p>Retrieves a JSON representation of the schema. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_schemas.html#jsonformat\">JSON Schema Format</a> for more information.</p>",
|
||||
"GetTypedLinkFacetInformation": "<p>Returns the identity attribute order for a specific <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
|
||||
"ListAppliedSchemaArns": "<p>Lists schemas applied to a directory.</p>",
|
||||
"ListAttachedIndices": "<p>Lists indices attached to an object.</p>",
|
||||
"ListAppliedSchemaArns": "<p>Lists schema major versions applied to a directory. If <code>SchemaArn</code> is provided, lists the minor version.</p>",
|
||||
"ListAttachedIndices": "<p>Lists indices attached to the specified object.</p>",
|
||||
"ListDevelopmentSchemaArns": "<p>Retrieves each Amazon Resource Name (ARN) of schemas in the development state.</p>",
|
||||
"ListDirectories": "<p>Lists directories created within an account.</p>",
|
||||
"ListFacetAttributes": "<p>Retrieves attributes attached to the facet.</p>",
|
||||
@@ -47,12 +49,12 @@
|
||||
"ListObjectPolicies": "<p>Returns policies attached to an object in pagination fashion.</p>",
|
||||
"ListOutgoingTypedLinks": "<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
|
||||
"ListPolicyAttachments": "<p>Returns all of the <code>ObjectIdentifiers</code> to which a given policy is attached.</p>",
|
||||
"ListPublishedSchemaArns": "<p>Retrieves each published schema Amazon Resource Name (ARN).</p>",
|
||||
"ListPublishedSchemaArns": "<p>Lists the major version families of each published schema. If a major version ARN is provided as <code>SchemaArn</code>, the minor version revisions in that family are listed instead.</p>",
|
||||
"ListTagsForResource": "<p>Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.</p>",
|
||||
"ListTypedLinkFacetAttributes": "<p>Returns a paginated list of all attribute definitions for a particular <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
|
||||
"ListTypedLinkFacetNames": "<p>Returns a paginated list of <code>TypedLink</code> facet names for a particular schema. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
|
||||
"LookupPolicy": "<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code> for such objects. If policies are present, it returns <code>ObjectIdentifier</code>, <code>policyId</code>, and <code>policyType</code>. Paths that don't lead to the root from the target object are ignored. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>",
|
||||
"PublishSchema": "<p>Publishes a development schema with a version. If description and attributes are specified, <code>PublishSchema</code> overrides the development schema description and attributes. If not, the development schema description and attributes are used.</p>",
|
||||
"PublishSchema": "<p>Publishes a development schema with a major version and a recommended minor version.</p>",
|
||||
"PutSchemaFromJson": "<p>Allows a schema to be updated using JSON upload. Only available for development schemas. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_schemas.html#jsonformat\">JSON Schema Format</a> for more information.</p>",
|
||||
"RemoveFacetFromObject": "<p>Removes the specified facet from the specified object.</p>",
|
||||
"TagResource": "<p>An API operation for adding tags to a resource.</p>",
|
||||
@@ -60,7 +62,9 @@
|
||||
"UpdateFacet": "<p>Does the following:</p> <ol> <li> <p>Adds new <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> <li> <p>Updates existing <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> <li> <p>Deletes existing <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> </ol>",
|
||||
"UpdateObjectAttributes": "<p>Updates a given object's attributes.</p>",
|
||||
"UpdateSchema": "<p>Updates the schema name with a new name. Only development schema names can be updated.</p>",
|
||||
"UpdateTypedLinkFacet": "<p>Updates a <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
"UpdateTypedLinkFacet": "<p>Updates a <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
|
||||
"UpgradeAppliedSchema": "<p>Upgrades a single directory in-place using the <code>PublishedSchemaArn</code> with schema updates found in <code>MinorVersion</code>. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory.</p>",
|
||||
"UpgradePublishedSchema": "<p>Upgrades a published schema under a new minor version revision using the current contents of <code>DevelopmentSchemaArn</code>.</p>"
|
||||
},
|
||||
"shapes": {
|
||||
"AccessDeniedException": {
|
||||
@@ -126,11 +130,15 @@
|
||||
"DisableDirectoryResponse$DirectoryArn": "<p>The ARN of the directory that has been disabled.</p>",
|
||||
"EnableDirectoryRequest$DirectoryArn": "<p>The ARN of the directory to enable.</p>",
|
||||
"EnableDirectoryResponse$DirectoryArn": "<p>The ARN of the enabled directory.</p>",
|
||||
"GetAppliedSchemaVersionRequest$SchemaArn": "<p>The ARN of the applied schema.</p>",
|
||||
"GetAppliedSchemaVersionResponse$AppliedSchemaArn": "<p>Current applied schema ARN, including the minor version in use if one was provided.</p>",
|
||||
"GetFacetRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) that is associated with the <a>Facet</a>. For more information, see <a>arns</a>.</p>",
|
||||
"GetObjectAttributesRequest$DirectoryArn": "<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides.</p>",
|
||||
"GetObjectInformationRequest$DirectoryArn": "<p>The ARN of the directory being retrieved.</p>",
|
||||
"GetSchemaAsJsonRequest$SchemaArn": "<p>The ARN of the schema to retrieve.</p>",
|
||||
"GetTypedLinkFacetInformationRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
|
||||
"ListAppliedSchemaArnsRequest$DirectoryArn": "<p>The ARN of the directory you are listing.</p>",
|
||||
"ListAppliedSchemaArnsRequest$SchemaArn": "<p>The response for <code>ListAppliedSchemaArns</code> when this parameter is used will list all minor version ARNs for a major version.</p>",
|
||||
"ListAttachedIndicesRequest$DirectoryArn": "<p>The ARN of the directory.</p>",
|
||||
"ListFacetAttributesRequest$SchemaArn": "<p>The ARN of the schema where the facet resides.</p>",
|
||||
"ListFacetNamesRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) to retrieve facet names from.</p>",
|
||||
@@ -143,6 +151,7 @@
|
||||
"ListObjectPoliciesRequest$DirectoryArn": "<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>",
|
||||
"ListOutgoingTypedLinksRequest$DirectoryArn": "<p>The Amazon Resource Name (ARN) of the directory where you want to list the typed links.</p>",
|
||||
"ListPolicyAttachmentsRequest$DirectoryArn": "<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>",
|
||||
"ListPublishedSchemaArnsRequest$SchemaArn": "<p>The response for <code>ListPublishedSchemaArns</code> when this parameter is used will list all minor version ARNs for a major version.</p>",
|
||||
"ListTagsForResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.</p>",
|
||||
"ListTypedLinkFacetAttributesRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
|
||||
"ListTypedLinkFacetNamesRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
|
||||
@@ -152,7 +161,7 @@
|
||||
"PutSchemaFromJsonRequest$SchemaArn": "<p>The ARN of the schema to update.</p>",
|
||||
"PutSchemaFromJsonResponse$Arn": "<p>The ARN of the schema to update.</p>",
|
||||
"RemoveFacetFromObjectRequest$DirectoryArn": "<p>The ARN of the directory in which the object resides.</p>",
|
||||
"SchemaFacet$SchemaArn": "<p>The ARN of the schema that contains the facet.</p>",
|
||||
"SchemaFacet$SchemaArn": "<p>The ARN of the schema that contains the facet with no minor component. See <a>arns</a> and <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/inplaceschemaupgrade.html\">In-Place Schema Upgrade</a> for a description of when to provide minor versions.</p>",
|
||||
"TagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.</p>",
|
||||
"TypedLinkSchemaAndFacetName$SchemaArn": "<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
|
||||
"UntagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.</p>",
|
||||
@@ -160,7 +169,14 @@
|
||||
"UpdateObjectAttributesRequest$DirectoryArn": "<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
|
||||
"UpdateSchemaRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) of the development schema. For more information, see <a>arns</a>.</p>",
|
||||
"UpdateSchemaResponse$SchemaArn": "<p>The ARN that is associated with the updated schema. For more information, see <a>arns</a>.</p>",
|
||||
"UpdateTypedLinkFacetRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>"
|
||||
"UpdateTypedLinkFacetRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
|
||||
"UpgradeAppliedSchemaRequest$PublishedSchemaArn": "<p>The revision of the published schema to upgrade the directory to.</p>",
|
||||
"UpgradeAppliedSchemaRequest$DirectoryArn": "<p>The ARN for the directory to which the upgraded schema will be applied.</p>",
|
||||
"UpgradeAppliedSchemaResponse$UpgradedSchemaArn": "<p>The ARN of the upgraded schema that is returned as part of the response.</p>",
|
||||
"UpgradeAppliedSchemaResponse$DirectoryArn": "<p>The ARN of the directory that is returned as part of the response.</p>",
|
||||
"UpgradePublishedSchemaRequest$DevelopmentSchemaArn": "<p>The ARN of the development schema with the changes used for the upgrade.</p>",
|
||||
"UpgradePublishedSchemaRequest$PublishedSchemaArn": "<p>The ARN of the published schema to be upgraded.</p>",
|
||||
"UpgradePublishedSchemaResponse$UpgradedSchemaArn": "<p>The ARN of the upgraded schema that is returned as part of the response.</p>"
|
||||
}
|
||||
},
|
||||
"Arns": {
|
||||
@@ -232,8 +248,10 @@
|
||||
"AddFacetToObjectRequest$ObjectAttributeList": "<p>Attributes on the facet that you are adding to the object.</p>",
|
||||
"BatchAddFacetToObject$ObjectAttributeList": "<p>The attributes to set on the object.</p>",
|
||||
"BatchCreateObject$ObjectAttributeList": "<p>An attribute map, which contains an attribute ARN as the key and attribute value as the map value.</p>",
|
||||
"BatchGetObjectAttributesResponse$Attributes": "<p>The attribute values that are associated with an object.</p>",
|
||||
"BatchListObjectAttributesResponse$Attributes": "<p>The attributes map that is associated with the object. <code>AttributeArn</code> is the key; attribute value is the value.</p>",
|
||||
"CreateObjectRequest$ObjectAttributeList": "<p>The attribute map whose attribute ARN contains the key and attribute value as the map value.</p>",
|
||||
"GetObjectAttributesResponse$Attributes": "<p>The attributes that are associated with the object.</p>",
|
||||
"IndexAttachment$IndexedAttributes": "<p>The indexed attribute values.</p>",
|
||||
"ListObjectAttributesResponse$Attributes": "<p>Attributes map that is associated with the object. <code>AttributeArn</code> is the key, and attribute value is the value.</p>"
|
||||
}
|
||||
@@ -274,6 +292,8 @@
|
||||
"AttributeNameList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchGetObjectAttributes$AttributeNames": "<p>List of attribute names whose values will be retrieved.</p>",
|
||||
"GetObjectAttributesRequest$AttributeNames": "<p>List of attribute names whose values will be retrieved.</p>",
|
||||
"GetTypedLinkFacetInformationResponse$IdentityAttributeOrder": "<p>The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
|
||||
"TypedLinkFacet$IdentityAttributeOrder": "<p>The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See <a>ListOutgoingTypedLinks</a> and <a>ListIncomingTypedLinks</a> for details.</p>",
|
||||
"UpdateTypedLinkFacetRequest$IdentityAttributeOrder": "<p>The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to a typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
@@ -400,7 +420,7 @@
|
||||
}
|
||||
},
|
||||
"BatchDetachPolicy": {
|
||||
"base": "<p>Detaches the specified policy from the specified directory inside a <a>BatchRead</a> operation. For more information, see <a>DetachPolicy</a> and <a>BatchReadRequest$Operations</a>.</p>",
|
||||
"base": "<p>Detaches the specified policy from the specified directory inside a <a>BatchWrite</a> operation. For more information, see <a>DetachPolicy</a> and <a>BatchWriteRequest$Operations</a>.</p>",
|
||||
"refs": {
|
||||
"BatchWriteOperation$DetachPolicy": "<p>Detaches a policy from a <a>Directory</a>.</p>"
|
||||
}
|
||||
@@ -423,6 +443,18 @@
|
||||
"BatchWriteOperationResponse$DetachTypedLink": "<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
}
|
||||
},
|
||||
"BatchGetObjectAttributes": {
|
||||
"base": "<p>Retrieves attributes within a facet that are associated with an object inside an <a>BatchRead</a> operation. For more information, see <a>GetObjectAttributes</a> and <a>BatchReadRequest$Operations</a>.</p>",
|
||||
"refs": {
|
||||
"BatchReadOperation$GetObjectAttributes": "<p>Retrieves attributes within a facet that are associated with an object.</p>"
|
||||
}
|
||||
},
|
||||
"BatchGetObjectAttributesResponse": {
|
||||
"base": "<p>Represents the output of a <a>GetObjectAttributes</a> response operation.</p>",
|
||||
"refs": {
|
||||
"BatchReadSuccessfulResponse$GetObjectAttributes": "<p>Retrieves attributes within a facet that are associated with an object.</p>"
|
||||
}
|
||||
},
|
||||
"BatchGetObjectInformation": {
|
||||
"base": "<p>Retrieves metadata about an object inside a <a>BatchRead</a> operation. For more information, see <a>GetObjectInformation</a> and <a>BatchReadRequest$Operations</a>.</p>",
|
||||
"refs": {
|
||||
@@ -702,7 +734,9 @@
|
||||
"BatchCreateIndex$IsUnique": "<p>Indicates whether the attribute that is being indexed has unique values or not.</p>",
|
||||
"CreateIndexRequest$IsUnique": "<p>Indicates whether the attribute that is being indexed has unique values or not.</p>",
|
||||
"FacetAttributeDefinition$IsImmutable": "<p>Whether the attribute is mutable or not.</p>",
|
||||
"TypedLinkAttributeDefinition$IsImmutable": "<p>Whether the attribute is mutable or not.</p>"
|
||||
"TypedLinkAttributeDefinition$IsImmutable": "<p>Whether the attribute is mutable or not.</p>",
|
||||
"UpgradeAppliedSchemaRequest$DryRun": "<p>Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.</p>",
|
||||
"UpgradePublishedSchemaRequest$DryRun": "<p>Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.</p>"
|
||||
}
|
||||
},
|
||||
"BooleanAttributeValue": {
|
||||
@@ -720,6 +754,7 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchReadRequest$ConsistencyLevel": "<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
|
||||
"GetObjectAttributesRequest$ConsistencyLevel": "<p>The consistency level at which to retrieve the attributes on an object.</p>",
|
||||
"GetObjectInformationRequest$ConsistencyLevel": "<p>The consistency level at which to retrieve the object information.</p>",
|
||||
"ListAttachedIndicesRequest$ConsistencyLevel": "<p>The consistency level to use for this operation.</p>",
|
||||
"ListIncomingTypedLinksRequest$ConsistencyLevel": "<p>The consistency level to execute the request at.</p>",
|
||||
@@ -934,7 +969,7 @@
|
||||
}
|
||||
},
|
||||
"DirectoryNotEnabledException": {
|
||||
"base": "<p>An operation can only operate on a directory that is not enabled.</p>",
|
||||
"base": "<p>Operations are only permitted on enabled directories.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -980,6 +1015,7 @@
|
||||
"FacetInUseException$Message": null,
|
||||
"FacetNotFoundException$Message": null,
|
||||
"FacetValidationException$Message": null,
|
||||
"IncompatibleSchemaException$Message": null,
|
||||
"IndexedAttributeMissingException$Message": null,
|
||||
"InternalServiceException$Message": null,
|
||||
"InvalidArnException$Message": null,
|
||||
@@ -1006,7 +1042,7 @@
|
||||
}
|
||||
},
|
||||
"Facet": {
|
||||
"base": "<p>A structure that contains <code>Name</code>, <code>ARN</code>, <code>Attributes</code>, <a>Rule</a>s, and <code>ObjectTypes</code>.</p>",
|
||||
"base": "<p>A structure that contains <code>Name</code>, <code>ARN</code>, <code>Attributes</code>, <code> <a>Rule</a>s</code>, and <code>ObjectTypes</code>. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/whatarefacets.html\">Facets</a> for more information.</p>",
|
||||
"refs": {
|
||||
"GetFacetResponse$Facet": "<p>The <a>Facet</a> structure that is associated with the facet.</p>"
|
||||
}
|
||||
@@ -1097,6 +1133,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetAppliedSchemaVersionRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetAppliedSchemaVersionResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetDirectoryRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -1117,6 +1163,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetObjectAttributesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetObjectAttributesResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetObjectInformationRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -1147,6 +1203,11 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"IncompatibleSchemaException": {
|
||||
"base": "<p>Indicates a failure occurred while performing a check for backward compatibility between the specified schema and the schema that is currently applied to the directory.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"IndexAttachment": {
|
||||
"base": "<p>Represents an index and an attached object.</p>",
|
||||
"refs": {
|
||||
@@ -1545,7 +1606,7 @@
|
||||
"ListFacetAttributesRequest$MaxResults": "<p>The maximum number of results to retrieve.</p>",
|
||||
"ListFacetNamesRequest$MaxResults": "<p>The maximum number of results to retrieve.</p>",
|
||||
"ListIncomingTypedLinksRequest$MaxResults": "<p>The maximum number of results to retrieve.</p>",
|
||||
"ListIndexRequest$MaxResults": "<p>The maximum number of results to retrieve from the index.</p>",
|
||||
"ListIndexRequest$MaxResults": "<p>The maximum number of objects in a single page to retrieve from the index during a request. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html#limits_cd\">AWS Directory Service Limits</a>.</p>",
|
||||
"ListObjectAttributesRequest$MaxResults": "<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>",
|
||||
"ListObjectChildrenRequest$MaxResults": "<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>",
|
||||
"ListObjectParentPathsRequest$MaxResults": "<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>",
|
||||
@@ -1615,7 +1676,7 @@
|
||||
"DetachFromIndexResponse$DetachedObjectIdentifier": "<p>The <code>ObjectIdentifier</code> of the object that was detached from the index.</p>",
|
||||
"DetachObjectResponse$DetachedObjectIdentifier": "<p>The <code>ObjectIdentifier</code> that was detached from the object.</p>",
|
||||
"GetObjectInformationResponse$ObjectIdentifier": "<p>The <code>ObjectIdentifier</code> of the specified object.</p>",
|
||||
"IndexAttachment$ObjectIdentifier": "<p>The <code>ObjectIdentifier</code> of the object attached to the index.</p>",
|
||||
"IndexAttachment$ObjectIdentifier": "<p>In response to <a>ListIndex</a>, the <code>ObjectIdentifier</code> of the object attached to the index. In response to <a>ListAttachedIndices</a>, the <code>ObjectIdentifier</code> of the index attached to the object. This field will always contain the <code>ObjectIdentifier</code> of the object on the opposite side of the attachment specified in the query.</p>",
|
||||
"LinkNameToObjectIdentifierMap$value": null,
|
||||
"ObjectIdentifierList$member": null,
|
||||
"ObjectIdentifierToLinkNameMap$key": null,
|
||||
@@ -1674,6 +1735,7 @@
|
||||
"BatchDetachObject$ParentReference": "<p>Parent reference from which the object with the specified link name is detached.</p>",
|
||||
"BatchDetachPolicy$PolicyReference": "<p>Reference that identifies the policy object.</p>",
|
||||
"BatchDetachPolicy$ObjectReference": "<p>Reference that identifies the object whose policy object will be detached.</p>",
|
||||
"BatchGetObjectAttributes$ObjectReference": "<p>Reference that identifies the object whose attributes will be retrieved.</p>",
|
||||
"BatchGetObjectInformation$ObjectReference": "<p>A reference to the object.</p>",
|
||||
"BatchListAttachedIndices$TargetReference": "<p>A reference to the object that has indices attached.</p>",
|
||||
"BatchListIncomingTypedLinks$ObjectReference": "<p>The reference that identifies the object whose attributes will be listed.</p>",
|
||||
@@ -1695,6 +1757,7 @@
|
||||
"DetachObjectRequest$ParentReference": "<p>The parent reference from which the object with the specified link name is detached.</p>",
|
||||
"DetachPolicyRequest$PolicyReference": "<p>Reference that identifies the policy object.</p>",
|
||||
"DetachPolicyRequest$ObjectReference": "<p>Reference that identifies the object whose policy object will be detached.</p>",
|
||||
"GetObjectAttributesRequest$ObjectReference": "<p>Reference that identifies the object whose attributes will be retrieved.</p>",
|
||||
"GetObjectInformationRequest$ObjectReference": "<p>A reference to the object.</p>",
|
||||
"ListAttachedIndicesRequest$TargetReference": "<p>A reference to the object that has indices attached.</p>",
|
||||
"ListIncomingTypedLinksRequest$ObjectReference": "<p>Reference that identifies the object whose attributes will be listed.</p>",
|
||||
@@ -1882,12 +1945,14 @@
|
||||
"SchemaFacet": {
|
||||
"base": "<p>A facet.</p>",
|
||||
"refs": {
|
||||
"AddFacetToObjectRequest$SchemaFacet": "<p>Identifiers for the facet that you are adding to the object.</p>",
|
||||
"AddFacetToObjectRequest$SchemaFacet": "<p>Identifiers for the facet that you are adding to the object. See <a>SchemaFacet</a> for details.</p>",
|
||||
"BatchAddFacetToObject$SchemaFacet": "<p>Represents the facet being added to the object.</p>",
|
||||
"BatchGetObjectAttributes$SchemaFacet": "<p>Identifier for the facet whose attributes will be retrieved. See <a>SchemaFacet</a> for details.</p>",
|
||||
"BatchListObjectAttributes$FacetFilter": "<p>Used to filter the list of object attributes that are associated with a certain facet.</p>",
|
||||
"BatchRemoveFacetFromObject$SchemaFacet": "<p>The facet to remove from the object.</p>",
|
||||
"GetObjectAttributesRequest$SchemaFacet": "<p>Identifier for the facet whose attributes will be retrieved. See <a>SchemaFacet</a> for details.</p>",
|
||||
"ListObjectAttributesRequest$FacetFilter": "<p>Used to filter the list of object attributes that are associated with a certain facet.</p>",
|
||||
"RemoveFacetFromObjectRequest$SchemaFacet": "<p>The facet to remove.</p>",
|
||||
"RemoveFacetFromObjectRequest$SchemaFacet": "<p>The facet to remove. See <a>SchemaFacet</a> for details.</p>",
|
||||
"SchemaFacetList$member": null
|
||||
}
|
||||
},
|
||||
@@ -1896,8 +1961,8 @@
|
||||
"refs": {
|
||||
"BatchCreateObject$SchemaFacet": "<p>A list of <code>FacetArns</code> that will be associated with the object. For more information, see <a>arns</a>.</p>",
|
||||
"BatchGetObjectInformationResponse$SchemaFacets": "<p>The facets attached to the specified object.</p>",
|
||||
"CreateObjectRequest$SchemaFacets": "<p>A list of schema facets to be associated with the object that contains <code>SchemaArn</code> and facet name. For more information, see <a>arns</a>.</p>",
|
||||
"GetObjectInformationResponse$SchemaFacets": "<p>The facets attached to the specified object.</p>"
|
||||
"CreateObjectRequest$SchemaFacets": "<p>A list of schema facets to be associated with the object. Do not provide minor version components. See <a>SchemaFacet</a> for details.</p>",
|
||||
"GetObjectInformationResponse$SchemaFacets": "<p>The facets attached to the specified object. Although the response does not include minor version information, the most recently applied minor version of each Facet is in effect. See <a>GetAppliedSchemaVersion</a> for details.</p>"
|
||||
}
|
||||
},
|
||||
"SchemaJsonDocument": {
|
||||
@@ -1994,7 +2059,7 @@
|
||||
}
|
||||
},
|
||||
"TypedAttributeValueRange": {
|
||||
"base": "<p>A range of attribute values.</p>",
|
||||
"base": "<p>A range of attribute values. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#rangefilters\">Range Filters</a>.</p>",
|
||||
"refs": {
|
||||
"ObjectAttributeRange$Range": "<p>The range of attribute values being selected.</p>",
|
||||
"TypedLinkAttributeRange$Range": "<p>The range of attribute values that are being selected.</p>"
|
||||
@@ -2159,6 +2224,26 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpgradeAppliedSchemaRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpgradeAppliedSchemaResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpgradePublishedSchemaRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpgradePublishedSchemaResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ValidationException": {
|
||||
"base": "<p>Indicates that your request is malformed in some manner. See the exception message.</p>",
|
||||
"refs": {
|
||||
@@ -2167,7 +2252,9 @@
|
||||
"Version": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PublishSchemaRequest$Version": "<p>The version under which the schema will be published.</p>"
|
||||
"PublishSchemaRequest$Version": "<p>The major version under which the schema will be published. Schemas have both a major and minor version associated with them.</p>",
|
||||
"PublishSchemaRequest$MinorVersion": "<p>The minor version under which the schema will be published. This parameter is recommended. Schemas have both a major and minor version associated with them.</p>",
|
||||
"UpgradePublishedSchemaRequest$MinorVersion": "<p>Identifies the minor version of the published schema that will be created. This parameter is NOT optional.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Generated
Vendored
+58
-4
@@ -5,6 +5,7 @@
|
||||
"endpointPrefix":"cloudformation",
|
||||
"protocol":"query",
|
||||
"serviceFullName":"AWS CloudFormation",
|
||||
"serviceId":"CloudFormation",
|
||||
"signatureVersion":"v4",
|
||||
"uid":"cloudformation-2010-05-15",
|
||||
"xmlNamespace":"http://cloudformation.amazonaws.com/doc/2010-05-15/"
|
||||
@@ -530,6 +531,26 @@
|
||||
{"shape":"TokenAlreadyExistsException"}
|
||||
]
|
||||
},
|
||||
"UpdateStackInstances":{
|
||||
"name":"UpdateStackInstances",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateStackInstancesInput"},
|
||||
"output":{
|
||||
"shape":"UpdateStackInstancesOutput",
|
||||
"resultWrapper":"UpdateStackInstancesResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"StackSetNotFoundException"},
|
||||
{"shape":"StackInstanceNotFoundException"},
|
||||
{"shape":"OperationInProgressException"},
|
||||
{"shape":"OperationIdAlreadyExistsException"},
|
||||
{"shape":"StaleRequestException"},
|
||||
{"shape":"InvalidOperationException"}
|
||||
]
|
||||
},
|
||||
"UpdateStackSet":{
|
||||
"name":"UpdateStackSet",
|
||||
"http":{
|
||||
@@ -836,6 +857,7 @@
|
||||
"StackSetName":{"shape":"StackSetName"},
|
||||
"Accounts":{"shape":"AccountList"},
|
||||
"Regions":{"shape":"RegionList"},
|
||||
"ParameterOverrides":{"shape":"Parameters"},
|
||||
"OperationPreferences":{"shape":"StackSetOperationPreferences"},
|
||||
"OperationId":{
|
||||
"shape":"ClientRequestToken",
|
||||
@@ -866,6 +888,7 @@
|
||||
"Parameters":{"shape":"Parameters"},
|
||||
"Capabilities":{"shape":"Capabilities"},
|
||||
"Tags":{"shape":"Tags"},
|
||||
"AdministrationRoleARN":{"shape":"RoleARN"},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"idempotencyToken":true
|
||||
@@ -1527,7 +1550,8 @@
|
||||
"members":{
|
||||
"ParameterKey":{"shape":"ParameterKey"},
|
||||
"ParameterValue":{"shape":"ParameterValue"},
|
||||
"UsePreviousValue":{"shape":"UsePreviousValue"}
|
||||
"UsePreviousValue":{"shape":"UsePreviousValue"},
|
||||
"ResolvedValue":{"shape":"ParameterValue"}
|
||||
}
|
||||
},
|
||||
"ParameterConstraints":{
|
||||
@@ -1799,6 +1823,7 @@
|
||||
"Region":{"shape":"Region"},
|
||||
"Account":{"shape":"Account"},
|
||||
"StackId":{"shape":"StackId"},
|
||||
"ParameterOverrides":{"shape":"Parameters"},
|
||||
"Status":{"shape":"StackInstanceStatus"},
|
||||
"StatusReason":{"shape":"Reason"}
|
||||
}
|
||||
@@ -1939,15 +1964,17 @@
|
||||
"TemplateBody":{"shape":"TemplateBody"},
|
||||
"Parameters":{"shape":"Parameters"},
|
||||
"Capabilities":{"shape":"Capabilities"},
|
||||
"Tags":{"shape":"Tags"}
|
||||
"Tags":{"shape":"Tags"},
|
||||
"StackSetARN":{"shape":"StackSetARN"},
|
||||
"AdministrationRoleARN":{"shape":"RoleARN"}
|
||||
}
|
||||
},
|
||||
"StackSetARN":{"type":"string"},
|
||||
"StackSetId":{"type":"string"},
|
||||
"StackSetName":{"type":"string"},
|
||||
"StackSetNameOrId":{
|
||||
"type":"string",
|
||||
"min":1,
|
||||
"pattern":"[a-zA-Z][-a-zA-Z0-9]*"
|
||||
"pattern":"[a-zA-Z][-a-zA-Z0-9]*(?::[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12})?"
|
||||
},
|
||||
"StackSetNotEmptyException":{
|
||||
"type":"structure",
|
||||
@@ -1980,6 +2007,7 @@
|
||||
"Status":{"shape":"StackSetOperationStatus"},
|
||||
"OperationPreferences":{"shape":"StackSetOperationPreferences"},
|
||||
"RetainStacks":{"shape":"RetainStacksNullable"},
|
||||
"AdministrationRoleARN":{"shape":"RoleARN"},
|
||||
"CreationTimestamp":{"shape":"Timestamp"},
|
||||
"EndTimestamp":{"shape":"Timestamp"}
|
||||
}
|
||||
@@ -2256,6 +2284,31 @@
|
||||
"ClientRequestToken":{"shape":"ClientRequestToken"}
|
||||
}
|
||||
},
|
||||
"UpdateStackInstancesInput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"StackSetName",
|
||||
"Accounts",
|
||||
"Regions"
|
||||
],
|
||||
"members":{
|
||||
"StackSetName":{"shape":"StackSetName"},
|
||||
"Accounts":{"shape":"AccountList"},
|
||||
"Regions":{"shape":"RegionList"},
|
||||
"ParameterOverrides":{"shape":"Parameters"},
|
||||
"OperationPreferences":{"shape":"StackSetOperationPreferences"},
|
||||
"OperationId":{
|
||||
"shape":"ClientRequestToken",
|
||||
"idempotencyToken":true
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateStackInstancesOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"OperationId":{"shape":"ClientRequestToken"}
|
||||
}
|
||||
},
|
||||
"UpdateStackOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -2275,6 +2328,7 @@
|
||||
"Capabilities":{"shape":"Capabilities"},
|
||||
"Tags":{"shape":"Tags"},
|
||||
"OperationPreferences":{"shape":"StackSetOperationPreferences"},
|
||||
"AdministrationRoleARN":{"shape":"RoleARN"},
|
||||
"OperationId":{
|
||||
"shape":"ClientRequestToken",
|
||||
"idempotencyToken":true
|
||||
|
||||
Generated
Vendored
+40
-9
@@ -39,6 +39,7 @@
|
||||
"SignalResource": "<p>Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.</p>",
|
||||
"StopStackSetOperation": "<p>Stops an in-progress operation on a stack set and its associated stack instances. </p>",
|
||||
"UpdateStack": "<p>Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the <a>DescribeStacks</a> action.</p> <p>To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action.</p> <p>For more information about creating an update template, updating a stack, and monitoring the progress of the update, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html\">Updating a Stack</a>.</p>",
|
||||
"UpdateStackInstances": "<p>Updates the parameter values for stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. </p> <p>You can only update stack instances in regions and accounts where they already exist; to create additional stack instances, use <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html\">CreateStackInstances</a>. </p> <p>During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value.</p> <p>You can only update the parameter <i>values</i> that are specified in the stack set; to add or delete a parameter itself, use <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using <code>UpdateStackInstances</code>.</p>",
|
||||
"UpdateStackSet": "<p>Updates the stack set and <i>all</i> associated stack instances.</p> <p>Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent <a>CreateStackInstances</a> calls on the specified stack set use the updated stack set.</p>",
|
||||
"UpdateTerminationProtection": "<p>Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html\">Protecting a Stack From Being Deleted</a> in the <i>AWS CloudFormation User Guide</i>.</p> <p> For <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html\">nested stacks</a>, termination protection is set on the root stack and cannot be changed directly on the nested stack.</p>",
|
||||
"ValidateTemplate": "<p>Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.</p>"
|
||||
@@ -89,7 +90,8 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateStackInstancesInput$Accounts": "<p>The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.</p>",
|
||||
"DeleteStackInstancesInput$Accounts": "<p>The names of the AWS accounts that you want to delete stack instances for.</p>"
|
||||
"DeleteStackInstancesInput$Accounts": "<p>The names of the AWS accounts that you want to delete stack instances for.</p>",
|
||||
"UpdateStackInstancesInput$Accounts": "<p>The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.</p>"
|
||||
}
|
||||
},
|
||||
"AllowedValue": {
|
||||
@@ -112,7 +114,7 @@
|
||||
"Arn": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"RollbackTrigger$Arn": "<p>The Amazon Resource Name (ARN) of the rollback trigger.</p>"
|
||||
"RollbackTrigger$Arn": "<p>The Amazon Resource Name (ARN) of the rollback trigger.</p> <p>If a specified trigger is missing, the entire stack operation fails and is rolled back. </p>"
|
||||
}
|
||||
},
|
||||
"CancelUpdateStackInput": {
|
||||
@@ -267,6 +269,8 @@
|
||||
"StackSetOperationSummary$OperationId": "<p>The unique ID of the stack set operation.</p>",
|
||||
"StopStackSetOperationInput$OperationId": "<p>The ID of the stack operation. </p>",
|
||||
"UpdateStackInput$ClientRequestToken": "<p>A unique identifier for this <code>UpdateStack</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry <code>UpdateStack</code> requests to ensure that AWS CloudFormation successfully received them.</p> <p>All events triggered by a given stack operation are assigned the same client request token, which you can use to track operations. For example, if you execute a <code>CreateStack</code> operation with the token <code>token1</code>, then all the <code>StackEvents</code> generated by that operation will have <code>ClientRequestToken</code> set as <code>token1</code>.</p> <p>In the console, stack operations display the client request token on the Events tab. Stack operations that are initiated from the console use the token format <i>Console-StackOperation-ID</i>, which helps you easily identify the stack operation . For example, if you create a stack using the console, each stack event would be assigned the same token in the following format: <code>Console-CreateStack-7f59c3cf-00d2-40c7-b2ff-e75db0987002</code>. </p>",
|
||||
"UpdateStackInstancesInput$OperationId": "<p>The unique identifier for this stack set operation. </p> <p>The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.</p> <p>If you don't specify an operation ID, the SDK generates one automatically. </p>",
|
||||
"UpdateStackInstancesOutput$OperationId": "<p>The unique identifier for this stack set operation. </p>",
|
||||
"UpdateStackSetInput$OperationId": "<p>The unique ID for this stack set operation. </p> <p>The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.</p> <p>If you don't specify an operation ID, AWS CloudFormation generates one automatically.</p> <p>Repeating this stack set operation with a new operation ID retries all stack instances whose status is <code>OUTDATED</code>. </p>",
|
||||
"UpdateStackSetOutput$OperationId": "<p>The unique ID for this stack set operation.</p>"
|
||||
}
|
||||
@@ -795,7 +799,7 @@
|
||||
"MonitoringTimeInMinutes": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"RollbackConfiguration$MonitoringTimeInMinutes": "<p>The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources. If any of the alarms goes to ALERT state during the stack operation or this monitoring period, CloudFormation rolls back the entire stack operation. Then, for update operations, if the monitoring period expires without any alarms going to ALERT state CloudFormation proceeds to dispose of old resources as usual.</p> <p>If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources for update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html\">CancelUpdateStack</a>, for example) as necessary.</p> <p>If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.</p>"
|
||||
"RollbackConfiguration$MonitoringTimeInMinutes": "<p>The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.</p> <p>The default is 0 minutes.</p> <p>If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html\">CancelUpdateStack</a>, for example) as necessary.</p> <p>If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.</p>"
|
||||
}
|
||||
},
|
||||
"NameAlreadyExistsException": {
|
||||
@@ -943,7 +947,8 @@
|
||||
"ParameterValue": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Parameter$ParameterValue": "<p>The value associated with the parameter.</p>",
|
||||
"Parameter$ParameterValue": "<p>The input value associated with the parameter.</p>",
|
||||
"Parameter$ResolvedValue": "<p>Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types\"> <code>SSM</code> parameter types</a> in the template.</p>",
|
||||
"ParameterDeclaration$DefaultValue": "<p>The default value of the parameter.</p>",
|
||||
"TemplateParameter$DefaultValue": "<p>The default value associated with the parameter.</p>"
|
||||
}
|
||||
@@ -953,12 +958,15 @@
|
||||
"refs": {
|
||||
"CreateChangeSetInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters for the change set. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>",
|
||||
"CreateStackInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>",
|
||||
"CreateStackInstancesInput$ParameterOverrides": "<p>A list of stack set parameters whose values you want to override in the selected stack instances.</p> <p>Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance operations:</p> <ul> <li> <p>To override the current value for a parameter, include the parameter and specify its value.</p> </li> <li> <p>To leave a parameter set to its present value, you can do one of the following:</p> <ul> <li> <p>Do not include the parameter in the list.</p> </li> <li> <p>Include the parameter and specify <code>UsePreviousValue</code> as <code>true</code>. (You cannot specify both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p> </li> </ul> </li> <li> <p>To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.</p> </li> <li> <p>To leave all parameters set to their present values, do not specify this property at all.</p> </li> </ul> <p>During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.</p> <p>You can only override the parameter <i>values</i> that are specified in the stack set; to add or delete a parameter itself, use <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update the stack set template.</p>",
|
||||
"CreateStackSetInput$Parameters": "<p>The input parameters for the stack set template. </p>",
|
||||
"DescribeChangeSetOutput$Parameters": "<p>A list of <code>Parameter</code> structures that describes the input parameters and their values used to create the change set. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>",
|
||||
"EstimateTemplateCostInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters.</p>",
|
||||
"Stack$Parameters": "<p>A list of <code>Parameter</code> structures.</p>",
|
||||
"StackInstance$ParameterOverrides": "<p>A list of parameters from the stack set template whose values have been overridden in this stack instance.</p>",
|
||||
"StackSet$Parameters": "<p>A list of input parameters for a stack set.</p>",
|
||||
"UpdateStackInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>",
|
||||
"UpdateStackInstancesInput$ParameterOverrides": "<p> A list of input parameters whose values you want to update for the specified stack instances. </p> <p>Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance update operations:</p> <ul> <li> <p>To override the current value for a parameter, include the parameter and specify its value.</p> </li> <li> <p>To leave a parameter set to its present value, you can do one of the following:</p> <ul> <li> <p>Do not include the parameter in the list.</p> </li> <li> <p>Include the parameter and specify <code>UsePreviousValue</code> as <code>true</code>. (You cannot specify both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p> </li> </ul> </li> <li> <p>To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.</p> </li> <li> <p>To leave all parameters set to their present values, do not specify this property at all.</p> </li> </ul> <p>During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.</p> <p>You can only override the parameter <i>values</i> that are specified in the stack set; to add or delete a parameter itself, use <code>UpdateStackSet</code> to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using <code>UpdateStackInstances</code>.</p>",
|
||||
"UpdateStackSetInput$Parameters": "<p>A list of input parameters for the stack set template. </p>"
|
||||
}
|
||||
},
|
||||
@@ -1003,7 +1011,8 @@
|
||||
"refs": {
|
||||
"CreateStackInstancesInput$Regions": "<p>The names of one or more regions where you want to create stack instances using the specified AWS account(s). </p>",
|
||||
"DeleteStackInstancesInput$Regions": "<p>The regions where you want to delete stack set instances. </p>",
|
||||
"StackSetOperationPreferences$RegionOrder": "<p>The order of the regions in where you want to perform the stack operation.</p>"
|
||||
"StackSetOperationPreferences$RegionOrder": "<p>The order of the regions in where you want to perform the stack operation.</p>",
|
||||
"UpdateStackInstancesInput$Regions": "<p>The names of one or more regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.</p>"
|
||||
}
|
||||
},
|
||||
"Replacement": {
|
||||
@@ -1141,13 +1150,17 @@
|
||||
"ContinueUpdateRollbackInput$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>",
|
||||
"CreateChangeSetInput$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>",
|
||||
"CreateStackInput$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>",
|
||||
"CreateStackSetInput$AdministrationRoleARN": "<p>The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. </p> <p>Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Define Permissions for Multiple Administrators</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
|
||||
"DeleteStackInput$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>",
|
||||
"Stack$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.</p>",
|
||||
"UpdateStackInput$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>"
|
||||
"StackSet$AdministrationRoleARN": "<p>The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.</p> <p>Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Define Permissions for Multiple Administrators</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
|
||||
"StackSetOperation$AdministrationRoleARN": "<p>The Amazon Resource Number (ARN) of the IAM role used to perform this stack set operation. </p> <p>Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Define Permissions for Multiple Administrators</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
|
||||
"UpdateStackInput$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>",
|
||||
"UpdateStackSetInput$AdministrationRoleARN": "<p>The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.</p> <p>Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Define Permissions for Multiple Administrators</a> in the <i>AWS CloudFormation User Guide</i>.</p> <p> If you specify a customized administrator role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized administrator role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.</p>"
|
||||
}
|
||||
},
|
||||
"RollbackConfiguration": {
|
||||
"base": "<p>Structure containing the rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p> <p>Rollback triggers enable you to have AWS CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For each rollback trigger you create, you specify the Cloudwatch alarm that CloudFormation should monitor. CloudFormation monitors the specified alarms during the stack create or update operation, and for the specified amount of time after all resources have been deployed. If any of the alarms goes to ALERT state during the stack operation or the monitoring period, CloudFormation rolls back the entire stack operation. If the monitoring period expires without any alarms going to ALERT state, CloudFormation proceeds to dispose of old resources as usual.</p> <p>By default, CloudFormation only rolls back stack operations if an alarm goes to ALERT state, not INSUFFICIENT_DATA state. To have CloudFormation roll back the stack operation if an alarm goes to INSUFFICIENT_DATA state as well, edit the CloudWatch alarm to treat missing data as <code>breaching</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html\">Configuring How CloudWatch Alarms Treats Missing Data</a>.</p> <p>AWS CloudFormation does not monitor rollback triggers when it rolls back a stack during an update operation.</p>",
|
||||
"base": "<p>Structure containing the rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p> <p>Rollback triggers enable you to have AWS CloudFormation monitor the state of your application during stack creation and updating, and to roll back that operation if the application breaches the threshold of any of the alarms you've specified. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-rollback-triggers.html\">Monitor and Roll Back Stack Operations</a>.</p>",
|
||||
"refs": {
|
||||
"CreateChangeSetInput$RollbackConfiguration": "<p>The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p>",
|
||||
"CreateStackInput$RollbackConfiguration": "<p>The rollback triggers for AWS CloudFormation to monitor during stack creation and updating operations, and for the specified monitoring period afterwards.</p>",
|
||||
@@ -1157,7 +1170,7 @@
|
||||
}
|
||||
},
|
||||
"RollbackTrigger": {
|
||||
"base": "<p>A rollback trigger AWS CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes to ALERT state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation. </p>",
|
||||
"base": "<p>A rollback trigger AWS CloudFormation monitors during creation and updating of stacks. If any of the alarms you specify goes to ALARM state during the stack operation or within the specified monitoring period afterwards, CloudFormation rolls back the entire stack operation. </p>",
|
||||
"refs": {
|
||||
"RollbackTriggers$member": null
|
||||
}
|
||||
@@ -1165,7 +1178,7 @@
|
||||
"RollbackTriggers": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"RollbackConfiguration$RollbackTriggers": "<p>The triggers to monitor during stack creation or update actions. </p> <p>By default, AWS CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:</p> <ul> <li> <p>If you don't specify this parameter, AWS CloudFormation uses the rollback triggers previously specified for this stack, if any.</p> </li> <li> <p>If you specify any rollback triggers using this parameter, you must specify all the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.</p> </li> <li> <p>If you specify an empty list, AWS CloudFormation removes all currently specified triggers.</p> </li> </ul> <p>If a specified Cloudwatch alarm is missing, the entire stack operation fails and is rolled back. </p>"
|
||||
"RollbackConfiguration$RollbackTriggers": "<p>The triggers to monitor during stack creation or update actions. </p> <p>By default, AWS CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means:</p> <ul> <li> <p>To use the rollback triggers previously specified for this stack, if any, don't specify this parameter.</p> </li> <li> <p>To specify new or updated rollback triggers, you must specify <i>all</i> the triggers that you want used for this stack, even triggers you've specifed before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack.</p> </li> <li> <p>To remove all currently specified triggers, specify an empty list for this parameter.</p> </li> </ul> <p>If a specified trigger is missing, the entire stack operation fails and is rolled back. </p>"
|
||||
}
|
||||
},
|
||||
"Scope": {
|
||||
@@ -1359,6 +1372,12 @@
|
||||
"DescribeStackSetOutput$StackSet": "<p>The specified stack set.</p>"
|
||||
}
|
||||
},
|
||||
"StackSetARN": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StackSet$StackSetARN": "<p>The Amazon Resource Number (ARN) of the stack set.</p>"
|
||||
}
|
||||
},
|
||||
"StackSetId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -1386,6 +1405,7 @@
|
||||
"StackSet$StackSetName": "<p>The name that's associated with the stack set.</p>",
|
||||
"StackSetSummary$StackSetName": "<p>The name of the stack set.</p>",
|
||||
"StopStackSetOperationInput$StackSetName": "<p>The name or unique ID of the stack set that you want to stop the operation for.</p>",
|
||||
"UpdateStackInstancesInput$StackSetName": "<p>The name or unique ID of the stack set associated with the stack instances.</p>",
|
||||
"UpdateStackSetInput$StackSetName": "<p>The name or unique ID of the stack set that you want to update.</p>"
|
||||
}
|
||||
},
|
||||
@@ -1424,6 +1444,7 @@
|
||||
"CreateStackInstancesInput$OperationPreferences": "<p>Preferences for how AWS CloudFormation performs this stack set operation.</p>",
|
||||
"DeleteStackInstancesInput$OperationPreferences": "<p>Preferences for how AWS CloudFormation performs this stack set operation.</p>",
|
||||
"StackSetOperation$OperationPreferences": "<p>The preferences for how AWS CloudFormation performs this stack set operation.</p>",
|
||||
"UpdateStackInstancesInput$OperationPreferences": "<p>Preferences for how AWS CloudFormation performs this stack set operation.</p>",
|
||||
"UpdateStackSetInput$OperationPreferences": "<p>Preferences for how AWS CloudFormation performs this stack set operation.</p>"
|
||||
}
|
||||
},
|
||||
@@ -1677,6 +1698,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateStackInstancesInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateStackInstancesOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateStackOutput": {
|
||||
"base": "<p>The output for an <a>UpdateStack</a> action.</p>",
|
||||
"refs": {
|
||||
|
||||
+38
-1
@@ -233,6 +233,21 @@
|
||||
{"shape":"PreconditionFailed"}
|
||||
]
|
||||
},
|
||||
"DeleteServiceLinkedRole":{
|
||||
"name":"DeleteServiceLinkedRole2017_03_25",
|
||||
"http":{
|
||||
"method":"DELETE",
|
||||
"requestUri":"/2017-03-25/service-linked-role/{RoleName}",
|
||||
"responseCode":204
|
||||
},
|
||||
"input":{"shape":"DeleteServiceLinkedRoleRequest"},
|
||||
"errors":[
|
||||
{"shape":"InvalidArgument"},
|
||||
{"shape":"AccessDenied"},
|
||||
{"shape":"ResourceInUse"},
|
||||
{"shape":"NoSuchResource"}
|
||||
]
|
||||
},
|
||||
"DeleteStreamingDistribution":{
|
||||
"name":"DeleteStreamingDistribution2017_03_25",
|
||||
"http":{
|
||||
@@ -1054,6 +1069,17 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteServiceLinkedRoleRequest":{
|
||||
"type":"structure",
|
||||
"required":["RoleName"],
|
||||
"members":{
|
||||
"RoleName":{
|
||||
"shape":"string",
|
||||
"location":"uri",
|
||||
"locationName":"RoleName"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteStreamingDistributionRequest":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
@@ -1937,7 +1963,10 @@
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"SSLv3",
|
||||
"TLSv1"
|
||||
"TLSv1",
|
||||
"TLSv1_2016",
|
||||
"TLSv1.1_2016",
|
||||
"TLSv1.2_2018"
|
||||
]
|
||||
},
|
||||
"MissingBody":{
|
||||
@@ -2114,6 +2143,14 @@
|
||||
"type":"string",
|
||||
"pattern":"arn:aws:cloudfront::[0-9]+:.*"
|
||||
},
|
||||
"ResourceInUse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":409},
|
||||
"exception":true
|
||||
},
|
||||
"Restrictions":{
|
||||
"type":"structure",
|
||||
"required":["GeoRestriction"],
|
||||
|
||||
+50
-37
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<fullname>Amazon CloudFront</fullname> <p>This is the <i>Amazon CloudFront API Reference</i>. This guide is for developers who need detailed information about the CloudFront API actions, data types, and errors. For detailed information about CloudFront features and their associated API calls, see the <i>Amazon CloudFront Developer Guide</i>.</p>",
|
||||
"service": "<fullname>Amazon CloudFront</fullname> <p>This is the <i>Amazon CloudFront API Reference</i>. This guide is for developers who need detailed information about CloudFront API actions, data types, and errors. For detailed information about CloudFront features, see the <i>Amazon CloudFront Developer Guide</i>.</p>",
|
||||
"operations": {
|
||||
"CreateCloudFrontOriginAccessIdentity": "<p>Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
|
||||
"CreateDistribution": "<p>Creates a new web distribution. Send a <code>POST</code> request to the <code>/<i>CloudFront API version</i>/distribution</code>/<code>distribution ID</code> resource.</p>",
|
||||
@@ -10,6 +10,7 @@
|
||||
"CreateStreamingDistributionWithTags": "<p>Create a new streaming distribution with tags.</p>",
|
||||
"DeleteCloudFrontOriginAccessIdentity": "<p>Delete an origin access identity. </p>",
|
||||
"DeleteDistribution": "<p>Delete a distribution. </p>",
|
||||
"DeleteServiceLinkedRole": null,
|
||||
"DeleteStreamingDistribution": "<p>Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.</p> <p> <b>To delete an RTMP distribution using the CloudFront API</b>:</p> <ol> <li> <p>Disable the RTMP distribution.</p> </li> <li> <p>Submit a <code>GET Streaming Distribution Config</code> request to get the current configuration and the <code>Etag</code> header for the distribution. </p> </li> <li> <p>Update the XML document that was returned in the response to your <code>GET Streaming Distribution Config</code> request to change the value of <code>Enabled</code> to <code>false</code>.</p> </li> <li> <p>Submit a <code>PUT Streaming Distribution Config</code> request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Streaming Distribution Config</code> request in Step 2.</p> </li> <li> <p>Review the response to the <code>PUT Streaming Distribution Config</code> request to confirm that the distribution was successfully disabled.</p> </li> <li> <p>Submit a <code>GET Streaming Distribution Config</code> request to confirm that your changes have propagated. When propagation is complete, the value of <code>Status</code> is <code>Deployed</code>.</p> </li> <li> <p>Submit a <code>DELETE Streaming Distribution</code> request. Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Streaming Distribution Config</code> request in Step 2.</p> </li> <li> <p>Review the response to your <code>DELETE Streaming Distribution</code> request to confirm that the distribution was successfully deleted.</p> </li> </ol> <p>For information about deleting a distribution using the CloudFront console, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html\">Deleting a Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
|
||||
"GetCloudFrontOriginAccessIdentity": "<p>Get the information about an origin access identity. </p>",
|
||||
"GetCloudFrontOriginAccessIdentityConfig": "<p>Get the configuration information about an origin access identity. </p>",
|
||||
@@ -109,7 +110,7 @@
|
||||
"CertificateSource": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ViewerCertificate$CertificateSource": "<note> <p>This field is deprecated. You can use one of the following: <code>[ACMCertificateArn</code>, <code>IAMCertificateId</code>, or <code>CloudFrontDefaultCertificate]</code>.</p> </note>"
|
||||
"ViewerCertificate$CertificateSource": "<p>This field has been deprecated. Use one of the following fields instead:</p> <ul> <li> <p> <a>ViewerCertificate$ACMCertificateArn</a> </p> </li> <li> <p> <a>ViewerCertificate$IAMCertificateId</a> </p> </li> <li> <p> <a>ViewerCertificate$CloudFrontDefaultCertificate</a> </p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"CloudFrontOriginAccessIdentity": {
|
||||
@@ -267,10 +268,10 @@
|
||||
}
|
||||
},
|
||||
"DefaultCacheBehavior": {
|
||||
"base": "<p>A complex type that describes the default cache behavior if you do not specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>",
|
||||
"base": "<p>A complex type that describes the default cache behavior if you don't specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>",
|
||||
"refs": {
|
||||
"DistributionConfig$DefaultCacheBehavior": "<p>A complex type that describes the default cache behavior if you do not specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>",
|
||||
"DistributionSummary$DefaultCacheBehavior": "<p>A complex type that describes the default cache behavior if you do not specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>"
|
||||
"DistributionConfig$DefaultCacheBehavior": "<p>A complex type that describes the default cache behavior if you don't specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>",
|
||||
"DistributionSummary$DefaultCacheBehavior": "<p>A complex type that describes the default cache behavior if you don't specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteCloudFrontOriginAccessIdentityRequest": {
|
||||
@@ -283,6 +284,11 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteServiceLinkedRoleRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteStreamingDistributionRequest": {
|
||||
"base": "<p>The request to delete a streaming distribution.</p>",
|
||||
"refs": {
|
||||
@@ -345,7 +351,7 @@
|
||||
"EventType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"LambdaFunctionAssociation$EventType": "<p>Specifies the event type that triggers a Lambda function invocation. Valid values are:</p> <ul> <li> <p> <code>viewer-request</code> </p> </li> <li> <p> <code>origin-request</code> </p> </li> <li> <p> <code>viewer-response</code> </p> </li> <li> <p> <code>origin-response</code> </p> </li> </ul>"
|
||||
"LambdaFunctionAssociation$EventType": "<p>Specifies the event type that triggers a Lambda function invocation. You can specify the following values:</p> <ul> <li> <p> <code>viewer-request</code>: The function executes when CloudFront receives a request from a viewer and before it checks to see whether the requested object is in the edge cache. </p> </li> <li> <p> <code>origin-request</code>: The function executes only when CloudFront forwards a request to your origin. When the requested object is in the edge cache, the function doesn't execute.</p> </li> <li> <p> <code>origin-response</code>: The function executes after CloudFront receives a response from the origin and before it caches the object in the response. When the requested object is in the edge cache, the function doesn't execute.</p> <p>If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.</p> </li> <li> <p> <code>viewer-response</code>: The function executes before CloudFront returns the requested object to the viewer. The function executes regardless of whether the object was already in the edge cache.</p> <p>If the origin returns an HTTP status code other than HTTP 200 (OK), the function doesn't execute.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"ForwardedValues": {
|
||||
@@ -364,7 +370,7 @@
|
||||
"GeoRestrictionType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GeoRestriction$RestrictionType": "<p>The method that you want to use to restrict distribution of your content by country:</p> <ul> <li> <p> <code>none</code>: No geo restriction is enabled, meaning access to content is not restricted by client geo location.</p> </li> <li> <p> <code>blacklist</code>: The <code>Location</code> elements specify the countries in which you do not want CloudFront to distribute your content.</p> </li> <li> <p> <code>whitelist</code>: The <code>Location</code> elements specify the countries in which you want CloudFront to distribute your content.</p> </li> </ul>"
|
||||
"GeoRestriction$RestrictionType": "<p>The method that you want to use to restrict distribution of your content by country:</p> <ul> <li> <p> <code>none</code>: No geo restriction is enabled, meaning access to content is not restricted by client geo location.</p> </li> <li> <p> <code>blacklist</code>: The <code>Location</code> elements specify the countries in which you don't want CloudFront to distribute your content.</p> </li> <li> <p> <code>whitelist</code>: The <code>Location</code> elements specify the countries in which you want CloudFront to distribute your content.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"GetCloudFrontOriginAccessIdentityConfigRequest": {
|
||||
@@ -440,13 +446,13 @@
|
||||
"HeaderList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Headers$Items": "<p>A complex type that contains one <code>Name</code> element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If <code>Quantity</code> is <code>0</code>, omit <code>Items</code>.</p>"
|
||||
"Headers$Items": "<p>A list that contains one <code>Name</code> element for each header that you want CloudFront to use for caching in this cache behavior. If <code>Quantity</code> is <code>0</code>, omit <code>Items</code>.</p>"
|
||||
}
|
||||
},
|
||||
"Headers": {
|
||||
"base": "<p>A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior.</p> <p>For the headers that you specify, CloudFront also caches separate versions of a specified object based on the header values in viewer requests. For example, suppose viewer requests for <code>logo.jpg</code> contain a custom <code>Product</code> header that has a value of either <code>Acme</code> or <code>Apex</code>, and you configure CloudFront to cache your content based on values in the <code>Product</code> header. CloudFront forwards the <code>Product</code> header to the origin and caches the response from the origin once for each header value. For more information about caching based on header values, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html\">How CloudFront Forwards and Caches Headers</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
|
||||
"base": "<p>A complex type that specifies the request headers, if any, that you want CloudFront to base caching on for this cache behavior. </p> <p>For the headers that you specify, CloudFront caches separate versions of a specified object based on the header values in viewer requests. For example, suppose viewer requests for <code>logo.jpg</code> contain a custom <code>product</code> header that has a value of either <code>acme</code> or <code>apex</code>, and you configure CloudFront to cache your content based on values in the <code>product</code> header. CloudFront forwards the <code>product</code> header to the origin and caches the response from the origin once for each header value. For more information about caching based on header values, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html\">How CloudFront Forwards and Caches Headers</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
|
||||
"refs": {
|
||||
"ForwardedValues$Headers": "<p>A complex type that specifies the <code>Headers</code>, if any, that you want CloudFront to vary upon for this cache behavior. </p>"
|
||||
"ForwardedValues$Headers": "<p>A complex type that specifies the <code>Headers</code>, if any, that you want CloudFront to base caching on for this cache behavior. </p>"
|
||||
}
|
||||
},
|
||||
"HttpVersion": {
|
||||
@@ -462,7 +468,7 @@
|
||||
}
|
||||
},
|
||||
"InconsistentQuantities": {
|
||||
"base": "<p>The value of <code>Quantity</code> and the size of <code>Items</code> do not match.</p>",
|
||||
"base": "<p>The value of <code>Quantity</code> and the size of <code>Items</code> don't match.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -713,7 +719,7 @@
|
||||
"LocationList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GeoRestriction$Items": "<p> A complex type that contains a <code>Location</code> element for each country in which you want CloudFront either to distribute your content (<code>whitelist</code>) or not distribute your content (<code>blacklist</code>).</p> <p>The <code>Location</code> element is a two-letter, uppercase country code for a country that you want to include in your <code>blacklist</code> or <code>whitelist</code>. Include one <code>Location</code> element for each country.</p> <p>CloudFront and <code>MaxMind</code> both use <code>ISO 3166</code> country codes. For the current list of countries and the corresponding codes, see <code>ISO 3166-1-alpha-2</code> code on the <i>International Organization for Standardization</i> website. You can also refer to the country list in the CloudFront console, which includes both country names and codes.</p>"
|
||||
"GeoRestriction$Items": "<p> A complex type that contains a <code>Location</code> element for each country in which you want CloudFront either to distribute your content (<code>whitelist</code>) or not distribute your content (<code>blacklist</code>).</p> <p>The <code>Location</code> element is a two-letter, uppercase country code for a country that you want to include in your <code>blacklist</code> or <code>whitelist</code>. Include one <code>Location</code> element for each country.</p> <p>CloudFront and <code>MaxMind</code> both use <code>ISO 3166</code> country codes. For the current list of countries and the corresponding codes, see <code>ISO 3166-1-alpha-2</code> code on the <i>International Organization for Standardization</i> website. You can also refer to the country list on the CloudFront console, which includes both country names and codes.</p>"
|
||||
}
|
||||
},
|
||||
"LoggingConfig": {
|
||||
@@ -738,11 +744,11 @@
|
||||
"MinimumProtocolVersion": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ViewerCertificate$MinimumProtocolVersion": "<p>Specify the minimum version of the SSL/TLS protocol that you want CloudFront to use for HTTPS connections between viewers and CloudFront: <code>SSLv3</code> or <code>TLSv1</code>. CloudFront serves your objects only to viewers that support SSL/TLS version that you specify and later versions. The <code>TLSv1</code> protocol is more secure, so we recommend that you specify <code>SSLv3</code> only if your users are using browsers or devices that don't support <code>TLSv1</code>. Note the following:</p> <ul> <li> <p>If you specify <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>, the minimum SSL protocol version is <code>TLSv1</code> and can't be changed.</p> </li> <li> <p>If you're using a custom certificate (if you specify a value for <code>ACMCertificateArn</code> or for <code>IAMCertificateId</code>) and if you're using SNI (if you specify <code>sni-only</code> for <code>SSLSupportMethod</code>), you must specify <code>TLSv1</code> for <code>MinimumProtocolVersion</code>.</p> </li> </ul>"
|
||||
"ViewerCertificate$MinimumProtocolVersion": "<p>Specify the security policy that you want CloudFront to use for HTTPS connections. A security policy determines two settings:</p> <ul> <li> <p>The minimum SSL/TLS protocol that CloudFront uses to communicate with viewers</p> </li> <li> <p>The cipher that CloudFront uses to encrypt the content that it returns to viewers</p> </li> </ul> <note> <p>On the CloudFront console, this setting is called <b>Security policy</b>.</p> </note> <p>We recommend that you specify <code>TLSv1.1_2016</code> unless your users are using browsers or devices that do not support TLSv1.1 or later.</p> <p>When both of the following are true, you must specify <code>TLSv1</code> or later for the security policy: </p> <ul> <li> <p>You're using a custom certificate: you specified a value for <code>ACMCertificateArn</code> or for <code>IAMCertificateId</code> </p> </li> <li> <p>You're using SNI: you specified <code>sni-only</code> for <code>SSLSupportMethod</code> </p> </li> </ul> <p>If you specify <code>true</code> for <code>CloudFrontDefaultCertificate</code>, CloudFront automatically sets the security policy to <code>TLSv1</code> regardless of the value that you specify for <code>MinimumProtocolVersion</code>.</p> <p>For information about the relationship between the security policy that you choose and the protocols and ciphers that CloudFront uses to communicate with viewers, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/secure-connections-supported-viewer-protocols-ciphers.html#secure-connections-supported-ciphers\"> Supported SSL/TLS Protocols and Ciphers for Communication Between Viewers and CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"MissingBody": {
|
||||
"base": "<p>This operation requires a body. Ensure that the body is present and the Content-Type header is set.</p>",
|
||||
"base": "<p>This operation requires a body. Ensure that the body is present and the <code>Content-Type</code> header is set.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -865,6 +871,11 @@
|
||||
"UntagResourceRequest$Resource": "<p> An ARN of a CloudFront resource.</p>"
|
||||
}
|
||||
},
|
||||
"ResourceInUse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Restrictions": {
|
||||
"base": "<p>A complex type that identifies ways in which you want to restrict distribution of your content.</p>",
|
||||
"refs": {
|
||||
@@ -888,7 +899,7 @@
|
||||
"SSLSupportMethod": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ViewerCertificate$SSLSupportMethod": "<p>If you specify a value for <code>ACMCertificateArn</code> or for <code>IAMCertificateId</code>, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:</p> <ul> <li> <p> <code>vip</code>: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges.</p> </li> <li> <p> <code>sni-only</code>: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:</p> <ul> <li> <p>Use the <code>vip</code> option (dedicated IP addresses) instead of <code>sni-only</code>.</p> </li> <li> <p>Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, <code>https://d111111abcdef8.cloudfront.net/logo.png</code>.</p> </li> <li> <p>If you can control which browser your users use, upgrade the browser to one that supports SNI.</p> </li> <li> <p>Use HTTP instead of HTTPS.</p> </li> </ul> </li> </ul> <p>Do not specify a value for <code>SSLSupportMethod</code> if you specified <code><CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate></code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html#CNAMEsAndHTTPS.html\">Using Alternate Domain Names and HTTPS</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
"ViewerCertificate$SSLSupportMethod": "<p>If you specify a value for <a>ViewerCertificate$ACMCertificateArn</a> or for <a>ViewerCertificate$IAMCertificateId</a>, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:</p> <ul> <li> <p> <code>vip</code>: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges.</p> </li> <li> <p> <code>sni-only</code>: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:</p> <ul> <li> <p>Use the <code>vip</code> option (dedicated IP addresses) instead of <code>sni-only</code>.</p> </li> <li> <p>Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, <code>https://d111111abcdef8.cloudfront.net/logo.png</code>.</p> </li> <li> <p>If you can control which browser your users use, upgrade the browser to one that supports SNI.</p> </li> <li> <p>Use HTTP instead of HTTPS.</p> </li> </ul> </li> </ul> <p>Don't specify a value for <code>SSLSupportMethod</code> if you specified <code><CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate></code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html#CNAMEsAndHTTPS.html\">Using Alternate Domain Names and HTTPS</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"Signer": {
|
||||
@@ -1106,7 +1117,7 @@
|
||||
}
|
||||
},
|
||||
"TrustedSignerDoesNotExist": {
|
||||
"base": "<p>One or more of your trusted signers do not exist.</p>",
|
||||
"base": "<p>One or more of your trusted signers don't exist.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -1155,7 +1166,7 @@
|
||||
}
|
||||
},
|
||||
"ViewerCertificate": {
|
||||
"base": "<p>A complex type that specifies the following:</p> <ul> <li> <p>Which SSL/TLS certificate to use when viewers request objects using HTTPS</p> </li> <li> <p>Whether you want CloudFront to use dedicated IP addresses or SNI when you're using alternate domain names in your object names</p> </li> <li> <p>The minimum protocol version that you want CloudFront to use when communicating with viewers</p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html\">Using an HTTPS Connection to Access Your Objects</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p>",
|
||||
"base": "<p>A complex type that specifies the following:</p> <ul> <li> <p>Whether you want viewers to use HTTP or HTTPS to request your objects.</p> </li> <li> <p>If you want viewers to use HTTPS, whether you're using an alternate domain name such as <code>example.com</code> or the CloudFront domain name for your distribution, such as <code>d111111abcdef8.cloudfront.net</code>.</p> </li> <li> <p>If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.</p> </li> </ul> <p>You must specify only one of the following values: </p> <ul> <li> <p> <a>ViewerCertificate$ACMCertificateArn</a> </p> </li> <li> <p> <a>ViewerCertificate$IAMCertificateId</a> </p> </li> <li> <p> <a>ViewerCertificate$CloudFrontDefaultCertificate</a> </p> </li> </ul> <p>Don't specify <code>false</code> for <code>CloudFrontDefaultCertificate</code>.</p> <p> <b>If you want viewers to use HTTP instead of HTTPS to request your objects</b>: Specify the following value:</p> <p> <code><CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate></code> </p> <p>In addition, specify <code>allow-all</code> for <code>ViewerProtocolPolicy</code> for all of your cache behaviors.</p> <p> <b>If you want viewers to use HTTPS to request your objects</b>: Choose the type of certificate that you want to use based on whether you're using an alternate domain name for your objects or the CloudFront domain name:</p> <ul> <li> <p> <b>If you're using an alternate domain name, such as example.com</b>: Specify one of the following values, depending on whether ACM provided your certificate or you purchased your certificate from third-party certificate authority:</p> <ul> <li> <p> <code><ACMCertificateArn><i>ARN for ACM SSL/TLS certificate</i><ACMCertificateArn></code> where <code> <i>ARN for ACM SSL/TLS certificate</i> </code> is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.</p> </li> <li> <p> <code><IAMCertificateId><i>IAM certificate ID</i><IAMCertificateId></code> where <code> <i>IAM certificate ID</i> </code> is the ID that IAM returned when you added the certificate to the IAM certificate store.</p> </li> </ul> <p>If you specify <code>ACMCertificateArn</code> or <code>IAMCertificateId</code>, you must also specify a value for <code>SSLSupportMethod</code>.</p> <p>If you choose to use an ACM certificate or a certificate in the IAM certificate store, we recommend that you use only an alternate domain name in your object URLs (<code>https://example.com/logo.jpg</code>). If you use the domain name that is associated with your CloudFront distribution (such as <code>https://d111111abcdef8.cloudfront.net/logo.jpg</code>) and the viewer supports <code>SNI</code>, then CloudFront behaves normally. However, if the browser does not support SNI, the user's experience depends on the value that you choose for <code>SSLSupportMethod</code>:</p> <ul> <li> <p> <code>vip</code>: The viewer displays a warning because there is a mismatch between the CloudFront domain name and the domain name in your SSL/TLS certificate.</p> </li> <li> <p> <code>sni-only</code>: CloudFront drops the connection with the browser without returning the object.</p> </li> </ul> </li> <li> <p> <b>If you're using the CloudFront domain name for your distribution, such as <code>d111111abcdef8.cloudfront.net</code> </b>: Specify the following value:</p> <p> <code><CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate> </code> </p> </li> </ul> <p>If you want viewers to use HTTPS, you must also specify one of the following values in your cache behaviors:</p> <ul> <li> <p> <code> <ViewerProtocolPolicy>https-only<ViewerProtocolPolicy></code> </p> </li> <li> <p> <code><ViewerProtocolPolicy>redirect-to-https<ViewerProtocolPolicy></code> </p> </li> </ul> <p>You can also optionally require that CloudFront use HTTPS to communicate with your origin by specifying one of the following values for the applicable origins:</p> <ul> <li> <p> <code><OriginProtocolPolicy>https-only<OriginProtocolPolicy> </code> </p> </li> <li> <p> <code><OriginProtocolPolicy>match-viewer<OriginProtocolPolicy> </code> </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html#CNAMEsAndHTTPS\">Using Alternate Domain Names and HTTPS</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
|
||||
"refs": {
|
||||
"DistributionConfig$ViewerCertificate": null,
|
||||
"DistributionSummary$ViewerCertificate": null
|
||||
@@ -1178,20 +1189,20 @@
|
||||
"DefaultCacheBehavior$SmoothStreaming": "<p>Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify <code>true</code>; if not, specify <code>false</code>. If you specify <code>true</code> for <code>SmoothStreaming</code>, you can still distribute other content using this cache behavior if the content matches the value of <code>PathPattern</code>. </p>",
|
||||
"DefaultCacheBehavior$Compress": "<p>Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify <code>true</code>; if not, specify <code>false</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html\">Serving Compressed Files</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
|
||||
"DistributionConfig$Enabled": "<p>From this field, you can enable or disable the selected distribution.</p> <p>If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code> and <code>Prefix</code>, the values are automatically deleted.</p>",
|
||||
"DistributionConfig$IsIPV6Enabled": "<p>If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify <code>true</code>. If you specify <code>false</code>, CloudFront responds to IPv6 DNS requests with the DNS response code <code>NOERROR</code> and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. </p> <p>In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the <code>IpAddress</code> parameter to restrict the IP addresses that can access your content, do not enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html\">Creating a Signed URL Using a Custom Policy</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:</p> <ul> <li> <p>You enable IPv6 for the distribution</p> </li> <li> <p>You're using alternate domain names in the URLs for your objects</p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html\">Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p>If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.</p>",
|
||||
"DistributionConfig$IsIPV6Enabled": "<p>If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify <code>true</code>. If you specify <code>false</code>, CloudFront responds to IPv6 DNS requests with the DNS response code <code>NOERROR</code> and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. </p> <p>In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the <code>IpAddress</code> parameter to restrict the IP addresses that can access your content, don't enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html\">Creating a Signed URL Using a Custom Policy</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:</p> <ul> <li> <p>You enable IPv6 for the distribution</p> </li> <li> <p>You're using alternate domain names in the URLs for your objects</p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html\">Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p>If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.</p>",
|
||||
"DistributionList$IsTruncated": "<p>A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the <code>Marker</code> request parameter to retrieve more distributions in the list.</p>",
|
||||
"DistributionSummary$Enabled": "<p>Whether the distribution is enabled to accept user requests for content.</p>",
|
||||
"DistributionSummary$IsIPV6Enabled": "<p>Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.</p>",
|
||||
"ForwardedValues$QueryString": "<p>Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of <code>QueryString</code> and on the values that you specify for <code>QueryStringCacheKeys</code>, if any:</p> <p>If you specify true for <code>QueryString</code> and you don't specify any values for <code>QueryStringCacheKeys</code>, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.</p> <p>If you specify true for <code>QueryString</code> and you specify one or more values for <code>QueryStringCacheKeys</code>, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.</p> <p>If you specify false for <code>QueryString</code>, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html\">Configuring CloudFront to Cache Based on Query String Parameters</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
|
||||
"InvalidationList$IsTruncated": "<p>A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the <code>Marker</code> request parameter to retrieve more invalidation batches in the list.</p>",
|
||||
"LoggingConfig$Enabled": "<p>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify <code>false</code> for <code>Enabled</code>, and specify empty <code>Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code>, <code>prefix</code>, and <code>IncludeCookies</code>, the values are automatically deleted.</p>",
|
||||
"LoggingConfig$IncludeCookies": "<p>Specifies whether you want CloudFront to include cookies in access logs, specify <code>true</code> for <code>IncludeCookies</code>. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify <code>false</code> for <code>IncludeCookies</code>.</p>",
|
||||
"LoggingConfig$Enabled": "<p>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify <code>false</code> for <code>Enabled</code>, and specify empty <code>Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code>, <code>prefix</code>, and <code>IncludeCookies</code>, the values are automatically deleted.</p>",
|
||||
"LoggingConfig$IncludeCookies": "<p>Specifies whether you want CloudFront to include cookies in access logs, specify <code>true</code> for <code>IncludeCookies</code>. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify <code>false</code> for <code>IncludeCookies</code>.</p>",
|
||||
"StreamingDistributionConfig$Enabled": "<p>Whether the streaming distribution is enabled to accept user requests for content.</p>",
|
||||
"StreamingDistributionList$IsTruncated": "<p>A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the <code>Marker</code> request parameter to retrieve more distributions in the list. </p>",
|
||||
"StreamingDistributionSummary$Enabled": "<p>Whether the distribution is enabled to accept end user requests for content.</p>",
|
||||
"StreamingLoggingConfig$Enabled": "<p>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify <code>false</code> for <code>Enabled</code>, and specify <code>empty Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code> and <code>Prefix</code>, the values are automatically deleted. </p>",
|
||||
"StreamingLoggingConfig$Enabled": "<p>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify <code>false</code> for <code>Enabled</code>, and specify <code>empty Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code> and <code>Prefix</code>, the values are automatically deleted. </p>",
|
||||
"TrustedSigners$Enabled": "<p>Specifies whether you want to require viewers to use signed URLs to access the files specified by <code>PathPattern</code> and <code>TargetOriginId</code>.</p>",
|
||||
"ViewerCertificate$CloudFrontDefaultCertificate": null
|
||||
"ViewerCertificate$CloudFrontDefaultCertificate": "<p>For information about how and when to use <code>CloudFrontDefaultCertificate</code>, see <a>ViewerCertificate</a>.</p>"
|
||||
}
|
||||
},
|
||||
"integer": {
|
||||
@@ -1216,7 +1227,7 @@
|
||||
"DistributionList$MaxItems": "<p>The value you provided for the <code>MaxItems</code> request parameter.</p>",
|
||||
"DistributionList$Quantity": "<p>The number of distributions that were created by the current AWS account. </p>",
|
||||
"GeoRestriction$Quantity": "<p>When geo restriction is <code>enabled</code>, this is the number of countries in your <code>whitelist</code> or <code>blacklist</code>. Otherwise, when it is not enabled, <code>Quantity</code> is <code>0</code>, and you can omit <code>Items</code>.</p>",
|
||||
"Headers$Quantity": "<p>The number of different headers that you want CloudFront to forward to the origin for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:</p> <ul> <li> <p> <b>Forward all headers to your origin</b>: Specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>.</p> <important> <p>If you configure CloudFront to forward all headers to your origin, CloudFront doesn't cache the objects associated with this cache behavior. Instead, it sends every request to the origin.</p> </important> </li> <li> <p> <i>Forward a whitelist of headers you specify</i>: Specify the number of headers that you want to forward, and specify the header names in <code>Name</code> elements. CloudFront caches your objects based on the values in all of the specified headers. CloudFront also forwards the headers that it forwards by default, but it caches your objects based only on the headers that you specify. </p> </li> <li> <p> <b>Forward only the default headers</b>: Specify <code>0</code> for <code>Quantity</code> and omit <code>Items</code>. In this configuration, CloudFront doesn't cache based on the values in the request headers.</p> </li> </ul>",
|
||||
"Headers$Quantity": "<p>The number of different headers that you want CloudFront to base caching on for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:</p> <ul> <li> <p> <b>Forward all headers to your origin</b>: Specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>.</p> <important> <p>CloudFront doesn't cache the objects that are associated with this cache behavior. Instead, CloudFront sends every request to the origin. </p> </important> </li> <li> <p> <b>Forward a whitelist of headers you specify</b>: Specify the number of headers that you want CloudFront to base caching on. Then specify the header names in <code>Name</code> elements. CloudFront caches your objects based on the values in the specified headers.</p> </li> <li> <p> <b>Forward only the default headers</b>: Specify <code>0</code> for <code>Quantity</code> and omit <code>Items</code>. In this configuration, CloudFront doesn't cache based on the values in the request headers.</p> </li> </ul> <p>Regardless of which option you choose, CloudFront forwards headers to your origin based on whether the origin is an S3 bucket or a custom origin. See the following documentation:</p> <ul> <li> <p> <b>S3 bucket</b>: See <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/RequestAndResponseBehaviorS3Origin.html#request-s3-removed-headers\">HTTP Request Headers That CloudFront Removes or Updates</a> </p> </li> <li> <p> <b>Custom origin</b>: See <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/RequestAndResponseBehaviorCustomOrigin.html#request-custom-headers-behavior\">HTTP Request Headers and CloudFront Behavior</a> </p> </li> </ul>",
|
||||
"InvalidationList$MaxItems": "<p>The value that you provided for the <code>MaxItems</code> request parameter.</p>",
|
||||
"InvalidationList$Quantity": "<p>The number of invalidation batches that were created by the current AWS account. </p>",
|
||||
"KeyPairIds$Quantity": "<p>The number of active CloudFront key pairs for <code>AwsAccountNumber</code>.</p> <p>For more information, see <a>ActiveTrustedSigners</a>.</p>",
|
||||
@@ -1252,7 +1263,7 @@
|
||||
"CNAMEAlreadyExists$Message": null,
|
||||
"CacheBehavior$PathPattern": "<p>The pattern (for example, <code>images/*.jpg</code>) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.</p> <note> <p>You can optionally include a slash (<code>/</code>) at the beginning of the path pattern. For example, <code>/images/*.jpg</code>. CloudFront behavior is the same with or without the leading <code>/</code>.</p> </note> <p>The path pattern for the default cache behavior is <code>*</code> and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern\">Path Pattern</a> in the <i> Amazon CloudFront Developer Guide</i>.</p>",
|
||||
"CacheBehavior$TargetOriginId": "<p>The value of <code>ID</code> for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.</p>",
|
||||
"CloudFrontOriginAccessIdentity$Id": "<p>The ID for the origin access identity. For example: <code>E74FTE3AJFJ256A</code>. </p>",
|
||||
"CloudFrontOriginAccessIdentity$Id": "<p>The ID for the origin access identity, for example, <code>E74FTE3AJFJ256A</code>. </p>",
|
||||
"CloudFrontOriginAccessIdentity$S3CanonicalUserId": "<p>The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3. </p>",
|
||||
"CloudFrontOriginAccessIdentityAlreadyExists$Message": null,
|
||||
"CloudFrontOriginAccessIdentityConfig$CallerReference": "<p>A unique number that ensures the request can't be replayed.</p> <p>If the <code>CallerReference</code> is new (no matter the content of the <code>CloudFrontOriginAccessIdentityConfig</code> object), a new origin access identity is created.</p> <p>If the <code>CallerReference</code> is a value already sent in a previous identity request, and the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is identical to the original request (ignoring white space), the response includes the same information returned to the original request. </p> <p>If the <code>CallerReference</code> is a value you already sent in a previous request to create an identity, but the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is different from the original request, CloudFront returns a <code>CloudFrontOriginAccessIdentityAlreadyExists</code> error. </p>",
|
||||
@@ -1283,15 +1294,16 @@
|
||||
"DeleteCloudFrontOriginAccessIdentityRequest$IfMatch": "<p>The value of the <code>ETag</code> header you received from a previous <code>GET</code> or <code>PUT</code> request. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"DeleteDistributionRequest$Id": "<p>The distribution ID. </p>",
|
||||
"DeleteDistributionRequest$IfMatch": "<p>The value of the <code>ETag</code> header that you received when you disabled the distribution. For example: <code>E2QWRUHAPOMQZL</code>. </p>",
|
||||
"DeleteServiceLinkedRoleRequest$RoleName": null,
|
||||
"DeleteStreamingDistributionRequest$Id": "<p>The distribution ID. </p>",
|
||||
"DeleteStreamingDistributionRequest$IfMatch": "<p>The value of the <code>ETag</code> header that you received when you disabled the streaming distribution. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"Distribution$Id": "<p>The identifier for the distribution. For example: <code>EDFDVBD632BHDS5</code>. </p>",
|
||||
"Distribution$ARN": "<p>The ARN (Amazon Resource Name) for the distribution. For example: <code>arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5</code>, where <code>123456789012</code> is your AWS account ID.</p>",
|
||||
"Distribution$Status": "<p>This response element indicates the current status of the distribution. When the status is <code>Deployed</code>, the distribution's information is fully propagated to all CloudFront edge locations. </p>",
|
||||
"Distribution$DomainName": "<p>The domain name corresponding to the distribution. For example: <code>d604721fxaaqy9.cloudfront.net</code>. </p>",
|
||||
"Distribution$DomainName": "<p>The domain name corresponding to the distribution, for example, <code>d111111abcdef8.cloudfront.net</code>. </p>",
|
||||
"DistributionAlreadyExists$Message": null,
|
||||
"DistributionConfig$CallerReference": "<p>A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.</p> <p>If the value of <code>CallerReference</code> is new (regardless of the content of the <code>DistributionConfig</code> object), CloudFront creates a new distribution.</p> <p>If <code>CallerReference</code> is a value you already sent in a previous request to create a distribution, and if the content of the <code>DistributionConfig</code> is identical to the original request (ignoring white space), CloudFront returns the same the response that it returned to the original request.</p> <p>If <code>CallerReference</code> is a value you already sent in a previous request to create a distribution but the content of the <code>DistributionConfig</code> is different from the original request, CloudFront returns a <code>DistributionAlreadyExists</code> error.</p>",
|
||||
"DistributionConfig$DefaultRootObject": "<p>The object that you want CloudFront to request from your origin (for example, <code>index.html</code>) when a viewer requests the root URL for your distribution (<code>http://www.example.com</code>) instead of an object in your distribution (<code>http://www.example.com/product-description.html</code>). Specifying a default root object avoids exposing the contents of your distribution.</p> <p>Specify only the object name, for example, <code>index.html</code>. Do not add a <code>/</code> before the object name.</p> <p>If you don't want to specify a default root object when you create a distribution, include an empty <code>DefaultRootObject</code> element.</p> <p>To delete the default root object from an existing distribution, update the distribution configuration and include an empty <code>DefaultRootObject</code> element.</p> <p>To replace the default root object, update the distribution configuration and specify the new object.</p> <p>For more information about the default root object, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html\">Creating a Default Root Object</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
|
||||
"DistributionConfig$DefaultRootObject": "<p>The object that you want CloudFront to request from your origin (for example, <code>index.html</code>) when a viewer requests the root URL for your distribution (<code>http://www.example.com</code>) instead of an object in your distribution (<code>http://www.example.com/product-description.html</code>). Specifying a default root object avoids exposing the contents of your distribution.</p> <p>Specify only the object name, for example, <code>index.html</code>. Don't add a <code>/</code> before the object name.</p> <p>If you don't want to specify a default root object when you create a distribution, include an empty <code>DefaultRootObject</code> element.</p> <p>To delete the default root object from an existing distribution, update the distribution configuration and include an empty <code>DefaultRootObject</code> element.</p> <p>To replace the default root object, update the distribution configuration and specify the new object.</p> <p>For more information about the default root object, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html\">Creating a Default Root Object</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
|
||||
"DistributionConfig$Comment": "<p>Any comments you want to include about the distribution.</p> <p>If you don't want to specify a comment, include an empty <code>Comment</code> element.</p> <p>To delete an existing comment, update the distribution configuration and include an empty <code>Comment</code> element.</p> <p>To add or change a comment, update the distribution configuration and specify the new comment.</p>",
|
||||
"DistributionConfig$WebACLId": "<p>A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.</p> <p>AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html\">AWS WAF Developer Guide</a>. </p>",
|
||||
"DistributionList$Marker": "<p>The value you provided for the <code>Marker</code> request parameter.</p>",
|
||||
@@ -1300,7 +1312,7 @@
|
||||
"DistributionSummary$Id": "<p>The identifier for the distribution. For example: <code>EDFDVBD632BHDS5</code>.</p>",
|
||||
"DistributionSummary$ARN": "<p>The ARN (Amazon Resource Name) for the distribution. For example: <code>arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5</code>, where <code>123456789012</code> is your AWS account ID.</p>",
|
||||
"DistributionSummary$Status": "<p>The current status of the distribution. When the status is <code>Deployed</code>, the distribution's information is propagated to all CloudFront edge locations.</p>",
|
||||
"DistributionSummary$DomainName": "<p>The domain name that corresponds to the distribution. For example: <code>d604721fxaaqy9.cloudfront.net</code>.</p>",
|
||||
"DistributionSummary$DomainName": "<p>The domain name that corresponds to the distribution, for example, <code>d111111abcdef8.cloudfront.net</code>.</p>",
|
||||
"DistributionSummary$Comment": "<p>The comment originally specified when this distribution was created.</p>",
|
||||
"DistributionSummary$WebACLId": "<p>The Web ACL Id (if any) associated with the distribution.</p>",
|
||||
"GetCloudFrontOriginAccessIdentityConfigRequest$Id": "<p>The identity's ID. </p>",
|
||||
@@ -1351,7 +1363,7 @@
|
||||
"InvalidationSummary$Id": "<p>The unique ID for an invalidation request.</p>",
|
||||
"InvalidationSummary$Status": "<p>The status of an invalidation request.</p>",
|
||||
"KeyPairIdList$member": null,
|
||||
"LambdaFunctionAssociation$LambdaFunctionARN": "<p>The ARN of the Lambda function.</p>",
|
||||
"LambdaFunctionAssociation$LambdaFunctionARN": "<p>The ARN of the Lambda function. You must specify the ARN of a function version; you can't specify a Lambda alias or $LATEST.</p>",
|
||||
"ListCloudFrontOriginAccessIdentitiesRequest$Marker": "<p>Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the <code>Marker</code> to the value of the <code>NextMarker</code> from the current page's response (which is also the ID of the last identity on that page).</p>",
|
||||
"ListCloudFrontOriginAccessIdentitiesRequest$MaxItems": "<p>The maximum number of origin access identities you want in the response body. </p>",
|
||||
"ListDistributionsByWebACLIdRequest$Marker": "<p>Use <code>Marker</code> and <code>MaxItems</code> to control pagination of results. If you have more than <code>MaxItems</code> distributions that satisfy the request, the response includes a <code>NextMarker</code> element. To get the next page of results, submit another request. For the value of <code>Marker</code>, specify the value of <code>NextMarker</code> from the last response. (For the first request, omit <code>Marker</code>.) </p>",
|
||||
@@ -1366,7 +1378,7 @@
|
||||
"ListStreamingDistributionsRequest$MaxItems": "<p>The value that you provided for the <code>MaxItems</code> request parameter.</p>",
|
||||
"LocationList$member": null,
|
||||
"LoggingConfig$Bucket": "<p>The Amazon S3 bucket to store the access logs in, for example, <code>myawslogbucket.s3.amazonaws.com</code>.</p>",
|
||||
"LoggingConfig$Prefix": "<p>An optional string that you want CloudFront to prefix to the access log <code>filenames</code> for this distribution, for example, <code>myprefix/</code>. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> element.</p>",
|
||||
"LoggingConfig$Prefix": "<p>An optional string that you want CloudFront to prefix to the access log <code>filenames</code> for this distribution, for example, <code>myprefix/</code>. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> element.</p>",
|
||||
"MissingBody$Message": null,
|
||||
"NoSuchCloudFrontOriginAccessIdentity$Message": null,
|
||||
"NoSuchDistribution$Message": null,
|
||||
@@ -1375,13 +1387,14 @@
|
||||
"NoSuchResource$Message": null,
|
||||
"NoSuchStreamingDistribution$Message": null,
|
||||
"Origin$Id": "<p>A unique identifier for the origin. The value of <code>Id</code> must be unique within the distribution.</p> <p>When you specify the value of <code>TargetOriginId</code> for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the <code>Id</code> element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior\">Cache Behavior Settings</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
|
||||
"Origin$DomainName": "<p> <b>Amazon S3 origins</b>: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, <code>myawsbucket.s3.amazonaws.com</code>.</p> <p>Constraints for Amazon S3 origins: </p> <ul> <li> <p>If you configured Amazon S3 Transfer Acceleration for your bucket, do not specify the <code>s3-accelerate</code> endpoint for <code>DomainName</code>.</p> </li> <li> <p>The bucket name must be between 3 and 63 characters long (inclusive).</p> </li> <li> <p>The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.</p> </li> <li> <p>The bucket name must not contain adjacent periods.</p> </li> </ul> <p> <b>Custom Origins</b>: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, <code>www.example.com</code>. </p> <p>Constraints for custom origins:</p> <ul> <li> <p> <code>DomainName</code> must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.</p> </li> <li> <p>The name cannot exceed 128 characters.</p> </li> </ul>",
|
||||
"Origin$DomainName": "<p> <b>Amazon S3 origins</b>: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, <code>myawsbucket.s3.amazonaws.com</code>.</p> <p>Constraints for Amazon S3 origins: </p> <ul> <li> <p>If you configured Amazon S3 Transfer Acceleration for your bucket, don't specify the <code>s3-accelerate</code> endpoint for <code>DomainName</code>.</p> </li> <li> <p>The bucket name must be between 3 and 63 characters long (inclusive).</p> </li> <li> <p>The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.</p> </li> <li> <p>The bucket name must not contain adjacent periods.</p> </li> </ul> <p> <b>Custom Origins</b>: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, <code>www.example.com</code>. </p> <p>Constraints for custom origins:</p> <ul> <li> <p> <code>DomainName</code> must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.</p> </li> <li> <p>The name cannot exceed 128 characters.</p> </li> </ul>",
|
||||
"Origin$OriginPath": "<p>An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the <code>OriginPath</code> element, specify the directory name, beginning with a <code>/</code>. CloudFront appends the directory name to the value of <code>DomainName</code>, for example, <code>example.com/production</code>. Do not include a <code>/</code> at the end of the directory name.</p> <p>For example, suppose you've specified the following values for your distribution:</p> <ul> <li> <p> <code>DomainName</code>: An Amazon S3 bucket named <code>myawsbucket</code>.</p> </li> <li> <p> <code>OriginPath</code>: <code>/production</code> </p> </li> <li> <p> <code>CNAME</code>: <code>example.com</code> </p> </li> </ul> <p>When a user enters <code>example.com/index.html</code> in a browser, CloudFront sends a request to Amazon S3 for <code>myawsbucket/production/index.html</code>.</p> <p>When a user enters <code>example.com/acme/index.html</code> in a browser, CloudFront sends a request to Amazon S3 for <code>myawsbucket/production/acme/index.html</code>.</p>",
|
||||
"OriginCustomHeader$HeaderName": "<p>The name of a header that you want CloudFront to forward to your origin. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html\">Forwarding Custom Headers to Your Origin (Web Distributions Only)</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p>",
|
||||
"OriginCustomHeader$HeaderValue": "<p>The value for the header that you specified in the <code>HeaderName</code> field.</p>",
|
||||
"PathList$member": null,
|
||||
"PreconditionFailed$Message": null,
|
||||
"QueryStringCacheKeysList$member": null,
|
||||
"ResourceInUse$Message": null,
|
||||
"S3Origin$DomainName": "<p>The DNS name of the Amazon S3 origin. </p>",
|
||||
"S3Origin$OriginAccessIdentity": "<p>The CloudFront origin access identity to associate with the RTMP distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.</p> <p>If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty <code>OriginAccessIdentity</code> element.</p> <p>To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty <code>OriginAccessIdentity</code> element.</p> <p>To replace the origin access identity, update the distribution configuration and specify the new origin access identity.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html\">Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p>",
|
||||
"S3OriginConfig$OriginAccessIdentity": "<p>The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can <i>only</i> access objects in an Amazon S3 bucket through CloudFront. The format of the value is:</p> <p>origin-access-identity/cloudfront/<i>ID-of-origin-access-identity</i> </p> <p>where <code> <i>ID-of-origin-access-identity</i> </code> is the value that CloudFront returned in the <code>ID</code> element when you created the origin access identity.</p> <p>If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty <code>OriginAccessIdentity</code> element.</p> <p>To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty <code>OriginAccessIdentity</code> element.</p> <p>To replace the origin access identity, update the distribution configuration and specify the new origin access identity.</p> <p>For more information about the origin access identity, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>",
|
||||
@@ -1389,20 +1402,20 @@
|
||||
"StreamingDistribution$Id": "<p>The identifier for the RTMP distribution. For example: <code>EGTXBD79EXAMPLE</code>.</p>",
|
||||
"StreamingDistribution$ARN": null,
|
||||
"StreamingDistribution$Status": "<p>The current status of the RTMP distribution. When the status is <code>Deployed</code>, the distribution's information is propagated to all CloudFront edge locations.</p>",
|
||||
"StreamingDistribution$DomainName": "<p>The domain name that corresponds to the streaming distribution. For example: <code>s5c39gqb8ow64r.cloudfront.net</code>. </p>",
|
||||
"StreamingDistribution$DomainName": "<p>The domain name that corresponds to the streaming distribution, for example, <code>s5c39gqb8ow64r.cloudfront.net</code>. </p>",
|
||||
"StreamingDistributionAlreadyExists$Message": null,
|
||||
"StreamingDistributionConfig$CallerReference": "<p>A unique number that ensures that the request can't be replayed. If the <code>CallerReference</code> is new (no matter the content of the <code>StreamingDistributionConfig</code> object), a new streaming distribution is created. If the <code>CallerReference</code> is a value that you already sent in a previous request to create a streaming distribution, and the content of the <code>StreamingDistributionConfig</code> is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the <code>CallerReference</code> is a value that you already sent in a previous request to create a streaming distribution but the content of the <code>StreamingDistributionConfig</code> is different from the original request, CloudFront returns a <code>DistributionAlreadyExists</code> error. </p>",
|
||||
"StreamingDistributionConfig$Comment": "<p>Any comments you want to include about the streaming distribution. </p>",
|
||||
"StreamingDistributionList$Marker": "<p>The value you provided for the <code>Marker</code> request parameter. </p>",
|
||||
"StreamingDistributionList$NextMarker": "<p>If <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value you can use for the <code>Marker</code> request parameter to continue listing your RTMP distributions where they left off. </p>",
|
||||
"StreamingDistributionNotDisabled$Message": null,
|
||||
"StreamingDistributionSummary$Id": "<p>The identifier for the distribution. For example: <code>EDFDVBD632BHDS5</code>.</p>",
|
||||
"StreamingDistributionSummary$Id": "<p>The identifier for the distribution, for example, <code>EDFDVBD632BHDS5</code>.</p>",
|
||||
"StreamingDistributionSummary$ARN": "<p> The ARN (Amazon Resource Name) for the streaming distribution. For example: <code>arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5</code>, where <code>123456789012</code> is your AWS account ID.</p>",
|
||||
"StreamingDistributionSummary$Status": "<p> Indicates the current status of the distribution. When the status is <code>Deployed</code>, the distribution's information is fully propagated throughout the Amazon CloudFront system.</p>",
|
||||
"StreamingDistributionSummary$DomainName": "<p>The domain name corresponding to the distribution. For example: <code>d604721fxaaqy9.cloudfront.net</code>.</p>",
|
||||
"StreamingDistributionSummary$DomainName": "<p>The domain name corresponding to the distribution, for example, <code>d111111abcdef8.cloudfront.net</code>.</p>",
|
||||
"StreamingDistributionSummary$Comment": "<p>The comment originally specified when this distribution was created.</p>",
|
||||
"StreamingLoggingConfig$Bucket": "<p>The Amazon S3 bucket to store the access logs in, for example, <code>myawslogbucket.s3.amazonaws.com</code>.</p>",
|
||||
"StreamingLoggingConfig$Prefix": "<p>An optional string that you want CloudFront to prefix to the access log <code>filenames</code> for this streaming distribution, for example, <code>myprefix/</code>. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> element.</p>",
|
||||
"StreamingLoggingConfig$Prefix": "<p>An optional string that you want CloudFront to prefix to the access log filenames for this streaming distribution, for example, <code>myprefix/</code>. If you want to enable logging, but you don't want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> element.</p>",
|
||||
"TooManyCacheBehaviors$Message": null,
|
||||
"TooManyCertificates$Message": null,
|
||||
"TooManyCloudFrontOriginAccessIdentities$Message": null,
|
||||
@@ -1429,9 +1442,9 @@
|
||||
"UpdateStreamingDistributionRequest$Id": "<p>The streaming distribution's id.</p>",
|
||||
"UpdateStreamingDistributionRequest$IfMatch": "<p>The value of the <code>ETag</code> header that you received when retrieving the streaming distribution's configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"UpdateStreamingDistributionResult$ETag": "<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"ViewerCertificate$IAMCertificateId": null,
|
||||
"ViewerCertificate$ACMCertificateArn": null,
|
||||
"ViewerCertificate$Certificate": "<p>Include one of these values to specify the following:</p> <ul> <li> <p>Whether you want viewers to use HTTP or HTTPS to request your objects.</p> </li> <li> <p>If you want viewers to use HTTPS, whether you're using an alternate domain name such as example.com or the CloudFront domain name for your distribution, such as <code>d111111abcdef8.cloudfront.net</code>.</p> </li> <li> <p>If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.</p> </li> </ul> <p>You must specify one (and only one) of the three values. Do not specify <code>false</code> for <code>CloudFrontDefaultCertificate</code>.</p> <p> <b>If you want viewers to use HTTP to request your objects</b>: Specify the following value:</p> <p> <code><CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate></code> </p> <p>In addition, specify <code>allow-all</code> for <code>ViewerProtocolPolicy</code> for all of your cache behaviors.</p> <p> <b>If you want viewers to use HTTPS to request your objects</b>: Choose the type of certificate that you want to use based on whether you're using an alternate domain name for your objects or the CloudFront domain name:</p> <ul> <li> <p> <b>If you're using an alternate domain name, such as example.com</b>: Specify one of the following values, depending on whether ACM provided your certificate or you purchased your certificate from third-party certificate authority:</p> <ul> <li> <p> <code><ACMCertificateArn>ARN for ACM SSL/TLS certificate<ACMCertificateArn></code> where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.</p> </li> <li> <p> <code><IAMCertificateId>IAM certificate ID<IAMCertificateId></code> where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store.</p> </li> </ul> <p>If you specify <code>ACMCertificateArn</code> or <code>IAMCertificateId</code>, you must also specify a value for <code>SSLSupportMethod</code>.</p> <p>If you choose to use an ACM certificate or a certificate in the IAM certificate store, we recommend that you use only an alternate domain name in your object URLs (<code>https://example.com/logo.jpg</code>). If you use the domain name that is associated with your CloudFront distribution (<code>https://d111111abcdef8.cloudfront.net/logo.jpg</code>) and the viewer supports <code>SNI</code>, then CloudFront behaves normally. However, if the browser does not support SNI, the user's experience depends on the value that you choose for <code>SSLSupportMethod</code>:</p> <ul> <li> <p> <code>vip</code>: The viewer displays a warning because there is a mismatch between the CloudFront domain name and the domain name in your SSL/TLS certificate.</p> </li> <li> <p> <code>sni-only</code>: CloudFront drops the connection with the browser without returning the object.</p> </li> </ul> </li> <li> <p> <b>If you're using the CloudFront domain name for your distribution, such as <code>d111111abcdef8.cloudfront.net</code> </b>: Specify the following value:</p> <p> <code> <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate> </code> </p> <p>If you want viewers to use HTTPS, you must also specify one of the following values in your cache behaviors:</p> <ul> <li> <p> <code> <ViewerProtocolPolicy>https-only<ViewerProtocolPolicy> </code> </p> </li> <li> <p> <code> <ViewerProtocolPolicy>redirect-to-https<ViewerProtocolPolicy> </code> </p> </li> </ul> <p>You can also optionally require that CloudFront use HTTPS to communicate with your origin by specifying one of the following values for the applicable origins:</p> <ul> <li> <p> <code> <OriginProtocolPolicy>https-only<OriginProtocolPolicy> </code> </p> </li> <li> <p> <code> <OriginProtocolPolicy>match-viewer<OriginProtocolPolicy> </code> </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html#CNAMEsAndHTTPS\">Using Alternate Domain Names and HTTPS</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </li> </ul>"
|
||||
"ViewerCertificate$IAMCertificateId": "<p>For information about how and when to use <code>IAMCertificateId</code>, see <a>ViewerCertificate</a>.</p>",
|
||||
"ViewerCertificate$ACMCertificateArn": "<p>For information about how and when to use <code>ACMCertificateArn</code>, see <a>ViewerCertificate</a>.</p>",
|
||||
"ViewerCertificate$Certificate": "<p>This field has been deprecated. Use one of the following fields instead:</p> <ul> <li> <p> <a>ViewerCertificate$ACMCertificateArn</a> </p> </li> <li> <p> <a>ViewerCertificate$IAMCertificateId</a> </p> </li> <li> <p> <a>ViewerCertificate$CloudFrontDefaultCertificate</a> </p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"timestamp": {
|
||||
|
||||
+3940
File diff suppressed because it is too large
Load Diff
+2058
File diff suppressed because it is too large
Load Diff
Generated
Vendored
+5
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+32
@@ -0,0 +1,32 @@
|
||||
{
|
||||
"pagination": {
|
||||
"ListCloudFrontOriginAccessIdentities": {
|
||||
"input_token": "Marker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "CloudFrontOriginAccessIdentityList.IsTruncated",
|
||||
"output_token": "CloudFrontOriginAccessIdentityList.NextMarker",
|
||||
"result_key": "CloudFrontOriginAccessIdentityList.Items"
|
||||
},
|
||||
"ListDistributions": {
|
||||
"input_token": "Marker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "DistributionList.IsTruncated",
|
||||
"output_token": "DistributionList.NextMarker",
|
||||
"result_key": "DistributionList.Items"
|
||||
},
|
||||
"ListInvalidations": {
|
||||
"input_token": "Marker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "InvalidationList.IsTruncated",
|
||||
"output_token": "InvalidationList.NextMarker",
|
||||
"result_key": "InvalidationList.Items"
|
||||
},
|
||||
"ListStreamingDistributions": {
|
||||
"input_token": "Marker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "StreamingDistributionList.IsTruncated",
|
||||
"output_token": "StreamingDistributionList.NextMarker",
|
||||
"result_key": "StreamingDistributionList.Items"
|
||||
}
|
||||
}
|
||||
}
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"version": 1,
|
||||
"defaultRegion": "us-east-1",
|
||||
"testCases": [
|
||||
{
|
||||
"operationName": "ListCloudFrontOriginAccessIdentities",
|
||||
"input": {
|
||||
"MaxItems": "1"
|
||||
},
|
||||
"errorExpectedFromService": false
|
||||
},
|
||||
{
|
||||
"operationName": "GetDistribution",
|
||||
"input": {
|
||||
"Id": "fake-id"
|
||||
},
|
||||
"errorExpectedFromService": true
|
||||
}
|
||||
]
|
||||
}
|
||||
Generated
Vendored
+47
@@ -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"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
+1
@@ -7,6 +7,7 @@
|
||||
"protocol":"json",
|
||||
"serviceAbbreviation":"CloudHSM",
|
||||
"serviceFullName":"Amazon CloudHSM",
|
||||
"serviceId":"CloudHSM",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"CloudHsmFrontendService",
|
||||
"uid":"cloudhsm-2014-05-30"
|
||||
|
||||
+38
-38
@@ -1,27 +1,27 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<fullname>AWS CloudHSM Service</fullname>",
|
||||
"service": "<fullname>AWS CloudHSM Service</fullname> <p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p>",
|
||||
"operations": {
|
||||
"AddTagsToResource": "<p>Adds or overwrites one or more tags for the specified AWS CloudHSM resource.</p> <p>Each tag consists of a key and a value. Tag keys must be unique to each resource.</p>",
|
||||
"CreateHapg": "<p>Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.</p>",
|
||||
"CreateHsm": "<p>Creates an uninitialized HSM instance.</p> <p>There is an upfront fee charged for each HSM instance that you create with the <a>CreateHsm</a> operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the <a>DeleteHsm</a> operation, go to the <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support Center</a>, create a new case, and select <b>Account and Billing Support</b>.</p> <important> <p>It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the <a>DescribeHsm</a> operation. The HSM is ready to be initialized when the status changes to <code>RUNNING</code>.</p> </important>",
|
||||
"CreateLunaClient": "<p>Creates an HSM client.</p>",
|
||||
"DeleteHapg": "<p>Deletes a high-availability partition group.</p>",
|
||||
"DeleteHsm": "<p>Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.</p>",
|
||||
"DeleteLunaClient": "<p>Deletes a client.</p>",
|
||||
"DescribeHapg": "<p>Retrieves information about a high-availability partition group.</p>",
|
||||
"DescribeHsm": "<p>Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.</p>",
|
||||
"DescribeLunaClient": "<p>Retrieves information about an HSM client.</p>",
|
||||
"GetConfig": "<p>Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.</p>",
|
||||
"ListAvailableZones": "<p>Lists the Availability Zones that have available AWS CloudHSM capacity.</p>",
|
||||
"ListHapgs": "<p>Lists the high-availability partition groups for the account.</p> <p>This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHapgs</a> to retrieve the next set of items.</p>",
|
||||
"ListHsms": "<p>Retrieves the identifiers of all of the HSMs provisioned for the current customer.</p> <p>This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListHsms</a> to retrieve the next set of items.</p>",
|
||||
"ListLunaClients": "<p>Lists all of the clients.</p> <p>This operation supports pagination with the use of the <i>NextToken</i> member. If more results are available, the <i>NextToken</i> member of the response contains a token that you pass in the next call to <a>ListLunaClients</a> to retrieve the next set of items.</p>",
|
||||
"ListTagsForResource": "<p>Returns a list of all tags for the specified AWS CloudHSM resource.</p>",
|
||||
"ModifyHapg": "<p>Modifies an existing high-availability partition group.</p>",
|
||||
"ModifyHsm": "<p>Modifies an HSM.</p> <important> <p>This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.</p> </important>",
|
||||
"ModifyLunaClient": "<p>Modifies the certificate used by the client.</p> <p>This action can potentially start a workflow to install the new certificate on the client's HSMs.</p>",
|
||||
"RemoveTagsFromResource": "<p>Removes one or more tags from the specified AWS CloudHSM resource.</p> <p>To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use <a>AddTagsToResource</a>.</p>"
|
||||
"AddTagsToResource": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Adds or overwrites one or more tags for the specified AWS CloudHSM resource.</p> <p>Each tag consists of a key and a value. Tag keys must be unique to each resource.</p>",
|
||||
"CreateHapg": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.</p>",
|
||||
"CreateHsm": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Creates an uninitialized HSM instance.</p> <p>There is an upfront fee charged for each HSM instance that you create with the <code>CreateHsm</code> operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the <a>DeleteHsm</a> operation, go to the <a href=\"https://console.aws.amazon.com/support/home\">AWS Support Center</a>, create a new case, and select <b>Account and Billing Support</b>.</p> <important> <p>It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the <a>DescribeHsm</a> operation. The HSM is ready to be initialized when the status changes to <code>RUNNING</code>.</p> </important>",
|
||||
"CreateLunaClient": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Creates an HSM client.</p>",
|
||||
"DeleteHapg": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Deletes a high-availability partition group.</p>",
|
||||
"DeleteHsm": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.</p>",
|
||||
"DeleteLunaClient": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Deletes a client.</p>",
|
||||
"DescribeHapg": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Retrieves information about a high-availability partition group.</p>",
|
||||
"DescribeHsm": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.</p>",
|
||||
"DescribeLunaClient": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Retrieves information about an HSM client.</p>",
|
||||
"GetConfig": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.</p>",
|
||||
"ListAvailableZones": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Lists the Availability Zones that have available AWS CloudHSM capacity.</p>",
|
||||
"ListHapgs": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Lists the high-availability partition groups for the account.</p> <p>This operation supports pagination with the use of the <code>NextToken</code> member. If more results are available, the <code>NextToken</code> member of the response contains a token that you pass in the next call to <code>ListHapgs</code> to retrieve the next set of items.</p>",
|
||||
"ListHsms": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Retrieves the identifiers of all of the HSMs provisioned for the current customer.</p> <p>This operation supports pagination with the use of the <code>NextToken</code> member. If more results are available, the <code>NextToken</code> member of the response contains a token that you pass in the next call to <code>ListHsms</code> to retrieve the next set of items.</p>",
|
||||
"ListLunaClients": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Lists all of the clients.</p> <p>This operation supports pagination with the use of the <code>NextToken</code> member. If more results are available, the <code>NextToken</code> member of the response contains a token that you pass in the next call to <code>ListLunaClients</code> to retrieve the next set of items.</p>",
|
||||
"ListTagsForResource": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Returns a list of all tags for the specified AWS CloudHSM resource.</p>",
|
||||
"ModifyHapg": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Modifies an existing high-availability partition group.</p>",
|
||||
"ModifyHsm": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Modifies an HSM.</p> <important> <p>This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.</p> </important>",
|
||||
"ModifyLunaClient": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Modifies the certificate used by the client.</p> <p>This action can potentially start a workflow to install the new certificate on the client's HSMs.</p>",
|
||||
"RemoveTagsFromResource": "<p>This is documentation for <b>AWS CloudHSM Classic</b>. For more information, see <a href=\"http://aws.amazon.com/cloudhsm/faqs-classic/\">AWS CloudHSM Classic FAQs</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/userguide/\">AWS CloudHSM Classic User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/classic/APIReference/\">AWS CloudHSM Classic API Reference</a>.</p> <p> <b>For information about the current version of AWS CloudHSM</b>, see <a href=\"http://aws.amazon.com/cloudhsm/\">AWS CloudHSM</a>, the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/userguide/\">AWS CloudHSM User Guide</a>, and the <a href=\"http://docs.aws.amazon.com/cloudhsm/latest/APIReference/\">AWS CloudHSM API Reference</a>.</p> <p>Removes one or more tags from the specified AWS CloudHSM resource.</p> <p>To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use <a>AddTagsToResource</a>.</p>"
|
||||
},
|
||||
"shapes": {
|
||||
"AZ": {
|
||||
@@ -132,12 +132,12 @@
|
||||
}
|
||||
},
|
||||
"CreateHsmRequest": {
|
||||
"base": "<p>Contains the inputs for the <a>CreateHsm</a> operation.</p>",
|
||||
"base": "<p>Contains the inputs for the <code>CreateHsm</code> operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateHsmResponse": {
|
||||
"base": "<p>Contains the output of the <a>CreateHsm</a> operation.</p>",
|
||||
"base": "<p>Contains the output of the <code>CreateHsm</code> operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -192,7 +192,7 @@
|
||||
}
|
||||
},
|
||||
"DescribeHsmRequest": {
|
||||
"base": "<p>Contains the inputs for the <a>DescribeHsm</a> operation. </p>",
|
||||
"base": "<p>Contains the inputs for the <a>DescribeHsm</a> operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -220,7 +220,7 @@
|
||||
"ExternalId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateHsmRequest$ExternalId": "<p>The external ID from <b>IamRoleArn</b>, if present.</p>",
|
||||
"CreateHsmRequest$ExternalId": "<p>The external ID from <code>IamRoleArn</code>, if present.</p>",
|
||||
"ModifyHsmRequest$ExternalId": "<p>The new external ID.</p>"
|
||||
}
|
||||
},
|
||||
@@ -258,7 +258,7 @@
|
||||
"refs": {
|
||||
"CreateHsmResponse$HsmArn": "<p>The ARN of the HSM.</p>",
|
||||
"DeleteHsmRequest$HsmArn": "<p>The ARN of the HSM to delete.</p>",
|
||||
"DescribeHsmRequest$HsmArn": "<p>The ARN of the HSM. Either the <i>HsmArn</i> or the <i>SerialNumber</i> parameter must be specified.</p>",
|
||||
"DescribeHsmRequest$HsmArn": "<p>The ARN of the HSM. Either the <code>HsmArn</code> or the <code>SerialNumber</code> parameter must be specified.</p>",
|
||||
"DescribeHsmResponse$HsmArn": "<p>The ARN of the HSM.</p>",
|
||||
"HsmList$member": null,
|
||||
"ModifyHsmRequest$HsmArn": "<p>The ARN of the HSM to modify.</p>",
|
||||
@@ -268,16 +268,16 @@
|
||||
"HsmList": {
|
||||
"base": "<p>Contains a list of ARNs that identify the HSMs.</p>",
|
||||
"refs": {
|
||||
"DescribeHapgResponse$HsmsLastActionFailed": null,
|
||||
"DescribeHapgResponse$HsmsPendingDeletion": null,
|
||||
"DescribeHapgResponse$HsmsPendingRegistration": null,
|
||||
"DescribeHapgResponse$HsmsLastActionFailed": "<p/>",
|
||||
"DescribeHapgResponse$HsmsPendingDeletion": "<p/>",
|
||||
"DescribeHapgResponse$HsmsPendingRegistration": "<p/>",
|
||||
"ListHsmsResponse$HsmList": "<p>The list of ARNs that identify the HSMs.</p>"
|
||||
}
|
||||
},
|
||||
"HsmSerialNumber": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeHsmRequest$HsmSerialNumber": "<p>The serial number of the HSM. Either the <i>HsmArn</i> or the <i>HsmSerialNumber</i> parameter must be specified.</p>",
|
||||
"DescribeHsmRequest$HsmSerialNumber": "<p>The serial number of the HSM. Either the <code>HsmArn</code> or the <code>HsmSerialNumber</code> parameter must be specified.</p>",
|
||||
"DescribeHsmResponse$SerialNumber": "<p>The serial number of the HSM.</p>"
|
||||
}
|
||||
},
|
||||
@@ -345,7 +345,7 @@
|
||||
}
|
||||
},
|
||||
"ListHsmsResponse": {
|
||||
"base": "<p>Contains the output of the <a>ListHsms</a> operation.</p>",
|
||||
"base": "<p>Contains the output of the <code>ListHsms</code> operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -402,12 +402,12 @@
|
||||
"PaginationToken": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListHapgsRequest$NextToken": "<p>The <i>NextToken</i> value from a previous call to <a>ListHapgs</a>. Pass null if this is the first call.</p>",
|
||||
"ListHapgsResponse$NextToken": "<p>If not null, more results are available. Pass this value to <a>ListHapgs</a> to retrieve the next set of items.</p>",
|
||||
"ListHsmsRequest$NextToken": "<p>The <i>NextToken</i> value from a previous call to <a>ListHsms</a>. Pass null if this is the first call.</p>",
|
||||
"ListHsmsResponse$NextToken": "<p>If not null, more results are available. Pass this value to <a>ListHsms</a> to retrieve the next set of items.</p>",
|
||||
"ListLunaClientsRequest$NextToken": "<p>The <i>NextToken</i> value from a previous call to <a>ListLunaClients</a>. Pass null if this is the first call.</p>",
|
||||
"ListLunaClientsResponse$NextToken": "<p>If not null, more results are available. Pass this to <a>ListLunaClients</a> to retrieve the next set of items.</p>"
|
||||
"ListHapgsRequest$NextToken": "<p>The <code>NextToken</code> value from a previous call to <code>ListHapgs</code>. Pass null if this is the first call.</p>",
|
||||
"ListHapgsResponse$NextToken": "<p>If not null, more results are available. Pass this value to <code>ListHapgs</code> to retrieve the next set of items.</p>",
|
||||
"ListHsmsRequest$NextToken": "<p>The <code>NextToken</code> value from a previous call to <code>ListHsms</code>. Pass null if this is the first call.</p>",
|
||||
"ListHsmsResponse$NextToken": "<p>If not null, more results are available. Pass this value to <code>ListHsms</code> to retrieve the next set of items.</p>",
|
||||
"ListLunaClientsRequest$NextToken": "<p>The <code>NextToken</code> value from a previous call to <code>ListLunaClients</code>. Pass null if this is the first call.</p>",
|
||||
"ListLunaClientsResponse$NextToken": "<p>If not null, more results are available. Pass this to <code>ListLunaClients</code> to retrieve the next set of items.</p>"
|
||||
}
|
||||
},
|
||||
"PartitionArn": {
|
||||
@@ -484,7 +484,7 @@
|
||||
}
|
||||
},
|
||||
"SubscriptionType": {
|
||||
"base": "<p>Specifies the type of subscription for the HSM.</p> <ul> <li><b>PRODUCTION</b> - The HSM is being used in a production environment.</li> <li><b>TRIAL</b> - The HSM is being used in a product trial.</li> </ul>",
|
||||
"base": "<p>Specifies the type of subscription for the HSM.</p> <ul> <li> <p> <b>PRODUCTION</b> - The HSM is being used in a production environment.</p> </li> <li> <p> <b>TRIAL</b> - The HSM is being used in a product trial.</p> </li> </ul>",
|
||||
"refs": {
|
||||
"CreateHsmRequest$SubscriptionType": null,
|
||||
"DescribeHsmResponse$SubscriptionType": null
|
||||
|
||||
Generated
Vendored
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"pagination": {
|
||||
}
|
||||
}
|
||||
+5
-3
@@ -7,6 +7,7 @@
|
||||
"protocol":"json",
|
||||
"serviceAbbreviation":"CloudHSM V2",
|
||||
"serviceFullName":"AWS CloudHSM V2",
|
||||
"serviceId":"CloudHSM V2",
|
||||
"signatureVersion":"v4",
|
||||
"signingName":"cloudhsm",
|
||||
"targetPrefix":"BaldrApiService",
|
||||
@@ -392,7 +393,7 @@
|
||||
},
|
||||
"EniId":{
|
||||
"type":"string",
|
||||
"pattern":"eni-[0-9a-fA-F]{8}"
|
||||
"pattern":"eni-[0-9a-fA-F]{8,17}"
|
||||
},
|
||||
"ExternalAz":{
|
||||
"type":"string",
|
||||
@@ -520,7 +521,7 @@
|
||||
},
|
||||
"SubnetId":{
|
||||
"type":"string",
|
||||
"pattern":"subnet-[0-9a-fA-F]{8}"
|
||||
"pattern":"subnet-[0-9a-fA-F]{8,17}"
|
||||
},
|
||||
"SubnetIds":{
|
||||
"type":"list",
|
||||
@@ -576,7 +577,8 @@
|
||||
"TagValue":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":0
|
||||
"min":0,
|
||||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
|
||||
},
|
||||
"Timestamp":{"type":"timestamp"},
|
||||
"UntagResourceRequest":{
|
||||
|
||||
+2
-2
@@ -54,8 +54,8 @@
|
||||
"Certificates$AwsHardwareCertificate": "<p>The HSM hardware certificate issued (signed) by AWS CloudHSM.</p>",
|
||||
"Certificates$ManufacturerHardwareCertificate": "<p>The HSM hardware certificate issued (signed) by the hardware manufacturer.</p>",
|
||||
"Certificates$ClusterCertificate": "<p>The cluster certificate issued (signed) by the issuing certificate authority (CA) of the cluster's owner.</p>",
|
||||
"InitializeClusterRequest$SignedCert": "<p>The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in PEM format.</p>",
|
||||
"InitializeClusterRequest$TrustAnchor": "<p>The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. This can be a root (self-signed) certificate or a certificate chain that begins with the certificate that issued the cluster certificate and ends with a root certificate. The certificate or certificate chain must be in PEM format.</p>"
|
||||
"InitializeClusterRequest$SignedCert": "<p>The cluster certificate issued (signed) by your issuing certificate authority (CA). The certificate must be in PEM format and can contain a maximum of 5000 characters.</p>",
|
||||
"InitializeClusterRequest$TrustAnchor": "<p>The issuing certificate of the issuing certificate authority (CA) that issued (signed) the cluster certificate. This can be a root (self-signed) certificate or a certificate chain that begins with the certificate that issued the cluster certificate and ends with a root certificate. The certificate or certificate chain must be in PEM format and can contain a maximum of 5000 characters.</p>"
|
||||
}
|
||||
},
|
||||
"Certificates": {
|
||||
|
||||
+18
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"version": 1,
|
||||
"defaultRegion": "us-west-2",
|
||||
"testCases": [
|
||||
{
|
||||
"operationName": "DescribeClusters",
|
||||
"input": {},
|
||||
"errorExpectedFromService": false
|
||||
},
|
||||
{
|
||||
"operationName": "ListTags",
|
||||
"input": {
|
||||
"ResourceId": "bogus-arn"
|
||||
},
|
||||
"errorExpectedFromService": true
|
||||
}
|
||||
]
|
||||
}
|
||||
+207
-8
@@ -61,6 +61,21 @@
|
||||
{"shape":"AccountLimitExceededException"}
|
||||
]
|
||||
},
|
||||
"CreateWebhook":{
|
||||
"name":"CreateWebhook",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateWebhookInput"},
|
||||
"output":{"shape":"CreateWebhookOutput"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"OAuthProviderException"},
|
||||
{"shape":"ResourceAlreadyExistsException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"DeleteProject":{
|
||||
"name":"DeleteProject",
|
||||
"http":{
|
||||
@@ -73,6 +88,33 @@
|
||||
{"shape":"InvalidInputException"}
|
||||
]
|
||||
},
|
||||
"DeleteWebhook":{
|
||||
"name":"DeleteWebhook",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteWebhookInput"},
|
||||
"output":{"shape":"DeleteWebhookOutput"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"OAuthProviderException"}
|
||||
]
|
||||
},
|
||||
"InvalidateProjectCache":{
|
||||
"name":"InvalidateProjectCache",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"InvalidateProjectCacheInput"},
|
||||
"output":{"shape":"InvalidateProjectCacheOutput"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"ListBuilds":{
|
||||
"name":"ListBuilds",
|
||||
"http":{
|
||||
@@ -158,6 +200,20 @@
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"UpdateWebhook":{
|
||||
"name":"UpdateWebhook",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateWebhookInput"},
|
||||
"output":{"shape":"UpdateWebhookOutput"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"OAuthProviderException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
@@ -246,11 +302,14 @@
|
||||
"phases":{"shape":"BuildPhases"},
|
||||
"source":{"shape":"ProjectSource"},
|
||||
"artifacts":{"shape":"BuildArtifacts"},
|
||||
"cache":{"shape":"ProjectCache"},
|
||||
"environment":{"shape":"ProjectEnvironment"},
|
||||
"logs":{"shape":"LogsLocation"},
|
||||
"timeoutInMinutes":{"shape":"WrapperInt"},
|
||||
"buildComplete":{"shape":"Boolean"},
|
||||
"initiator":{"shape":"String"}
|
||||
"initiator":{"shape":"String"},
|
||||
"vpcConfig":{"shape":"VpcConfig"},
|
||||
"networkInterface":{"shape":"NetworkInterface"}
|
||||
}
|
||||
},
|
||||
"BuildArtifacts":{
|
||||
@@ -312,6 +371,13 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"BuildNotDeleted"}
|
||||
},
|
||||
"CacheType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"NO_CACHE",
|
||||
"S3"
|
||||
]
|
||||
},
|
||||
"ComputeType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
@@ -333,11 +399,14 @@
|
||||
"description":{"shape":"ProjectDescription"},
|
||||
"source":{"shape":"ProjectSource"},
|
||||
"artifacts":{"shape":"ProjectArtifacts"},
|
||||
"cache":{"shape":"ProjectCache"},
|
||||
"environment":{"shape":"ProjectEnvironment"},
|
||||
"serviceRole":{"shape":"NonEmptyString"},
|
||||
"timeoutInMinutes":{"shape":"TimeOut"},
|
||||
"encryptionKey":{"shape":"NonEmptyString"},
|
||||
"tags":{"shape":"TagList"}
|
||||
"tags":{"shape":"TagList"},
|
||||
"vpcConfig":{"shape":"VpcConfig"},
|
||||
"badgeEnabled":{"shape":"WrapperBoolean"}
|
||||
}
|
||||
},
|
||||
"CreateProjectOutput":{
|
||||
@@ -346,6 +415,20 @@
|
||||
"project":{"shape":"Project"}
|
||||
}
|
||||
},
|
||||
"CreateWebhookInput":{
|
||||
"type":"structure",
|
||||
"required":["projectName"],
|
||||
"members":{
|
||||
"projectName":{"shape":"ProjectName"},
|
||||
"branchFilter":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"CreateWebhookOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"webhook":{"shape":"Webhook"}
|
||||
}
|
||||
},
|
||||
"DeleteProjectInput":{
|
||||
"type":"structure",
|
||||
"required":["name"],
|
||||
@@ -358,11 +441,24 @@
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteWebhookInput":{
|
||||
"type":"structure",
|
||||
"required":["projectName"],
|
||||
"members":{
|
||||
"projectName":{"shape":"ProjectName"}
|
||||
}
|
||||
},
|
||||
"DeleteWebhookOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"EnvironmentImage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"name":{"shape":"String"},
|
||||
"description":{"shape":"String"}
|
||||
"description":{"shape":"String"},
|
||||
"versions":{"shape":"ImageVersions"}
|
||||
}
|
||||
},
|
||||
"EnvironmentImages":{
|
||||
@@ -418,12 +514,32 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"EnvironmentVariable"}
|
||||
},
|
||||
"GitCloneDepth":{
|
||||
"type":"integer",
|
||||
"min":0
|
||||
},
|
||||
"ImageVersions":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"InvalidInputException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidateProjectCacheInput":{
|
||||
"type":"structure",
|
||||
"required":["projectName"],
|
||||
"members":{
|
||||
"projectName":{"shape":"NonEmptyString"}
|
||||
}
|
||||
},
|
||||
"InvalidateProjectCacheOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"KeyInput":{
|
||||
"type":"string",
|
||||
"max":127,
|
||||
@@ -508,10 +624,23 @@
|
||||
"deepLink":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"NetworkInterface":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"subnetId":{"shape":"NonEmptyString"},
|
||||
"networkInterfaceId":{"shape":"NonEmptyString"}
|
||||
}
|
||||
},
|
||||
"NonEmptyString":{
|
||||
"type":"string",
|
||||
"min":1
|
||||
},
|
||||
"OAuthProviderException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"PhaseContext":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -539,13 +668,17 @@
|
||||
"description":{"shape":"ProjectDescription"},
|
||||
"source":{"shape":"ProjectSource"},
|
||||
"artifacts":{"shape":"ProjectArtifacts"},
|
||||
"cache":{"shape":"ProjectCache"},
|
||||
"environment":{"shape":"ProjectEnvironment"},
|
||||
"serviceRole":{"shape":"NonEmptyString"},
|
||||
"timeoutInMinutes":{"shape":"TimeOut"},
|
||||
"encryptionKey":{"shape":"NonEmptyString"},
|
||||
"tags":{"shape":"TagList"},
|
||||
"created":{"shape":"Timestamp"},
|
||||
"lastModified":{"shape":"Timestamp"}
|
||||
"lastModified":{"shape":"Timestamp"},
|
||||
"webhook":{"shape":"Webhook"},
|
||||
"vpcConfig":{"shape":"VpcConfig"},
|
||||
"badge":{"shape":"ProjectBadge"}
|
||||
}
|
||||
},
|
||||
"ProjectArtifacts":{
|
||||
@@ -560,6 +693,21 @@
|
||||
"packaging":{"shape":"ArtifactPackaging"}
|
||||
}
|
||||
},
|
||||
"ProjectBadge":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"badgeEnabled":{"shape":"Boolean"},
|
||||
"badgeRequestUrl":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ProjectCache":{
|
||||
"type":"structure",
|
||||
"required":["type"],
|
||||
"members":{
|
||||
"type":{"shape":"CacheType"},
|
||||
"location":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ProjectDescription":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
@@ -577,7 +725,8 @@
|
||||
"image":{"shape":"NonEmptyString"},
|
||||
"computeType":{"shape":"ComputeType"},
|
||||
"environmentVariables":{"shape":"EnvironmentVariables"},
|
||||
"privilegedMode":{"shape":"WrapperBoolean"}
|
||||
"privilegedMode":{"shape":"WrapperBoolean"},
|
||||
"certificate":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ProjectName":{
|
||||
@@ -606,8 +755,10 @@
|
||||
"members":{
|
||||
"type":{"shape":"SourceType"},
|
||||
"location":{"shape":"String"},
|
||||
"gitCloneDepth":{"shape":"GitCloneDepth"},
|
||||
"buildspec":{"shape":"String"},
|
||||
"auth":{"shape":"SourceAuth"}
|
||||
"auth":{"shape":"SourceAuth"},
|
||||
"insecureSsl":{"shape":"WrapperBoolean"}
|
||||
}
|
||||
},
|
||||
"Projects":{
|
||||
@@ -626,6 +777,11 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"SecurityGroupIds":{
|
||||
"type":"list",
|
||||
"member":{"shape":"NonEmptyString"},
|
||||
"max":5
|
||||
},
|
||||
"SortOrderType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
@@ -652,7 +808,8 @@
|
||||
"CODEPIPELINE",
|
||||
"GITHUB",
|
||||
"S3",
|
||||
"BITBUCKET"
|
||||
"BITBUCKET",
|
||||
"GITHUB_ENTERPRISE"
|
||||
]
|
||||
},
|
||||
"StartBuildInput":{
|
||||
@@ -663,6 +820,7 @@
|
||||
"sourceVersion":{"shape":"String"},
|
||||
"artifactsOverride":{"shape":"ProjectArtifacts"},
|
||||
"environmentVariablesOverride":{"shape":"EnvironmentVariables"},
|
||||
"gitCloneDepthOverride":{"shape":"GitCloneDepth"},
|
||||
"buildspecOverride":{"shape":"String"},
|
||||
"timeoutInMinutesOverride":{"shape":"TimeOut"}
|
||||
}
|
||||
@@ -698,6 +856,11 @@
|
||||
}
|
||||
},
|
||||
"String":{"type":"string"},
|
||||
"Subnets":{
|
||||
"type":"list",
|
||||
"member":{"shape":"NonEmptyString"},
|
||||
"max":16
|
||||
},
|
||||
"Tag":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -725,11 +888,14 @@
|
||||
"description":{"shape":"ProjectDescription"},
|
||||
"source":{"shape":"ProjectSource"},
|
||||
"artifacts":{"shape":"ProjectArtifacts"},
|
||||
"cache":{"shape":"ProjectCache"},
|
||||
"environment":{"shape":"ProjectEnvironment"},
|
||||
"serviceRole":{"shape":"NonEmptyString"},
|
||||
"timeoutInMinutes":{"shape":"TimeOut"},
|
||||
"encryptionKey":{"shape":"NonEmptyString"},
|
||||
"tags":{"shape":"TagList"}
|
||||
"tags":{"shape":"TagList"},
|
||||
"vpcConfig":{"shape":"VpcConfig"},
|
||||
"badgeEnabled":{"shape":"WrapperBoolean"}
|
||||
}
|
||||
},
|
||||
"UpdateProjectOutput":{
|
||||
@@ -738,12 +904,45 @@
|
||||
"project":{"shape":"Project"}
|
||||
}
|
||||
},
|
||||
"UpdateWebhookInput":{
|
||||
"type":"structure",
|
||||
"required":["projectName"],
|
||||
"members":{
|
||||
"projectName":{"shape":"ProjectName"},
|
||||
"branchFilter":{"shape":"String"},
|
||||
"rotateSecret":{"shape":"Boolean"}
|
||||
}
|
||||
},
|
||||
"UpdateWebhookOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"webhook":{"shape":"Webhook"}
|
||||
}
|
||||
},
|
||||
"ValueInput":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":1,
|
||||
"pattern":"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=@+\\\\-]*)$"
|
||||
},
|
||||
"VpcConfig":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"vpcId":{"shape":"NonEmptyString"},
|
||||
"subnets":{"shape":"Subnets"},
|
||||
"securityGroupIds":{"shape":"SecurityGroupIds"}
|
||||
}
|
||||
},
|
||||
"Webhook":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"url":{"shape":"NonEmptyString"},
|
||||
"payloadUrl":{"shape":"NonEmptyString"},
|
||||
"secret":{"shape":"NonEmptyString"},
|
||||
"branchFilter":{"shape":"String"},
|
||||
"lastModifiedSecret":{"shape":"Timestamp"}
|
||||
}
|
||||
},
|
||||
"WrapperBoolean":{"type":"boolean"},
|
||||
"WrapperInt":{"type":"integer"},
|
||||
"WrapperLong":{"type":"long"}
|
||||
|
||||
+154
-11
@@ -1,19 +1,23 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<fullname>AWS CodeBuild</fullname> <p>AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. AWS CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apach Maven, Gradle, and more. You can also fully customize build environments in AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests, and you pay only for the build time you consume. For more information about AWS CodeBuild, see the <i>AWS CodeBuild User Guide</i>.</p> <p>AWS CodeBuild supports these operations:</p> <ul> <li> <p> <code>BatchDeleteBuilds</code>: Deletes one or more builds.</p> </li> <li> <p> <code>BatchGetProjects</code>: Gets information about one or more build projects. A <i>build project</i> defines how AWS CodeBuild will run a build. This includes information such as where to get the source code to build, the build environment to use, the build commands to run, and where to store the build output. A <i>build environment</i> represents a combination of operating system, programming language runtime, and tools that AWS CodeBuild will use to run a build. Also, you can add tags to build projects to help manage your resources and costs.</p> </li> <li> <p> <code>CreateProject</code>: Creates a build project.</p> </li> <li> <p> <code>DeleteProject</code>: Deletes a build project.</p> </li> <li> <p> <code>ListProjects</code>: Gets a list of build project names, with each build project name representing a single build project.</p> </li> <li> <p> <code>UpdateProject</code>: Changes the settings of an existing build project.</p> </li> <li> <p> <code>BatchGetBuilds</code>: Gets information about one or more builds.</p> </li> <li> <p> <code>ListBuilds</code>: Gets a list of build IDs, with each build ID representing a single build.</p> </li> <li> <p> <code>ListBuildsForProject</code>: Gets a list of build IDs for the specified build project, with each build ID representing a single build.</p> </li> <li> <p> <code>StartBuild</code>: Starts running a build.</p> </li> <li> <p> <code>StopBuild</code>: Attempts to stop running a build.</p> </li> <li> <p> <code>ListCuratedEnvironmentImages</code>: Gets information about Docker images that are managed by AWS CodeBuild.</p> </li> </ul>",
|
||||
"service": "<fullname>AWS CodeBuild</fullname> <p>AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. AWS CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests, and you pay only for the build time you consume. For more information about AWS CodeBuild, see the <i>AWS CodeBuild User Guide</i>.</p> <p>AWS CodeBuild supports these operations:</p> <ul> <li> <p> <code>BatchDeleteBuilds</code>: Deletes one or more builds.</p> </li> <li> <p> <code>BatchGetProjects</code>: Gets information about one or more build projects. A <i>build project</i> defines how AWS CodeBuild will run a build. This includes information such as where to get the source code to build, the build environment to use, the build commands to run, and where to store the build output. A <i>build environment</i> represents a combination of operating system, programming language runtime, and tools that AWS CodeBuild will use to run a build. Also, you can add tags to build projects to help manage your resources and costs.</p> </li> <li> <p> <code>CreateProject</code>: Creates a build project.</p> </li> <li> <p> <code>CreateWebhook</code>: For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.</p> </li> <li> <p> <code>UpdateWebhook</code>: Changes the settings of an existing webhook.</p> </li> <li> <p> <code>DeleteProject</code>: Deletes a build project.</p> </li> <li> <p> <code>DeleteWebhook</code>: For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, stops AWS CodeBuild from automatically rebuilding the source code every time a code change is pushed to the repository.</p> </li> <li> <p> <code>ListProjects</code>: Gets a list of build project names, with each build project name representing a single build project.</p> </li> <li> <p> <code>UpdateProject</code>: Changes the settings of an existing build project.</p> </li> <li> <p> <code>BatchGetBuilds</code>: Gets information about one or more builds.</p> </li> <li> <p> <code>ListBuilds</code>: Gets a list of build IDs, with each build ID representing a single build.</p> </li> <li> <p> <code>ListBuildsForProject</code>: Gets a list of build IDs for the specified build project, with each build ID representing a single build.</p> </li> <li> <p> <code>StartBuild</code>: Starts running a build.</p> </li> <li> <p> <code>StopBuild</code>: Attempts to stop running a build.</p> </li> <li> <p> <code>ListCuratedEnvironmentImages</code>: Gets information about Docker images that are managed by AWS CodeBuild.</p> </li> </ul>",
|
||||
"operations": {
|
||||
"BatchDeleteBuilds": "<p>Deletes one or more builds.</p>",
|
||||
"BatchGetBuilds": "<p>Gets information about builds.</p>",
|
||||
"BatchGetProjects": "<p>Gets information about build projects.</p>",
|
||||
"CreateProject": "<p>Creates a build project.</p>",
|
||||
"CreateWebhook": "<p>For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.</p> <important> <p>If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds will be created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you will be billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 9 in <a href=\"http://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-console\">Change a Build Project's Settings</a>.</p> </important>",
|
||||
"DeleteProject": "<p>Deletes a build project.</p>",
|
||||
"DeleteWebhook": "<p>For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, stops AWS CodeBuild from automatically rebuilding the source code every time a code change is pushed to the repository.</p>",
|
||||
"InvalidateProjectCache": "<p>Resets the cache for a project.</p>",
|
||||
"ListBuilds": "<p>Gets a list of build IDs, with each build ID representing a single build.</p>",
|
||||
"ListBuildsForProject": "<p>Gets a list of build IDs for the specified build project, with each build ID representing a single build.</p>",
|
||||
"ListCuratedEnvironmentImages": "<p>Gets information about Docker images that are managed by AWS CodeBuild.</p>",
|
||||
"ListProjects": "<p>Gets a list of build project names, with each build project name representing a single build project.</p>",
|
||||
"StartBuild": "<p>Starts running a build.</p>",
|
||||
"StopBuild": "<p>Attempts to stop running a build.</p>",
|
||||
"UpdateProject": "<p>Changes the settings of a build project.</p>"
|
||||
"UpdateProject": "<p>Changes the settings of a build project.</p>",
|
||||
"UpdateWebhook": "<p> Updates the webhook associated with an AWS CodeBuild build project. </p>"
|
||||
},
|
||||
"shapes": {
|
||||
"AccountLimitExceededException": {
|
||||
@@ -72,7 +76,9 @@
|
||||
"Boolean": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Build$buildComplete": "<p>Whether the build has finished. True if completed; otherwise, false.</p>"
|
||||
"Build$buildComplete": "<p>Whether the build has finished. True if completed; otherwise, false.</p>",
|
||||
"ProjectBadge$badgeEnabled": "<p>Set this to true to generate a publicly-accessible URL for your project's build badge.</p>",
|
||||
"UpdateWebhookInput$rotateSecret": "<p> A boolean value that specifies whether the associated repository's secret token should be updated. </p>"
|
||||
}
|
||||
},
|
||||
"Build": {
|
||||
@@ -136,6 +142,12 @@
|
||||
"BatchDeleteBuildsOutput$buildsNotDeleted": "<p>Information about any builds that could not be successfully deleted.</p>"
|
||||
}
|
||||
},
|
||||
"CacheType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ProjectCache$type": "<p>The type of cache used by the build project. Valid values include:</p> <ul> <li> <p> <code>NO_CACHE</code>: The build project will not use any cache.</p> </li> <li> <p> <code>S3</code>: The build project will read and write from/to S3.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"ComputeType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -152,6 +164,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateWebhookInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateWebhookOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteProjectInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -162,6 +184,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteWebhookInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteWebhookOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"EnvironmentImage": {
|
||||
"base": "<p>Information about a Docker image that is managed by AWS CodeBuild.</p>",
|
||||
"refs": {
|
||||
@@ -223,11 +255,34 @@
|
||||
"StartBuildInput$environmentVariablesOverride": "<p>A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.</p>"
|
||||
}
|
||||
},
|
||||
"GitCloneDepth": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ProjectSource$gitCloneDepth": "<p>Information about the git clone depth for the build project.</p>",
|
||||
"StartBuildInput$gitCloneDepthOverride": "<p>The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.</p>"
|
||||
}
|
||||
},
|
||||
"ImageVersions": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"EnvironmentImage$versions": "<p>A list of environment image versions.</p>"
|
||||
}
|
||||
},
|
||||
"InvalidInputException": {
|
||||
"base": "<p>The input value that was provided is not valid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidateProjectCacheInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidateProjectCacheOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"KeyInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -286,30 +341,50 @@
|
||||
"Build$logs": "<p>Information about the build's logs in Amazon CloudWatch Logs.</p>"
|
||||
}
|
||||
},
|
||||
"NetworkInterface": {
|
||||
"base": "<p>Describes a network interface.</p>",
|
||||
"refs": {
|
||||
"Build$networkInterface": "<p>Describes a network interface.</p>"
|
||||
}
|
||||
},
|
||||
"NonEmptyString": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Build$id": "<p>The unique ID for the build.</p>",
|
||||
"Build$arn": "<p>The Amazon Resource Name (ARN) of the build.</p>",
|
||||
"Build$sourceVersion": "<p>Any version identifier for the version of the source code to be built.</p>",
|
||||
"Build$projectName": "<p>The name of the build project.</p>",
|
||||
"Build$projectName": "<p>The name of the AWS CodeBuild project.</p>",
|
||||
"BuildIds$member": null,
|
||||
"BuildNotDeleted$id": "<p>The ID of the build that could not be successfully deleted.</p>",
|
||||
"CreateProjectInput$serviceRole": "<p>The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.</p>",
|
||||
"CreateProjectInput$encryptionKey": "<p>The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <p>You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format <code>alias/<i>alias-name</i> </code>).</p>",
|
||||
"DeleteProjectInput$name": "<p>The name of the build project.</p>",
|
||||
"EnvironmentVariable$name": "<p>The name or key of the environment variable.</p>",
|
||||
"ListBuildsForProjectInput$projectName": "<p>The name of the build project.</p>",
|
||||
"InvalidateProjectCacheInput$projectName": "<p>The name of the AWS CodeBuild build project that the cache will be reset for.</p>",
|
||||
"ListBuildsForProjectInput$projectName": "<p>The name of the AWS CodeBuild project.</p>",
|
||||
"ListProjectsInput$nextToken": "<p>During a previous call, if there are more than 100 items in the list, only the first 100 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>",
|
||||
"NetworkInterface$subnetId": "<p>The ID of the subnet.</p>",
|
||||
"NetworkInterface$networkInterfaceId": "<p>The ID of the network interface.</p>",
|
||||
"Project$serviceRole": "<p>The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.</p>",
|
||||
"Project$encryptionKey": "<p>The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <p>This is expressed either as the CMK's Amazon Resource Name (ARN) or, if specified, the CMK's alias (using the format <code>alias/<i>alias-name</i> </code>).</p>",
|
||||
"ProjectEnvironment$image": "<p>The ID of the Docker image to use for this build project.</p>",
|
||||
"ProjectNames$member": null,
|
||||
"StartBuildInput$projectName": "<p>The name of the build project to start running a build.</p>",
|
||||
"SecurityGroupIds$member": null,
|
||||
"StartBuildInput$projectName": "<p>The name of the AWS CodeBuild build project to start running a build.</p>",
|
||||
"StopBuildInput$id": "<p>The ID of the build.</p>",
|
||||
"Subnets$member": null,
|
||||
"UpdateProjectInput$name": "<p>The name of the build project.</p> <note> <p>You cannot change a build project's name.</p> </note>",
|
||||
"UpdateProjectInput$serviceRole": "<p>The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.</p>",
|
||||
"UpdateProjectInput$encryptionKey": "<p>The replacement AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <p>You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format <code>alias/<i>alias-name</i> </code>).</p>"
|
||||
"UpdateProjectInput$encryptionKey": "<p>The replacement AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <p>You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format <code>alias/<i>alias-name</i> </code>).</p>",
|
||||
"VpcConfig$vpcId": "<p>The ID of the Amazon VPC.</p>",
|
||||
"Webhook$url": "<p>The URL to the webhook.</p>",
|
||||
"Webhook$payloadUrl": "<p> The CodeBuild endpoint where webhook events are sent.</p>",
|
||||
"Webhook$secret": "<p> The secret token of the associated repository. </p>"
|
||||
}
|
||||
},
|
||||
"OAuthProviderException": {
|
||||
"base": "<p>There was a problem with the underlying OAuth provider.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"PhaseContext": {
|
||||
@@ -347,6 +422,21 @@
|
||||
"UpdateProjectInput$artifacts": "<p>Information to be changed about the build output artifacts for the build project.</p>"
|
||||
}
|
||||
},
|
||||
"ProjectBadge": {
|
||||
"base": "<p>Information about the build badge for the build project.</p>",
|
||||
"refs": {
|
||||
"Project$badge": "<p>Information about the build badge for the build project.</p>"
|
||||
}
|
||||
},
|
||||
"ProjectCache": {
|
||||
"base": "<p>Information about the cache for the build project.</p>",
|
||||
"refs": {
|
||||
"Build$cache": "<p>Information about the cache for the build.</p>",
|
||||
"CreateProjectInput$cache": "<p>Stores recently used information so that it can be quickly accessed at a later time.</p>",
|
||||
"Project$cache": "<p>Information about the cache for the build project.</p>",
|
||||
"UpdateProjectInput$cache": "<p>Stores recently used information so that it can be quickly accessed at a later time.</p>"
|
||||
}
|
||||
},
|
||||
"ProjectDescription": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -368,7 +458,10 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateProjectInput$name": "<p>The name of the build project.</p>",
|
||||
"Project$name": "<p>The name of the build project.</p>"
|
||||
"CreateWebhookInput$projectName": "<p>The name of the AWS CodeBuild project.</p>",
|
||||
"DeleteWebhookInput$projectName": "<p>The name of the AWS CodeBuild project.</p>",
|
||||
"Project$name": "<p>The name of the build project.</p>",
|
||||
"UpdateWebhookInput$projectName": "<p>The name of the AWS CodeBuild project.</p>"
|
||||
}
|
||||
},
|
||||
"ProjectNames": {
|
||||
@@ -410,6 +503,12 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"SecurityGroupIds": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"VpcConfig$securityGroupIds": "<p>A list of one or more security groups IDs in your Amazon VPC.</p>"
|
||||
}
|
||||
},
|
||||
"SortOrderType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -472,9 +571,11 @@
|
||||
"BuildArtifacts$sha256sum": "<p>The SHA-256 hash of the build artifact.</p> <p>You can use this hash along with a checksum tool to confirm both file integrity and authenticity.</p> <note> <p>This value is available only if the build project's <code>packaging</code> value is set to <code>ZIP</code>.</p> </note>",
|
||||
"BuildArtifacts$md5sum": "<p>The MD5 hash of the build artifact.</p> <p>You can use this hash along with a checksum tool to confirm both file integrity and authenticity.</p> <note> <p>This value is available only if the build project's <code>packaging</code> value is set to <code>ZIP</code>.</p> </note>",
|
||||
"BuildNotDeleted$statusCode": "<p>Additional information about the build that could not be successfully deleted.</p>",
|
||||
"CreateWebhookInput$branchFilter": "<p>A regular expression used to determine which branches in a repository are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If it doesn't match, then it is not. If branchFilter is empty, then all branches are built.</p>",
|
||||
"EnvironmentImage$name": "<p>The name of the Docker image.</p>",
|
||||
"EnvironmentImage$description": "<p>The description of the Docker image.</p>",
|
||||
"EnvironmentVariable$value": "<p>The value of the environment variable.</p> <important> <p>We strongly discourage using environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. Environment variables can be displayed in plain text using tools such as the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI).</p> </important>",
|
||||
"ImageVersions$member": null,
|
||||
"ListBuildsForProjectInput$nextToken": "<p>During a previous call, if there are more than 100 items in the list, only the first 100 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>",
|
||||
"ListBuildsForProjectOutput$nextToken": "<p>If there are more than 100 items in the list, only the first 100 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>",
|
||||
"ListBuildsInput$nextToken": "<p>During a previous call, if there are more than 100 items in the list, only the first 100 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>",
|
||||
@@ -489,11 +590,22 @@
|
||||
"ProjectArtifacts$location": "<p>Information about the build output artifact location, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, then this value will be ignored if specified, because no build output will be produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket.</p> </li> </ul>",
|
||||
"ProjectArtifacts$path": "<p>Along with <code>namespaceType</code> and <code>name</code>, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, then this value will be ignored if specified, because no build output will be produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the path to the output artifact. If <code>path</code> is not specified, then <code>path</code> will not be used.</p> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact would be stored in the output bucket at <code>MyArtifacts/MyArtifact.zip</code>.</p>",
|
||||
"ProjectArtifacts$name": "<p>Along with <code>path</code> and <code>namespaceType</code>, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, then this value will be ignored if specified, because no build output will be produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output artifact object.</p> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact would be stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>.</p>",
|
||||
"ProjectBadge$badgeRequestUrl": "<p>The publicly-accessible URL through which you can access the build badge for your project. </p>",
|
||||
"ProjectCache$location": "<p>Information about the cache location, as follows: </p> <ul> <li> <p> <code>NO_CACHE</code>: This value will be ignored.</p> </li> <li> <p> <code>S3</code>: This is the S3 bucket name/prefix.</p> </li> </ul>",
|
||||
"ProjectEnvironment$certificate": "<p>The certificate to use with this build project.</p>",
|
||||
"ProjectSource$location": "<p>Information about the location of the source code to be built. Valid values include:</p> <ul> <li> <p>For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, <code>location</code> should not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.</p> </li> <li> <p>For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, <code>https://git-codecommit.<i>region-ID</i>.amazonaws.com/v1/repos/<i>repo-name</i> </code>).</p> </li> <li> <p>For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example, <code> <i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>object-name</i>.zip</code>)</p> </li> <li> <p>For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your GitHub account. To do this, use the AWS CodeBuild console to begin creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub <b>Authorize application</b> page that displays, for <b>Organization access</b>, choose <b>Request access</b> next to each repository you want to allow AWS CodeBuild to have access to. Then choose <b>Authorize application</b>. (After you have connected to your GitHub account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</p> </li> <li> <p>For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your Bitbucket account. To do this, use the AWS CodeBuild console to begin creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket <b>Confirm access to your account</b> page that displays, choose <b>Grant access</b>. (After you have connected to your Bitbucket account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</p> </li> </ul>",
|
||||
"ProjectSource$buildspec": "<p>The build spec declaration to use for the builds in this build project.</p> <p>If this value is not specified, a build spec must be included along with the source code to be built.</p>",
|
||||
"SourceAuth$resource": "<p>The resource value that applies to the specified authorization type.</p>",
|
||||
"StartBuildInput$sourceVersion": "<p>A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of:</p> <ul> <li> <p>For AWS CodeCommit: the commit ID to use.</p> </li> <li> <p>For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format <code>pr/pull-request-ID</code> (for example <code>pr/25</code>). If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used.</p> </li> <li> <p>For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used.</p> </li> <li> <p>For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.</p> </li> </ul>",
|
||||
"StartBuildInput$buildspecOverride": "<p>A build spec declaration that overrides, for this build only, the latest one already defined in the build project.</p>"
|
||||
"StartBuildInput$buildspecOverride": "<p>A build spec declaration that overrides, for this build only, the latest one already defined in the build project.</p>",
|
||||
"UpdateWebhookInput$branchFilter": "<p>A regular expression used to determine which branches in a repository are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If it doesn't match, then it is not. If branchFilter is empty, then all branches are built.</p>",
|
||||
"Webhook$branchFilter": "<p>A regular expression used to determine which branches in a repository are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If it doesn't match, then it is not. If branchFilter is empty, then all branches are built.</p>"
|
||||
}
|
||||
},
|
||||
"Subnets": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"VpcConfig$subnets": "<p>A list of one or more subnet IDs in your Amazon VPC.</p>"
|
||||
}
|
||||
},
|
||||
"Tag": {
|
||||
@@ -527,7 +639,8 @@
|
||||
"BuildPhase$startTime": "<p>When the build phase started, expressed in Unix time format.</p>",
|
||||
"BuildPhase$endTime": "<p>When the build phase ended, expressed in Unix time format.</p>",
|
||||
"Project$created": "<p>When the build project was created, expressed in Unix time format.</p>",
|
||||
"Project$lastModified": "<p>When the build project's settings were last modified, expressed in Unix time format.</p>"
|
||||
"Project$lastModified": "<p>When the build project's settings were last modified, expressed in Unix time format.</p>",
|
||||
"Webhook$lastModifiedSecret": "<p> A timestamp indicating the last time a repository's secret token was modified. </p>"
|
||||
}
|
||||
},
|
||||
"UpdateProjectInput": {
|
||||
@@ -540,16 +653,46 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateWebhookInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateWebhookOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ValueInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Tag$value": "<p>The tag's value.</p>"
|
||||
}
|
||||
},
|
||||
"VpcConfig": {
|
||||
"base": "<p>Information about the VPC configuration that AWS CodeBuild will access.</p>",
|
||||
"refs": {
|
||||
"Build$vpcConfig": "<p>If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.</p>",
|
||||
"CreateProjectInput$vpcConfig": "<p>VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.</p>",
|
||||
"Project$vpcConfig": "<p>Information about the VPC configuration that AWS CodeBuild will access.</p>",
|
||||
"UpdateProjectInput$vpcConfig": "<p>VpcConfig enables AWS CodeBuild to access resources in an Amazon VPC.</p>"
|
||||
}
|
||||
},
|
||||
"Webhook": {
|
||||
"base": "<p>Information about a webhook in GitHub that connects repository events to a build project in AWS CodeBuild.</p>",
|
||||
"refs": {
|
||||
"CreateWebhookOutput$webhook": "<p>Information about a webhook in GitHub that connects repository events to a build project in AWS CodeBuild.</p>",
|
||||
"Project$webhook": "<p>Information about a webhook in GitHub that connects repository events to a build project in AWS CodeBuild.</p>",
|
||||
"UpdateWebhookOutput$webhook": "<p> Information about a repository's webhook that is associated with a project in AWS CodeBuild. </p>"
|
||||
}
|
||||
},
|
||||
"WrapperBoolean": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ProjectEnvironment$privilegedMode": "<p>If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay& - timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\"</code> </p>"
|
||||
"CreateProjectInput$badgeEnabled": "<p>Set this to true to generate a publicly-accessible URL for your project's build badge.</p>",
|
||||
"ProjectEnvironment$privilegedMode": "<p>Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay& - timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\"</code> </p>",
|
||||
"ProjectSource$insecureSsl": "<p>Enable this flag to ignore SSL warnings while connecting to the project source code.</p>",
|
||||
"UpdateProjectInput$badgeEnabled": "<p>Set this to true to generate a publicly-accessible URL for your project's build badge.</p>"
|
||||
}
|
||||
},
|
||||
"WrapperInt": {
|
||||
|
||||
+1459
-1
File diff suppressed because it is too large
Load Diff
+909
-12
File diff suppressed because one or more lines are too long
Generated
Vendored
+20
@@ -1,5 +1,20 @@
|
||||
{
|
||||
"pagination": {
|
||||
"DescribePullRequestEvents": {
|
||||
"input_token": "nextToken",
|
||||
"limit_key": "maxResults",
|
||||
"output_token": "nextToken"
|
||||
},
|
||||
"GetCommentsForComparedCommit": {
|
||||
"input_token": "nextToken",
|
||||
"limit_key": "maxResults",
|
||||
"output_token": "nextToken"
|
||||
},
|
||||
"GetCommentsForPullRequest": {
|
||||
"input_token": "nextToken",
|
||||
"limit_key": "maxResults",
|
||||
"output_token": "nextToken"
|
||||
},
|
||||
"GetDifferences": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
@@ -10,6 +25,11 @@
|
||||
"output_token": "nextToken",
|
||||
"result_key": "branches"
|
||||
},
|
||||
"ListPullRequests": {
|
||||
"input_token": "nextToken",
|
||||
"limit_key": "maxResults",
|
||||
"output_token": "nextToken"
|
||||
},
|
||||
"ListRepositories": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
|
||||
+18
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"version": 1,
|
||||
"defaultRegion": "us-west-2",
|
||||
"testCases": [
|
||||
{
|
||||
"operationName": "ListRepositories",
|
||||
"input": {},
|
||||
"errorExpectedFromService": false
|
||||
},
|
||||
{
|
||||
"operationName": "ListBranches",
|
||||
"input": {
|
||||
"repositoryName": "fake-repo"
|
||||
},
|
||||
"errorExpectedFromService": true
|
||||
}
|
||||
]
|
||||
}
|
||||
+251
-22
@@ -7,6 +7,7 @@
|
||||
"protocol":"json",
|
||||
"serviceAbbreviation":"CodeDeploy",
|
||||
"serviceFullName":"AWS CodeDeploy",
|
||||
"serviceId":"CodeDeploy",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"CodeDeploy_20141006",
|
||||
"timestampFormat":"unixTimestamp",
|
||||
@@ -22,6 +23,7 @@
|
||||
"input":{"shape":"AddTagsToOnPremisesInstancesInput"},
|
||||
"errors":[
|
||||
{"shape":"InstanceNameRequiredException"},
|
||||
{"shape":"InvalidInstanceNameException"},
|
||||
{"shape":"TagRequiredException"},
|
||||
{"shape":"InvalidTagException"},
|
||||
{"shape":"TagLimitExceededException"},
|
||||
@@ -151,7 +153,8 @@
|
||||
{"shape":"ApplicationNameRequiredException"},
|
||||
{"shape":"InvalidApplicationNameException"},
|
||||
{"shape":"ApplicationAlreadyExistsException"},
|
||||
{"shape":"ApplicationLimitExceededException"}
|
||||
{"shape":"ApplicationLimitExceededException"},
|
||||
{"shape":"InvalidComputePlatformException"}
|
||||
]
|
||||
},
|
||||
"CreateDeployment":{
|
||||
@@ -179,7 +182,12 @@
|
||||
{"shape":"InvalidTargetInstancesException"},
|
||||
{"shape":"InvalidAutoRollbackConfigException"},
|
||||
{"shape":"InvalidLoadBalancerInfoException"},
|
||||
{"shape":"InvalidFileExistsBehaviorException"}
|
||||
{"shape":"InvalidFileExistsBehaviorException"},
|
||||
{"shape":"InvalidRoleException"},
|
||||
{"shape":"InvalidAutoScalingGroupException"},
|
||||
{"shape":"ThrottlingException"},
|
||||
{"shape":"InvalidUpdateOutdatedInstancesOnlyValueException"},
|
||||
{"shape":"InvalidIgnoreApplicationStopFailuresValueException"}
|
||||
]
|
||||
},
|
||||
"CreateDeploymentConfig":{
|
||||
@@ -195,7 +203,9 @@
|
||||
{"shape":"DeploymentConfigNameRequiredException"},
|
||||
{"shape":"DeploymentConfigAlreadyExistsException"},
|
||||
{"shape":"InvalidMinimumHealthyHostValueException"},
|
||||
{"shape":"DeploymentConfigLimitExceededException"}
|
||||
{"shape":"DeploymentConfigLimitExceededException"},
|
||||
{"shape":"InvalidComputePlatformException"},
|
||||
{"shape":"InvalidTrafficRoutingConfigurationException"}
|
||||
]
|
||||
},
|
||||
"CreateDeploymentGroup":{
|
||||
@@ -232,7 +242,8 @@
|
||||
{"shape":"InvalidBlueGreenDeploymentConfigurationException"},
|
||||
{"shape":"InvalidEC2TagCombinationException"},
|
||||
{"shape":"InvalidOnPremisesTagCombinationException"},
|
||||
{"shape":"TagSetListLimitExceededException"}
|
||||
{"shape":"TagSetListLimitExceededException"},
|
||||
{"shape":"InvalidInputException"}
|
||||
]
|
||||
},
|
||||
"DeleteApplication":{
|
||||
@@ -277,6 +288,22 @@
|
||||
{"shape":"InvalidRoleException"}
|
||||
]
|
||||
},
|
||||
"DeleteGitHubAccountToken":{
|
||||
"name":"DeleteGitHubAccountToken",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteGitHubAccountTokenInput"},
|
||||
"output":{"shape":"DeleteGitHubAccountTokenOutput"},
|
||||
"errors":[
|
||||
{"shape":"GitHubAccountTokenNameRequiredException"},
|
||||
{"shape":"GitHubAccountTokenDoesNotExistException"},
|
||||
{"shape":"InvalidGitHubAccountTokenNameException"},
|
||||
{"shape":"ResourceValidationException"},
|
||||
{"shape":"OperationNotSupportedException"}
|
||||
]
|
||||
},
|
||||
"DeregisterOnPremisesInstance":{
|
||||
"name":"DeregisterOnPremisesInstance",
|
||||
"http":{
|
||||
@@ -505,7 +532,8 @@
|
||||
"output":{"shape":"ListGitHubAccountTokenNamesOutput"},
|
||||
"errors":[
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ResourceValidationException"}
|
||||
{"shape":"ResourceValidationException"},
|
||||
{"shape":"OperationNotSupportedException"}
|
||||
]
|
||||
},
|
||||
"ListOnPremisesInstances":{
|
||||
@@ -522,6 +550,24 @@
|
||||
{"shape":"InvalidNextTokenException"}
|
||||
]
|
||||
},
|
||||
"PutLifecycleEventHookExecutionStatus":{
|
||||
"name":"PutLifecycleEventHookExecutionStatus",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"PutLifecycleEventHookExecutionStatusInput"},
|
||||
"output":{"shape":"PutLifecycleEventHookExecutionStatusOutput"},
|
||||
"errors":[
|
||||
{"shape":"InvalidLifecycleEventHookExecutionStatusException"},
|
||||
{"shape":"InvalidLifecycleEventHookExecutionIdException"},
|
||||
{"shape":"LifecycleEventAlreadyCompletedException"},
|
||||
{"shape":"DeploymentIdRequiredException"},
|
||||
{"shape":"DeploymentDoesNotExistException"},
|
||||
{"shape":"InvalidDeploymentIdException"},
|
||||
{"shape":"UnsupportedActionForDeploymentTypeException"}
|
||||
]
|
||||
},
|
||||
"RegisterApplicationRevision":{
|
||||
"name":"RegisterApplicationRevision",
|
||||
"http":{
|
||||
@@ -567,6 +613,7 @@
|
||||
"input":{"shape":"RemoveTagsFromOnPremisesInstancesInput"},
|
||||
"errors":[
|
||||
{"shape":"InstanceNameRequiredException"},
|
||||
{"shape":"InvalidInstanceNameException"},
|
||||
{"shape":"TagRequiredException"},
|
||||
{"shape":"InvalidTagException"},
|
||||
{"shape":"TagLimitExceededException"},
|
||||
@@ -652,7 +699,8 @@
|
||||
{"shape":"InvalidBlueGreenDeploymentConfigurationException"},
|
||||
{"shape":"InvalidEC2TagCombinationException"},
|
||||
{"shape":"InvalidOnPremisesTagCombinationException"},
|
||||
{"shape":"TagSetListLimitExceededException"}
|
||||
{"shape":"TagSetListLimitExceededException"},
|
||||
{"shape":"InvalidInputException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
@@ -668,7 +716,10 @@
|
||||
"instanceNames":{"shape":"InstanceNameList"}
|
||||
}
|
||||
},
|
||||
"AdditionalDeploymentStatusInfo":{"type":"string"},
|
||||
"AdditionalDeploymentStatusInfo":{
|
||||
"type":"string",
|
||||
"deprecated":true
|
||||
},
|
||||
"Alarm":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -714,7 +765,8 @@
|
||||
"applicationName":{"shape":"ApplicationName"},
|
||||
"createTime":{"shape":"Timestamp"},
|
||||
"linkedToGitHub":{"shape":"Boolean"},
|
||||
"gitHubAccountName":{"shape":"GitHubAccountTokenName"}
|
||||
"gitHubAccountName":{"shape":"GitHubAccountTokenName"},
|
||||
"computePlatform":{"shape":"ComputePlatform"}
|
||||
}
|
||||
},
|
||||
"ApplicationLimitExceededException":{
|
||||
@@ -807,6 +859,7 @@
|
||||
},
|
||||
"BatchGetApplicationsInput":{
|
||||
"type":"structure",
|
||||
"required":["applicationNames"],
|
||||
"members":{
|
||||
"applicationNames":{"shape":"ApplicationsList"}
|
||||
}
|
||||
@@ -855,6 +908,7 @@
|
||||
},
|
||||
"BatchGetDeploymentsInput":{
|
||||
"type":"structure",
|
||||
"required":["deploymentIds"],
|
||||
"members":{
|
||||
"deploymentIds":{"shape":"DeploymentsList"}
|
||||
}
|
||||
@@ -867,6 +921,7 @@
|
||||
},
|
||||
"BatchGetOnPremisesInstancesInput":{
|
||||
"type":"structure",
|
||||
"required":["instanceNames"],
|
||||
"members":{
|
||||
"instanceNames":{"shape":"InstanceNameList"}
|
||||
}
|
||||
@@ -910,10 +965,19 @@
|
||||
"enum":[
|
||||
"tar",
|
||||
"tgz",
|
||||
"zip"
|
||||
"zip",
|
||||
"YAML",
|
||||
"JSON"
|
||||
]
|
||||
},
|
||||
"CommitId":{"type":"string"},
|
||||
"ComputePlatform":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"Server",
|
||||
"Lambda"
|
||||
]
|
||||
},
|
||||
"ContinueDeploymentInput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -924,7 +988,8 @@
|
||||
"type":"structure",
|
||||
"required":["applicationName"],
|
||||
"members":{
|
||||
"applicationName":{"shape":"ApplicationName"}
|
||||
"applicationName":{"shape":"ApplicationName"},
|
||||
"computePlatform":{"shape":"ComputePlatform"}
|
||||
}
|
||||
},
|
||||
"CreateApplicationOutput":{
|
||||
@@ -935,13 +1000,12 @@
|
||||
},
|
||||
"CreateDeploymentConfigInput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"deploymentConfigName",
|
||||
"minimumHealthyHosts"
|
||||
],
|
||||
"required":["deploymentConfigName"],
|
||||
"members":{
|
||||
"deploymentConfigName":{"shape":"DeploymentConfigName"},
|
||||
"minimumHealthyHosts":{"shape":"MinimumHealthyHosts"}
|
||||
"minimumHealthyHosts":{"shape":"MinimumHealthyHosts"},
|
||||
"trafficRoutingConfig":{"shape":"TrafficRoutingConfig"},
|
||||
"computePlatform":{"shape":"ComputePlatform"}
|
||||
}
|
||||
},
|
||||
"CreateDeploymentConfigOutput":{
|
||||
@@ -1034,6 +1098,18 @@
|
||||
"hooksNotCleanedUp":{"shape":"AutoScalingGroupList"}
|
||||
}
|
||||
},
|
||||
"DeleteGitHubAccountTokenInput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"tokenName":{"shape":"GitHubAccountTokenName"}
|
||||
}
|
||||
},
|
||||
"DeleteGitHubAccountTokenOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"tokenName":{"shape":"GitHubAccountTokenName"}
|
||||
}
|
||||
},
|
||||
"DeploymentAlreadyCompletedException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1065,7 +1141,9 @@
|
||||
"deploymentConfigId":{"shape":"DeploymentConfigId"},
|
||||
"deploymentConfigName":{"shape":"DeploymentConfigName"},
|
||||
"minimumHealthyHosts":{"shape":"MinimumHealthyHosts"},
|
||||
"createTime":{"shape":"Timestamp"}
|
||||
"createTime":{"shape":"Timestamp"},
|
||||
"computePlatform":{"shape":"ComputePlatform"},
|
||||
"trafficRoutingConfig":{"shape":"TrafficRoutingConfig"}
|
||||
}
|
||||
},
|
||||
"DeploymentConfigLimitExceededException":{
|
||||
@@ -1137,7 +1215,8 @@
|
||||
"lastSuccessfulDeployment":{"shape":"LastDeploymentInfo"},
|
||||
"lastAttemptedDeployment":{"shape":"LastDeploymentInfo"},
|
||||
"ec2TagSet":{"shape":"EC2TagSet"},
|
||||
"onPremisesTagSet":{"shape":"OnPremisesTagSet"}
|
||||
"onPremisesTagSet":{"shape":"OnPremisesTagSet"},
|
||||
"computePlatform":{"shape":"ComputePlatform"}
|
||||
}
|
||||
},
|
||||
"DeploymentGroupInfoList":{
|
||||
@@ -1199,7 +1278,9 @@
|
||||
"blueGreenDeploymentConfiguration":{"shape":"BlueGreenDeploymentConfiguration"},
|
||||
"loadBalancerInfo":{"shape":"LoadBalancerInfo"},
|
||||
"additionalDeploymentStatusInfo":{"shape":"AdditionalDeploymentStatusInfo"},
|
||||
"fileExistsBehavior":{"shape":"FileExistsBehavior"}
|
||||
"fileExistsBehavior":{"shape":"FileExistsBehavior"},
|
||||
"deploymentStatusMessages":{"shape":"DeploymentStatusMessageList"},
|
||||
"computePlatform":{"shape":"ComputePlatform"}
|
||||
}
|
||||
},
|
||||
"DeploymentIsNotInReadyStateException":{
|
||||
@@ -1268,6 +1349,10 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"DeploymentStatus"}
|
||||
},
|
||||
"DeploymentStatusMessageList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"DeploymentStyle":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1376,7 +1461,15 @@
|
||||
"AGENT_ISSUE",
|
||||
"AUTO_SCALING_IAM_ROLE_PERMISSIONS",
|
||||
"AUTO_SCALING_CONFIGURATION",
|
||||
"MANUAL_STOP"
|
||||
"MANUAL_STOP",
|
||||
"MISSING_BLUE_GREEN_DEPLOYMENT_CONFIGURATION",
|
||||
"MISSING_ELB_INFORMATION",
|
||||
"MISSING_GITHUB_TOKEN",
|
||||
"ELASTIC_LOAD_BALANCING_INVALID",
|
||||
"ELB_INVALID_INSTANCE",
|
||||
"INVALID_LAMBDA_CONFIGURATION",
|
||||
"INVALID_LAMBDA_FUNCTION",
|
||||
"HOOK_EXECUTION_FAILURE"
|
||||
]
|
||||
},
|
||||
"ErrorInformation":{
|
||||
@@ -1521,6 +1614,12 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"GitHubAccountTokenName"}
|
||||
},
|
||||
"GitHubAccountTokenNameRequiredException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"GitHubLocation":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1716,6 +1815,12 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidComputePlatformException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidDeployedStateFilterException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1776,6 +1881,12 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidGitHubAccountTokenNameException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidIamSessionArnException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1788,6 +1899,24 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidIgnoreApplicationStopFailuresValueException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidInputException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidInstanceIdException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidInstanceNameException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1812,6 +1941,18 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidLifecycleEventHookExecutionIdException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidLifecycleEventHookExecutionStatusException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidLoadBalancerInfoException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1896,12 +2037,24 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidTrafficRoutingConfigurationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidTriggerConfigException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidUpdateOutdatedInstancesOnlyValueException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"Key":{"type":"string"},
|
||||
"LastDeploymentInfo":{
|
||||
"type":"structure",
|
||||
@@ -1933,6 +2086,13 @@
|
||||
"status":{"shape":"LifecycleEventStatus"}
|
||||
}
|
||||
},
|
||||
"LifecycleEventAlreadyCompletedException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"LifecycleEventHookExecutionId":{"type":"string"},
|
||||
"LifecycleEventList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"LifecycleEvent"}
|
||||
@@ -2130,6 +2290,36 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"TagFilterList"}
|
||||
},
|
||||
"OperationNotSupportedException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"Percentage":{"type":"integer"},
|
||||
"PutLifecycleEventHookExecutionStatusInput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"deploymentId":{"shape":"DeploymentId"},
|
||||
"lifecycleEventHookExecutionId":{"shape":"LifecycleEventHookExecutionId"},
|
||||
"status":{"shape":"LifecycleEventStatus"}
|
||||
}
|
||||
},
|
||||
"PutLifecycleEventHookExecutionStatusOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"lifecycleEventHookExecutionId":{"shape":"LifecycleEventHookExecutionId"}
|
||||
}
|
||||
},
|
||||
"RawString":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"content":{"shape":"RawStringContent"},
|
||||
"sha256":{"shape":"RawStringSha256"}
|
||||
}
|
||||
},
|
||||
"RawStringContent":{"type":"string"},
|
||||
"RawStringSha256":{"type":"string"},
|
||||
"RegisterApplicationRevisionInput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -2198,7 +2388,8 @@
|
||||
"members":{
|
||||
"revisionType":{"shape":"RevisionLocationType"},
|
||||
"s3Location":{"shape":"S3Location"},
|
||||
"gitHubLocation":{"shape":"GitHubLocation"}
|
||||
"gitHubLocation":{"shape":"GitHubLocation"},
|
||||
"string":{"shape":"RawString"}
|
||||
}
|
||||
},
|
||||
"RevisionLocationList":{
|
||||
@@ -2209,7 +2400,8 @@
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"S3",
|
||||
"GitHub"
|
||||
"GitHub",
|
||||
"String"
|
||||
]
|
||||
},
|
||||
"RevisionRequiredException":{
|
||||
@@ -2349,6 +2541,26 @@
|
||||
"ec2TagSet":{"shape":"EC2TagSet"}
|
||||
}
|
||||
},
|
||||
"ThrottlingException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"TimeBasedCanary":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"canaryPercentage":{"shape":"Percentage"},
|
||||
"canaryInterval":{"shape":"WaitTimeInMins"}
|
||||
}
|
||||
},
|
||||
"TimeBasedLinear":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"linearPercentage":{"shape":"Percentage"},
|
||||
"linearInterval":{"shape":"WaitTimeInMins"}
|
||||
}
|
||||
},
|
||||
"TimeRange":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -2357,6 +2569,22 @@
|
||||
}
|
||||
},
|
||||
"Timestamp":{"type":"timestamp"},
|
||||
"TrafficRoutingConfig":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"type":{"shape":"TrafficRoutingType"},
|
||||
"timeBasedCanary":{"shape":"TimeBasedCanary"},
|
||||
"timeBasedLinear":{"shape":"TimeBasedLinear"}
|
||||
}
|
||||
},
|
||||
"TrafficRoutingType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"TimeBasedCanary",
|
||||
"TimeBasedLinear",
|
||||
"AllAtOnce"
|
||||
]
|
||||
},
|
||||
"TriggerConfig":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -2441,6 +2669,7 @@
|
||||
}
|
||||
},
|
||||
"Value":{"type":"string"},
|
||||
"VersionId":{"type":"string"}
|
||||
"VersionId":{"type":"string"},
|
||||
"WaitTimeInMins":{"type":"integer"}
|
||||
}
|
||||
}
|
||||
|
||||
+178
-5
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<fullname>AWS CodeDeploy</fullname> <p>AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances or on-premises instances running in your own facility.</p> <p>You can deploy a nearly unlimited variety of application content, such as code, web and configuration files, executables, packages, scripts, multimedia files, and so on. AWS CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use AWS CodeDeploy.</p> <p>AWS CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.</p> <p> <b>AWS CodeDeploy Components</b> </p> <p>Use the information in this guide to help you work with the following AWS CodeDeploy components:</p> <ul> <li> <p> <b>Application</b>: A name that uniquely identifies the application you want to deploy. AWS CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.</p> </li> <li> <p> <b>Deployment group</b>: A set of individual instances. A deployment group contains individually tagged instances, Amazon EC2 instances in Auto Scaling groups, or both. </p> </li> <li> <p> <b>Deployment configuration</b>: A set of deployment rules and deployment success and failure conditions used by AWS CodeDeploy during a deployment.</p> </li> <li> <p> <b>Deployment</b>: The process, and the components involved in the process, of installing content on one or more instances. </p> </li> <li> <p> <b>Application revisions</b>: An archive file containing source content—source code, web pages, executable files, and deployment scripts—along with an application specification file (AppSpec file). Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.</p> </li> </ul> <p>This guide also contains information to help you get details about the instances in your deployments and to make on-premises instances available for AWS CodeDeploy deployments.</p> <p> <b>AWS CodeDeploy Information Resources</b> </p> <ul> <li> <p> <a href=\"http://docs.aws.amazon.com/codedeploy/latest/userguide\">AWS CodeDeploy User Guide</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/codedeploy/latest/APIReference/\">AWS CodeDeploy API Reference Guide</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/cli/latest/reference/deploy/index.html\">AWS CLI Reference for AWS CodeDeploy</a> </p> </li> <li> <p> <a href=\"https://forums.aws.amazon.com/forum.jspa?forumID=179\">AWS CodeDeploy Developer Forum</a> </p> </li> </ul>",
|
||||
"service": "<fullname>AWS CodeDeploy</fullname> <p>AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances, on-premises instances running in your own facility, or serverless AWS Lambda functions.</p> <p>You can deploy a nearly unlimited variety of application content, such as an updated Lambda function, code, web and configuration files, executables, packages, scripts, multimedia files, and so on. AWS CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use AWS CodeDeploy.</p> <p>AWS CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.</p> <p> <b>AWS CodeDeploy Components</b> </p> <p>Use the information in this guide to help you work with the following AWS CodeDeploy components:</p> <ul> <li> <p> <b>Application</b>: A name that uniquely identifies the application you want to deploy. AWS CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.</p> </li> <li> <p> <b>Deployment group</b>: A set of individual instances or CodeDeploy Lambda applications. A Lambda deployment group contains a group of applications. An EC2/On-premises deployment group contains individually tagged instances, Amazon EC2 instances in Auto Scaling groups, or both. </p> </li> <li> <p> <b>Deployment configuration</b>: A set of deployment rules and deployment success and failure conditions used by AWS CodeDeploy during a deployment.</p> </li> <li> <p> <b>Deployment</b>: The process and the components used in the process of updating a Lambda function or of installing content on one or more instances. </p> </li> <li> <p> <b>Application revisions</b>: For an AWS Lambda deployment, this is an AppSpec file that specifies the Lambda function to update and one or more functions to validate deployment lifecycle events. For an EC2/On-premises deployment, this is an archive file containing source content—source code, web pages, executable files, and deployment scripts—along with an AppSpec file. Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.</p> </li> </ul> <p>This guide also contains information to help you get details about the instances in your deployments, to make on-premises instances available for AWS CodeDeploy deployments, and to get details about a Lambda function deployment.</p> <p> <b>AWS CodeDeploy Information Resources</b> </p> <ul> <li> <p> <a href=\"http://docs.aws.amazon.com/codedeploy/latest/userguide\">AWS CodeDeploy User Guide</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/codedeploy/latest/APIReference/\">AWS CodeDeploy API Reference Guide</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/cli/latest/reference/deploy/index.html\">AWS CLI Reference for AWS CodeDeploy</a> </p> </li> <li> <p> <a href=\"https://forums.aws.amazon.com/forum.jspa?forumID=179\">AWS CodeDeploy Developer Forum</a> </p> </li> </ul>",
|
||||
"operations": {
|
||||
"AddTagsToOnPremisesInstances": "<p>Adds tags to on-premises instances.</p>",
|
||||
"BatchGetApplicationRevisions": "<p>Gets information about one or more application revisions.</p>",
|
||||
@@ -17,6 +17,7 @@
|
||||
"DeleteApplication": "<p>Deletes an application.</p>",
|
||||
"DeleteDeploymentConfig": "<p>Deletes a deployment configuration.</p> <note> <p>A deployment configuration cannot be deleted if it is currently in use. Predefined configurations cannot be deleted.</p> </note>",
|
||||
"DeleteDeploymentGroup": "<p>Deletes a deployment group.</p>",
|
||||
"DeleteGitHubAccountToken": "<p>Deletes a GitHub account connection.</p>",
|
||||
"DeregisterOnPremisesInstance": "<p>Deregisters an on-premises instance.</p>",
|
||||
"GetApplication": "<p>Gets information about an application.</p>",
|
||||
"GetApplicationRevision": "<p>Gets information about an application revision.</p>",
|
||||
@@ -33,6 +34,7 @@
|
||||
"ListDeployments": "<p>Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account.</p>",
|
||||
"ListGitHubAccountTokenNames": "<p>Lists the names of stored connections to GitHub accounts.</p>",
|
||||
"ListOnPremisesInstances": "<p>Gets a list of names for one or more on-premises instances.</p> <p>Unless otherwise specified, both registered and deregistered on-premises instance names will be listed. To list only registered or deregistered on-premises instance names, use the registration status parameter.</p>",
|
||||
"PutLifecycleEventHookExecutionStatus": "<p>Sets the result of a Lambda validation function. The function validates one or both lifecycle events (<code>BeforeAllowTraffic</code> and <code>AfterAllowTraffic</code>) and returns <code>Succeeded</code> or <code>Failed</code>.</p>",
|
||||
"RegisterApplicationRevision": "<p>Registers with AWS CodeDeploy a revision for the specified application.</p>",
|
||||
"RegisterOnPremisesInstance": "<p>Registers an on-premises instance.</p> <note> <p>Only one IAM ARN (an IAM session ARN or IAM user ARN) is supported in the request. You cannot use both.</p> </note>",
|
||||
"RemoveTagsFromOnPremisesInstances": "<p>Removes one or more tags from one or more on-premises instances.</p>",
|
||||
@@ -334,6 +336,17 @@
|
||||
"GitHubLocation$commitId": "<p>The SHA1 commit ID of the GitHub commit that represents the bundled artifacts for the application revision.</p>"
|
||||
}
|
||||
},
|
||||
"ComputePlatform": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ApplicationInfo$computePlatform": "<p>The destination platform type for deployment of the application (<code>Lambda</code> or <code>Server</code>).</p>",
|
||||
"CreateApplicationInput$computePlatform": "<p> The destination platform type for the deployment (<code>Lambda</code> or <code>Server</code>).</p>",
|
||||
"CreateDeploymentConfigInput$computePlatform": "<p>The destination platform type for the deployment (<code>Lambda</code> or <code>Server</code>>).</p>",
|
||||
"DeploymentConfigInfo$computePlatform": "<p>The destination platform type for the deployment (<code>Lambda</code> or <code>Server</code>).</p>",
|
||||
"DeploymentGroupInfo$computePlatform": "<p>The destination platform type for the deployment group (<code>Lambda</code> or <code>Server</code>).</p>",
|
||||
"DeploymentInfo$computePlatform": "<p>The destination platform type for the deployment (<code>Lambda</code> or <code>Server</code>).</p>"
|
||||
}
|
||||
},
|
||||
"ContinueDeploymentInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -399,6 +412,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteGitHubAccountTokenInput": {
|
||||
"base": "<p>Represents the input of a DeleteGitHubAccount operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteGitHubAccountTokenOutput": {
|
||||
"base": "<p>Represents the output of a DeleteGitHubAccountToken operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeploymentAlreadyCompletedException": {
|
||||
"base": "<p>The deployment is already complete.</p>",
|
||||
"refs": {
|
||||
@@ -550,6 +573,7 @@
|
||||
"InstanceSummary$deploymentId": "<p>The deployment ID.</p>",
|
||||
"LastDeploymentInfo$deploymentId": "<p>The deployment ID.</p>",
|
||||
"ListDeploymentInstancesInput$deploymentId": "<p>The unique ID of a deployment.</p>",
|
||||
"PutLifecycleEventHookExecutionStatusInput$deploymentId": "<p>The ID of the deployment. Pass this ID to a Lambda function that validates a deployment lifecycle event.</p>",
|
||||
"RollbackInfo$rollbackDeploymentId": "<p>The ID of the deployment rollback.</p>",
|
||||
"RollbackInfo$rollbackTriggeringDeploymentId": "<p>The deployment ID of the deployment that was underway and triggered a rollback deployment because it failed or was stopped.</p>",
|
||||
"SkipWaitTimeForInstanceTerminationInput$deploymentId": "<p>The ID of the blue/green deployment for which you want to skip the instance termination wait time.</p>",
|
||||
@@ -621,6 +645,12 @@
|
||||
"ListDeploymentsInput$includeOnlyStatuses": "<p>A subset of deployments to list by status:</p> <ul> <li> <p>Created: Include created deployments in the resulting list.</p> </li> <li> <p>Queued: Include queued deployments in the resulting list.</p> </li> <li> <p>In Progress: Include in-progress deployments in the resulting list.</p> </li> <li> <p>Succeeded: Include successful deployments in the resulting list.</p> </li> <li> <p>Failed: Include failed deployments in the resulting list.</p> </li> <li> <p>Stopped: Include stopped deployments in the resulting list.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"DeploymentStatusMessageList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DeploymentInfo$deploymentStatusMessages": "<p>Messages that contain information about the status of a deployment.</p>"
|
||||
}
|
||||
},
|
||||
"DeploymentStyle": {
|
||||
"base": "<p>Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.</p>",
|
||||
"refs": {
|
||||
@@ -734,7 +764,7 @@
|
||||
"ELBName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ELBInfo$name": "<p>For blue/green deployments, the name of the load balancer that will be used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment completes.</p>"
|
||||
"ELBInfo$name": "<p>For blue/green deployments, the name of the load balancer that will be used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment completes.</p>"
|
||||
}
|
||||
},
|
||||
"ETag": {
|
||||
@@ -761,6 +791,7 @@
|
||||
"BatchGetApplicationRevisionsOutput$errorMessage": "<p>Information about errors that may have occurred during the API call.</p>",
|
||||
"BatchGetDeploymentGroupsOutput$errorMessage": "<p>Information about errors that may have occurred during the API call.</p>",
|
||||
"BatchGetDeploymentInstancesOutput$errorMessage": "<p>Information about errors that may have occurred during the API call.</p>",
|
||||
"DeploymentStatusMessageList$member": null,
|
||||
"ErrorInformation$message": "<p>An accompanying error message.</p>"
|
||||
}
|
||||
},
|
||||
@@ -857,6 +888,8 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ApplicationInfo$gitHubAccountName": "<p>The name for a connection to a GitHub account.</p>",
|
||||
"DeleteGitHubAccountTokenInput$tokenName": "<p>The name of the GitHub account connection to delete.</p>",
|
||||
"DeleteGitHubAccountTokenOutput$tokenName": "<p>The name of the GitHub account connection that was deleted.</p>",
|
||||
"GitHubAccountTokenNameList$member": null
|
||||
}
|
||||
},
|
||||
@@ -866,6 +899,11 @@
|
||||
"ListGitHubAccountTokenNamesOutput$tokenNameList": "<p>A list of names of connections to GitHub accounts.</p>"
|
||||
}
|
||||
},
|
||||
"GitHubAccountTokenNameRequiredException": {
|
||||
"base": "<p>The call is missing a required GitHub account connection name.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GitHubLocation": {
|
||||
"base": "<p>Information about the location of application artifacts stored in GitHub.</p>",
|
||||
"refs": {
|
||||
@@ -1087,6 +1125,11 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidComputePlatformException": {
|
||||
"base": "<p>The computePlatform is invalid. The computePlatform should be <code>Lambda</code> or <code>Server</code>.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidDeployedStateFilterException": {
|
||||
"base": "<p>The deployed state filter was specified in an invalid format.</p>",
|
||||
"refs": {
|
||||
@@ -1137,6 +1180,11 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidGitHubAccountTokenNameException": {
|
||||
"base": "<p>The format of the specified GitHub account connection name is invalid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidIamSessionArnException": {
|
||||
"base": "<p>The IAM session ARN was specified in an invalid format.</p>",
|
||||
"refs": {
|
||||
@@ -1147,6 +1195,21 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidIgnoreApplicationStopFailuresValueException": {
|
||||
"base": "<p>The IgnoreApplicationStopFailures value is invalid. For AWS Lambda deployments, <code>false</code> is expected. For EC2/On-premises deployments, <code>true</code> or <code>false</code> is expected.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidInputException": {
|
||||
"base": "<p>The specified input was specified in an invalid format.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidInstanceIdException": {
|
||||
"base": "<p> </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidInstanceNameException": {
|
||||
"base": "<p>The specified on-premises instance name was specified in an invalid format.</p>",
|
||||
"refs": {
|
||||
@@ -1167,6 +1230,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidLifecycleEventHookExecutionIdException": {
|
||||
"base": "<p>A lifecycle event hook is invalid. Review the <code>hooks</code> section in your AppSpec file to ensure the lifecycle events and <code>hooks</code> functions are valid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidLifecycleEventHookExecutionStatusException": {
|
||||
"base": "<p>The result of a Lambda validation function that verifies a lifecycle event is invalid. It should return <code>Succeeded</code> or <code>Failed</code>.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidLoadBalancerInfoException": {
|
||||
"base": "<p>An invalid load balancer name, or no load balancer name, was specified.</p>",
|
||||
"refs": {
|
||||
@@ -1237,11 +1310,21 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidTrafficRoutingConfigurationException": {
|
||||
"base": "<p> The configuration that specifies how traffic is routed during a deployment is invalid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidTriggerConfigException": {
|
||||
"base": "<p>The trigger was specified in an invalid format.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidUpdateOutdatedInstancesOnlyValueException": {
|
||||
"base": "<p>The UpdateOutdatedInstancesOnly value is invalid. For AWS Lambda deployments, <code>false</code> is expected. For EC2/On-premises deployments, <code>true</code> or <code>false</code> is expected.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Key": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -1269,6 +1352,18 @@
|
||||
"LifecycleEventList$member": null
|
||||
}
|
||||
},
|
||||
"LifecycleEventAlreadyCompletedException": {
|
||||
"base": "<p>An attempt to return the status of an already completed lifecycle event occurred.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"LifecycleEventHookExecutionId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PutLifecycleEventHookExecutionStatusInput$lifecycleEventHookExecutionId": "<p>The execution ID of a deployment's lifecycle hook. A deployment lifecycle hook is specified in the <code>hooks</code> section of the AppSpec file.</p>",
|
||||
"PutLifecycleEventHookExecutionStatusOutput$lifecycleEventHookExecutionId": "<p>The execution ID of the lifecycle event hook. A hook is specified in the <code>hooks</code> section of the deployment's AppSpec file.</p>"
|
||||
}
|
||||
},
|
||||
"LifecycleEventList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -1284,7 +1379,8 @@
|
||||
"LifecycleEventStatus": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"LifecycleEvent$status": "<p>The deployment lifecycle event status:</p> <ul> <li> <p>Pending: The deployment lifecycle event is pending.</p> </li> <li> <p>InProgress: The deployment lifecycle event is in progress.</p> </li> <li> <p>Succeeded: The deployment lifecycle event ran successfully.</p> </li> <li> <p>Failed: The deployment lifecycle event has failed.</p> </li> <li> <p>Skipped: The deployment lifecycle event has been skipped.</p> </li> <li> <p>Unknown: The deployment lifecycle event is unknown.</p> </li> </ul>"
|
||||
"LifecycleEvent$status": "<p>The deployment lifecycle event status:</p> <ul> <li> <p>Pending: The deployment lifecycle event is pending.</p> </li> <li> <p>InProgress: The deployment lifecycle event is in progress.</p> </li> <li> <p>Succeeded: The deployment lifecycle event ran successfully.</p> </li> <li> <p>Failed: The deployment lifecycle event has failed.</p> </li> <li> <p>Skipped: The deployment lifecycle event has been skipped.</p> </li> <li> <p>Unknown: The deployment lifecycle event is unknown.</p> </li> </ul>",
|
||||
"PutLifecycleEventHookExecutionStatusInput$status": "<p>The result of a Lambda function that validates a deployment lifecycle event (<code>Succeeded</code> or <code>Failed</code>).</p>"
|
||||
}
|
||||
},
|
||||
"LifecycleHookLimitExceededException": {
|
||||
@@ -1470,6 +1566,46 @@
|
||||
"OnPremisesTagSet$onPremisesTagSetList": "<p>A list containing other lists of on-premises instance tag groups. In order for an instance to be included in the deployment group, it must be identified by all the tag groups in the list.</p>"
|
||||
}
|
||||
},
|
||||
"OperationNotSupportedException": {
|
||||
"base": "<p>The API used does not support the deployment.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Percentage": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"TimeBasedCanary$canaryPercentage": "<p>The percentage of traffic to shift in the first increment of a <code>TimeBasedCanary</code> deployment.</p>",
|
||||
"TimeBasedLinear$linearPercentage": "<p>The percentage of traffic that is shifted at the start of each increment of a <code>TimeBasedLinear</code> deployment.</p>"
|
||||
}
|
||||
},
|
||||
"PutLifecycleEventHookExecutionStatusInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"PutLifecycleEventHookExecutionStatusOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"RawString": {
|
||||
"base": "<p>A revision for an AWS Lambda deployment that is a YAML-formatted or JSON-formatted string. For AWS Lambda deployments, the revision is the same as the AppSpec file.</p>",
|
||||
"refs": {
|
||||
"RevisionLocation$string": "<p>Information about the location of an AWS Lambda deployment revision stored as a RawString.</p>"
|
||||
}
|
||||
},
|
||||
"RawStringContent": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"RawString$content": "<p>The YAML-formatted or JSON-formatted revision string. It includes information about which Lambda function to update and optional Lambda functions that validate deployment lifecycle events.</p>"
|
||||
}
|
||||
},
|
||||
"RawStringSha256": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"RawString$sha256": "<p>The SHA256 hash value of the revision that is specified as a RawString.</p>"
|
||||
}
|
||||
},
|
||||
"RegisterApplicationRevisionInput": {
|
||||
"base": "<p>Represents the input of a RegisterApplicationRevision operation.</p>",
|
||||
"refs": {
|
||||
@@ -1543,7 +1679,7 @@
|
||||
"RevisionLocationType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"RevisionLocation$revisionType": "<p>The type of application revision:</p> <ul> <li> <p>S3: An application revision stored in Amazon S3.</p> </li> <li> <p>GitHub: An application revision stored in GitHub.</p> </li> </ul>"
|
||||
"RevisionLocation$revisionType": "<p>The type of application revision:</p> <ul> <li> <p>S3: An application revision stored in Amazon S3.</p> </li> <li> <p>GitHub: An application revision stored in GitHub (EC2/On-premises deployments only)</p> </li> <li> <p>String: A YAML-formatted or JSON-formatted string (AWS Lambda deployments only)</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"RevisionRequiredException": {
|
||||
@@ -1587,7 +1723,7 @@
|
||||
"S3Location": {
|
||||
"base": "<p>Information about the location of application artifacts stored in Amazon S3.</p>",
|
||||
"refs": {
|
||||
"RevisionLocation$s3Location": "<p>Information about the location of application artifacts stored in Amazon S3. </p>"
|
||||
"RevisionLocation$s3Location": "<p>Information about the location of a revision stored in Amazon S3. </p>"
|
||||
}
|
||||
},
|
||||
"ScriptName": {
|
||||
@@ -1699,6 +1835,23 @@
|
||||
"DeploymentInfo$targetInstances": "<p>Information about the instances that belong to the replacement environment in a blue/green deployment.</p>"
|
||||
}
|
||||
},
|
||||
"ThrottlingException": {
|
||||
"base": "<p>An API function was called too frequently.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"TimeBasedCanary": {
|
||||
"base": "<p>A configuration that shifts traffic from one version of a Lambda function to another in two increments. The original and target Lambda function versions are specified in the deployment's AppSpec file.</p>",
|
||||
"refs": {
|
||||
"TrafficRoutingConfig$timeBasedCanary": "<p>A configuration that shifts traffic from one version of a Lambda function to another in two increments. The original and target Lambda function versions are specified in the deployment's AppSpec file.</p>"
|
||||
}
|
||||
},
|
||||
"TimeBasedLinear": {
|
||||
"base": "<p>A configuration that shifts traffic from one version of a Lambda function to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions are specified in the deployment's AppSpec file.</p>",
|
||||
"refs": {
|
||||
"TrafficRoutingConfig$timeBasedLinear": "<p>A configuration that shifts traffic from one version of a Lambda function to another in equal increments, with an equal number of minutes between each increment. The original and target Lambda function versions are specified in the deployment's AppSpec file.</p>"
|
||||
}
|
||||
},
|
||||
"TimeRange": {
|
||||
"base": "<p>Information about a time range.</p>",
|
||||
"refs": {
|
||||
@@ -1727,6 +1880,19 @@
|
||||
"TimeRange$end": "<p>The end time of the time range.</p> <note> <p>Specify null to leave the end time open-ended.</p> </note>"
|
||||
}
|
||||
},
|
||||
"TrafficRoutingConfig": {
|
||||
"base": "<p>The configuration that specifies how traffic is shifted from one version of a Lambda function to another version during an AWS Lambda deployment.</p>",
|
||||
"refs": {
|
||||
"CreateDeploymentConfigInput$trafficRoutingConfig": "<p>The configuration that specifies how the deployment traffic will be routed.</p>",
|
||||
"DeploymentConfigInfo$trafficRoutingConfig": "<p>The configuration specifying how the deployment traffic will be routed. Only deployments with a Lambda compute platform can specify this.</p>"
|
||||
}
|
||||
},
|
||||
"TrafficRoutingType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"TrafficRoutingConfig$type": "<p>The type of traffic shifting (<code>TimeBasedCanary</code> or <code>TimeBasedLinear</code>) used by a deployment configuration .</p>"
|
||||
}
|
||||
},
|
||||
"TriggerConfig": {
|
||||
"base": "<p>Information about notification triggers for the deployment group.</p>",
|
||||
"refs": {
|
||||
@@ -1803,6 +1969,13 @@
|
||||
"refs": {
|
||||
"S3Location$version": "<p>A specific version of the Amazon S3 object that represents the bundled artifacts for the application revision.</p> <p>If the version is not specified, the system will use the most recent version by default.</p>"
|
||||
}
|
||||
},
|
||||
"WaitTimeInMins": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"TimeBasedCanary$canaryInterval": "<p>The number of minutes between the first and second traffic shifts of a <code>TimeBasedCanary</code> deployment.</p>",
|
||||
"TimeBasedLinear$linearInterval": "<p>The number of minutes between each incremental traffic shift of a <code>TimeBasedLinear</code> deployment.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+868
-22
File diff suppressed because it is too large
Load Diff
+610
-50
File diff suppressed because it is too large
Load Diff
+685
@@ -0,0 +1,685 @@
|
||||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"apiVersion":"2017-11-27",
|
||||
"endpointPrefix":"comprehend",
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceFullName":"Amazon Comprehend",
|
||||
"serviceId":"Comprehend",
|
||||
"signatureVersion":"v4",
|
||||
"signingName":"comprehend",
|
||||
"targetPrefix":"Comprehend_20171127",
|
||||
"uid":"comprehend-2017-11-27"
|
||||
},
|
||||
"operations":{
|
||||
"BatchDetectDominantLanguage":{
|
||||
"name":"BatchDetectDominantLanguage",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"BatchDetectDominantLanguageRequest"},
|
||||
"output":{"shape":"BatchDetectDominantLanguageResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"TextSizeLimitExceededException"},
|
||||
{"shape":"BatchSizeLimitExceededException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"BatchDetectEntities":{
|
||||
"name":"BatchDetectEntities",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"BatchDetectEntitiesRequest"},
|
||||
"output":{"shape":"BatchDetectEntitiesResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"TextSizeLimitExceededException"},
|
||||
{"shape":"UnsupportedLanguageException"},
|
||||
{"shape":"BatchSizeLimitExceededException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"BatchDetectKeyPhrases":{
|
||||
"name":"BatchDetectKeyPhrases",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"BatchDetectKeyPhrasesRequest"},
|
||||
"output":{"shape":"BatchDetectKeyPhrasesResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"TextSizeLimitExceededException"},
|
||||
{"shape":"UnsupportedLanguageException"},
|
||||
{"shape":"BatchSizeLimitExceededException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"BatchDetectSentiment":{
|
||||
"name":"BatchDetectSentiment",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"BatchDetectSentimentRequest"},
|
||||
"output":{"shape":"BatchDetectSentimentResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"TextSizeLimitExceededException"},
|
||||
{"shape":"UnsupportedLanguageException"},
|
||||
{"shape":"BatchSizeLimitExceededException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"DescribeTopicsDetectionJob":{
|
||||
"name":"DescribeTopicsDetectionJob",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeTopicsDetectionJobRequest"},
|
||||
"output":{"shape":"DescribeTopicsDetectionJobResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"JobNotFoundException"},
|
||||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"DetectDominantLanguage":{
|
||||
"name":"DetectDominantLanguage",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DetectDominantLanguageRequest"},
|
||||
"output":{"shape":"DetectDominantLanguageResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"TextSizeLimitExceededException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"DetectEntities":{
|
||||
"name":"DetectEntities",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DetectEntitiesRequest"},
|
||||
"output":{"shape":"DetectEntitiesResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"TextSizeLimitExceededException"},
|
||||
{"shape":"UnsupportedLanguageException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"DetectKeyPhrases":{
|
||||
"name":"DetectKeyPhrases",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DetectKeyPhrasesRequest"},
|
||||
"output":{"shape":"DetectKeyPhrasesResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"TextSizeLimitExceededException"},
|
||||
{"shape":"UnsupportedLanguageException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"DetectSentiment":{
|
||||
"name":"DetectSentiment",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DetectSentimentRequest"},
|
||||
"output":{"shape":"DetectSentimentResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"TextSizeLimitExceededException"},
|
||||
{"shape":"UnsupportedLanguageException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"ListTopicsDetectionJobs":{
|
||||
"name":"ListTopicsDetectionJobs",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListTopicsDetectionJobsRequest"},
|
||||
"output":{"shape":"ListTopicsDetectionJobsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"InvalidFilterException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"StartTopicsDetectionJob":{
|
||||
"name":"StartTopicsDetectionJob",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StartTopicsDetectionJobRequest"},
|
||||
"output":{"shape":"StartTopicsDetectionJobResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AnyLengthString":{"type":"string"},
|
||||
"BatchDetectDominantLanguageItemResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Index":{"shape":"Integer"},
|
||||
"Languages":{"shape":"ListOfDominantLanguages"}
|
||||
}
|
||||
},
|
||||
"BatchDetectDominantLanguageRequest":{
|
||||
"type":"structure",
|
||||
"required":["TextList"],
|
||||
"members":{
|
||||
"TextList":{"shape":"StringList"}
|
||||
}
|
||||
},
|
||||
"BatchDetectDominantLanguageResponse":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResultList",
|
||||
"ErrorList"
|
||||
],
|
||||
"members":{
|
||||
"ResultList":{"shape":"ListOfDetectDominantLanguageResult"},
|
||||
"ErrorList":{"shape":"BatchItemErrorList"}
|
||||
}
|
||||
},
|
||||
"BatchDetectEntitiesItemResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Index":{"shape":"Integer"},
|
||||
"Entities":{"shape":"ListOfEntities"}
|
||||
}
|
||||
},
|
||||
"BatchDetectEntitiesRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"TextList",
|
||||
"LanguageCode"
|
||||
],
|
||||
"members":{
|
||||
"TextList":{"shape":"StringList"},
|
||||
"LanguageCode":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"BatchDetectEntitiesResponse":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResultList",
|
||||
"ErrorList"
|
||||
],
|
||||
"members":{
|
||||
"ResultList":{"shape":"ListOfDetectEntitiesResult"},
|
||||
"ErrorList":{"shape":"BatchItemErrorList"}
|
||||
}
|
||||
},
|
||||
"BatchDetectKeyPhrasesItemResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Index":{"shape":"Integer"},
|
||||
"KeyPhrases":{"shape":"ListOfKeyPhrases"}
|
||||
}
|
||||
},
|
||||
"BatchDetectKeyPhrasesRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"TextList",
|
||||
"LanguageCode"
|
||||
],
|
||||
"members":{
|
||||
"TextList":{"shape":"StringList"},
|
||||
"LanguageCode":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"BatchDetectKeyPhrasesResponse":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResultList",
|
||||
"ErrorList"
|
||||
],
|
||||
"members":{
|
||||
"ResultList":{"shape":"ListOfDetectKeyPhrasesResult"},
|
||||
"ErrorList":{"shape":"BatchItemErrorList"}
|
||||
}
|
||||
},
|
||||
"BatchDetectSentimentItemResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Index":{"shape":"Integer"},
|
||||
"Sentiment":{"shape":"SentimentType"},
|
||||
"SentimentScore":{"shape":"SentimentScore"}
|
||||
}
|
||||
},
|
||||
"BatchDetectSentimentRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"TextList",
|
||||
"LanguageCode"
|
||||
],
|
||||
"members":{
|
||||
"TextList":{"shape":"StringList"},
|
||||
"LanguageCode":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"BatchDetectSentimentResponse":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResultList",
|
||||
"ErrorList"
|
||||
],
|
||||
"members":{
|
||||
"ResultList":{"shape":"ListOfDetectSentimentResult"},
|
||||
"ErrorList":{"shape":"BatchItemErrorList"}
|
||||
}
|
||||
},
|
||||
"BatchItemError":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Index":{"shape":"Integer"},
|
||||
"ErrorCode":{"shape":"String"},
|
||||
"ErrorMessage":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"BatchItemErrorList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"BatchItemError"}
|
||||
},
|
||||
"BatchSizeLimitExceededException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ClientRequestTokenString":{
|
||||
"type":"string",
|
||||
"max":64,
|
||||
"min":1,
|
||||
"pattern":"^[a-zA-Z0-9-]+$"
|
||||
},
|
||||
"DescribeTopicsDetectionJobRequest":{
|
||||
"type":"structure",
|
||||
"required":["JobId"],
|
||||
"members":{
|
||||
"JobId":{"shape":"JobId"}
|
||||
}
|
||||
},
|
||||
"DescribeTopicsDetectionJobResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TopicsDetectionJobProperties":{"shape":"TopicsDetectionJobProperties"}
|
||||
}
|
||||
},
|
||||
"DetectDominantLanguageRequest":{
|
||||
"type":"structure",
|
||||
"required":["Text"],
|
||||
"members":{
|
||||
"Text":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DetectDominantLanguageResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Languages":{"shape":"ListOfDominantLanguages"}
|
||||
}
|
||||
},
|
||||
"DetectEntitiesRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Text",
|
||||
"LanguageCode"
|
||||
],
|
||||
"members":{
|
||||
"Text":{"shape":"String"},
|
||||
"LanguageCode":{"shape":"LanguageCode"}
|
||||
}
|
||||
},
|
||||
"DetectEntitiesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Entities":{"shape":"ListOfEntities"}
|
||||
}
|
||||
},
|
||||
"DetectKeyPhrasesRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Text",
|
||||
"LanguageCode"
|
||||
],
|
||||
"members":{
|
||||
"Text":{"shape":"String"},
|
||||
"LanguageCode":{"shape":"LanguageCode"}
|
||||
}
|
||||
},
|
||||
"DetectKeyPhrasesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"KeyPhrases":{"shape":"ListOfKeyPhrases"}
|
||||
}
|
||||
},
|
||||
"DetectSentimentRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Text",
|
||||
"LanguageCode"
|
||||
],
|
||||
"members":{
|
||||
"Text":{"shape":"String"},
|
||||
"LanguageCode":{"shape":"LanguageCode"}
|
||||
}
|
||||
},
|
||||
"DetectSentimentResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Sentiment":{"shape":"SentimentType"},
|
||||
"SentimentScore":{"shape":"SentimentScore"}
|
||||
}
|
||||
},
|
||||
"DominantLanguage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"LanguageCode":{"shape":"String"},
|
||||
"Score":{"shape":"Float"}
|
||||
}
|
||||
},
|
||||
"Entity":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Score":{"shape":"Float"},
|
||||
"Type":{"shape":"EntityType"},
|
||||
"Text":{"shape":"String"},
|
||||
"BeginOffset":{"shape":"Integer"},
|
||||
"EndOffset":{"shape":"Integer"}
|
||||
}
|
||||
},
|
||||
"EntityType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"PERSON",
|
||||
"LOCATION",
|
||||
"ORGANIZATION",
|
||||
"COMMERCIAL_ITEM",
|
||||
"EVENT",
|
||||
"DATE",
|
||||
"QUANTITY",
|
||||
"TITLE",
|
||||
"OTHER"
|
||||
]
|
||||
},
|
||||
"Float":{"type":"float"},
|
||||
"IamRoleArn":{
|
||||
"type":"string",
|
||||
"pattern":"arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+"
|
||||
},
|
||||
"InputDataConfig":{
|
||||
"type":"structure",
|
||||
"required":["S3Uri"],
|
||||
"members":{
|
||||
"S3Uri":{"shape":"S3Uri"},
|
||||
"InputFormat":{"shape":"InputFormat"}
|
||||
}
|
||||
},
|
||||
"InputFormat":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ONE_DOC_PER_FILE",
|
||||
"ONE_DOC_PER_LINE"
|
||||
]
|
||||
},
|
||||
"Integer":{"type":"integer"},
|
||||
"InternalServerException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"String"}
|
||||
},
|
||||
"exception":true,
|
||||
"fault":true
|
||||
},
|
||||
"InvalidFilterException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidRequestException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"JobId":{
|
||||
"type":"string",
|
||||
"max":32,
|
||||
"min":1
|
||||
},
|
||||
"JobName":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":1,
|
||||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$"
|
||||
},
|
||||
"JobNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"JobStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"SUBMITTED",
|
||||
"IN_PROGRESS",
|
||||
"COMPLETED",
|
||||
"FAILED"
|
||||
]
|
||||
},
|
||||
"KeyPhrase":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Score":{"shape":"Float"},
|
||||
"Text":{"shape":"String"},
|
||||
"BeginOffset":{"shape":"Integer"},
|
||||
"EndOffset":{"shape":"Integer"}
|
||||
}
|
||||
},
|
||||
"LanguageCode":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"en",
|
||||
"es"
|
||||
]
|
||||
},
|
||||
"ListOfDetectDominantLanguageResult":{
|
||||
"type":"list",
|
||||
"member":{"shape":"BatchDetectDominantLanguageItemResult"}
|
||||
},
|
||||
"ListOfDetectEntitiesResult":{
|
||||
"type":"list",
|
||||
"member":{"shape":"BatchDetectEntitiesItemResult"}
|
||||
},
|
||||
"ListOfDetectKeyPhrasesResult":{
|
||||
"type":"list",
|
||||
"member":{"shape":"BatchDetectKeyPhrasesItemResult"}
|
||||
},
|
||||
"ListOfDetectSentimentResult":{
|
||||
"type":"list",
|
||||
"member":{"shape":"BatchDetectSentimentItemResult"}
|
||||
},
|
||||
"ListOfDominantLanguages":{
|
||||
"type":"list",
|
||||
"member":{"shape":"DominantLanguage"}
|
||||
},
|
||||
"ListOfEntities":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Entity"}
|
||||
},
|
||||
"ListOfKeyPhrases":{
|
||||
"type":"list",
|
||||
"member":{"shape":"KeyPhrase"}
|
||||
},
|
||||
"ListTopicsDetectionJobsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Filter":{"shape":"TopicsDetectionJobFilter"},
|
||||
"NextToken":{"shape":"String"},
|
||||
"MaxResults":{"shape":"MaxResultsInteger"}
|
||||
}
|
||||
},
|
||||
"ListTopicsDetectionJobsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TopicsDetectionJobPropertiesList":{"shape":"TopicsDetectionJobPropertiesList"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"MaxResultsInteger":{
|
||||
"type":"integer",
|
||||
"max":500,
|
||||
"min":1
|
||||
},
|
||||
"NumberOfTopicsInteger":{
|
||||
"type":"integer",
|
||||
"max":100,
|
||||
"min":1
|
||||
},
|
||||
"OutputDataConfig":{
|
||||
"type":"structure",
|
||||
"required":["S3Uri"],
|
||||
"members":{
|
||||
"S3Uri":{"shape":"S3Uri"}
|
||||
}
|
||||
},
|
||||
"S3Uri":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
"pattern":"s3://([^/]+)(/.*)?"
|
||||
},
|
||||
"SentimentScore":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Positive":{"shape":"Float"},
|
||||
"Negative":{"shape":"Float"},
|
||||
"Neutral":{"shape":"Float"},
|
||||
"Mixed":{"shape":"Float"}
|
||||
}
|
||||
},
|
||||
"SentimentType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"POSITIVE",
|
||||
"NEGATIVE",
|
||||
"NEUTRAL",
|
||||
"MIXED"
|
||||
]
|
||||
},
|
||||
"StartTopicsDetectionJobRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"InputDataConfig",
|
||||
"OutputDataConfig",
|
||||
"DataAccessRoleArn"
|
||||
],
|
||||
"members":{
|
||||
"InputDataConfig":{"shape":"InputDataConfig"},
|
||||
"OutputDataConfig":{"shape":"OutputDataConfig"},
|
||||
"DataAccessRoleArn":{"shape":"IamRoleArn"},
|
||||
"JobName":{"shape":"JobName"},
|
||||
"NumberOfTopics":{"shape":"NumberOfTopicsInteger"},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestTokenString",
|
||||
"idempotencyToken":true
|
||||
}
|
||||
}
|
||||
},
|
||||
"StartTopicsDetectionJobResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"JobId":{"shape":"JobId"},
|
||||
"JobStatus":{"shape":"JobStatus"}
|
||||
}
|
||||
},
|
||||
"String":{
|
||||
"type":"string",
|
||||
"min":1
|
||||
},
|
||||
"StringList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"TextSizeLimitExceededException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"Timestamp":{"type":"timestamp"},
|
||||
"TooManyRequestsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"TopicsDetectionJobFilter":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"JobName":{"shape":"JobName"},
|
||||
"JobStatus":{"shape":"JobStatus"},
|
||||
"SubmitTimeBefore":{"shape":"Timestamp"},
|
||||
"SubmitTimeAfter":{"shape":"Timestamp"}
|
||||
}
|
||||
},
|
||||
"TopicsDetectionJobProperties":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"JobId":{"shape":"JobId"},
|
||||
"JobName":{"shape":"JobName"},
|
||||
"JobStatus":{"shape":"JobStatus"},
|
||||
"Message":{"shape":"AnyLengthString"},
|
||||
"SubmitTime":{"shape":"Timestamp"},
|
||||
"EndTime":{"shape":"Timestamp"},
|
||||
"InputDataConfig":{"shape":"InputDataConfig"},
|
||||
"OutputDataConfig":{"shape":"OutputDataConfig"},
|
||||
"NumberOfTopics":{"shape":"Integer"}
|
||||
}
|
||||
},
|
||||
"TopicsDetectionJobPropertiesList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"TopicsDetectionJobProperties"}
|
||||
},
|
||||
"UnsupportedLanguageException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
}
|
||||
}
|
||||
}
|
||||
+472
@@ -0,0 +1,472 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<p>Amazon Comprehend is an AWS service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.</p>",
|
||||
"operations": {
|
||||
"BatchDetectDominantLanguage": "<p>Determines the dominant language of the input text for a batch of documents. For a list of languages that Amazon Comprehend can detect, see <a href=\"http://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html\">Amazon Comprehend Supported Languages</a>. </p>",
|
||||
"BatchDetectEntities": "<p>Inspects the text of a batch of documents and returns information about them. For more information about entities, see <a>how-entities</a> </p>",
|
||||
"BatchDetectKeyPhrases": "<p>Detects the key noun phrases found in a batch of documents.</p>",
|
||||
"BatchDetectSentiment": "<p>Inspects a batch of documents and returns an inference of the prevailing sentiment, <code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>, in each one.</p>",
|
||||
"DescribeTopicsDetectionJob": "<p>Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.</p>",
|
||||
"DetectDominantLanguage": "<p>Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see <a href=\"http://docs.aws.amazon.com/comprehend/latest/dg/how-languages.html\">Amazon Comprehend Supported Languages</a>. </p>",
|
||||
"DetectEntities": "<p>Inspects text for entities, and returns information about them. For more information, about entities, see <a>how-entities</a>. </p>",
|
||||
"DetectKeyPhrases": "<p>Detects the key noun phrases found in the text. </p>",
|
||||
"DetectSentiment": "<p>Inspects text and returns an inference of the prevailing sentiment (<code>POSITIVE</code>, <code>NEUTRAL</code>, <code>MIXED</code>, or <code>NEGATIVE</code>). </p>",
|
||||
"ListTopicsDetectionJobs": "<p>Gets a list of the topic detection jobs that you have submitted.</p>",
|
||||
"StartTopicsDetectionJob": "<p>Starts an asynchronous topic detection job. Use the <code>DescribeTopicDetectionJob</code> operation to track the status of a job.</p>"
|
||||
},
|
||||
"shapes": {
|
||||
"AnyLengthString": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"TopicsDetectionJobProperties$Message": "<p>A description for the status of a job.</p>"
|
||||
}
|
||||
},
|
||||
"BatchDetectDominantLanguageItemResult": {
|
||||
"base": "<p>The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.</p>",
|
||||
"refs": {
|
||||
"ListOfDetectDominantLanguageResult$member": null
|
||||
}
|
||||
},
|
||||
"BatchDetectDominantLanguageRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"BatchDetectDominantLanguageResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"BatchDetectEntitiesItemResult": {
|
||||
"base": "<p>The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.</p>",
|
||||
"refs": {
|
||||
"ListOfDetectEntitiesResult$member": null
|
||||
}
|
||||
},
|
||||
"BatchDetectEntitiesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"BatchDetectEntitiesResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"BatchDetectKeyPhrasesItemResult": {
|
||||
"base": "<p>The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.</p>",
|
||||
"refs": {
|
||||
"ListOfDetectKeyPhrasesResult$member": null
|
||||
}
|
||||
},
|
||||
"BatchDetectKeyPhrasesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"BatchDetectKeyPhrasesResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"BatchDetectSentimentItemResult": {
|
||||
"base": "<p>The result of calling the operation. The operation returns one object for each document that is successfully processed by the operation.</p>",
|
||||
"refs": {
|
||||
"ListOfDetectSentimentResult$member": null
|
||||
}
|
||||
},
|
||||
"BatchDetectSentimentRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"BatchDetectSentimentResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"BatchItemError": {
|
||||
"base": "<p>Describes an error that occurred while processing a document in a batch. The operation returns on <code>BatchItemError</code> object for each document that contained an error.</p>",
|
||||
"refs": {
|
||||
"BatchItemErrorList$member": null
|
||||
}
|
||||
},
|
||||
"BatchItemErrorList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchDetectDominantLanguageResponse$ErrorList": "<p>A list containing one object for each document that contained an error. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If there are no errors in the batch, the <code>ErrorList</code> is empty.</p>",
|
||||
"BatchDetectEntitiesResponse$ErrorList": "<p>A list containing one object for each document that contained an error. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If there are no errors in the batch, the <code>ErrorList</code> is empty.</p>",
|
||||
"BatchDetectKeyPhrasesResponse$ErrorList": "<p>A list containing one object for each document that contained an error. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If there are no errors in the batch, the <code>ErrorList</code> is empty.</p>",
|
||||
"BatchDetectSentimentResponse$ErrorList": "<p>A list containing one object for each document that contained an error. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If there are no errors in the batch, the <code>ErrorList</code> is empty.</p>"
|
||||
}
|
||||
},
|
||||
"BatchSizeLimitExceededException": {
|
||||
"base": "<p>The number of documents in the request exceeds the limit of 25. Try your request again with fewer documents.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ClientRequestTokenString": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StartTopicsDetectionJobRequest$ClientRequestToken": "<p>A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeTopicsDetectionJobRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeTopicsDetectionJobResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DetectDominantLanguageRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DetectDominantLanguageResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DetectEntitiesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DetectEntitiesResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DetectKeyPhrasesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DetectKeyPhrasesResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DetectSentimentRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DetectSentimentResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DominantLanguage": {
|
||||
"base": "<p>Returns the code for the dominant language in the input text and the level of confidence that Amazon Comprehend has in the accuracy of the detection.</p>",
|
||||
"refs": {
|
||||
"ListOfDominantLanguages$member": null
|
||||
}
|
||||
},
|
||||
"Entity": {
|
||||
"base": "<p>Provides information about an entity. </p> <p> </p>",
|
||||
"refs": {
|
||||
"ListOfEntities$member": null
|
||||
}
|
||||
},
|
||||
"EntityType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Entity$Type": "<p>The entity's type.</p>"
|
||||
}
|
||||
},
|
||||
"Float": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DominantLanguage$Score": "<p>The level of confidence that Amazon Comprehend has in the accuracy of the detection.</p>",
|
||||
"Entity$Score": "<p>The level of confidence that Amazon Comprehend has in the accuracy of the detection.</p>",
|
||||
"KeyPhrase$Score": "<p>The level of confidence that Amazon Comprehend has in the accuracy of the detection.</p>",
|
||||
"SentimentScore$Positive": "<p>The level of confidence that Amazon Comprehend has in the accuracy of its detection of the <code>POSITIVE</code> sentiment.</p>",
|
||||
"SentimentScore$Negative": "<p>The level of confidence that Amazon Comprehend has in the accuracy of its detection of the <code>NEGATIVE</code> sentiment.</p>",
|
||||
"SentimentScore$Neutral": "<p>The level of confidence that Amazon Comprehend has in the accuracy of its detection of the <code>NEUTRAL</code> sentiment.</p>",
|
||||
"SentimentScore$Mixed": "<p>The level of confidence that Amazon Comprehend has in the accuracy of its detection of the <code>MIXED</code> sentiment.</p>"
|
||||
}
|
||||
},
|
||||
"IamRoleArn": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StartTopicsDetectionJobRequest$DataAccessRoleArn": "<p>The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. </p>"
|
||||
}
|
||||
},
|
||||
"InputDataConfig": {
|
||||
"base": "<p>The input properties for a topic detection job.</p>",
|
||||
"refs": {
|
||||
"StartTopicsDetectionJobRequest$InputDataConfig": "<p>Specifies the format and location of the input data for the job.</p>",
|
||||
"TopicsDetectionJobProperties$InputDataConfig": "<p>The input data configuration supplied when you created the topic detection job.</p>"
|
||||
}
|
||||
},
|
||||
"InputFormat": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"InputDataConfig$InputFormat": "<p>Specifies how the text in an input file should be processed:</p> <ul> <li> <p> <code>ONE_DOC_PER_FILE</code> - Each file is considered a separate document. Use this option when you are processing large documents, such as newspaper articles or scientific papers.</p> </li> <li> <p> <code>ONE_DOC_PER_LINE</code> - Each line in a file is considered a separate document. Use this option when you are processing many short documents, such as text messages.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"Integer": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchDetectDominantLanguageItemResult$Index": "<p>The zero-based index of the document in the input list.</p>",
|
||||
"BatchDetectEntitiesItemResult$Index": "<p>The zero-based index of the document in the input list.</p>",
|
||||
"BatchDetectKeyPhrasesItemResult$Index": "<p>The zero-based index of the document in the input list.</p>",
|
||||
"BatchDetectSentimentItemResult$Index": "<p>The zero-based index of the document in the input list.</p>",
|
||||
"BatchItemError$Index": "<p>The zero-based index of the document in the input list.</p>",
|
||||
"Entity$BeginOffset": "<p>A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A <i>code point</i> is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.</p>",
|
||||
"Entity$EndOffset": "<p>A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A <i>code point</i> is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point. </p>",
|
||||
"KeyPhrase$BeginOffset": "<p>A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A <i>code point</i> is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.</p>",
|
||||
"KeyPhrase$EndOffset": "<p>A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A <code>code point</code> is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.</p>",
|
||||
"TopicsDetectionJobProperties$NumberOfTopics": "<p>The number of topics to detect supplied when you created the topic detection job. The default is 10. </p>"
|
||||
}
|
||||
},
|
||||
"InternalServerException": {
|
||||
"base": "<p>An internal server error occurred. Retry your request.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidFilterException": {
|
||||
"base": "<p>The filter specified for the <code>ListTopicDetectionJobs</code> operation is invalid. Specify a different filter.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidRequestException": {
|
||||
"base": "<p>The request is invalid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"JobId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeTopicsDetectionJobRequest$JobId": "<p>The identifier assigned by the user to the detection job.</p>",
|
||||
"StartTopicsDetectionJobResponse$JobId": "<p>The identifier generated for the job. To get the status of the job, use this identifier with the <code>DescribeTopicDetectionJob</code> operation.</p>",
|
||||
"TopicsDetectionJobProperties$JobId": "<p>The identifier assigned to the topic detection job.</p>"
|
||||
}
|
||||
},
|
||||
"JobName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StartTopicsDetectionJobRequest$JobName": "<p>The identifier of the job.</p>",
|
||||
"TopicsDetectionJobFilter$JobName": "<p/>",
|
||||
"TopicsDetectionJobProperties$JobName": "<p>The name of the topic detection job.</p>"
|
||||
}
|
||||
},
|
||||
"JobNotFoundException": {
|
||||
"base": "<p>The specified job was not found. Check the job ID and try again.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"JobStatus": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StartTopicsDetectionJobResponse$JobStatus": "<p>The status of the job: </p> <ul> <li> <p>SUBMITTED - The job has been received and is queued for processing.</p> </li> <li> <p>IN_PROGRESS - Amazon Comprehend is processing the job.</p> </li> <li> <p>COMPLETED - The job was successfully completed and the output is available.</p> </li> <li> <p>FAILED - The job did not complete. To get details, use the <code>DescribeTopicDetectionJob</code> operation.</p> </li> </ul>",
|
||||
"TopicsDetectionJobFilter$JobStatus": "<p>Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.</p>",
|
||||
"TopicsDetectionJobProperties$JobStatus": "<p>The current status of the topic detection job. If the status is <code>Failed</code>, the reason for the failure is shown in the <code>Message</code> field.</p>"
|
||||
}
|
||||
},
|
||||
"KeyPhrase": {
|
||||
"base": "<p>Describes a key noun phrase.</p>",
|
||||
"refs": {
|
||||
"ListOfKeyPhrases$member": null
|
||||
}
|
||||
},
|
||||
"LanguageCode": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DetectEntitiesRequest$LanguageCode": "<p>The RFC 5646 language code of the input text. If the request does not specify the language code, the service detects the dominant language. If you specify a language code that the service does not support, it returns <code>UnsupportedLanguageException</code> exception. For more information about RFC 5646, see <a href=\"https://tools.ietf.org/html/rfc5646\">Tags for Identifying Languages</a> on the <i>IETF Tools</i> web site. </p>",
|
||||
"DetectKeyPhrasesRequest$LanguageCode": "<p>The RFC 5646 language code for the input text. If you don't specify a language code, Amazon Comprehend detects the dominant language. If you specify the code for a language that Amazon Comprehend does not support, it returns and <code>UnsupportedLanguageException</code>. For more information about RFC 5646, see <a href=\"https://tools.ietf.org/html/rfc5646\">Tags for Identifying Languages</a> on the <i>IETF Tools</i> web site.</p>",
|
||||
"DetectSentimentRequest$LanguageCode": "<p>The RFC 5646 language code for the input text. If you don't specify a language code, Amazon Comprehend detects the dominant language. If you specify the code for a language that Amazon Comprehend does not support, it returns and <code>UnsupportedLanguageException</code>. For more information about RFC 5646, see <a href=\"https://tools.ietf.org/html/rfc5646\">Tags for Identifying Languages</a> on the <i>IETF Tools</i> web site.</p>"
|
||||
}
|
||||
},
|
||||
"ListOfDetectDominantLanguageResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchDetectDominantLanguageResponse$ResultList": "<p>A list of objects containing the results of the operation. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If all of the documents contain an error, the <code>ResultList</code> is empty.</p>"
|
||||
}
|
||||
},
|
||||
"ListOfDetectEntitiesResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchDetectEntitiesResponse$ResultList": "<p>A list of objects containing the results of the operation. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If all of the documents contain an error, the <code>ResultList</code> is empty.</p>"
|
||||
}
|
||||
},
|
||||
"ListOfDetectKeyPhrasesResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchDetectKeyPhrasesResponse$ResultList": "<p>A list of objects containing the results of the operation. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If all of the documents contain an error, the <code>ResultList</code> is empty.</p>"
|
||||
}
|
||||
},
|
||||
"ListOfDetectSentimentResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchDetectSentimentResponse$ResultList": "<p>A list of objects containing the results of the operation. The results are sorted in ascending order by the <code>Index</code> field and match the order of the documents in the input list. If all of the documents contain an error, the <code>ResultList</code> is empty.</p>"
|
||||
}
|
||||
},
|
||||
"ListOfDominantLanguages": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchDetectDominantLanguageItemResult$Languages": "<p>One or more <a>DominantLanguage</a> objects describing the dominant languages in the document.</p>",
|
||||
"DetectDominantLanguageResponse$Languages": "<p>The languages that Amazon Comprehend detected in the input text. For each language, the response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend has in the accuracy of its inference. For more information about RFC 5646, see <a href=\"https://tools.ietf.org/html/rfc5646\">Tags for Identifying Languages</a> on the <i>IETF Tools</i> web site.</p>"
|
||||
}
|
||||
},
|
||||
"ListOfEntities": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchDetectEntitiesItemResult$Entities": "<p>One or more <a>Entity</a> objects, one for each entity detected in the document.</p>",
|
||||
"DetectEntitiesResponse$Entities": "<p>A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection. For a list of entity types, see <a>how-entities</a>. </p>"
|
||||
}
|
||||
},
|
||||
"ListOfKeyPhrases": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchDetectKeyPhrasesItemResult$KeyPhrases": "<p>One or more <a>KeyPhrase</a> objects, one for each key phrase detected in the document.</p>",
|
||||
"DetectKeyPhrasesResponse$KeyPhrases": "<p>A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection. </p>"
|
||||
}
|
||||
},
|
||||
"ListTopicsDetectionJobsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListTopicsDetectionJobsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"MaxResultsInteger": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListTopicsDetectionJobsRequest$MaxResults": "<p>The maximum number of results to return in each page.</p>"
|
||||
}
|
||||
},
|
||||
"NumberOfTopicsInteger": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StartTopicsDetectionJobRequest$NumberOfTopics": "<p>The number of topics to detect.</p>"
|
||||
}
|
||||
},
|
||||
"OutputDataConfig": {
|
||||
"base": "<p>Provides configuration parameters for the output of topic detection jobs.</p> <p/>",
|
||||
"refs": {
|
||||
"StartTopicsDetectionJobRequest$OutputDataConfig": "<p>Specifies where to send the output files.</p>",
|
||||
"TopicsDetectionJobProperties$OutputDataConfig": "<p>The output data configuration supplied when you created the topic detection job.</p>"
|
||||
}
|
||||
},
|
||||
"S3Uri": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"InputDataConfig$S3Uri": "<p>The Amazon S3 URI for the input data. The URI must be in same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files. </p> <p>For example, if you use the URI <code>S3://bucketName/prefix</code>, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.</p>",
|
||||
"OutputDataConfig$S3Uri": "<p>The Amazon S3 URI where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. </p> <p>The service creates an output file called <code>output.tar.gz</code>. It is a compressed archive that contains two files, <code>topic-terms.csv</code> that lists the terms associated with each topic, and <code>doc-topics.csv</code> that lists the documents associated with each topic. For more information, see <a>topic-modeling</a>.</p>"
|
||||
}
|
||||
},
|
||||
"SentimentScore": {
|
||||
"base": "<p>Describes the level of confidence that Amazon Comprehend has in the accuracy of its detection of sentiments.</p>",
|
||||
"refs": {
|
||||
"BatchDetectSentimentItemResult$SentimentScore": "<p>The level of confidence that Amazon Comprehend has in the accuracy of its sentiment detection.</p>",
|
||||
"DetectSentimentResponse$SentimentScore": "<p>An object that lists the sentiments, and their corresponding confidence levels.</p>"
|
||||
}
|
||||
},
|
||||
"SentimentType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchDetectSentimentItemResult$Sentiment": "<p>The sentiment detected in the document.</p>",
|
||||
"DetectSentimentResponse$Sentiment": "<p>The inferred sentiment that Amazon Comprehend has the highest level of confidence in.</p>"
|
||||
}
|
||||
},
|
||||
"StartTopicsDetectionJobRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"StartTopicsDetectionJobResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"String": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchDetectEntitiesRequest$LanguageCode": "<p>The language of the input documents. All documents must be in the same language.</p>",
|
||||
"BatchDetectKeyPhrasesRequest$LanguageCode": "<p>The language of the input documents. All documents must be in the same language.</p>",
|
||||
"BatchDetectSentimentRequest$LanguageCode": "<p>The language of the input documents. All documents must be in the same language.</p>",
|
||||
"BatchItemError$ErrorCode": "<p>The numeric error code of the error.</p>",
|
||||
"BatchItemError$ErrorMessage": "<p>A text description of the error.</p>",
|
||||
"BatchSizeLimitExceededException$Message": null,
|
||||
"DetectDominantLanguageRequest$Text": "<p>A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>",
|
||||
"DetectEntitiesRequest$Text": "<p>A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>",
|
||||
"DetectKeyPhrasesRequest$Text": "<p>A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>",
|
||||
"DetectSentimentRequest$Text": "<p>A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>",
|
||||
"DominantLanguage$LanguageCode": "<p>The RFC 5646 language code for the dominant language. </p>",
|
||||
"Entity$Text": "<p>The text of the entity.</p>",
|
||||
"InternalServerException$Message": null,
|
||||
"InvalidFilterException$Message": null,
|
||||
"InvalidRequestException$Message": null,
|
||||
"JobNotFoundException$Message": null,
|
||||
"KeyPhrase$Text": "<p>The text of a key noun phrase.</p>",
|
||||
"ListTopicsDetectionJobsRequest$NextToken": "<p>Identifies the next page of results to return.</p>",
|
||||
"ListTopicsDetectionJobsResponse$NextToken": "<p>Identifies the next page of results to return.</p>",
|
||||
"StringList$member": null,
|
||||
"TextSizeLimitExceededException$Message": null,
|
||||
"TooManyRequestsException$Message": null,
|
||||
"UnsupportedLanguageException$Message": null
|
||||
}
|
||||
},
|
||||
"StringList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchDetectDominantLanguageRequest$TextList": "<p>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters and must contain fewer than 5,000 bytes of UTF-8 encoded characters.</p>",
|
||||
"BatchDetectEntitiesRequest$TextList": "<p>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.</p>",
|
||||
"BatchDetectKeyPhrasesRequest$TextList": "<p>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>",
|
||||
"BatchDetectSentimentRequest$TextList": "<p>A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.</p>"
|
||||
}
|
||||
},
|
||||
"TextSizeLimitExceededException": {
|
||||
"base": "<p>The size of the input text exceeds the limit. Use a smaller document.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Timestamp": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"TopicsDetectionJobFilter$SubmitTimeBefore": "<p>Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.</p>",
|
||||
"TopicsDetectionJobFilter$SubmitTimeAfter": "<p>Filters the list of jobs based on the time that the job was submitted for processing. Only returns jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.</p>",
|
||||
"TopicsDetectionJobProperties$SubmitTime": "<p>The time that the topic detection job was submitted for processing.</p>",
|
||||
"TopicsDetectionJobProperties$EndTime": "<p>The time that the topic detection job was completed.</p>"
|
||||
}
|
||||
},
|
||||
"TooManyRequestsException": {
|
||||
"base": "<p>The number of requests exceeds the limit. Resubmit your request later.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"TopicsDetectionJobFilter": {
|
||||
"base": "<p>Provides information for filtering topic detection jobs. For more information, see .</p>",
|
||||
"refs": {
|
||||
"ListTopicsDetectionJobsRequest$Filter": "<p>Filters the jobs that are returned. Jobs can be filtered on their name, status, or the date and time that they were submitted. You can set only one filter at a time.</p>"
|
||||
}
|
||||
},
|
||||
"TopicsDetectionJobProperties": {
|
||||
"base": "<p>Provides information about a topic detection job.</p>",
|
||||
"refs": {
|
||||
"DescribeTopicsDetectionJobResponse$TopicsDetectionJobProperties": "<p>The list of properties for the requested job.</p>",
|
||||
"TopicsDetectionJobPropertiesList$member": null
|
||||
}
|
||||
},
|
||||
"TopicsDetectionJobPropertiesList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListTopicsDetectionJobsResponse$TopicsDetectionJobPropertiesList": "<p>A list containing the properties of each job that is returned.</p>"
|
||||
}
|
||||
},
|
||||
"UnsupportedLanguageException": {
|
||||
"base": "<p>Amazon Comprehend can't process the language of the input text. For all APIs except <code>DetectDominantLanguage</code>, Amazon Comprehend accepts only English or Spanish text. For the <code>DetectDominantLanguage</code> API, Amazon Comprehend detects 100 languages. For a list of languages, see <a>how-languages</a> </p>",
|
||||
"refs": {
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+5
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+9
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"pagination": {
|
||||
"ListTopicsDetectionJobs": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
}
|
||||
}
|
||||
}
|
||||
+666
-7
@@ -7,11 +7,36 @@
|
||||
"protocol":"json",
|
||||
"serviceAbbreviation":"Config Service",
|
||||
"serviceFullName":"AWS Config",
|
||||
"serviceId":"Config Service",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"StarlingDoveService",
|
||||
"uid":"config-2014-11-12"
|
||||
},
|
||||
"operations":{
|
||||
"BatchGetResourceConfig":{
|
||||
"name":"BatchGetResourceConfig",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"BatchGetResourceConfigRequest"},
|
||||
"output":{"shape":"BatchGetResourceConfigResponse"},
|
||||
"errors":[
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"NoAvailableConfigurationRecorderException"}
|
||||
]
|
||||
},
|
||||
"DeleteAggregationAuthorization":{
|
||||
"name":"DeleteAggregationAuthorization",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteAggregationAuthorizationRequest"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterValueException"}
|
||||
]
|
||||
},
|
||||
"DeleteConfigRule":{
|
||||
"name":"DeleteConfigRule",
|
||||
"http":{
|
||||
@@ -24,6 +49,17 @@
|
||||
{"shape":"ResourceInUseException"}
|
||||
]
|
||||
},
|
||||
"DeleteConfigurationAggregator":{
|
||||
"name":"DeleteConfigurationAggregator",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteConfigurationAggregatorRequest"},
|
||||
"errors":[
|
||||
{"shape":"NoSuchConfigurationAggregatorException"}
|
||||
]
|
||||
},
|
||||
"DeleteConfigurationRecorder":{
|
||||
"name":"DeleteConfigurationRecorder",
|
||||
"http":{
|
||||
@@ -60,6 +96,17 @@
|
||||
{"shape":"ResourceInUseException"}
|
||||
]
|
||||
},
|
||||
"DeletePendingAggregationRequest":{
|
||||
"name":"DeletePendingAggregationRequest",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeletePendingAggregationRequestRequest"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterValueException"}
|
||||
]
|
||||
},
|
||||
"DeliverConfigSnapshot":{
|
||||
"name":"DeliverConfigSnapshot",
|
||||
"http":{
|
||||
@@ -74,6 +121,35 @@
|
||||
{"shape":"NoRunningConfigurationRecorderException"}
|
||||
]
|
||||
},
|
||||
"DescribeAggregateComplianceByConfigRules":{
|
||||
"name":"DescribeAggregateComplianceByConfigRules",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeAggregateComplianceByConfigRulesRequest"},
|
||||
"output":{"shape":"DescribeAggregateComplianceByConfigRulesResponse"},
|
||||
"errors":[
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InvalidLimitException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"NoSuchConfigurationAggregatorException"}
|
||||
]
|
||||
},
|
||||
"DescribeAggregationAuthorizations":{
|
||||
"name":"DescribeAggregationAuthorizations",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeAggregationAuthorizationsRequest"},
|
||||
"output":{"shape":"DescribeAggregationAuthorizationsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"InvalidLimitException"}
|
||||
]
|
||||
},
|
||||
"DescribeComplianceByConfigRule":{
|
||||
"name":"DescribeComplianceByConfigRule",
|
||||
"http":{
|
||||
@@ -128,6 +204,36 @@
|
||||
{"shape":"InvalidNextTokenException"}
|
||||
]
|
||||
},
|
||||
"DescribeConfigurationAggregatorSourcesStatus":{
|
||||
"name":"DescribeConfigurationAggregatorSourcesStatus",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeConfigurationAggregatorSourcesStatusRequest"},
|
||||
"output":{"shape":"DescribeConfigurationAggregatorSourcesStatusResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"NoSuchConfigurationAggregatorException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"InvalidLimitException"}
|
||||
]
|
||||
},
|
||||
"DescribeConfigurationAggregators":{
|
||||
"name":"DescribeConfigurationAggregators",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeConfigurationAggregatorsRequest"},
|
||||
"output":{"shape":"DescribeConfigurationAggregatorsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"NoSuchConfigurationAggregatorException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"InvalidLimitException"}
|
||||
]
|
||||
},
|
||||
"DescribeConfigurationRecorderStatus":{
|
||||
"name":"DescribeConfigurationRecorderStatus",
|
||||
"http":{
|
||||
@@ -176,6 +282,50 @@
|
||||
{"shape":"NoSuchDeliveryChannelException"}
|
||||
]
|
||||
},
|
||||
"DescribePendingAggregationRequests":{
|
||||
"name":"DescribePendingAggregationRequests",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribePendingAggregationRequestsRequest"},
|
||||
"output":{"shape":"DescribePendingAggregationRequestsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"InvalidLimitException"}
|
||||
]
|
||||
},
|
||||
"GetAggregateComplianceDetailsByConfigRule":{
|
||||
"name":"GetAggregateComplianceDetailsByConfigRule",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetAggregateComplianceDetailsByConfigRuleRequest"},
|
||||
"output":{"shape":"GetAggregateComplianceDetailsByConfigRuleResponse"},
|
||||
"errors":[
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InvalidLimitException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"NoSuchConfigurationAggregatorException"}
|
||||
]
|
||||
},
|
||||
"GetAggregateConfigRuleComplianceSummary":{
|
||||
"name":"GetAggregateConfigRuleComplianceSummary",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetAggregateConfigRuleComplianceSummaryRequest"},
|
||||
"output":{"shape":"GetAggregateConfigRuleComplianceSummaryResponse"},
|
||||
"errors":[
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InvalidLimitException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"NoSuchConfigurationAggregatorException"}
|
||||
]
|
||||
},
|
||||
"GetComplianceDetailsByConfigRule":{
|
||||
"name":"GetComplianceDetailsByConfigRule",
|
||||
"http":{
|
||||
@@ -268,6 +418,18 @@
|
||||
{"shape":"NoAvailableConfigurationRecorderException"}
|
||||
]
|
||||
},
|
||||
"PutAggregationAuthorization":{
|
||||
"name":"PutAggregationAuthorization",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"PutAggregationAuthorizationRequest"},
|
||||
"output":{"shape":"PutAggregationAuthorizationResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterValueException"}
|
||||
]
|
||||
},
|
||||
"PutConfigRule":{
|
||||
"name":"PutConfigRule",
|
||||
"http":{
|
||||
@@ -283,6 +445,23 @@
|
||||
{"shape":"NoAvailableConfigurationRecorderException"}
|
||||
]
|
||||
},
|
||||
"PutConfigurationAggregator":{
|
||||
"name":"PutConfigurationAggregator",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"PutConfigurationAggregatorRequest"},
|
||||
"output":{"shape":"PutConfigurationAggregatorResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidRoleException"},
|
||||
{"shape":"OrganizationAccessDeniedException"},
|
||||
{"shape":"NoAvailableOrganizationException"},
|
||||
{"shape":"OrganizationAllFeaturesNotEnabledException"}
|
||||
]
|
||||
},
|
||||
"PutConfigurationRecorder":{
|
||||
"name":"PutConfigurationRecorder",
|
||||
"http":{
|
||||
@@ -369,15 +548,173 @@
|
||||
},
|
||||
"shapes":{
|
||||
"ARN":{"type":"string"},
|
||||
"AccountId":{"type":"string"},
|
||||
"AccountAggregationSource":{
|
||||
"type":"structure",
|
||||
"required":["AccountIds"],
|
||||
"members":{
|
||||
"AccountIds":{"shape":"AccountAggregationSourceAccountList"},
|
||||
"AllAwsRegions":{"shape":"Boolean"},
|
||||
"AwsRegions":{"shape":"AggregatorRegionList"}
|
||||
}
|
||||
},
|
||||
"AccountAggregationSourceAccountList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AccountId"},
|
||||
"min":1
|
||||
},
|
||||
"AccountAggregationSourceList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AccountAggregationSource"},
|
||||
"max":1,
|
||||
"min":0
|
||||
},
|
||||
"AccountId":{
|
||||
"type":"string",
|
||||
"pattern":"\\d{12}"
|
||||
},
|
||||
"AggregateComplianceByConfigRule":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ConfigRuleName":{"shape":"ConfigRuleName"},
|
||||
"Compliance":{"shape":"Compliance"},
|
||||
"AccountId":{"shape":"AccountId"},
|
||||
"AwsRegion":{"shape":"AwsRegion"}
|
||||
}
|
||||
},
|
||||
"AggregateComplianceByConfigRuleList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AggregateComplianceByConfigRule"}
|
||||
},
|
||||
"AggregateComplianceCount":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"GroupName":{"shape":"StringWithCharLimit256"},
|
||||
"ComplianceSummary":{"shape":"ComplianceSummary"}
|
||||
}
|
||||
},
|
||||
"AggregateComplianceCountList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AggregateComplianceCount"}
|
||||
},
|
||||
"AggregateEvaluationResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"EvaluationResultIdentifier":{"shape":"EvaluationResultIdentifier"},
|
||||
"ComplianceType":{"shape":"ComplianceType"},
|
||||
"ResultRecordedTime":{"shape":"Date"},
|
||||
"ConfigRuleInvokedTime":{"shape":"Date"},
|
||||
"Annotation":{"shape":"StringWithCharLimit256"},
|
||||
"AccountId":{"shape":"AccountId"},
|
||||
"AwsRegion":{"shape":"AwsRegion"}
|
||||
}
|
||||
},
|
||||
"AggregateEvaluationResultList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AggregateEvaluationResult"}
|
||||
},
|
||||
"AggregatedSourceStatus":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SourceId":{"shape":"String"},
|
||||
"SourceType":{"shape":"AggregatedSourceType"},
|
||||
"AwsRegion":{"shape":"AwsRegion"},
|
||||
"LastUpdateStatus":{"shape":"AggregatedSourceStatusType"},
|
||||
"LastUpdateTime":{"shape":"Date"},
|
||||
"LastErrorCode":{"shape":"String"},
|
||||
"LastErrorMessage":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"AggregatedSourceStatusList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AggregatedSourceStatus"}
|
||||
},
|
||||
"AggregatedSourceStatusType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"FAILED",
|
||||
"SUCCEEDED",
|
||||
"OUTDATED"
|
||||
]
|
||||
},
|
||||
"AggregatedSourceStatusTypeList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AggregatedSourceStatusType"},
|
||||
"min":1
|
||||
},
|
||||
"AggregatedSourceType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ACCOUNT",
|
||||
"ORGANIZATION"
|
||||
]
|
||||
},
|
||||
"AggregationAuthorization":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AggregationAuthorizationArn":{"shape":"String"},
|
||||
"AuthorizedAccountId":{"shape":"AccountId"},
|
||||
"AuthorizedAwsRegion":{"shape":"AwsRegion"},
|
||||
"CreationTime":{"shape":"Date"}
|
||||
}
|
||||
},
|
||||
"AggregationAuthorizationList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AggregationAuthorization"}
|
||||
},
|
||||
"AggregatorRegionList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"},
|
||||
"min":1
|
||||
},
|
||||
"AllSupported":{"type":"boolean"},
|
||||
"AvailabilityZone":{"type":"string"},
|
||||
"AwsRegion":{"type":"string"},
|
||||
"AwsRegion":{
|
||||
"type":"string",
|
||||
"max":64,
|
||||
"min":1
|
||||
},
|
||||
"BaseConfigurationItem":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"version":{"shape":"Version"},
|
||||
"accountId":{"shape":"AccountId"},
|
||||
"configurationItemCaptureTime":{"shape":"ConfigurationItemCaptureTime"},
|
||||
"configurationItemStatus":{"shape":"ConfigurationItemStatus"},
|
||||
"configurationStateId":{"shape":"ConfigurationStateId"},
|
||||
"arn":{"shape":"ARN"},
|
||||
"resourceType":{"shape":"ResourceType"},
|
||||
"resourceId":{"shape":"ResourceId"},
|
||||
"resourceName":{"shape":"ResourceName"},
|
||||
"awsRegion":{"shape":"AwsRegion"},
|
||||
"availabilityZone":{"shape":"AvailabilityZone"},
|
||||
"resourceCreationTime":{"shape":"ResourceCreationTime"},
|
||||
"configuration":{"shape":"Configuration"},
|
||||
"supplementaryConfiguration":{"shape":"SupplementaryConfiguration"}
|
||||
}
|
||||
},
|
||||
"BaseConfigurationItems":{
|
||||
"type":"list",
|
||||
"member":{"shape":"BaseConfigurationItem"}
|
||||
},
|
||||
"BaseResourceId":{
|
||||
"type":"string",
|
||||
"max":768,
|
||||
"min":1
|
||||
},
|
||||
"BatchGetResourceConfigRequest":{
|
||||
"type":"structure",
|
||||
"required":["resourceKeys"],
|
||||
"members":{
|
||||
"resourceKeys":{"shape":"ResourceKeys"}
|
||||
}
|
||||
},
|
||||
"BatchGetResourceConfigResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"baseConfigurationItems":{"shape":"BaseConfigurationItems"},
|
||||
"unprocessedResourceKeys":{"shape":"ResourceKeys"}
|
||||
}
|
||||
},
|
||||
"Boolean":{"type":"boolean"},
|
||||
"ChannelName":{
|
||||
"type":"string",
|
||||
@@ -494,6 +831,29 @@
|
||||
"ConfigRuleState":{"shape":"ConfigRuleState"}
|
||||
}
|
||||
},
|
||||
"ConfigRuleComplianceFilters":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ConfigRuleName":{"shape":"ConfigRuleName"},
|
||||
"ComplianceType":{"shape":"ComplianceType"},
|
||||
"AccountId":{"shape":"AccountId"},
|
||||
"AwsRegion":{"shape":"AwsRegion"}
|
||||
}
|
||||
},
|
||||
"ConfigRuleComplianceSummaryFilters":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AccountId":{"shape":"AccountId"},
|
||||
"AwsRegion":{"shape":"AwsRegion"}
|
||||
}
|
||||
},
|
||||
"ConfigRuleComplianceSummaryGroupKey":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ACCOUNT_ID",
|
||||
"AWS_REGION"
|
||||
]
|
||||
},
|
||||
"ConfigRuleEvaluationStatus":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -514,6 +874,11 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"ConfigRuleEvaluationStatus"}
|
||||
},
|
||||
"ConfigRuleName":{
|
||||
"type":"string",
|
||||
"max":64,
|
||||
"min":1
|
||||
},
|
||||
"ConfigRuleNames":{
|
||||
"type":"list",
|
||||
"member":{"shape":"StringWithCharLimit64"},
|
||||
@@ -549,6 +914,37 @@
|
||||
}
|
||||
},
|
||||
"Configuration":{"type":"string"},
|
||||
"ConfigurationAggregator":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ConfigurationAggregatorName":{"shape":"ConfigurationAggregatorName"},
|
||||
"ConfigurationAggregatorArn":{"shape":"ConfigurationAggregatorArn"},
|
||||
"AccountAggregationSources":{"shape":"AccountAggregationSourceList"},
|
||||
"OrganizationAggregationSource":{"shape":"OrganizationAggregationSource"},
|
||||
"CreationTime":{"shape":"Date"},
|
||||
"LastUpdatedTime":{"shape":"Date"}
|
||||
}
|
||||
},
|
||||
"ConfigurationAggregatorArn":{
|
||||
"type":"string",
|
||||
"pattern":"arn:aws[a-z\\-]*:config:[a-z\\-\\d]+:\\d+:config-aggregator/config-aggregator-[a-z\\d]+"
|
||||
},
|
||||
"ConfigurationAggregatorList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ConfigurationAggregator"}
|
||||
},
|
||||
"ConfigurationAggregatorName":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":1,
|
||||
"pattern":"[\\w\\-]+"
|
||||
},
|
||||
"ConfigurationAggregatorNameList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ConfigurationAggregatorName"},
|
||||
"max":10,
|
||||
"min":0
|
||||
},
|
||||
"ConfigurationItem":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -581,10 +977,11 @@
|
||||
"ConfigurationItemStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"Ok",
|
||||
"Failed",
|
||||
"Discovered",
|
||||
"Deleted"
|
||||
"OK",
|
||||
"ResourceDiscovered",
|
||||
"ResourceNotRecorded",
|
||||
"ResourceDeleted",
|
||||
"ResourceDeletedNotRecorded"
|
||||
]
|
||||
},
|
||||
"ConfigurationRecorder":{
|
||||
@@ -622,6 +1019,17 @@
|
||||
},
|
||||
"ConfigurationStateId":{"type":"string"},
|
||||
"Date":{"type":"timestamp"},
|
||||
"DeleteAggregationAuthorizationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AuthorizedAccountId",
|
||||
"AuthorizedAwsRegion"
|
||||
],
|
||||
"members":{
|
||||
"AuthorizedAccountId":{"shape":"AccountId"},
|
||||
"AuthorizedAwsRegion":{"shape":"AwsRegion"}
|
||||
}
|
||||
},
|
||||
"DeleteConfigRuleRequest":{
|
||||
"type":"structure",
|
||||
"required":["ConfigRuleName"],
|
||||
@@ -629,6 +1037,13 @@
|
||||
"ConfigRuleName":{"shape":"StringWithCharLimit64"}
|
||||
}
|
||||
},
|
||||
"DeleteConfigurationAggregatorRequest":{
|
||||
"type":"structure",
|
||||
"required":["ConfigurationAggregatorName"],
|
||||
"members":{
|
||||
"ConfigurationAggregatorName":{"shape":"ConfigurationAggregatorName"}
|
||||
}
|
||||
},
|
||||
"DeleteConfigurationRecorderRequest":{
|
||||
"type":"structure",
|
||||
"required":["ConfigurationRecorderName"],
|
||||
@@ -655,6 +1070,17 @@
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeletePendingAggregationRequestRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"RequesterAccountId",
|
||||
"RequesterAwsRegion"
|
||||
],
|
||||
"members":{
|
||||
"RequesterAccountId":{"shape":"AccountId"},
|
||||
"RequesterAwsRegion":{"shape":"AwsRegion"}
|
||||
}
|
||||
},
|
||||
"DeliverConfigSnapshotRequest":{
|
||||
"type":"structure",
|
||||
"required":["deliveryChannelName"],
|
||||
@@ -707,6 +1133,37 @@
|
||||
"Not_Applicable"
|
||||
]
|
||||
},
|
||||
"DescribeAggregateComplianceByConfigRulesRequest":{
|
||||
"type":"structure",
|
||||
"required":["ConfigurationAggregatorName"],
|
||||
"members":{
|
||||
"ConfigurationAggregatorName":{"shape":"ConfigurationAggregatorName"},
|
||||
"Filters":{"shape":"ConfigRuleComplianceFilters"},
|
||||
"Limit":{"shape":"GroupByAPILimit"},
|
||||
"NextToken":{"shape":"NextToken"}
|
||||
}
|
||||
},
|
||||
"DescribeAggregateComplianceByConfigRulesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AggregateComplianceByConfigRules":{"shape":"AggregateComplianceByConfigRuleList"},
|
||||
"NextToken":{"shape":"NextToken"}
|
||||
}
|
||||
},
|
||||
"DescribeAggregationAuthorizationsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Limit":{"shape":"Limit"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeAggregationAuthorizationsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AggregationAuthorizations":{"shape":"AggregationAuthorizationList"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeComplianceByConfigRuleRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -768,6 +1225,38 @@
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeConfigurationAggregatorSourcesStatusRequest":{
|
||||
"type":"structure",
|
||||
"required":["ConfigurationAggregatorName"],
|
||||
"members":{
|
||||
"ConfigurationAggregatorName":{"shape":"ConfigurationAggregatorName"},
|
||||
"UpdateStatus":{"shape":"AggregatedSourceStatusTypeList"},
|
||||
"NextToken":{"shape":"String"},
|
||||
"Limit":{"shape":"Limit"}
|
||||
}
|
||||
},
|
||||
"DescribeConfigurationAggregatorSourcesStatusResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AggregatedSourceStatusList":{"shape":"AggregatedSourceStatusList"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeConfigurationAggregatorsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ConfigurationAggregatorNames":{"shape":"ConfigurationAggregatorNameList"},
|
||||
"NextToken":{"shape":"String"},
|
||||
"Limit":{"shape":"Limit"}
|
||||
}
|
||||
},
|
||||
"DescribeConfigurationAggregatorsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ConfigurationAggregators":{"shape":"ConfigurationAggregatorList"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeConfigurationRecorderStatusRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -816,6 +1305,25 @@
|
||||
"DeliveryChannels":{"shape":"DeliveryChannelList"}
|
||||
}
|
||||
},
|
||||
"DescribePendingAggregationRequestsLimit":{
|
||||
"type":"integer",
|
||||
"max":20,
|
||||
"min":0
|
||||
},
|
||||
"DescribePendingAggregationRequestsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Limit":{"shape":"DescribePendingAggregationRequestsLimit"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribePendingAggregationRequestsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"PendingAggregationRequests":{"shape":"PendingAggregationRequestList"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"EarlierTime":{"type":"timestamp"},
|
||||
"EmptiableStringWithCharLimit256":{
|
||||
"type":"string",
|
||||
@@ -878,6 +1386,50 @@
|
||||
"type":"string",
|
||||
"enum":["aws.config"]
|
||||
},
|
||||
"GetAggregateComplianceDetailsByConfigRuleRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ConfigurationAggregatorName",
|
||||
"ConfigRuleName",
|
||||
"AccountId",
|
||||
"AwsRegion"
|
||||
],
|
||||
"members":{
|
||||
"ConfigurationAggregatorName":{"shape":"ConfigurationAggregatorName"},
|
||||
"ConfigRuleName":{"shape":"ConfigRuleName"},
|
||||
"AccountId":{"shape":"AccountId"},
|
||||
"AwsRegion":{"shape":"AwsRegion"},
|
||||
"ComplianceType":{"shape":"ComplianceType"},
|
||||
"Limit":{"shape":"Limit"},
|
||||
"NextToken":{"shape":"NextToken"}
|
||||
}
|
||||
},
|
||||
"GetAggregateComplianceDetailsByConfigRuleResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AggregateEvaluationResults":{"shape":"AggregateEvaluationResultList"},
|
||||
"NextToken":{"shape":"NextToken"}
|
||||
}
|
||||
},
|
||||
"GetAggregateConfigRuleComplianceSummaryRequest":{
|
||||
"type":"structure",
|
||||
"required":["ConfigurationAggregatorName"],
|
||||
"members":{
|
||||
"ConfigurationAggregatorName":{"shape":"ConfigurationAggregatorName"},
|
||||
"Filters":{"shape":"ConfigRuleComplianceSummaryFilters"},
|
||||
"GroupByKey":{"shape":"ConfigRuleComplianceSummaryGroupKey"},
|
||||
"Limit":{"shape":"GroupByAPILimit"},
|
||||
"NextToken":{"shape":"NextToken"}
|
||||
}
|
||||
},
|
||||
"GetAggregateConfigRuleComplianceSummaryResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"GroupByKey":{"shape":"StringWithCharLimit256"},
|
||||
"AggregateComplianceCounts":{"shape":"AggregateComplianceCountList"},
|
||||
"NextToken":{"shape":"NextToken"}
|
||||
}
|
||||
},
|
||||
"GetComplianceDetailsByConfigRuleRequest":{
|
||||
"type":"structure",
|
||||
"required":["ConfigRuleName"],
|
||||
@@ -972,6 +1524,11 @@
|
||||
"nextToken":{"shape":"NextToken"}
|
||||
}
|
||||
},
|
||||
"GroupByAPILimit":{
|
||||
"type":"integer",
|
||||
"max":1000,
|
||||
"min":0
|
||||
},
|
||||
"IncludeGlobalResourceTypes":{"type":"boolean"},
|
||||
"InsufficientDeliveryPolicyException":{
|
||||
"type":"structure",
|
||||
@@ -1141,6 +1698,12 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"NoAvailableOrganizationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"NoRunningConfigurationRecorderException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1159,6 +1722,12 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"NoSuchConfigurationAggregatorException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"NoSuchConfigurationRecorderException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1172,6 +1741,27 @@
|
||||
"exception":true
|
||||
},
|
||||
"OrderingTimestamp":{"type":"timestamp"},
|
||||
"OrganizationAccessDeniedException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"OrganizationAggregationSource":{
|
||||
"type":"structure",
|
||||
"required":["RoleArn"],
|
||||
"members":{
|
||||
"RoleArn":{"shape":"String"},
|
||||
"AwsRegions":{"shape":"AggregatorRegionList"},
|
||||
"AllAwsRegions":{"shape":"Boolean"}
|
||||
}
|
||||
},
|
||||
"OrganizationAllFeaturesNotEnabledException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"Owner":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
@@ -1179,6 +1769,34 @@
|
||||
"AWS"
|
||||
]
|
||||
},
|
||||
"PendingAggregationRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"RequesterAccountId":{"shape":"AccountId"},
|
||||
"RequesterAwsRegion":{"shape":"AwsRegion"}
|
||||
}
|
||||
},
|
||||
"PendingAggregationRequestList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"PendingAggregationRequest"}
|
||||
},
|
||||
"PutAggregationAuthorizationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AuthorizedAccountId",
|
||||
"AuthorizedAwsRegion"
|
||||
],
|
||||
"members":{
|
||||
"AuthorizedAccountId":{"shape":"AccountId"},
|
||||
"AuthorizedAwsRegion":{"shape":"AwsRegion"}
|
||||
}
|
||||
},
|
||||
"PutAggregationAuthorizationResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AggregationAuthorization":{"shape":"AggregationAuthorization"}
|
||||
}
|
||||
},
|
||||
"PutConfigRuleRequest":{
|
||||
"type":"structure",
|
||||
"required":["ConfigRule"],
|
||||
@@ -1186,6 +1804,21 @@
|
||||
"ConfigRule":{"shape":"ConfigRule"}
|
||||
}
|
||||
},
|
||||
"PutConfigurationAggregatorRequest":{
|
||||
"type":"structure",
|
||||
"required":["ConfigurationAggregatorName"],
|
||||
"members":{
|
||||
"ConfigurationAggregatorName":{"shape":"ConfigurationAggregatorName"},
|
||||
"AccountAggregationSources":{"shape":"AccountAggregationSourceList"},
|
||||
"OrganizationAggregationSource":{"shape":"OrganizationAggregationSource"}
|
||||
}
|
||||
},
|
||||
"PutConfigurationAggregatorResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ConfigurationAggregator":{"shape":"ConfigurationAggregator"}
|
||||
}
|
||||
},
|
||||
"PutConfigurationRecorderRequest":{
|
||||
"type":"structure",
|
||||
"required":["ConfigurationRecorder"],
|
||||
@@ -1298,6 +1931,23 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ResourceKey":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"resourceType",
|
||||
"resourceId"
|
||||
],
|
||||
"members":{
|
||||
"resourceType":{"shape":"ResourceType"},
|
||||
"resourceId":{"shape":"ResourceId"}
|
||||
}
|
||||
},
|
||||
"ResourceKeys":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ResourceKey"},
|
||||
"max":100,
|
||||
"min":1
|
||||
},
|
||||
"ResourceName":{"type":"string"},
|
||||
"ResourceNotDiscoveredException":{
|
||||
"type":"structure",
|
||||
@@ -1348,7 +1998,16 @@
|
||||
"AWS::AutoScaling::AutoScalingGroup",
|
||||
"AWS::AutoScaling::LaunchConfiguration",
|
||||
"AWS::AutoScaling::ScalingPolicy",
|
||||
"AWS::AutoScaling::ScheduledAction"
|
||||
"AWS::AutoScaling::ScheduledAction",
|
||||
"AWS::CodeBuild::Project",
|
||||
"AWS::WAF::RateBasedRule",
|
||||
"AWS::WAF::Rule",
|
||||
"AWS::WAF::WebACL",
|
||||
"AWS::WAFRegional::RateBasedRule",
|
||||
"AWS::WAFRegional::Rule",
|
||||
"AWS::WAFRegional::WebACL",
|
||||
"AWS::CloudFront::Distribution",
|
||||
"AWS::CloudFront::StreamingDistribution"
|
||||
]
|
||||
},
|
||||
"ResourceTypeList":{
|
||||
|
||||
+522
-68
File diff suppressed because it is too large
Load Diff
+19
@@ -0,0 +1,19 @@
|
||||
{
|
||||
"version": 1,
|
||||
"defaultRegion": "us-west-2",
|
||||
"testCases": [
|
||||
{
|
||||
"operationName": "DescribeConfigurationRecorders",
|
||||
"input": {},
|
||||
"errorExpectedFromService": false
|
||||
},
|
||||
{
|
||||
"operationName": "GetResourceConfigHistory",
|
||||
"input": {
|
||||
"resourceType": "fake-type",
|
||||
"resourceId": "fake-id"
|
||||
},
|
||||
"errorExpectedFromService": true
|
||||
}
|
||||
]
|
||||
}
|
||||
+191
@@ -0,0 +1,191 @@
|
||||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"apiVersion":"2017-08-08",
|
||||
"endpointPrefix":"connect",
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"rest-json",
|
||||
"serviceAbbreviation":"Amazon Connect",
|
||||
"serviceFullName":"Amazon Connect Service",
|
||||
"serviceId":"Connect",
|
||||
"signatureVersion":"v4",
|
||||
"signingName":"connect",
|
||||
"uid":"connect-2017-08-08"
|
||||
},
|
||||
"operations":{
|
||||
"StartOutboundVoiceContact":{
|
||||
"name":"StartOutboundVoiceContact",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/contact/outbound-voice"
|
||||
},
|
||||
"input":{"shape":"StartOutboundVoiceContactRequest"},
|
||||
"output":{"shape":"StartOutboundVoiceContactResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"DestinationNotAllowedException"},
|
||||
{"shape":"OutboundContactNotPermittedException"}
|
||||
]
|
||||
},
|
||||
"StopContact":{
|
||||
"name":"StopContact",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/contact/stop"
|
||||
},
|
||||
"input":{"shape":"StopContactRequest"},
|
||||
"output":{"shape":"StopContactResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"ContactNotFoundException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AttributeName":{
|
||||
"type":"string",
|
||||
"max":32767,
|
||||
"min":1
|
||||
},
|
||||
"AttributeValue":{
|
||||
"type":"string",
|
||||
"max":32767,
|
||||
"min":0
|
||||
},
|
||||
"Attributes":{
|
||||
"type":"map",
|
||||
"key":{"shape":"AttributeName"},
|
||||
"value":{"shape":"AttributeValue"}
|
||||
},
|
||||
"ClientToken":{
|
||||
"type":"string",
|
||||
"max":500
|
||||
},
|
||||
"ContactFlowId":{
|
||||
"type":"string",
|
||||
"max":500
|
||||
},
|
||||
"ContactId":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":1
|
||||
},
|
||||
"ContactNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"Message"}
|
||||
},
|
||||
"error":{"httpStatusCode":410},
|
||||
"exception":true
|
||||
},
|
||||
"DestinationNotAllowedException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"Message"}
|
||||
},
|
||||
"error":{"httpStatusCode":403},
|
||||
"exception":true
|
||||
},
|
||||
"InstanceId":{"type":"string"},
|
||||
"InternalServiceException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"Message"}
|
||||
},
|
||||
"error":{"httpStatusCode":500},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidParameterException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"Message"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidRequestException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"Message"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"LimitExceededException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"Message"}
|
||||
},
|
||||
"error":{"httpStatusCode":429},
|
||||
"exception":true
|
||||
},
|
||||
"Message":{"type":"string"},
|
||||
"OutboundContactNotPermittedException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"Message"}
|
||||
},
|
||||
"error":{"httpStatusCode":403},
|
||||
"exception":true
|
||||
},
|
||||
"PhoneNumber":{"type":"string"},
|
||||
"QueueId":{"type":"string"},
|
||||
"ResourceNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"Message"}
|
||||
},
|
||||
"error":{"httpStatusCode":404},
|
||||
"exception":true
|
||||
},
|
||||
"StartOutboundVoiceContactRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DestinationPhoneNumber",
|
||||
"ContactFlowId",
|
||||
"InstanceId"
|
||||
],
|
||||
"members":{
|
||||
"DestinationPhoneNumber":{"shape":"PhoneNumber"},
|
||||
"ContactFlowId":{"shape":"ContactFlowId"},
|
||||
"InstanceId":{"shape":"InstanceId"},
|
||||
"ClientToken":{
|
||||
"shape":"ClientToken",
|
||||
"idempotencyToken":true
|
||||
},
|
||||
"SourcePhoneNumber":{"shape":"PhoneNumber"},
|
||||
"QueueId":{"shape":"QueueId"},
|
||||
"Attributes":{"shape":"Attributes"}
|
||||
}
|
||||
},
|
||||
"StartOutboundVoiceContactResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ContactId":{"shape":"ContactId"}
|
||||
}
|
||||
},
|
||||
"StopContactRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ContactId",
|
||||
"InstanceId"
|
||||
],
|
||||
"members":{
|
||||
"ContactId":{"shape":"ContactId"},
|
||||
"InstanceId":{"shape":"InstanceId"}
|
||||
}
|
||||
},
|
||||
"StopContactResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+140
@@ -0,0 +1,140 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<p>The Amazon Connect API Reference provides descriptions, syntax, and usage examples for each of the Amazon Connect actions, data types, parameters, and errors. Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.</p>",
|
||||
"operations": {
|
||||
"StartOutboundVoiceContact": "<p>The <code>StartOutboundVoiceContact</code> operation initiates a contact flow to place an outbound call to a customer.</p> <p>There is a throttling limit placed on usage of the API that includes a <code>RateLimit</code> of 2 per second, and a <code>BurstLimit</code> of 5 per second.</p> <p>If you are using an IAM account, it must have permissions to the <code>connect:StartOutboundVoiceContact</code> action.</p>",
|
||||
"StopContact": "<p>Ends the contact initiated by the <code>StartOutboundVoiceContact</code> operation.</p> <p>If you are using an IAM account, it must have permissions to the <code>connect:StopContact</code> operation.</p>"
|
||||
},
|
||||
"shapes": {
|
||||
"AttributeName": {
|
||||
"base": "Key for the key value pair to be used for additional attributes.",
|
||||
"refs": {
|
||||
"Attributes$key": null
|
||||
}
|
||||
},
|
||||
"AttributeValue": {
|
||||
"base": "Value for the key value pair to be used for additional attributes.",
|
||||
"refs": {
|
||||
"Attributes$value": null
|
||||
}
|
||||
},
|
||||
"Attributes": {
|
||||
"base": "Additional attributes can be provided in the request using this field. This will be passed to the contact flow execution. Client can make use of this additional info in their contact flow.",
|
||||
"refs": {
|
||||
"StartOutboundVoiceContactRequest$Attributes": "<p>Specify a custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.</p> <p>There can be up to 32,768 UTF-8 bytes across all key-value pairs. Attribute keys can include only alphanumeric, dash, and underscore characters.</p> <p>For example, to play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:</p>"
|
||||
}
|
||||
},
|
||||
"ClientToken": {
|
||||
"base": "Dedupe token to be provided by the client. This token is used to avoid duplicate calls to the customer.",
|
||||
"refs": {
|
||||
"StartOutboundVoiceContactRequest$ClientToken": "<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned. If the contact is disconnected, a new contact is started.</p>"
|
||||
}
|
||||
},
|
||||
"ContactFlowId": {
|
||||
"base": "Amazon resource name for the contact flow to be executed to handle the current call.",
|
||||
"refs": {
|
||||
"StartOutboundVoiceContactRequest$ContactFlowId": "<p>The identifier for the contact flow to execute for the outbound call. This is a GUID value only. Amazon Resource Name (ARN) values are not supported.</p> <p>To find the <code>ContactFlowId</code>, open the contact flow to use in the Amazon Connect contact flow designer. The ID for the contact flow is displayed in the address bar as part of the URL. For example, an address displayed when you open a contact flow is similar to the following: <code>https://myconnectinstance.awsapps.com/connect/contact-flows/edit?id=arn:aws:connect:us-east-1:361814831152:instance/2fb42df9-78a2-4b99-b484-f5cf80dc300c/contact-flow/<i>b0b8f2dd-ed1b-4c44-af36-ce189a178181</i> </code>. At the end of the URL, you see <code>contact-flow/b0b8f2dd-ed1b-4c44-af36-ce189a178181</code>. The <code>ContactFlowID</code> for this contact flow is <code> <i>b0b8f2dd-ed1b-4c44-af36-ce189a178181</i> </code>. Make sure to include only the GUID after the \"contact-flow/\" in your requests.</p>"
|
||||
}
|
||||
},
|
||||
"ContactId": {
|
||||
"base": "Amazon Connect contact identifier. An unique ContactId will be generated for each contact request.",
|
||||
"refs": {
|
||||
"StartOutboundVoiceContactResponse$ContactId": "<p>The unique identifier of this contact within your Amazon Connect instance.</p>",
|
||||
"StopContactRequest$ContactId": "<p>The unique identifier of the contact to end. This is the <code>ContactId</code> value returned from the <code>StartOutboundVoiceContact</code> operation.</p>"
|
||||
}
|
||||
},
|
||||
"ContactNotFoundException": {
|
||||
"base": "<p>The contact with the specified ID is not active or does not exist.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DestinationNotAllowedException": {
|
||||
"base": "<p>Outbound calls to the destination number are not allowed for your instance. You can request that the country be included in the allowed countries for your instance by submitting a <a href=\"https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase\">Service Limit Increase</a>.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InstanceId": {
|
||||
"base": "Amazon Connect Organization ARN. A client must provide its organization ARN in order to place a call. This defines the call from organization.",
|
||||
"refs": {
|
||||
"StartOutboundVoiceContactRequest$InstanceId": "<p>The identifier for your Amazon Connect instance. To find the <code>InstanceId</code> value for your Amazon Connect instance, open the <a href=\"https://console.aws.amazon.com/connect/\">Amazon Connect console</a>. Select the instance alias of the instance and view the instance ID in the <b>Overview</b> section. For example, the instance ID is the set of characters at the end of the instance ARN, after \"instance/\", such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</p>",
|
||||
"StopContactRequest$InstanceId": "<p>The identifier of the Amazon Connect instance in which the contact is active.</p>"
|
||||
}
|
||||
},
|
||||
"InternalServiceException": {
|
||||
"base": "<p>Request processing failed due to an error or failure with the service.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidParameterException": {
|
||||
"base": "<p>One or more of the parameters provided to the operation are not valid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidRequestException": {
|
||||
"base": "<p>The request is not valid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"LimitExceededException": {
|
||||
"base": "<p>The limit exceeded the maximum allowed active calls in a queue.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Message": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ContactNotFoundException$Message": "<p>The message.</p>",
|
||||
"DestinationNotAllowedException$Message": "<p>The message.</p>",
|
||||
"InternalServiceException$Message": "<p>The message.</p>",
|
||||
"InvalidParameterException$Message": "<p>The message.</p>",
|
||||
"InvalidRequestException$Message": "<p>The message.</p>",
|
||||
"LimitExceededException$Message": "<p>The message.</p>",
|
||||
"OutboundContactNotPermittedException$Message": "<p>The message.</p>",
|
||||
"ResourceNotFoundException$Message": "<p>The message.</p>"
|
||||
}
|
||||
},
|
||||
"OutboundContactNotPermittedException": {
|
||||
"base": "<p>The contact is not permitted because outbound calling is not enabled for the instance.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"PhoneNumber": {
|
||||
"base": "End customer's phone number to call.",
|
||||
"refs": {
|
||||
"StartOutboundVoiceContactRequest$DestinationPhoneNumber": "<p>The phone number, in E.164 format, of the customer to call with the outbound contact.</p>",
|
||||
"StartOutboundVoiceContactRequest$SourcePhoneNumber": "<p>The phone number, in E.164 format, associated with your Amazon Connect instance to use to place the outbound call.</p>"
|
||||
}
|
||||
},
|
||||
"QueueId": {
|
||||
"base": "Identifier of the queue to be used for the contact routing.",
|
||||
"refs": {
|
||||
"StartOutboundVoiceContactRequest$QueueId": "<p>The queue to which to add the call. If you specify a queue, the phone displayed for caller ID is the phone number defined for the queue. If you do not specify a queue, the queue used is the queue defined in the contact flow specified by <code>ContactFlowId</code>.</p> <p>To find the <code>QueueId</code>, open the queue to use in the Amazon Connect queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, the <code>QueueId</code> value is the set of characters at the end of the URL, after \"queue/\", such as <code>aeg40574-2d01-51c3-73d6-bf8624d2168c</code>.</p>"
|
||||
}
|
||||
},
|
||||
"ResourceNotFoundException": {
|
||||
"base": "<p>The specified resource was not found.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"StartOutboundVoiceContactRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"StartOutboundVoiceContactResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"StopContactRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"StopContactResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"pagination": {
|
||||
}
|
||||
}
|
||||
+333
-8
@@ -6,6 +6,7 @@
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceFullName":"AWS Device Farm",
|
||||
"serviceId":"Device Farm",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"DeviceFarm_20150623",
|
||||
"uid":"devicefarm-2015-06-23"
|
||||
@@ -26,6 +27,21 @@
|
||||
{"shape":"ServiceAccountException"}
|
||||
]
|
||||
},
|
||||
"CreateInstanceProfile":{
|
||||
"name":"CreateInstanceProfile",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateInstanceProfileRequest"},
|
||||
"output":{"shape":"CreateInstanceProfileResult"},
|
||||
"errors":[
|
||||
{"shape":"ArgumentException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ServiceAccountException"}
|
||||
]
|
||||
},
|
||||
"CreateNetworkProfile":{
|
||||
"name":"CreateNetworkProfile",
|
||||
"http":{
|
||||
@@ -101,6 +117,21 @@
|
||||
{"shape":"ServiceAccountException"}
|
||||
]
|
||||
},
|
||||
"DeleteInstanceProfile":{
|
||||
"name":"DeleteInstanceProfile",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteInstanceProfileRequest"},
|
||||
"output":{"shape":"DeleteInstanceProfileResult"},
|
||||
"errors":[
|
||||
{"shape":"ArgumentException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ServiceAccountException"}
|
||||
]
|
||||
},
|
||||
"DeleteNetworkProfile":{
|
||||
"name":"DeleteNetworkProfile",
|
||||
"http":{
|
||||
@@ -206,6 +237,21 @@
|
||||
{"shape":"ServiceAccountException"}
|
||||
]
|
||||
},
|
||||
"GetDeviceInstance":{
|
||||
"name":"GetDeviceInstance",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetDeviceInstanceRequest"},
|
||||
"output":{"shape":"GetDeviceInstanceResult"},
|
||||
"errors":[
|
||||
{"shape":"ArgumentException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ServiceAccountException"}
|
||||
]
|
||||
},
|
||||
"GetDevicePool":{
|
||||
"name":"GetDevicePool",
|
||||
"http":{
|
||||
@@ -236,6 +282,21 @@
|
||||
{"shape":"ServiceAccountException"}
|
||||
]
|
||||
},
|
||||
"GetInstanceProfile":{
|
||||
"name":"GetInstanceProfile",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetInstanceProfileRequest"},
|
||||
"output":{"shape":"GetInstanceProfileResult"},
|
||||
"errors":[
|
||||
{"shape":"ArgumentException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ServiceAccountException"}
|
||||
]
|
||||
},
|
||||
"GetJob":{
|
||||
"name":"GetJob",
|
||||
"http":{
|
||||
@@ -402,6 +463,21 @@
|
||||
{"shape":"ServiceAccountException"}
|
||||
]
|
||||
},
|
||||
"ListDeviceInstances":{
|
||||
"name":"ListDeviceInstances",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListDeviceInstancesRequest"},
|
||||
"output":{"shape":"ListDeviceInstancesResult"},
|
||||
"errors":[
|
||||
{"shape":"ArgumentException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ServiceAccountException"}
|
||||
]
|
||||
},
|
||||
"ListDevicePools":{
|
||||
"name":"ListDevicePools",
|
||||
"http":{
|
||||
@@ -432,6 +508,21 @@
|
||||
{"shape":"ServiceAccountException"}
|
||||
]
|
||||
},
|
||||
"ListInstanceProfiles":{
|
||||
"name":"ListInstanceProfiles",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListInstanceProfilesRequest"},
|
||||
"output":{"shape":"ListInstanceProfilesResult"},
|
||||
"errors":[
|
||||
{"shape":"ArgumentException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ServiceAccountException"}
|
||||
]
|
||||
},
|
||||
"ListJobs":{
|
||||
"name":"ListJobs",
|
||||
"http":{
|
||||
@@ -708,6 +799,21 @@
|
||||
{"shape":"ServiceAccountException"}
|
||||
]
|
||||
},
|
||||
"UpdateDeviceInstance":{
|
||||
"name":"UpdateDeviceInstance",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateDeviceInstanceRequest"},
|
||||
"output":{"shape":"UpdateDeviceInstanceResult"},
|
||||
"errors":[
|
||||
{"shape":"ArgumentException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ServiceAccountException"}
|
||||
]
|
||||
},
|
||||
"UpdateDevicePool":{
|
||||
"name":"UpdateDevicePool",
|
||||
"http":{
|
||||
@@ -723,6 +829,21 @@
|
||||
{"shape":"ServiceAccountException"}
|
||||
]
|
||||
},
|
||||
"UpdateInstanceProfile":{
|
||||
"name":"UpdateInstanceProfile",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateInstanceProfileRequest"},
|
||||
"output":{"shape":"UpdateInstanceProfileResult"},
|
||||
"errors":[
|
||||
{"shape":"ArgumentException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ServiceAccountException"}
|
||||
]
|
||||
},
|
||||
"UpdateNetworkProfile":{
|
||||
"name":"UpdateNetworkProfile",
|
||||
"http":{
|
||||
@@ -769,7 +890,8 @@
|
||||
"maxJobTimeoutMinutes":{"shape":"JobTimeoutMinutes"},
|
||||
"trialMinutes":{"shape":"TrialMinutes"},
|
||||
"maxSlots":{"shape":"MaxSlotMap"},
|
||||
"defaultJobTimeoutMinutes":{"shape":"JobTimeoutMinutes"}
|
||||
"defaultJobTimeoutMinutes":{"shape":"JobTimeoutMinutes"},
|
||||
"skipAppResign":{"shape":"SkipAppResign"}
|
||||
}
|
||||
},
|
||||
"AccountsCleanup":{"type":"boolean"},
|
||||
@@ -905,6 +1027,23 @@
|
||||
"devicePool":{"shape":"DevicePool"}
|
||||
}
|
||||
},
|
||||
"CreateInstanceProfileRequest":{
|
||||
"type":"structure",
|
||||
"required":["name"],
|
||||
"members":{
|
||||
"name":{"shape":"Name"},
|
||||
"description":{"shape":"Message"},
|
||||
"packageCleanup":{"shape":"Boolean"},
|
||||
"excludeAppPackagesFromCleanup":{"shape":"PackageIds"},
|
||||
"rebootAfterUse":{"shape":"Boolean"}
|
||||
}
|
||||
},
|
||||
"CreateInstanceProfileResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"instanceProfile":{"shape":"InstanceProfile"}
|
||||
}
|
||||
},
|
||||
"CreateNetworkProfileRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -961,11 +1100,16 @@
|
||||
"members":{
|
||||
"projectArn":{"shape":"AmazonResourceName"},
|
||||
"deviceArn":{"shape":"AmazonResourceName"},
|
||||
"instanceArn":{"shape":"AmazonResourceName"},
|
||||
"sshPublicKey":{"shape":"SshPublicKey"},
|
||||
"remoteDebugEnabled":{"shape":"Boolean"},
|
||||
"remoteRecordEnabled":{"shape":"Boolean"},
|
||||
"remoteRecordAppArn":{"shape":"AmazonResourceName"},
|
||||
"name":{"shape":"Name"},
|
||||
"clientId":{"shape":"ClientId"},
|
||||
"configuration":{"shape":"CreateRemoteAccessSessionConfiguration"}
|
||||
"configuration":{"shape":"CreateRemoteAccessSessionConfiguration"},
|
||||
"interactionMode":{"shape":"InteractionMode"},
|
||||
"skipAppResign":{"shape":"Boolean"}
|
||||
}
|
||||
},
|
||||
"CreateRemoteAccessSessionResult":{
|
||||
@@ -1019,6 +1163,18 @@
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteInstanceProfileRequest":{
|
||||
"type":"structure",
|
||||
"required":["arn"],
|
||||
"members":{
|
||||
"arn":{"shape":"AmazonResourceName"}
|
||||
}
|
||||
},
|
||||
"DeleteInstanceProfileResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteNetworkProfileRequest":{
|
||||
"type":"structure",
|
||||
"required":["arn"],
|
||||
@@ -1086,6 +1242,7 @@
|
||||
"name":{"shape":"Name"},
|
||||
"manufacturer":{"shape":"String"},
|
||||
"model":{"shape":"String"},
|
||||
"modelId":{"shape":"String"},
|
||||
"formFactor":{"shape":"DeviceFormFactor"},
|
||||
"platform":{"shape":"DevicePlatform"},
|
||||
"os":{"shape":"String"},
|
||||
@@ -1099,7 +1256,8 @@
|
||||
"remoteAccessEnabled":{"shape":"Boolean"},
|
||||
"remoteDebugEnabled":{"shape":"Boolean"},
|
||||
"fleetType":{"shape":"String"},
|
||||
"fleetName":{"shape":"String"}
|
||||
"fleetName":{"shape":"String"},
|
||||
"instances":{"shape":"DeviceInstances"}
|
||||
}
|
||||
},
|
||||
"DeviceAttribute":{
|
||||
@@ -1111,7 +1269,9 @@
|
||||
"MANUFACTURER",
|
||||
"REMOTE_ACCESS_ENABLED",
|
||||
"REMOTE_DEBUG_ENABLED",
|
||||
"APPIUM_VERSION"
|
||||
"APPIUM_VERSION",
|
||||
"INSTANCE_ARN",
|
||||
"INSTANCE_LABELS"
|
||||
]
|
||||
},
|
||||
"DeviceFormFactor":{
|
||||
@@ -1125,6 +1285,21 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"DeviceInstance":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"arn":{"shape":"AmazonResourceName"},
|
||||
"deviceArn":{"shape":"AmazonResourceName"},
|
||||
"labels":{"shape":"InstanceLabels"},
|
||||
"status":{"shape":"InstanceStatus"},
|
||||
"udid":{"shape":"String"},
|
||||
"instanceProfile":{"shape":"InstanceProfile"}
|
||||
}
|
||||
},
|
||||
"DeviceInstances":{
|
||||
"type":"list",
|
||||
"member":{"shape":"DeviceInstance"}
|
||||
},
|
||||
"DeviceMinutes":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1183,7 +1358,8 @@
|
||||
"members":{
|
||||
"jobTimeoutMinutes":{"shape":"JobTimeoutMinutes"},
|
||||
"accountsCleanup":{"shape":"AccountsCleanup"},
|
||||
"appPackagesCleanup":{"shape":"AppPackagesCleanup"}
|
||||
"appPackagesCleanup":{"shape":"AppPackagesCleanup"},
|
||||
"skipAppResign":{"shape":"SkipAppResign"}
|
||||
}
|
||||
},
|
||||
"ExecutionResult":{
|
||||
@@ -1232,6 +1408,19 @@
|
||||
"accountSettings":{"shape":"AccountSettings"}
|
||||
}
|
||||
},
|
||||
"GetDeviceInstanceRequest":{
|
||||
"type":"structure",
|
||||
"required":["arn"],
|
||||
"members":{
|
||||
"arn":{"shape":"AmazonResourceName"}
|
||||
}
|
||||
},
|
||||
"GetDeviceInstanceResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"deviceInstance":{"shape":"DeviceInstance"}
|
||||
}
|
||||
},
|
||||
"GetDevicePoolCompatibilityRequest":{
|
||||
"type":"structure",
|
||||
"required":["devicePoolArn"],
|
||||
@@ -1275,6 +1464,19 @@
|
||||
"device":{"shape":"Device"}
|
||||
}
|
||||
},
|
||||
"GetInstanceProfileRequest":{
|
||||
"type":"structure",
|
||||
"required":["arn"],
|
||||
"members":{
|
||||
"arn":{"shape":"AmazonResourceName"}
|
||||
}
|
||||
},
|
||||
"GetInstanceProfileResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"instanceProfile":{"shape":"InstanceProfile"}
|
||||
}
|
||||
},
|
||||
"GetJobRequest":{
|
||||
"type":"structure",
|
||||
"required":["arn"],
|
||||
@@ -1432,7 +1634,45 @@
|
||||
"appUpload":{"shape":"Upload"}
|
||||
}
|
||||
},
|
||||
"InstanceLabels":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"InstanceProfile":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"arn":{"shape":"AmazonResourceName"},
|
||||
"packageCleanup":{"shape":"Boolean"},
|
||||
"excludeAppPackagesFromCleanup":{"shape":"PackageIds"},
|
||||
"rebootAfterUse":{"shape":"Boolean"},
|
||||
"name":{"shape":"Name"},
|
||||
"description":{"shape":"Message"}
|
||||
}
|
||||
},
|
||||
"InstanceProfiles":{
|
||||
"type":"list",
|
||||
"member":{"shape":"InstanceProfile"}
|
||||
},
|
||||
"InstanceStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"IN_USE",
|
||||
"PREPARING",
|
||||
"AVAILABLE",
|
||||
"NOT_AVAILABLE"
|
||||
]
|
||||
},
|
||||
"Integer":{"type":"integer"},
|
||||
"InteractionMode":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"INTERACTIVE",
|
||||
"NO_VIDEO",
|
||||
"VIDEO_ONLY"
|
||||
],
|
||||
"max":64,
|
||||
"min":0
|
||||
},
|
||||
"IosPaths":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
@@ -1451,6 +1691,7 @@
|
||||
"counters":{"shape":"Counters"},
|
||||
"message":{"shape":"Message"},
|
||||
"device":{"shape":"Device"},
|
||||
"instanceArn":{"shape":"AmazonResourceName"},
|
||||
"deviceMinutes":{"shape":"DeviceMinutes"}
|
||||
}
|
||||
},
|
||||
@@ -1485,6 +1726,20 @@
|
||||
"nextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListDeviceInstancesRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"maxResults":{"shape":"Integer"},
|
||||
"nextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListDeviceInstancesResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"deviceInstances":{"shape":"DeviceInstances"},
|
||||
"nextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListDevicePoolsRequest":{
|
||||
"type":"structure",
|
||||
"required":["arn"],
|
||||
@@ -1515,6 +1770,20 @@
|
||||
"nextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListInstanceProfilesRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"maxResults":{"shape":"Integer"},
|
||||
"nextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListInstanceProfilesResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"instanceProfiles":{"shape":"InstanceProfiles"},
|
||||
"nextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListJobsRequest":{
|
||||
"type":"structure",
|
||||
"required":["arn"],
|
||||
@@ -1858,6 +2127,10 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"Offering"}
|
||||
},
|
||||
"PackageIds":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"PaginationToken":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
@@ -1959,13 +2232,18 @@
|
||||
"started":{"shape":"DateTime"},
|
||||
"stopped":{"shape":"DateTime"},
|
||||
"device":{"shape":"Device"},
|
||||
"instanceArn":{"shape":"AmazonResourceName"},
|
||||
"remoteDebugEnabled":{"shape":"Boolean"},
|
||||
"remoteRecordEnabled":{"shape":"Boolean"},
|
||||
"remoteRecordAppArn":{"shape":"AmazonResourceName"},
|
||||
"hostAddress":{"shape":"HostAddress"},
|
||||
"clientId":{"shape":"ClientId"},
|
||||
"billingMethod":{"shape":"BillingMethod"},
|
||||
"deviceMinutes":{"shape":"DeviceMinutes"},
|
||||
"endpoint":{"shape":"String"},
|
||||
"deviceUdid":{"shape":"String"}
|
||||
"deviceUdid":{"shape":"String"},
|
||||
"interactionMode":{"shape":"InteractionMode"},
|
||||
"skipAppResign":{"shape":"SkipAppResign"}
|
||||
}
|
||||
},
|
||||
"RemoteAccessSessions":{
|
||||
@@ -2036,7 +2314,17 @@
|
||||
"networkProfile":{"shape":"NetworkProfile"},
|
||||
"parsingResultUrl":{"shape":"String"},
|
||||
"resultCode":{"shape":"ExecutionResultCode"},
|
||||
"customerArtifactPaths":{"shape":"CustomerArtifactPaths"}
|
||||
"seed":{"shape":"Integer"},
|
||||
"appUpload":{"shape":"AmazonResourceName"},
|
||||
"eventCount":{"shape":"Integer"},
|
||||
"jobTimeoutMinutes":{"shape":"JobTimeoutMinutes"},
|
||||
"devicePoolArn":{"shape":"AmazonResourceName"},
|
||||
"locale":{"shape":"String"},
|
||||
"radios":{"shape":"Radios"},
|
||||
"location":{"shape":"Location"},
|
||||
"customerArtifactPaths":{"shape":"CustomerArtifactPaths"},
|
||||
"webUrl":{"shape":"String"},
|
||||
"skipAppResign":{"shape":"SkipAppResign"}
|
||||
}
|
||||
},
|
||||
"Runs":{
|
||||
@@ -2130,6 +2418,7 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"SkipAppResign":{"type":"boolean"},
|
||||
"SshPublicKey":{
|
||||
"type":"string",
|
||||
"max":8192,
|
||||
@@ -2208,6 +2497,7 @@
|
||||
"enum":[
|
||||
"BUILTIN_FUZZ",
|
||||
"BUILTIN_EXPLORER",
|
||||
"WEB_PERFORMANCE_PROFILE",
|
||||
"APPIUM_JAVA_JUNIT",
|
||||
"APPIUM_JAVA_TESTNG",
|
||||
"APPIUM_PYTHON",
|
||||
@@ -2219,7 +2509,9 @@
|
||||
"UIAUTOMATION",
|
||||
"UIAUTOMATOR",
|
||||
"XCTEST",
|
||||
"XCTEST_UI"
|
||||
"XCTEST_UI",
|
||||
"REMOTE_ACCESS_RECORD",
|
||||
"REMOTE_ACCESS_REPLAY"
|
||||
]
|
||||
},
|
||||
"Tests":{
|
||||
@@ -2258,6 +2550,21 @@
|
||||
"key":{"shape":"ExecutionResult"},
|
||||
"value":{"shape":"UniqueProblems"}
|
||||
},
|
||||
"UpdateDeviceInstanceRequest":{
|
||||
"type":"structure",
|
||||
"required":["arn"],
|
||||
"members":{
|
||||
"arn":{"shape":"AmazonResourceName"},
|
||||
"profileArn":{"shape":"AmazonResourceName"},
|
||||
"labels":{"shape":"InstanceLabels"}
|
||||
}
|
||||
},
|
||||
"UpdateDeviceInstanceResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"deviceInstance":{"shape":"DeviceInstance"}
|
||||
}
|
||||
},
|
||||
"UpdateDevicePoolRequest":{
|
||||
"type":"structure",
|
||||
"required":["arn"],
|
||||
@@ -2274,6 +2581,24 @@
|
||||
"devicePool":{"shape":"DevicePool"}
|
||||
}
|
||||
},
|
||||
"UpdateInstanceProfileRequest":{
|
||||
"type":"structure",
|
||||
"required":["arn"],
|
||||
"members":{
|
||||
"arn":{"shape":"AmazonResourceName"},
|
||||
"name":{"shape":"Name"},
|
||||
"description":{"shape":"Message"},
|
||||
"packageCleanup":{"shape":"Boolean"},
|
||||
"excludeAppPackagesFromCleanup":{"shape":"PackageIds"},
|
||||
"rebootAfterUse":{"shape":"Boolean"}
|
||||
}
|
||||
},
|
||||
"UpdateInstanceProfileResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"instanceProfile":{"shape":"InstanceProfile"}
|
||||
}
|
||||
},
|
||||
"UpdateNetworkProfileRequest":{
|
||||
"type":"structure",
|
||||
"required":["arn"],
|
||||
|
||||
+217
-13
@@ -3,11 +3,13 @@
|
||||
"service": "<p>AWS Device Farm is a service that enables mobile app developers to test Android, iOS, and Fire OS apps on physical phones, tablets, and other devices in the cloud.</p>",
|
||||
"operations": {
|
||||
"CreateDevicePool": "<p>Creates a device pool.</p>",
|
||||
"CreateInstanceProfile": "<p>Creates a profile that can be applied to one or more private fleet device instances.</p>",
|
||||
"CreateNetworkProfile": "<p>Creates a network profile.</p>",
|
||||
"CreateProject": "<p>Creates a new project.</p>",
|
||||
"CreateRemoteAccessSession": "<p>Specifies and starts a remote access session.</p>",
|
||||
"CreateUpload": "<p>Uploads an app or test scripts.</p>",
|
||||
"DeleteDevicePool": "<p>Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.</p>",
|
||||
"DeleteInstanceProfile": "<p>Deletes a profile that can be applied to one or more private device instances.</p>",
|
||||
"DeleteNetworkProfile": "<p>Deletes a network profile.</p>",
|
||||
"DeleteProject": "<p>Deletes an AWS Device Farm project, given the project ARN.</p> <p> <b>Note</b> Deleting this resource does not stop an in-progress run.</p>",
|
||||
"DeleteRemoteAccessSession": "<p>Deletes a completed remote access session and its results.</p>",
|
||||
@@ -15,8 +17,10 @@
|
||||
"DeleteUpload": "<p>Deletes an upload given the upload ARN.</p>",
|
||||
"GetAccountSettings": "<p>Returns the number of unmetered iOS and/or unmetered Android devices that have been purchased by the account.</p>",
|
||||
"GetDevice": "<p>Gets information about a unique device type.</p>",
|
||||
"GetDeviceInstance": "<p>Returns information about a device instance belonging to a private device fleet.</p>",
|
||||
"GetDevicePool": "<p>Gets information about a device pool.</p>",
|
||||
"GetDevicePoolCompatibility": "<p>Gets information about compatibility with a device pool.</p>",
|
||||
"GetInstanceProfile": "<p>Returns information about the specified instance profile.</p>",
|
||||
"GetJob": "<p>Gets information about a job.</p>",
|
||||
"GetNetworkProfile": "<p>Returns information about a network profile.</p>",
|
||||
"GetOfferingStatus": "<p>Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a <code>NotEligible</code> error if the user is not permitted to invoke the operation. Please contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this operation.</p>",
|
||||
@@ -28,9 +32,11 @@
|
||||
"GetUpload": "<p>Gets information about an upload.</p>",
|
||||
"InstallToRemoteAccessSession": "<p>Installs an application to the device in a remote access session. For Android applications, the file must be in .apk format. For iOS applications, the file must be in .ipa format.</p>",
|
||||
"ListArtifacts": "<p>Gets information about artifacts.</p>",
|
||||
"ListDeviceInstances": "<p>Returns information about the private device instances associated with one or more AWS accounts.</p>",
|
||||
"ListDevicePools": "<p>Gets information about device pools.</p>",
|
||||
"ListDevices": "<p>Gets information about unique device types.</p>",
|
||||
"ListJobs": "<p>Gets information about jobs.</p>",
|
||||
"ListInstanceProfiles": "<p>Returns information about all the instance profiles in an AWS account.</p>",
|
||||
"ListJobs": "<p>Gets information about jobs for a given test run.</p>",
|
||||
"ListNetworkProfiles": "<p>Returns the list of available network profiles.</p>",
|
||||
"ListOfferingPromotions": "<p>Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a <code>NotEligible</code> error if the caller is not permitted to invoke the operation. Contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this operation.</p>",
|
||||
"ListOfferingTransactions": "<p>Returns a list of all historical purchases, renewals, and system renewal transactions for an AWS account. The list is paginated and ordered by a descending timestamp (most recent transactions are first). The API returns a <code>NotEligible</code> error if the user is not permitted to invoke the operation. Please contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this operation.</p>",
|
||||
@@ -39,8 +45,8 @@
|
||||
"ListRemoteAccessSessions": "<p>Returns a list of all currently running remote access sessions.</p>",
|
||||
"ListRuns": "<p>Gets information about runs, given an AWS Device Farm project ARN.</p>",
|
||||
"ListSamples": "<p>Gets information about samples, given an AWS Device Farm project ARN</p>",
|
||||
"ListSuites": "<p>Gets information about suites.</p>",
|
||||
"ListTests": "<p>Gets information about tests.</p>",
|
||||
"ListSuites": "<p>Gets information about test suites for a given job.</p>",
|
||||
"ListTests": "<p>Gets information about tests in a given test suite.</p>",
|
||||
"ListUniqueProblems": "<p>Gets information about unique problems.</p>",
|
||||
"ListUploads": "<p>Gets information about uploads, given an AWS Device Farm project ARN.</p>",
|
||||
"PurchaseOffering": "<p>Immediately purchases offerings for an AWS account. Offerings renew with the latest total purchased quantity for an offering, unless the renewal was overridden. The API returns a <code>NotEligible</code> error if the user is not permitted to invoke the operation. Please contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this operation.</p>",
|
||||
@@ -48,7 +54,9 @@
|
||||
"ScheduleRun": "<p>Schedules a run.</p>",
|
||||
"StopRemoteAccessSession": "<p>Ends a specified remote access session.</p>",
|
||||
"StopRun": "<p>Initiates a stop request for the current test run. AWS Device Farm will immediately stop the run on devices where tests have not started executing, and you will not be billed for these devices. On devices where tests have started executing, Setup Suite and Teardown Suite tests will run to completion before stopping execution on those devices. You will be billed for Setup, Teardown, and any tests that were in progress or already completed.</p>",
|
||||
"UpdateDeviceInstance": "<p>Updates information about an existing private device instance.</p>",
|
||||
"UpdateDevicePool": "<p>Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).</p>",
|
||||
"UpdateInstanceProfile": "<p>Updates information about an existing private device instance profile.</p>",
|
||||
"UpdateNetworkProfile": "<p>Updates the network profile with specific settings.</p>",
|
||||
"UpdateProject": "<p>Modifies the specified project name, given the project ARN and a new name.</p>"
|
||||
},
|
||||
@@ -80,19 +88,26 @@
|
||||
"CreateNetworkProfileRequest$projectArn": "<p>The Amazon Resource Name (ARN) of the project for which you want to create a network profile.</p>",
|
||||
"CreateRemoteAccessSessionRequest$projectArn": "<p>The Amazon Resource Name (ARN) of the project for which you want to create a remote access session.</p>",
|
||||
"CreateRemoteAccessSessionRequest$deviceArn": "<p>The Amazon Resource Name (ARN) of the device for which you want to create a remote access session.</p>",
|
||||
"CreateRemoteAccessSessionRequest$instanceArn": "<p>The Amazon Resource Name (ARN) of the device instance for which you want to create a remote access session.</p>",
|
||||
"CreateRemoteAccessSessionRequest$remoteRecordAppArn": "<p>The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.</p>",
|
||||
"CreateUploadRequest$projectArn": "<p>The ARN of the project for the upload.</p>",
|
||||
"DeleteDevicePoolRequest$arn": "<p>Represents the Amazon Resource Name (ARN) of the Device Farm device pool you wish to delete.</p>",
|
||||
"DeleteInstanceProfileRequest$arn": "<p>The Amazon Resource Name (ARN) of the instance profile you are requesting to delete.</p>",
|
||||
"DeleteNetworkProfileRequest$arn": "<p>The Amazon Resource Name (ARN) of the network profile you want to delete.</p>",
|
||||
"DeleteProjectRequest$arn": "<p>Represents the Amazon Resource Name (ARN) of the Device Farm project you wish to delete.</p>",
|
||||
"DeleteRemoteAccessSessionRequest$arn": "<p>The Amazon Resource Name (ARN) of the sesssion for which you want to delete remote access.</p>",
|
||||
"DeleteRunRequest$arn": "<p>The Amazon Resource Name (ARN) for the run you wish to delete.</p>",
|
||||
"DeleteUploadRequest$arn": "<p>Represents the Amazon Resource Name (ARN) of the Device Farm upload you wish to delete.</p>",
|
||||
"Device$arn": "<p>The device's ARN.</p>",
|
||||
"DeviceInstance$arn": "<p>The Amazon Resource Name (ARN) of the device instance.</p>",
|
||||
"DeviceInstance$deviceArn": "<p>The Amazon Resource Name (ARN) of the device.</p>",
|
||||
"DevicePool$arn": "<p>The device pool's ARN.</p>",
|
||||
"GetDeviceInstanceRequest$arn": "<p>The Amazon Resource Name (ARN) of the instance you're requesting information about.</p>",
|
||||
"GetDevicePoolCompatibilityRequest$devicePoolArn": "<p>The device pool's ARN.</p>",
|
||||
"GetDevicePoolCompatibilityRequest$appArn": "<p>The ARN of the app that is associated with the specified device pool.</p>",
|
||||
"GetDevicePoolRequest$arn": "<p>The device pool's ARN.</p>",
|
||||
"GetDeviceRequest$arn": "<p>The device type's ARN.</p>",
|
||||
"GetInstanceProfileRequest$arn": "<p>The Amazon Resource Name (ARN) of your instance profile.</p>",
|
||||
"GetJobRequest$arn": "<p>The job's ARN.</p>",
|
||||
"GetNetworkProfileRequest$arn": "<p>The Amazon Resource Name (ARN) of the network profile you want to return information about.</p>",
|
||||
"GetProjectRequest$arn": "<p>The project's ARN.</p>",
|
||||
@@ -103,25 +118,31 @@
|
||||
"GetUploadRequest$arn": "<p>The upload's ARN.</p>",
|
||||
"InstallToRemoteAccessSessionRequest$remoteAccessSessionArn": "<p>The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.</p>",
|
||||
"InstallToRemoteAccessSessionRequest$appArn": "<p>The Amazon Resource Name (ARN) of the app about which you are requesting information.</p>",
|
||||
"InstanceProfile$arn": "<p>The Amazon Resource Name (ARN) of the instance profile.</p>",
|
||||
"Job$arn": "<p>The job's ARN.</p>",
|
||||
"Job$instanceArn": "<p>The Amazon Resource Name (ARN) of the instance.</p>",
|
||||
"ListArtifactsRequest$arn": "<p>The Run, Job, Suite, or Test ARN.</p>",
|
||||
"ListDevicePoolsRequest$arn": "<p>The project ARN.</p>",
|
||||
"ListDevicesRequest$arn": "<p>The Amazon Resource Name (ARN) of the project.</p>",
|
||||
"ListJobsRequest$arn": "<p>The jobs' ARNs.</p>",
|
||||
"ListJobsRequest$arn": "<p>The run's Amazon Resource Name (ARN).</p>",
|
||||
"ListNetworkProfilesRequest$arn": "<p>The Amazon Resource Name (ARN) of the project for which you want to list network profiles.</p>",
|
||||
"ListProjectsRequest$arn": "<p>Optional. If no Amazon Resource Name (ARN) is specified, then AWS Device Farm returns a list of all projects for the AWS account. You can also specify a project ARN.</p>",
|
||||
"ListRemoteAccessSessionsRequest$arn": "<p>The Amazon Resource Name (ARN) of the remote access session about which you are requesting information.</p>",
|
||||
"ListRunsRequest$arn": "<p>The Amazon Resource Name (ARN) of the project for which you want to list runs.</p>",
|
||||
"ListSamplesRequest$arn": "<p>The Amazon Resource Name (ARN) of the project for which you want to list samples.</p>",
|
||||
"ListSuitesRequest$arn": "<p>The suites' ARNs.</p>",
|
||||
"ListTestsRequest$arn": "<p>The tests' ARNs.</p>",
|
||||
"ListSuitesRequest$arn": "<p>The job's Amazon Resource Name (ARN).</p>",
|
||||
"ListTestsRequest$arn": "<p>The test suite's Amazon Resource Name (ARN).</p>",
|
||||
"ListUniqueProblemsRequest$arn": "<p>The unique problems' ARNs.</p>",
|
||||
"ListUploadsRequest$arn": "<p>The Amazon Resource Name (ARN) of the project for which you want to list uploads.</p>",
|
||||
"NetworkProfile$arn": "<p>The Amazon Resource Name (ARN) of the network profile.</p>",
|
||||
"ProblemDetail$arn": "<p>The problem detail's ARN.</p>",
|
||||
"Project$arn": "<p>The project's ARN.</p>",
|
||||
"RemoteAccessSession$arn": "<p>The Amazon Resource Name (ARN) of the remote access session.</p>",
|
||||
"RemoteAccessSession$instanceArn": "<p>The Amazon Resource Name (ARN) of the instance.</p>",
|
||||
"RemoteAccessSession$remoteRecordAppArn": "<p>The Amazon Resource Name (ARN) for the app to be recorded in the remote access session.</p>",
|
||||
"Run$arn": "<p>The run's ARN.</p>",
|
||||
"Run$appUpload": "<p>An app to upload or that has been uploaded.</p>",
|
||||
"Run$devicePoolArn": "<p>The ARN of the device pool for the run.</p>",
|
||||
"Sample$arn": "<p>The sample's ARN.</p>",
|
||||
"ScheduleRunConfiguration$extraDataPackageArn": "<p>The ARN of the extra data for the run. The extra data is a .zip file that AWS Device Farm will extract to external data for Android or the app's sandbox for iOS.</p>",
|
||||
"ScheduleRunConfiguration$networkProfileArn": "<p>Reserved for internal use.</p>",
|
||||
@@ -133,8 +154,11 @@
|
||||
"StopRunRequest$arn": "<p>Represents the Amazon Resource Name (ARN) of the Device Farm run you wish to stop.</p>",
|
||||
"Suite$arn": "<p>The suite's ARN.</p>",
|
||||
"Test$arn": "<p>The test's ARN.</p>",
|
||||
"UpdateDeviceInstanceRequest$arn": "<p>The Amazon Resource Name (ARN) of the device instance.</p>",
|
||||
"UpdateDeviceInstanceRequest$profileArn": "<p>The Amazon Resource Name (ARN) of the profile that you want to associate with the device instance.</p>",
|
||||
"UpdateDevicePoolRequest$arn": "<p>The Amazon Resourc Name (ARN) of the Device Farm device pool you wish to update.</p>",
|
||||
"UpdateNetworkProfileRequest$arn": "<p>The Amazon Resource Name (ARN) of the project that you wish to update network profile settings.</p>",
|
||||
"UpdateInstanceProfileRequest$arn": "<p>The Amazon Resource Name (ARN) of the instance profile.</p>",
|
||||
"UpdateNetworkProfileRequest$arn": "<p>The Amazon Resource Name (ARN) of the project for which you want to update network profile settings.</p>",
|
||||
"UpdateProjectRequest$arn": "<p>The Amazon Resource Name (ARN) of the project whose name you wish to update.</p>",
|
||||
"Upload$arn": "<p>The upload's ARN.</p>"
|
||||
}
|
||||
@@ -189,7 +213,7 @@
|
||||
"BillingMethod": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateRemoteAccessSessionConfiguration$billingMethod": "<p>Returns the billing method for purposes of configuring a remote access session.</p>",
|
||||
"CreateRemoteAccessSessionConfiguration$billingMethod": "<p>The billing method for the remote access session.</p>",
|
||||
"RemoteAccessSession$billingMethod": "<p>The billing method of the remote access session. Possible values include <code>METERED</code> or <code>UNMETERED</code>. For more information about metered devices, see <a href=\"http://docs.aws.amazon.com/devicefarm/latest/developerguide/welcome.html#welcome-terminology\">AWS Device Farm terminology</a>.\"</p>",
|
||||
"Run$billingMethod": "<p>Specifies the billing method for a test run: <code>metered</code> or <code>unmetered</code>. If the parameter is not specified, the default value is <code>metered</code>.</p>",
|
||||
"ScheduleRunConfiguration$billingMethod": "<p>Specifies the billing method for a test run: <code>metered</code> or <code>unmetered</code>. If the parameter is not specified, the default value is <code>metered</code>.</p>"
|
||||
@@ -198,15 +222,24 @@
|
||||
"Boolean": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateInstanceProfileRequest$packageCleanup": "<p>When set to <code>true</code>, Device Farm will remove app packages after a test run. The default value is <code>false</code> for private devices.</p>",
|
||||
"CreateInstanceProfileRequest$rebootAfterUse": "<p>When set to <code>true</code>, Device Farm will reboot the instance after a test run. The default value is <code>true</code>.</p>",
|
||||
"CreateRemoteAccessSessionRequest$remoteDebugEnabled": "<p>Set to <code>true</code> if you want to access devices remotely for debugging in your remote access session.</p>",
|
||||
"CreateRemoteAccessSessionRequest$remoteRecordEnabled": "<p>Set to <code>true</code> to enable remote recording for the remote access session.</p>",
|
||||
"CreateRemoteAccessSessionRequest$skipAppResign": "<p>When set to <code>true</code>, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.</p> <p>For more information about how Device Farm re-signs your app(s), see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>",
|
||||
"Device$remoteAccessEnabled": "<p>Specifies whether remote access has been enabled for the specified device.</p>",
|
||||
"Device$remoteDebugEnabled": "<p>This flag is set to <code>true</code> if remote debugging is enabled for the device.</p>",
|
||||
"DevicePoolCompatibilityResult$compatible": "<p>Whether the result was compatible with the device pool.</p>",
|
||||
"InstanceProfile$packageCleanup": "<p>When set to <code>true</code>, Device Farm will remove app packages after a test run. The default value is <code>false</code> for private devices.</p>",
|
||||
"InstanceProfile$rebootAfterUse": "<p>When set to <code>true</code>, Device Farm will reboot the instance after a test run. The default value is <code>true</code>.</p>",
|
||||
"Radios$wifi": "<p>True if Wi-Fi is enabled at the beginning of the test; otherwise, false.</p>",
|
||||
"Radios$bluetooth": "<p>True if Bluetooth is enabled at the beginning of the test; otherwise, false.</p>",
|
||||
"Radios$nfc": "<p>True if NFC is enabled at the beginning of the test; otherwise, false.</p>",
|
||||
"Radios$gps": "<p>True if GPS is enabled at the beginning of the test; otherwise, false.</p>",
|
||||
"RemoteAccessSession$remoteDebugEnabled": "<p>This flag is set to <code>true</code> if remote debugging is enabled for the remote access session.</p>"
|
||||
"RemoteAccessSession$remoteDebugEnabled": "<p>This flag is set to <code>true</code> if remote debugging is enabled for the remote access session.</p>",
|
||||
"RemoteAccessSession$remoteRecordEnabled": "<p>This flag is set to <code>true</code> if remote recording is enabled for the remote access session.</p>",
|
||||
"UpdateInstanceProfileRequest$packageCleanup": "<p>The updated choice for whether you want to specify package cleanup. The default value is <code>false</code> for private devices.</p>",
|
||||
"UpdateInstanceProfileRequest$rebootAfterUse": "<p>The updated choice for whether you want to reboot the device after use. The default value is <code>true</code>.</p>"
|
||||
}
|
||||
},
|
||||
"CPU": {
|
||||
@@ -218,7 +251,7 @@
|
||||
"ClientId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateRemoteAccessSessionRequest$clientId": "<p>Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same <code>clientId</code> value in each call to <code>CreateRemoteAccessSession</code>. This is required only if <code>remoteDebugEnabled</code> is set to true <code>true</code>.</p>",
|
||||
"CreateRemoteAccessSessionRequest$clientId": "<p>Unique identifier for the client. If you want access to multiple devices on the same client, you should pass the same <code>clientId</code> value in each call to <code>CreateRemoteAccessSession</code>. This is required only if <code>remoteDebugEnabled</code> is set to <code>true</code>.</p>",
|
||||
"RemoteAccessSession$clientId": "<p>Unique identifier of your client for the remote access session. Only returned if remote debugging is enabled for the remote access session.</p>"
|
||||
}
|
||||
},
|
||||
@@ -248,6 +281,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateInstanceProfileRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateInstanceProfileResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateNetworkProfileRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -269,7 +312,7 @@
|
||||
}
|
||||
},
|
||||
"CreateRemoteAccessSessionConfiguration": {
|
||||
"base": "<p>Creates the configuration settings for a remote access session, including the device model and type.</p>",
|
||||
"base": "<p>Configuration settings for a remote access session, including billing method.</p>",
|
||||
"refs": {
|
||||
"CreateRemoteAccessSessionRequest$configuration": "<p>The configuration information for the remote access session request.</p>"
|
||||
}
|
||||
@@ -341,6 +384,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteInstanceProfileRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteInstanceProfileResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteNetworkProfileRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -406,7 +459,7 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"IncompatibilityMessage$type": "<p>The type of incompatibility.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The ARN.</p> </li> <li> <p>FORM_FACTOR: The form factor (for example, phone or tablet).</p> </li> <li> <p>MANUFACTURER: The manufacturer.</p> </li> <li> <p>PLATFORM: The platform (for example, Android or iOS).</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.</p> </li> <li> <p>APPIUM_VERSION: The Appium version for the test.</p> </li> </ul>",
|
||||
"Rule$attribute": "<p>The rule's stringified attribute. For example, specify the value as <code>\"\\\"abc\\\"\"</code>.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The ARN.</p> </li> <li> <p>FORM_FACTOR: The form factor (for example, phone or tablet).</p> </li> <li> <p>MANUFACTURER: The manufacturer.</p> </li> <li> <p>PLATFORM: The platform (for example, Android or iOS).</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.</p> </li> <li> <p>APPIUM_VERSION: The Appium version for the test.</p> </li> </ul>"
|
||||
"Rule$attribute": "<p>The rule's stringified attribute. For example, specify the value as <code>\"\\\"abc\\\"\"</code>.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The ARN.</p> </li> <li> <p>FORM_FACTOR: The form factor (for example, phone or tablet).</p> </li> <li> <p>MANUFACTURER: The manufacturer.</p> </li> <li> <p>PLATFORM: The platform (for example, Android or iOS).</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.</p> </li> <li> <p>APPIUM_VERSION: The Appium version for the test.</p> </li> <li> <p>INSTANCE_ARN: The Amazon Resource Name (ARN) of the device instance.</p> </li> <li> <p>INSTANCE_LABELS: The label of the device instance.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"DeviceFormFactor": {
|
||||
@@ -421,6 +474,21 @@
|
||||
"CustomerArtifactPaths$deviceHostPaths": "<p>Comma-separated list of paths in the test execution environment where the artifacts generated by the customer's tests will be pulled from.</p>"
|
||||
}
|
||||
},
|
||||
"DeviceInstance": {
|
||||
"base": "<p>Represents the device instance.</p>",
|
||||
"refs": {
|
||||
"DeviceInstances$member": null,
|
||||
"GetDeviceInstanceResult$deviceInstance": "<p>An object containing information about your device instance.</p>",
|
||||
"UpdateDeviceInstanceResult$deviceInstance": "<p>An object containing information about your device instance.</p>"
|
||||
}
|
||||
},
|
||||
"DeviceInstances": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Device$instances": "<p>The instances belonging to this device.</p>",
|
||||
"ListDeviceInstancesResult$deviceInstances": "<p>An object containing information about your device instances.</p>"
|
||||
}
|
||||
},
|
||||
"DeviceMinutes": {
|
||||
"base": "<p>Represents the total (metered or unmetered) minutes used by the resource to run tests. Contains the sum of minutes consumed by all children.</p>",
|
||||
"refs": {
|
||||
@@ -545,6 +613,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetDeviceInstanceRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetDeviceInstanceResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetDevicePoolCompatibilityRequest": {
|
||||
"base": "<p>Represents a request to the get device pool compatibility operation.</p>",
|
||||
"refs": {
|
||||
@@ -575,6 +653,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetInstanceProfileRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetInstanceProfileResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetJobRequest": {
|
||||
"base": "<p>Represents a request to the get job operation.</p>",
|
||||
"refs": {
|
||||
@@ -698,6 +786,35 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InstanceLabels": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DeviceInstance$labels": "<p>An array of strings describing the device instance.</p>",
|
||||
"UpdateDeviceInstanceRequest$labels": "<p>An array of strings that you want to associate with the device instance.</p>"
|
||||
}
|
||||
},
|
||||
"InstanceProfile": {
|
||||
"base": "<p>Represents the instance profile.</p>",
|
||||
"refs": {
|
||||
"CreateInstanceProfileResult$instanceProfile": "<p>An object containing information about your instance profile.</p>",
|
||||
"DeviceInstance$instanceProfile": "<p>A object containing information about the instance profile.</p>",
|
||||
"GetInstanceProfileResult$instanceProfile": "<p>An object containing information about your instance profile.</p>",
|
||||
"InstanceProfiles$member": null,
|
||||
"UpdateInstanceProfileResult$instanceProfile": "<p>An object containing information about your instance profile.</p>"
|
||||
}
|
||||
},
|
||||
"InstanceProfiles": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListInstanceProfilesResult$instanceProfiles": "<p>An object containing information about your instance profiles.</p>"
|
||||
}
|
||||
},
|
||||
"InstanceStatus": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DeviceInstance$status": "<p>The status of the device instance. Valid values are listed below.</p>"
|
||||
}
|
||||
},
|
||||
"Integer": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -708,6 +825,8 @@
|
||||
"Counters$errored": "<p>The number of errored entities.</p>",
|
||||
"Counters$stopped": "<p>The number of stopped entities.</p>",
|
||||
"Counters$skipped": "<p>The number of skipped entities.</p>",
|
||||
"ListDeviceInstancesRequest$maxResults": "<p>An integer specifying the maximum number of items you want to return in the API response.</p>",
|
||||
"ListInstanceProfilesRequest$maxResults": "<p>An integer specifying the maximum number of items you want to return in the API response.</p>",
|
||||
"MaxSlotMap$value": null,
|
||||
"OfferingStatus$quantity": "<p>The number of available devices in the offering.</p>",
|
||||
"PurchaseOfferingRequest$quantity": "<p>The number of device slots you wish to purchase in an offering request.</p>",
|
||||
@@ -716,7 +835,16 @@
|
||||
"Resolution$width": "<p>The screen resolution's width, expressed in pixels.</p>",
|
||||
"Resolution$height": "<p>The screen resolution's height, expressed in pixels.</p>",
|
||||
"Run$totalJobs": "<p>The total number of jobs for the run.</p>",
|
||||
"Run$completedJobs": "<p>The total number of completed jobs.</p>"
|
||||
"Run$completedJobs": "<p>The total number of completed jobs.</p>",
|
||||
"Run$seed": "<p>For fuzz tests, this is a seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.</p>",
|
||||
"Run$eventCount": "<p>For fuzz tests, this is the number of events, between 1 and 10000, that the UI fuzz test should perform.</p>"
|
||||
}
|
||||
},
|
||||
"InteractionMode": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateRemoteAccessSessionRequest$interactionMode": "<p>The interaction mode of the remote access session. Valid values are:</p> <ul> <li> <p>INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You <b>cannot</b> run XCUITest framework-based tests in this mode.</p> </li> <li> <p>NO_VIDEO: You are connected to the device but cannot interact with it or view the screen. This mode has the fastest test execution speed. You <b>can</b> run XCUITest framework-based tests in this mode.</p> </li> <li> <p>VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You <b>can</b> run XCUITest framework-based tests and watch the screen in this mode.</p> </li> </ul>",
|
||||
"RemoteAccessSession$interactionMode": "<p>The interaction mode of the remote access session. Valid values are:</p> <ul> <li> <p>INTERACTIVE: You can interact with the iOS device by viewing, touching, and rotating the screen. You <b>cannot</b> run XCUITest framework-based tests in this mode.</p> </li> <li> <p>NO_VIDEO: You are connected to the device but cannot interact with it or view the screen. This mode has the fastest test execution speed. You <b>can</b> run XCUITest framework-based tests in this mode.</p> </li> <li> <p>VIDEO_ONLY: You can view the screen but cannot touch or rotate it. You <b>can</b> run XCUITest framework-based tests and watch the screen in this mode.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"IosPaths": {
|
||||
@@ -740,6 +868,7 @@
|
||||
"CreateProjectRequest$defaultJobTimeoutMinutes": "<p>Sets the execution timeout value (in minutes) for a project. All test runs in this project will use the specified execution timeout value unless overridden when scheduling a run.</p>",
|
||||
"ExecutionConfiguration$jobTimeoutMinutes": "<p>The number of minutes a test run will execute before it times out.</p>",
|
||||
"Project$defaultJobTimeoutMinutes": "<p>The default number of minutes (at the project level) a test run will execute before it times out. Default value is 60 minutes.</p>",
|
||||
"Run$jobTimeoutMinutes": "<p>The number of minutes the job will execute before it times out.</p>",
|
||||
"UpdateProjectRequest$defaultJobTimeoutMinutes": "<p>The number of minutes a test run in the project will execute before it times out.</p>"
|
||||
}
|
||||
},
|
||||
@@ -764,6 +893,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListDeviceInstancesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListDeviceInstancesResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListDevicePoolsRequest": {
|
||||
"base": "<p>Represents the result of a list device pools request.</p>",
|
||||
"refs": {
|
||||
@@ -784,6 +923,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListInstanceProfilesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListInstanceProfilesResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListJobsRequest": {
|
||||
"base": "<p>Represents a request to the list jobs operation.</p>",
|
||||
"refs": {
|
||||
@@ -917,6 +1066,7 @@
|
||||
"Location": {
|
||||
"base": "<p>Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example 47.6204, -122.3491).</p> <p>Elevation is currently not supported.</p>",
|
||||
"refs": {
|
||||
"Run$location": "<p>Information about the location that is used for the run.</p>",
|
||||
"ScheduleRunConfiguration$location": "<p>Information about the location that is used for the run.</p>"
|
||||
}
|
||||
},
|
||||
@@ -956,10 +1106,12 @@
|
||||
"refs": {
|
||||
"ArgumentException$message": "<p>Any additional information about the exception.</p>",
|
||||
"CreateDevicePoolRequest$description": "<p>The device pool's description.</p>",
|
||||
"CreateInstanceProfileRequest$description": "<p>The description of your instance profile.</p>",
|
||||
"CreateNetworkProfileRequest$description": "<p>The description of the network profile.</p>",
|
||||
"DevicePool$description": "<p>The device pool's description.</p>",
|
||||
"IdempotencyException$message": "<p>Any additional information about the exception.</p>",
|
||||
"IncompatibilityMessage$message": "<p>A message about the incompatibility.</p>",
|
||||
"InstanceProfile$description": "<p>The description of the instance profile.</p>",
|
||||
"Job$message": "<p>A message about the job's result.</p>",
|
||||
"LimitExceededException$message": "<p>Any additional information about the exception.</p>",
|
||||
"NetworkProfile$description": "<p>The description of the network profile.</p>",
|
||||
@@ -975,6 +1127,7 @@
|
||||
"Test$message": "<p>A message about the test's result.</p>",
|
||||
"UniqueProblem$message": "<p>A message about the unique problems' result.</p>",
|
||||
"UpdateDevicePoolRequest$description": "<p>A description of the device pool you wish to update.</p>",
|
||||
"UpdateInstanceProfileRequest$description": "<p>The updated description for your instance profile.</p>",
|
||||
"UpdateNetworkProfileRequest$description": "<p>The descriptoin of the network profile about which you are returning information.</p>",
|
||||
"Upload$message": "<p>A message about the upload's result.</p>"
|
||||
}
|
||||
@@ -997,12 +1150,14 @@
|
||||
"refs": {
|
||||
"Artifact$name": "<p>The artifact's name.</p>",
|
||||
"CreateDevicePoolRequest$name": "<p>The device pool's name.</p>",
|
||||
"CreateInstanceProfileRequest$name": "<p>The name of your instance profile.</p>",
|
||||
"CreateNetworkProfileRequest$name": "<p>The name you wish to specify for the new network profile.</p>",
|
||||
"CreateProjectRequest$name": "<p>The project's name.</p>",
|
||||
"CreateRemoteAccessSessionRequest$name": "<p>The name of the remote access session that you wish to create.</p>",
|
||||
"CreateUploadRequest$name": "<p>The upload's file name. The name should not contain the '/' character. If uploading an iOS app, the file name needs to end with the <code>.ipa</code> extension. If uploading an Android app, the file name needs to end with the <code>.apk</code> extension. For all others, the file name must end with the <code>.zip</code> file extension.</p>",
|
||||
"Device$name": "<p>The device's display name.</p>",
|
||||
"DevicePool$name": "<p>The device pool's name.</p>",
|
||||
"InstanceProfile$name": "<p>The name of the instance profile.</p>",
|
||||
"Job$name": "<p>The job's name.</p>",
|
||||
"NetworkProfile$name": "<p>The name of the network profile.</p>",
|
||||
"ProblemDetail$name": "<p>The problem detail's name.</p>",
|
||||
@@ -1013,6 +1168,7 @@
|
||||
"Suite$name": "<p>The suite's name.</p>",
|
||||
"Test$name": "<p>The test's name.</p>",
|
||||
"UpdateDevicePoolRequest$name": "<p>A string representing the name of the device pool you wish to update.</p>",
|
||||
"UpdateInstanceProfileRequest$name": "<p>The updated name for your instance profile.</p>",
|
||||
"UpdateNetworkProfileRequest$name": "<p>The name of the network profile about which you are returning information.</p>",
|
||||
"UpdateProjectRequest$name": "<p>A string representing the new name of the project that you are updating.</p>",
|
||||
"Upload$name": "<p>The upload's file name.</p>"
|
||||
@@ -1135,6 +1291,14 @@
|
||||
"ListOfferingsResult$offerings": "<p>A value representing the list offering results.</p>"
|
||||
}
|
||||
},
|
||||
"PackageIds": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateInstanceProfileRequest$excludeAppPackagesFromCleanup": "<p>An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.</p> <p>The list of packages is only considered if you set <code>packageCleanup</code> to <code>true</code>.</p>",
|
||||
"InstanceProfile$excludeAppPackagesFromCleanup": "<p>An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.</p> <p>The list of packages is only considered if you set <code>packageCleanup</code> to <code>true</code>.</p>",
|
||||
"UpdateInstanceProfileRequest$excludeAppPackagesFromCleanup": "<p>An array of strings specifying the list of app packages that should not be cleaned up from the device after a test run is over.</p> <p>The list of packages is only considered if you set <code>packageCleanup</code> to <code>true</code>.</p>"
|
||||
}
|
||||
},
|
||||
"PaginationToken": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -1142,10 +1306,14 @@
|
||||
"GetOfferingStatusResult$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>",
|
||||
"ListArtifactsRequest$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>",
|
||||
"ListArtifactsResult$nextToken": "<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>",
|
||||
"ListDeviceInstancesRequest$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>",
|
||||
"ListDeviceInstancesResult$nextToken": "<p>An identifier that can be used in the next call to this operation to return the next set of items in the list.</p>",
|
||||
"ListDevicePoolsRequest$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>",
|
||||
"ListDevicePoolsResult$nextToken": "<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>",
|
||||
"ListDevicesRequest$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>",
|
||||
"ListDevicesResult$nextToken": "<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>",
|
||||
"ListInstanceProfilesRequest$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>",
|
||||
"ListInstanceProfilesResult$nextToken": "<p>An identifier that can be used in the next call to this operation to return the next set of items in the list.</p>",
|
||||
"ListJobsRequest$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>",
|
||||
"ListJobsResult$nextToken": "<p>If the number of items that are returned is significantly large, this is an identifier that is also returned, which can be used in a subsequent call to this operation to return the next set of items in the list.</p>",
|
||||
"ListNetworkProfilesRequest$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>",
|
||||
@@ -1241,6 +1409,7 @@
|
||||
"Radios": {
|
||||
"base": "<p>Represents the set of radios and their states on a device. Examples of radios include Wi-Fi, GPS, Bluetooth, and NFC.</p>",
|
||||
"refs": {
|
||||
"Run$radios": "<p>Information about the radio states for the run.</p>",
|
||||
"ScheduleRunConfiguration$radios": "<p>Information about the radio states for the run.</p>"
|
||||
}
|
||||
},
|
||||
@@ -1374,6 +1543,15 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"SkipAppResign": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AccountSettings$skipAppResign": "<p>When set to <code>true</code>, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.</p> <p>For more information about how Device Farm re-signs your app(s), see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>",
|
||||
"ExecutionConfiguration$skipAppResign": "<p>When set to <code>true</code>, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.</p> <p>For more information about how Device Farm re-signs your app(s), see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>",
|
||||
"RemoteAccessSession$skipAppResign": "<p>When set to <code>true</code>, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.</p> <p>For more information about how Device Farm re-signs your app(s), see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>",
|
||||
"Run$skipAppResign": "<p>When set to <code>true</code>, for private devices, Device Farm will not sign your app again. For public devices, Device Farm always signs your apps again and this parameter has no effect.</p> <p>For more information about how Device Farm re-signs your app(s), see <a href=\"https://aws.amazon.com/device-farm/faq/\">Do you modify my app?</a> in the <i>AWS Device Farm FAQs</i>.</p>"
|
||||
}
|
||||
},
|
||||
"SshPublicKey": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -1409,6 +1587,7 @@
|
||||
"CPU$architecture": "<p>The CPU's architecture, for example x86 or ARM.</p>",
|
||||
"Device$manufacturer": "<p>The device's manufacturer name.</p>",
|
||||
"Device$model": "<p>The device's model name.</p>",
|
||||
"Device$modelId": "<p>The device's model ID.</p>",
|
||||
"Device$os": "<p>The device's operating system type.</p>",
|
||||
"Device$image": "<p>The device's image name.</p>",
|
||||
"Device$carrier": "<p>The device's carrier.</p>",
|
||||
@@ -1416,12 +1595,17 @@
|
||||
"Device$fleetType": "<p>The type of fleet to which this device belongs. Possible values for fleet type are PRIVATE and PUBLIC.</p>",
|
||||
"Device$fleetName": "<p>The name of the fleet to which this device belongs.</p>",
|
||||
"DeviceHostPaths$member": null,
|
||||
"DeviceInstance$udid": "<p>Unique device identifier for the device instance.</p>",
|
||||
"InstanceLabels$member": null,
|
||||
"IosPaths$member": null,
|
||||
"MaxSlotMap$key": null,
|
||||
"PackageIds$member": null,
|
||||
"RemoteAccessSession$endpoint": "<p>The endpoint for the remote access sesssion.</p>",
|
||||
"RemoteAccessSession$deviceUdid": "<p>Unique device identifier for the remote device. Only returned if remote debugging is enabled for the remote access session.</p>",
|
||||
"Rule$value": "<p>The rule's value.</p>",
|
||||
"Run$parsingResultUrl": "<p>Read-only URL for an object in S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.</p>",
|
||||
"Run$locale": "<p>Information about the locale that is used for the run.</p>",
|
||||
"Run$webUrl": "<p>The Device Farm console URL for the recording of the run.</p>",
|
||||
"ScheduleRunConfiguration$locale": "<p>Information about the locale that is used for the run.</p>",
|
||||
"TestParameters$key": null,
|
||||
"TestParameters$value": null
|
||||
@@ -1508,6 +1692,16 @@
|
||||
"ListUniqueProblemsResult$uniqueProblems": "<p>Information about the unique problems.</p> <p>Allowed values include:</p> <ul> <li> <p>PENDING: A pending condition.</p> </li> <li> <p>PASSED: A passing condition.</p> </li> <li> <p>WARNED: A warning condition.</p> </li> <li> <p>FAILED: A failed condition.</p> </li> <li> <p>SKIPPED: A skipped condition.</p> </li> <li> <p>ERRORED: An error condition.</p> </li> <li> <p>STOPPED: A stopped condition.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"UpdateDeviceInstanceRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateDeviceInstanceResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateDevicePoolRequest": {
|
||||
"base": "<p>Represents a request to the update device pool operation.</p>",
|
||||
"refs": {
|
||||
@@ -1518,6 +1712,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateInstanceProfileRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateInstanceProfileResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateNetworkProfileRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
|
||||
+18
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"version": 1,
|
||||
"defaultRegion": "us-west-2",
|
||||
"testCases": [
|
||||
{
|
||||
"operationName": "ListDevices",
|
||||
"input": {},
|
||||
"errorExpectedFromService": false
|
||||
},
|
||||
{
|
||||
"operationName": "GetDevice",
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2::device:000000000000000000000000fake-arn"
|
||||
},
|
||||
"errorExpectedFromService": true
|
||||
}
|
||||
]
|
||||
}
|
||||
+290
-8
@@ -168,6 +168,32 @@
|
||||
{"shape":"DirectConnectClientException"}
|
||||
]
|
||||
},
|
||||
"CreateDirectConnectGateway":{
|
||||
"name":"CreateDirectConnectGateway",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateDirectConnectGatewayRequest"},
|
||||
"output":{"shape":"CreateDirectConnectGatewayResult"},
|
||||
"errors":[
|
||||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
]
|
||||
},
|
||||
"CreateDirectConnectGatewayAssociation":{
|
||||
"name":"CreateDirectConnectGatewayAssociation",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateDirectConnectGatewayAssociationRequest"},
|
||||
"output":{"shape":"CreateDirectConnectGatewayAssociationResult"},
|
||||
"errors":[
|
||||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
]
|
||||
},
|
||||
"CreateInterconnect":{
|
||||
"name":"CreateInterconnect",
|
||||
"http":{
|
||||
@@ -246,6 +272,32 @@
|
||||
{"shape":"DirectConnectClientException"}
|
||||
]
|
||||
},
|
||||
"DeleteDirectConnectGateway":{
|
||||
"name":"DeleteDirectConnectGateway",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteDirectConnectGatewayRequest"},
|
||||
"output":{"shape":"DeleteDirectConnectGatewayResult"},
|
||||
"errors":[
|
||||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
]
|
||||
},
|
||||
"DeleteDirectConnectGatewayAssociation":{
|
||||
"name":"DeleteDirectConnectGatewayAssociation",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteDirectConnectGatewayAssociationRequest"},
|
||||
"output":{"shape":"DeleteDirectConnectGatewayAssociationResult"},
|
||||
"errors":[
|
||||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
]
|
||||
},
|
||||
"DeleteInterconnect":{
|
||||
"name":"DeleteInterconnect",
|
||||
"http":{
|
||||
@@ -326,6 +378,45 @@
|
||||
],
|
||||
"deprecated":true
|
||||
},
|
||||
"DescribeDirectConnectGatewayAssociations":{
|
||||
"name":"DescribeDirectConnectGatewayAssociations",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeDirectConnectGatewayAssociationsRequest"},
|
||||
"output":{"shape":"DescribeDirectConnectGatewayAssociationsResult"},
|
||||
"errors":[
|
||||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
]
|
||||
},
|
||||
"DescribeDirectConnectGatewayAttachments":{
|
||||
"name":"DescribeDirectConnectGatewayAttachments",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeDirectConnectGatewayAttachmentsRequest"},
|
||||
"output":{"shape":"DescribeDirectConnectGatewayAttachmentsResult"},
|
||||
"errors":[
|
||||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
]
|
||||
},
|
||||
"DescribeDirectConnectGateways":{
|
||||
"name":"DescribeDirectConnectGateways",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeDirectConnectGatewaysRequest"},
|
||||
"output":{"shape":"DescribeDirectConnectGatewaysResult"},
|
||||
"errors":[
|
||||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
]
|
||||
},
|
||||
"DescribeHostedConnections":{
|
||||
"name":"DescribeHostedConnections",
|
||||
"http":{
|
||||
@@ -653,13 +744,11 @@
|
||||
},
|
||||
"ConfirmPrivateVirtualInterfaceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"virtualInterfaceId",
|
||||
"virtualGatewayId"
|
||||
],
|
||||
"required":["virtualInterfaceId"],
|
||||
"members":{
|
||||
"virtualInterfaceId":{"shape":"VirtualInterfaceId"},
|
||||
"virtualGatewayId":{"shape":"VirtualGatewayId"}
|
||||
"virtualGatewayId":{"shape":"VirtualGatewayId"},
|
||||
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"}
|
||||
}
|
||||
},
|
||||
"ConfirmPrivateVirtualInterfaceResponse":{
|
||||
@@ -751,6 +840,37 @@
|
||||
"lagId":{"shape":"LagId"}
|
||||
}
|
||||
},
|
||||
"CreateDirectConnectGatewayAssociationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"directConnectGatewayId",
|
||||
"virtualGatewayId"
|
||||
],
|
||||
"members":{
|
||||
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"},
|
||||
"virtualGatewayId":{"shape":"VirtualGatewayId"}
|
||||
}
|
||||
},
|
||||
"CreateDirectConnectGatewayAssociationResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"directConnectGatewayAssociation":{"shape":"DirectConnectGatewayAssociation"}
|
||||
}
|
||||
},
|
||||
"CreateDirectConnectGatewayRequest":{
|
||||
"type":"structure",
|
||||
"required":["directConnectGatewayName"],
|
||||
"members":{
|
||||
"directConnectGatewayName":{"shape":"DirectConnectGatewayName"},
|
||||
"amazonSideAsn":{"shape":"LongAsn"}
|
||||
}
|
||||
},
|
||||
"CreateDirectConnectGatewayResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"directConnectGateway":{"shape":"DirectConnectGateway"}
|
||||
}
|
||||
},
|
||||
"CreateInterconnectRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -825,6 +945,36 @@
|
||||
"connectionId":{"shape":"ConnectionId"}
|
||||
}
|
||||
},
|
||||
"DeleteDirectConnectGatewayAssociationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"directConnectGatewayId",
|
||||
"virtualGatewayId"
|
||||
],
|
||||
"members":{
|
||||
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"},
|
||||
"virtualGatewayId":{"shape":"VirtualGatewayId"}
|
||||
}
|
||||
},
|
||||
"DeleteDirectConnectGatewayAssociationResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"directConnectGatewayAssociation":{"shape":"DirectConnectGatewayAssociation"}
|
||||
}
|
||||
},
|
||||
"DeleteDirectConnectGatewayRequest":{
|
||||
"type":"structure",
|
||||
"required":["directConnectGatewayId"],
|
||||
"members":{
|
||||
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"}
|
||||
}
|
||||
},
|
||||
"DeleteDirectConnectGatewayResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"directConnectGateway":{"shape":"DirectConnectGateway"}
|
||||
}
|
||||
},
|
||||
"DeleteInterconnectRequest":{
|
||||
"type":"structure",
|
||||
"required":["interconnectId"],
|
||||
@@ -886,6 +1036,53 @@
|
||||
"connectionId":{"shape":"ConnectionId"}
|
||||
}
|
||||
},
|
||||
"DescribeDirectConnectGatewayAssociationsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"},
|
||||
"virtualGatewayId":{"shape":"VirtualGatewayId"},
|
||||
"maxResults":{"shape":"MaxResultSetSize"},
|
||||
"nextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"DescribeDirectConnectGatewayAssociationsResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"directConnectGatewayAssociations":{"shape":"DirectConnectGatewayAssociationList"},
|
||||
"nextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"DescribeDirectConnectGatewayAttachmentsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"},
|
||||
"virtualInterfaceId":{"shape":"VirtualInterfaceId"},
|
||||
"maxResults":{"shape":"MaxResultSetSize"},
|
||||
"nextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"DescribeDirectConnectGatewayAttachmentsResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"directConnectGatewayAttachments":{"shape":"DirectConnectGatewayAttachmentList"},
|
||||
"nextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"DescribeDirectConnectGatewaysRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"},
|
||||
"maxResults":{"shape":"MaxResultSetSize"},
|
||||
"nextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"DescribeDirectConnectGatewaysResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"directConnectGateways":{"shape":"DirectConnectGatewayList"},
|
||||
"nextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"DescribeHostedConnectionsRequest":{
|
||||
"type":"structure",
|
||||
"required":["connectionId"],
|
||||
@@ -956,6 +1153,80 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"DirectConnectGateway":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"},
|
||||
"directConnectGatewayName":{"shape":"DirectConnectGatewayName"},
|
||||
"amazonSideAsn":{"shape":"LongAsn"},
|
||||
"ownerAccount":{"shape":"OwnerAccount"},
|
||||
"directConnectGatewayState":{"shape":"DirectConnectGatewayState"},
|
||||
"stateChangeError":{"shape":"StateChangeError"}
|
||||
}
|
||||
},
|
||||
"DirectConnectGatewayAssociation":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"},
|
||||
"virtualGatewayId":{"shape":"VirtualGatewayId"},
|
||||
"virtualGatewayRegion":{"shape":"VirtualGatewayRegion"},
|
||||
"virtualGatewayOwnerAccount":{"shape":"OwnerAccount"},
|
||||
"associationState":{"shape":"DirectConnectGatewayAssociationState"},
|
||||
"stateChangeError":{"shape":"StateChangeError"}
|
||||
}
|
||||
},
|
||||
"DirectConnectGatewayAssociationList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"DirectConnectGatewayAssociation"}
|
||||
},
|
||||
"DirectConnectGatewayAssociationState":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"associating",
|
||||
"associated",
|
||||
"disassociating",
|
||||
"disassociated"
|
||||
]
|
||||
},
|
||||
"DirectConnectGatewayAttachment":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"},
|
||||
"virtualInterfaceId":{"shape":"VirtualInterfaceId"},
|
||||
"virtualInterfaceRegion":{"shape":"VirtualInterfaceRegion"},
|
||||
"virtualInterfaceOwnerAccount":{"shape":"OwnerAccount"},
|
||||
"attachmentState":{"shape":"DirectConnectGatewayAttachmentState"},
|
||||
"stateChangeError":{"shape":"StateChangeError"}
|
||||
}
|
||||
},
|
||||
"DirectConnectGatewayAttachmentList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"DirectConnectGatewayAttachment"}
|
||||
},
|
||||
"DirectConnectGatewayAttachmentState":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"attaching",
|
||||
"attached",
|
||||
"detaching",
|
||||
"detached"
|
||||
]
|
||||
},
|
||||
"DirectConnectGatewayId":{"type":"string"},
|
||||
"DirectConnectGatewayList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"DirectConnectGateway"}
|
||||
},
|
||||
"DirectConnectGatewayName":{"type":"string"},
|
||||
"DirectConnectGatewayState":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"pending",
|
||||
"available",
|
||||
"deleting",
|
||||
"deleted"
|
||||
]
|
||||
},
|
||||
"DirectConnectServerException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1090,6 +1361,11 @@
|
||||
"locations":{"shape":"LocationList"}
|
||||
}
|
||||
},
|
||||
"LongAsn":{"type":"long"},
|
||||
"MaxResultSetSize":{
|
||||
"type":"integer",
|
||||
"box":true
|
||||
},
|
||||
"NewBGPPeer":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1105,8 +1381,7 @@
|
||||
"required":[
|
||||
"virtualInterfaceName",
|
||||
"vlan",
|
||||
"asn",
|
||||
"virtualGatewayId"
|
||||
"asn"
|
||||
],
|
||||
"members":{
|
||||
"virtualInterfaceName":{"shape":"VirtualInterfaceName"},
|
||||
@@ -1116,7 +1391,8 @@
|
||||
"amazonAddress":{"shape":"AmazonAddress"},
|
||||
"customerAddress":{"shape":"CustomerAddress"},
|
||||
"addressFamily":{"shape":"AddressFamily"},
|
||||
"virtualGatewayId":{"shape":"VirtualGatewayId"}
|
||||
"virtualGatewayId":{"shape":"VirtualGatewayId"},
|
||||
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"}
|
||||
}
|
||||
},
|
||||
"NewPrivateVirtualInterfaceAllocation":{
|
||||
@@ -1173,6 +1449,7 @@
|
||||
}
|
||||
},
|
||||
"OwnerAccount":{"type":"string"},
|
||||
"PaginationToken":{"type":"string"},
|
||||
"PartnerName":{"type":"string"},
|
||||
"ProviderName":{"type":"string"},
|
||||
"Region":{"type":"string"},
|
||||
@@ -1203,6 +1480,7 @@
|
||||
"member":{"shape":"RouteFilterPrefix"}
|
||||
},
|
||||
"RouterConfig":{"type":"string"},
|
||||
"StateChangeError":{"type":"string"},
|
||||
"Tag":{
|
||||
"type":"structure",
|
||||
"required":["key"],
|
||||
@@ -1292,6 +1570,7 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"VirtualGateway"}
|
||||
},
|
||||
"VirtualGatewayRegion":{"type":"string"},
|
||||
"VirtualGatewayState":{"type":"string"},
|
||||
"VirtualGateways":{
|
||||
"type":"structure",
|
||||
@@ -1310,6 +1589,7 @@
|
||||
"virtualInterfaceName":{"shape":"VirtualInterfaceName"},
|
||||
"vlan":{"shape":"VLAN"},
|
||||
"asn":{"shape":"ASN"},
|
||||
"amazonSideAsn":{"shape":"LongAsn"},
|
||||
"authKey":{"shape":"BGPAuthKey"},
|
||||
"amazonAddress":{"shape":"AmazonAddress"},
|
||||
"customerAddress":{"shape":"CustomerAddress"},
|
||||
@@ -1317,6 +1597,7 @@
|
||||
"virtualInterfaceState":{"shape":"VirtualInterfaceState"},
|
||||
"customerRouterConfig":{"shape":"RouterConfig"},
|
||||
"virtualGatewayId":{"shape":"VirtualGatewayId"},
|
||||
"directConnectGatewayId":{"shape":"DirectConnectGatewayId"},
|
||||
"routeFilterPrefixes":{"shape":"RouteFilterPrefixList"},
|
||||
"bgpPeers":{"shape":"BGPPeerList"}
|
||||
}
|
||||
@@ -1327,6 +1608,7 @@
|
||||
"member":{"shape":"VirtualInterface"}
|
||||
},
|
||||
"VirtualInterfaceName":{"type":"string"},
|
||||
"VirtualInterfaceRegion":{"type":"string"},
|
||||
"VirtualInterfaceState":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
||||
Generated
Vendored
+219
-4
@@ -8,30 +8,37 @@
|
||||
"AllocatePublicVirtualInterface": "<p>Provisions a public virtual interface to be owned by a different customer.</p> <p>The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer.</p> <p>Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.</p> <p>When creating an IPv6 public virtual interface (addressFamily is 'ipv6'), the customer and amazon address fields should be left blank to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently not supported.</p>",
|
||||
"AssociateConnectionWithLag": "<p>Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to AWS will be interrupted). The connection must be hosted on the same AWS Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can reassociate a connection that's currently associated with a different LAG; however, if removing the connection will cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.</p> <p>Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG.</p> <p>For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG.</p>",
|
||||
"AssociateHostedConnection": "<p>Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to AWS as it is being migrated.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>",
|
||||
"AssociateVirtualInterface": "<p>Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to AWS is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails. </p> <p>Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using <a>AssociateHostedConnection</a>.</p> <p>Hosted virtual interfaces (an interface for which the owner of the connection is not the owner of physical connection) can only be reassociated by the owner of the physical connection.</p>",
|
||||
"AssociateVirtualInterface": "<p>Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to AWS is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails. </p> <p>Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using <a>AssociateHostedConnection</a>.</p> <p>In order to reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG to which the virtual interface will be newly associated.</p>",
|
||||
"ConfirmConnection": "<p>Confirm the creation of a hosted connection on an interconnect.</p> <p>Upon creation, the hosted connection is initially in the 'Ordering' state, and will remain in this state until the owner calls ConfirmConnection to confirm creation of the hosted connection.</p>",
|
||||
"ConfirmPrivateVirtualInterface": "<p>Accept ownership of a private virtual interface created by another customer.</p> <p>After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway, and will be available for handling traffic.</p>",
|
||||
"ConfirmPrivateVirtualInterface": "<p>Accept ownership of a private virtual interface created by another customer.</p> <p>After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway or direct connect gateway, and will be available for handling traffic.</p>",
|
||||
"ConfirmPublicVirtualInterface": "<p>Accept ownership of a public virtual interface created by another customer.</p> <p>After the virtual interface owner calls this function, the specified virtual interface will be created and made available for handling traffic.</p>",
|
||||
"CreateBGPPeer": "<p>Creates a new BGP peer on a specified virtual interface. The BGP peer cannot be in the same address family (IPv4/IPv6) of an existing BGP peer on the virtual interface.</p> <p>You must create a BGP peer for the corresponding address family in order to access AWS resources that also use that address family.</p> <p>When creating a IPv6 BGP peer, the Amazon address and customer address fields must be left blank. IPv6 addresses are automatically assigned from Amazon's pool of IPv6 addresses; you cannot specify custom IPv6 addresses.</p> <p>For a public virtual interface, the Autonomous System Number (ASN) must be private or already whitelisted for the virtual interface.</p>",
|
||||
"CreateConnection": "<p>Creates a new connection between the customer network and a specific AWS Direct Connect location.</p> <p>A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions.</p> <p>You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection will be created.</p>",
|
||||
"CreateConnection": "<p>Creates a new connection between the customer network and a specific AWS Direct Connect location.</p> <p>A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions.</p> <p>To find the locations for your region, use <a>DescribeLocations</a>.</p> <p>You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection will be created.</p>",
|
||||
"CreateDirectConnectGateway": "<p>Creates a new direct connect gateway. A direct connect gateway is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. direct connect gateways are global and visible in any AWS region after they are created. The virtual interfaces and virtual private gateways that are connected through a direct connect gateway can be in different regions. This enables you to connect to a VPC in any region, regardless of the region in which the virtual interfaces are located, and pass traffic between them.</p>",
|
||||
"CreateDirectConnectGatewayAssociation": "<p>Creates an association between a direct connect gateway and a virtual private gateway (VGW). The VGW must be attached to a VPC and must not be associated with another direct connect gateway.</p>",
|
||||
"CreateInterconnect": "<p>Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.</p> <p>An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router.</p> <p>You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect will be created.</p> <p>For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>",
|
||||
"CreateLag": "<p>Creates a new link aggregation group (LAG) with the specified number of bundled physical connections between the customer network and a specific AWS Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple 1 gigabit or 10 gigabit interfaces, allowing you to treat them as a single interface.</p> <p>All connections in a LAG must use the same bandwidth (for example, 10 Gbps), and must terminate at the same AWS Direct Connect endpoint.</p> <p>You can have up to 10 connections per LAG. Regardless of this limit, if you request more connections for the LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is created.</p> <p>You can specify an existing physical connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical connection or hosted connections, and re-establishes them as a member of the LAG. The LAG will be created on the same AWS Direct Connect endpoint to which the connection terminates. Any virtual interfaces associated with the connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.</p> <p>If the AWS account used to create a LAG is a registered AWS Direct Connect partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.</p>",
|
||||
"CreatePrivateVirtualInterface": "<p>Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC).</p>",
|
||||
"CreatePublicVirtualInterface": "<p>Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3).</p> <p>When creating an IPv6 public virtual interface (addressFamily is 'ipv6'), the customer and amazon address fields should be left blank to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently not supported.</p>",
|
||||
"DeleteBGPPeer": "<p>Deletes a BGP peer on the specified virtual interface that matches the specified customer address and ASN. You cannot delete the last BGP peer from a virtual interface.</p>",
|
||||
"DeleteConnection": "<p>Deletes the connection.</p> <p>Deleting a connection only stops the AWS Direct Connect port hour and data transfer charges. You need to cancel separately with the providers any services or charges for cross-connects or network circuits that connect you to the AWS Direct Connect location.</p>",
|
||||
"DeleteDirectConnectGateway": "<p>Deletes a direct connect gateway. You must first delete all virtual interfaces that are attached to the direct connect gateway and disassociate all virtual private gateways that are associated with the direct connect gateway.</p>",
|
||||
"DeleteDirectConnectGatewayAssociation": "<p>Deletes the association between a direct connect gateway and a virtual private gateway.</p>",
|
||||
"DeleteInterconnect": "<p>Deletes the specified interconnect.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>",
|
||||
"DeleteLag": "<p>Deletes a link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.</p>",
|
||||
"DeleteVirtualInterface": "<p>Deletes a virtual interface.</p>",
|
||||
"DescribeConnectionLoa": "<p>Deprecated in favor of <a>DescribeLoa</a>.</p> <p>Returns the LOA-CFA for a Connection.</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to AWS at the colocation facility. For more information, see <a href=\"http://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html\">Requesting Cross Connects at AWS Direct Connect Locations</a> in the AWS Direct Connect user guide.</p>",
|
||||
"DescribeConnections": "<p>Displays all connections in this region.</p> <p>If a connection ID is provided, the call returns only that particular connection.</p>",
|
||||
"DescribeConnectionsOnInterconnect": "<p>Deprecated in favor of <a>DescribeHostedConnections</a>.</p> <p>Returns a list of connections that have been provisioned on the given interconnect.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>",
|
||||
"DescribeDirectConnectGatewayAssociations": "<p>Returns a list of all direct connect gateway and virtual private gateway (VGW) associations. Either a direct connect gateway ID or a VGW ID must be provided in the request. If a direct connect gateway ID is provided, the response returns all VGWs associated with the direct connect gateway. If a VGW ID is provided, the response returns all direct connect gateways associated with the VGW. If both are provided, the response only returns the association that matches both the direct connect gateway and the VGW.</p>",
|
||||
"DescribeDirectConnectGatewayAttachments": "<p>Returns a list of all direct connect gateway and virtual interface (VIF) attachments. Either a direct connect gateway ID or a VIF ID must be provided in the request. If a direct connect gateway ID is provided, the response returns all VIFs attached to the direct connect gateway. If a VIF ID is provided, the response returns all direct connect gateways attached to the VIF. If both are provided, the response only returns the attachment that matches both the direct connect gateway and the VIF.</p>",
|
||||
"DescribeDirectConnectGateways": "<p>Returns a list of direct connect gateways in your account. Deleted direct connect gateways are not returned. You can provide a direct connect gateway ID in the request to return information about the specific direct connect gateway only. Otherwise, if a direct connect gateway ID is not provided, information about all of your direct connect gateways is returned. </p>",
|
||||
"DescribeHostedConnections": "<p>Returns a list of hosted connections that have been provisioned on the given interconnect or link aggregation group (LAG).</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>",
|
||||
"DescribeInterconnectLoa": "<p>Deprecated in favor of <a>DescribeLoa</a>.</p> <p>Returns the LOA-CFA for an Interconnect.</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see <a href=\"http://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html\">Requesting Cross Connects at AWS Direct Connect Locations</a> in the AWS Direct Connect user guide.</p>",
|
||||
"DescribeInterconnects": "<p>Returns a list of interconnects owned by the AWS account.</p> <p>If an interconnect ID is provided, it will only return this particular interconnect.</p>",
|
||||
"DescribeLags": "<p>Describes the link aggregation groups (LAGs) in your account. </p> <p>If a LAG ID is provided, only information about the specified LAG is returned.</p>",
|
||||
"DescribeLoa": "<p>Returns the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see <a href=\"http://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html\">Requesting Cross Connects at AWS Direct Connect Locations</a> in the AWS Direct Connect user guide.</p>",
|
||||
"DescribeLocations": "<p>Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling CreateConnection or CreateInterconnect.</p>",
|
||||
"DescribeLocations": "<p>Returns the list of AWS Direct Connect locations in the current AWS region. These are the locations that may be selected when calling <a>CreateConnection</a> or <a>CreateInterconnect</a>.</p>",
|
||||
"DescribeTags": "<p>Describes the tags associated with the specified Direct Connect resources.</p>",
|
||||
"DescribeVirtualGateways": "<p>Returns a list of virtual private gateways owned by the AWS account.</p> <p>You can create one or more AWS Direct Connect private virtual interfaces linking to a virtual private gateway. A virtual private gateway can be managed via Amazon Virtual Private Cloud (VPC) console or the <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html\">EC2 CreateVpnGateway</a> action.</p>",
|
||||
"DescribeVirtualInterfaces": "<p>Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.</p> <p>A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.</p>",
|
||||
@@ -295,6 +302,26 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateDirectConnectGatewayAssociationRequest": {
|
||||
"base": "<p>Container for the parameters to the CreateDirectConnectGatewayAssociation operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateDirectConnectGatewayAssociationResult": {
|
||||
"base": "<p>Container for the response from the CreateDirectConnectGatewayAssociation API call</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateDirectConnectGatewayRequest": {
|
||||
"base": "<p>Container for the parameters to the CreateDirectConnectGateway operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateDirectConnectGatewayResult": {
|
||||
"base": "<p>Container for the response from the CreateDirectConnectGateway API call</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateInterconnectRequest": {
|
||||
"base": "<p>Container for the parameters to the CreateInterconnect operation.</p>",
|
||||
"refs": {
|
||||
@@ -343,6 +370,26 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteDirectConnectGatewayAssociationRequest": {
|
||||
"base": "<p>Container for the parameters to the DeleteDirectConnectGatewayAssociation operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteDirectConnectGatewayAssociationResult": {
|
||||
"base": "<p>Container for the response from the DeleteDirectConnectGatewayAssociation API call</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteDirectConnectGatewayRequest": {
|
||||
"base": "<p>Container for the parameters to the DeleteDirectConnectGateway operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteDirectConnectGatewayResult": {
|
||||
"base": "<p>Container for the response from the DeleteDirectConnectGateway API call</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteInterconnectRequest": {
|
||||
"base": "<p>Container for the parameters to the DeleteInterconnect operation.</p>",
|
||||
"refs": {
|
||||
@@ -388,6 +435,36 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeDirectConnectGatewayAssociationsRequest": {
|
||||
"base": "<p>Container for the parameters to the DescribeDirectConnectGatewayAssociations operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeDirectConnectGatewayAssociationsResult": {
|
||||
"base": "<p>Container for the response from the DescribeDirectConnectGatewayAssociations API call</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeDirectConnectGatewayAttachmentsRequest": {
|
||||
"base": "<p>Container for the parameters to the DescribeDirectConnectGatewayAttachments operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeDirectConnectGatewayAttachmentsResult": {
|
||||
"base": "<p>Container for the response from the DescribeDirectConnectGatewayAttachments API call</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeDirectConnectGatewaysRequest": {
|
||||
"base": "<p>Container for the parameters to the DescribeDirectConnectGateways operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeDirectConnectGatewaysResult": {
|
||||
"base": "<p>Container for the response from the DescribeDirectConnectGateways API call</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeHostedConnectionsRequest": {
|
||||
"base": "<p>Container for the parameters to the DescribeHostedConnections operation.</p>",
|
||||
"refs": {
|
||||
@@ -438,6 +515,88 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DirectConnectGateway": {
|
||||
"base": "<p>A direct connect gateway is an intermediate object that enables you to connect virtual interfaces and virtual private gateways.</p>",
|
||||
"refs": {
|
||||
"CreateDirectConnectGatewayResult$directConnectGateway": "<p>The direct connect gateway to be created.</p>",
|
||||
"DeleteDirectConnectGatewayResult$directConnectGateway": "<p>The direct connect gateway to be deleted.</p>",
|
||||
"DirectConnectGatewayList$member": null
|
||||
}
|
||||
},
|
||||
"DirectConnectGatewayAssociation": {
|
||||
"base": "<p>The association between a direct connect gateway and virtual private gateway.</p>",
|
||||
"refs": {
|
||||
"CreateDirectConnectGatewayAssociationResult$directConnectGatewayAssociation": "<p>The direct connect gateway association to be created.</p>",
|
||||
"DeleteDirectConnectGatewayAssociationResult$directConnectGatewayAssociation": "<p>The direct connect gateway association to be deleted.</p>",
|
||||
"DirectConnectGatewayAssociationList$member": null
|
||||
}
|
||||
},
|
||||
"DirectConnectGatewayAssociationList": {
|
||||
"base": "<p>A list of direct connect gateway associations.</p>",
|
||||
"refs": {
|
||||
"DescribeDirectConnectGatewayAssociationsResult$directConnectGatewayAssociations": "<p>Information about the direct connect gateway associations.</p>"
|
||||
}
|
||||
},
|
||||
"DirectConnectGatewayAssociationState": {
|
||||
"base": "<p>State of the direct connect gateway association.</p> <ul> <li> <p> <b>Associating</b>: The initial state after calling <a>CreateDirectConnectGatewayAssociation</a>.</p> </li> <li> <p> <b>Associated</b>: The direct connect gateway and virtual private gateway are successfully associated and ready to pass traffic.</p> </li> <li> <p> <b>Disassociating</b>: The initial state after calling <a>DeleteDirectConnectGatewayAssociation</a>.</p> </li> <li> <p> <b>Disassociated</b>: The virtual private gateway is successfully disassociated from the direct connect gateway. Traffic flow between the direct connect gateway and virtual private gateway stops.</p> </li> </ul>",
|
||||
"refs": {
|
||||
"DirectConnectGatewayAssociation$associationState": null
|
||||
}
|
||||
},
|
||||
"DirectConnectGatewayAttachment": {
|
||||
"base": "<p>The association between a direct connect gateway and virtual interface.</p>",
|
||||
"refs": {
|
||||
"DirectConnectGatewayAttachmentList$member": null
|
||||
}
|
||||
},
|
||||
"DirectConnectGatewayAttachmentList": {
|
||||
"base": "<p>A list of direct connect gateway attachments.</p>",
|
||||
"refs": {
|
||||
"DescribeDirectConnectGatewayAttachmentsResult$directConnectGatewayAttachments": "<p>Information about the direct connect gateway attachments.</p>"
|
||||
}
|
||||
},
|
||||
"DirectConnectGatewayAttachmentState": {
|
||||
"base": "<p>State of the direct connect gateway attachment.</p> <ul> <li> <p> <b>Attaching</b>: The initial state after a virtual interface is created using the direct connect gateway.</p> </li> <li> <p> <b>Attached</b>: The direct connect gateway and virtual interface are successfully attached and ready to pass traffic.</p> </li> <li> <p> <b>Detaching</b>: The initial state after calling <a>DeleteVirtualInterface</a> on a virtual interface that is attached to a direct connect gateway.</p> </li> <li> <p> <b>Detached</b>: The virtual interface is successfully detached from the direct connect gateway. Traffic flow between the direct connect gateway and virtual interface stops.</p> </li> </ul>",
|
||||
"refs": {
|
||||
"DirectConnectGatewayAttachment$attachmentState": null
|
||||
}
|
||||
},
|
||||
"DirectConnectGatewayId": {
|
||||
"base": "<p>The ID of the direct connect gateway.</p> <p>Example: \"abcd1234-dcba-5678-be23-cdef9876ab45\"</p>",
|
||||
"refs": {
|
||||
"ConfirmPrivateVirtualInterfaceRequest$directConnectGatewayId": "<p>ID of the direct connect gateway that will be attached to the virtual interface.</p> <p> A direct connect gateway can be managed via the AWS Direct Connect console or the <a>CreateDirectConnectGateway</a> action.</p> <p>Default: None</p>",
|
||||
"CreateDirectConnectGatewayAssociationRequest$directConnectGatewayId": "<p>The ID of the direct connect gateway.</p> <p>Example: \"abcd1234-dcba-5678-be23-cdef9876ab45\"</p> <p>Default: None</p>",
|
||||
"DeleteDirectConnectGatewayAssociationRequest$directConnectGatewayId": "<p>The ID of the direct connect gateway.</p> <p>Example: \"abcd1234-dcba-5678-be23-cdef9876ab45\"</p> <p>Default: None</p>",
|
||||
"DeleteDirectConnectGatewayRequest$directConnectGatewayId": "<p>The ID of the direct connect gateway.</p> <p>Example: \"abcd1234-dcba-5678-be23-cdef9876ab45\"</p> <p>Default: None</p>",
|
||||
"DescribeDirectConnectGatewayAssociationsRequest$directConnectGatewayId": "<p>The ID of the direct connect gateway.</p> <p>Example: \"abcd1234-dcba-5678-be23-cdef9876ab45\"</p> <p>Default: None</p>",
|
||||
"DescribeDirectConnectGatewayAttachmentsRequest$directConnectGatewayId": "<p>The ID of the direct connect gateway.</p> <p>Example: \"abcd1234-dcba-5678-be23-cdef9876ab45\"</p> <p>Default: None</p>",
|
||||
"DescribeDirectConnectGatewaysRequest$directConnectGatewayId": "<p>The ID of the direct connect gateway.</p> <p>Example: \"abcd1234-dcba-5678-be23-cdef9876ab45\"</p> <p>Default: None</p>",
|
||||
"DirectConnectGateway$directConnectGatewayId": null,
|
||||
"DirectConnectGatewayAssociation$directConnectGatewayId": null,
|
||||
"DirectConnectGatewayAttachment$directConnectGatewayId": null,
|
||||
"NewPrivateVirtualInterface$directConnectGatewayId": null,
|
||||
"VirtualInterface$directConnectGatewayId": null
|
||||
}
|
||||
},
|
||||
"DirectConnectGatewayList": {
|
||||
"base": "<p>A list of direct connect gateways.</p>",
|
||||
"refs": {
|
||||
"DescribeDirectConnectGatewaysResult$directConnectGateways": "<p>Information about the direct connect gateways.</p>"
|
||||
}
|
||||
},
|
||||
"DirectConnectGatewayName": {
|
||||
"base": "<p>The name of the direct connect gateway.</p> <p>Example: \"My direct connect gateway\"</p> <p>Default: None</p>",
|
||||
"refs": {
|
||||
"CreateDirectConnectGatewayRequest$directConnectGatewayName": "<p>The name of the direct connect gateway.</p> <p>Example: \"My direct connect gateway\"</p> <p>Default: None</p>",
|
||||
"DirectConnectGateway$directConnectGatewayName": null
|
||||
}
|
||||
},
|
||||
"DirectConnectGatewayState": {
|
||||
"base": "<p>State of the direct connect gateway.</p> <ul> <li> <p> <b>Pending</b>: The initial state after calling <a>CreateDirectConnectGateway</a>.</p> </li> <li> <p> <b>Available</b>: The direct connect gateway is ready for use.</p> </li> <li> <p> <b>Deleting</b>: The initial state after calling <a>DeleteDirectConnectGateway</a>.</p> </li> <li> <p> <b>Deleted</b>: The direct connect gateway is deleted and cannot pass traffic.</p> </li> </ul>",
|
||||
"refs": {
|
||||
"DirectConnectGateway$directConnectGatewayState": null
|
||||
}
|
||||
},
|
||||
"DirectConnectServerException": {
|
||||
"base": "<p>A server-side error occurred during the API call. The error message will contain additional details about the cause.</p>",
|
||||
"refs": {
|
||||
@@ -613,6 +772,22 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"LongAsn": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateDirectConnectGatewayRequest$amazonSideAsn": "<p>The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294 </p> <p>Example: 65200</p> <p>Default: 64512</p>",
|
||||
"DirectConnectGateway$amazonSideAsn": "<p>The autonomous system number (ASN) for the Amazon side of the connection.</p>",
|
||||
"VirtualInterface$amazonSideAsn": "<p>The autonomous system number (ASN) for the Amazon side of the connection.</p>"
|
||||
}
|
||||
},
|
||||
"MaxResultSetSize": {
|
||||
"base": "<p>Maximum number of objects to return per page.</p>",
|
||||
"refs": {
|
||||
"DescribeDirectConnectGatewayAssociationsRequest$maxResults": "<p>The maximum number of direct connect gateway associations to return per page.</p> <p>Example: 15</p> <p>Default: None</p>",
|
||||
"DescribeDirectConnectGatewayAttachmentsRequest$maxResults": "<p>The maximum number of direct connect gateway attachments to return per page.</p> <p>Example: 15</p> <p>Default: None</p>",
|
||||
"DescribeDirectConnectGatewaysRequest$maxResults": "<p>The maximum number of direct connect gateways to return per page.</p> <p>Example: 15</p> <p>Default: None</p>"
|
||||
}
|
||||
},
|
||||
"NewBGPPeer": {
|
||||
"base": "<p>A structure containing information about a new BGP peer.</p>",
|
||||
"refs": {
|
||||
@@ -651,10 +826,24 @@
|
||||
"AllocatePrivateVirtualInterfaceRequest$ownerAccount": "<p>The AWS account that will own the new private virtual interface.</p> <p>Default: None</p>",
|
||||
"AllocatePublicVirtualInterfaceRequest$ownerAccount": "<p>The AWS account that will own the new public virtual interface.</p> <p>Default: None</p>",
|
||||
"Connection$ownerAccount": "<p>The AWS account that will own the new connection.</p>",
|
||||
"DirectConnectGateway$ownerAccount": "<p>The AWS account ID of the owner of the direct connect gateway.</p>",
|
||||
"DirectConnectGatewayAssociation$virtualGatewayOwnerAccount": "<p>The AWS account ID of the owner of the virtual private gateway.</p>",
|
||||
"DirectConnectGatewayAttachment$virtualInterfaceOwnerAccount": "<p>The AWS account ID of the owner of the virtual interface.</p>",
|
||||
"Lag$ownerAccount": "<p>The owner of the LAG.</p>",
|
||||
"VirtualInterface$ownerAccount": "<p>The AWS account that will own the new virtual interface.</p>"
|
||||
}
|
||||
},
|
||||
"PaginationToken": {
|
||||
"base": "<p>Token to retrieve the next page of the result.</p>",
|
||||
"refs": {
|
||||
"DescribeDirectConnectGatewayAssociationsRequest$nextToken": "<p>The token provided in the previous describe result to retrieve the next page of the result.</p> <p>Default: None</p>",
|
||||
"DescribeDirectConnectGatewayAssociationsResult$nextToken": null,
|
||||
"DescribeDirectConnectGatewayAttachmentsRequest$nextToken": "<p>The token provided in the previous describe result to retrieve the next page of the result.</p> <p>Default: None</p>",
|
||||
"DescribeDirectConnectGatewayAttachmentsResult$nextToken": null,
|
||||
"DescribeDirectConnectGatewaysRequest$nextToken": "<p>The token provided in the previous describe result to retrieve the next page of the result.</p> <p>Default: None</p>",
|
||||
"DescribeDirectConnectGatewaysResult$nextToken": null
|
||||
}
|
||||
},
|
||||
"PartnerName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -724,6 +913,14 @@
|
||||
"VirtualInterface$customerRouterConfig": "<p>Information for generating the customer router configuration.</p>"
|
||||
}
|
||||
},
|
||||
"StateChangeError": {
|
||||
"base": "<p>Error message when the state of an object fails to advance.</p>",
|
||||
"refs": {
|
||||
"DirectConnectGateway$stateChangeError": null,
|
||||
"DirectConnectGatewayAssociation$stateChangeError": null,
|
||||
"DirectConnectGatewayAttachment$stateChangeError": null
|
||||
}
|
||||
},
|
||||
"Tag": {
|
||||
"base": "<p>Information about a tag.</p>",
|
||||
"refs": {
|
||||
@@ -809,6 +1006,10 @@
|
||||
"base": "<p>The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.</p> <p>Example: vgw-123er56</p>",
|
||||
"refs": {
|
||||
"ConfirmPrivateVirtualInterfaceRequest$virtualGatewayId": "<p>ID of the virtual private gateway that will be attached to the virtual interface.</p> <p> A virtual private gateway can be managed via the Amazon Virtual Private Cloud (VPC) console or the <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateVpnGateway.html\">EC2 CreateVpnGateway</a> action.</p> <p>Default: None</p>",
|
||||
"CreateDirectConnectGatewayAssociationRequest$virtualGatewayId": "<p>The ID of the virtual private gateway.</p> <p>Example: \"vgw-abc123ef\"</p> <p>Default: None</p>",
|
||||
"DeleteDirectConnectGatewayAssociationRequest$virtualGatewayId": "<p>The ID of the virtual private gateway.</p> <p>Example: \"vgw-abc123ef\"</p> <p>Default: None</p>",
|
||||
"DescribeDirectConnectGatewayAssociationsRequest$virtualGatewayId": "<p>The ID of the virtual private gateway.</p> <p>Example: \"vgw-abc123ef\"</p> <p>Default: None</p>",
|
||||
"DirectConnectGatewayAssociation$virtualGatewayId": null,
|
||||
"NewPrivateVirtualInterface$virtualGatewayId": null,
|
||||
"VirtualGateway$virtualGatewayId": null,
|
||||
"VirtualInterface$virtualGatewayId": null
|
||||
@@ -820,6 +1021,12 @@
|
||||
"VirtualGateways$virtualGateways": "<p>A list of virtual private gateways.</p>"
|
||||
}
|
||||
},
|
||||
"VirtualGatewayRegion": {
|
||||
"base": "<p>The region in which the virtual private gateway is located.</p> <p>Example: us-east-1</p>",
|
||||
"refs": {
|
||||
"DirectConnectGatewayAssociation$virtualGatewayRegion": null
|
||||
}
|
||||
},
|
||||
"VirtualGatewayState": {
|
||||
"base": "<p>State of the virtual private gateway.</p> <ul> <li> <p> <b>Pending</b>: This is the initial state after calling <i>CreateVpnGateway</i>.</p> </li> <li> <p> <b>Available</b>: Ready for use by a private virtual interface.</p> </li> <li> <p> <b>Deleting</b>: This is the initial state after calling <i>DeleteVpnGateway</i>.</p> </li> <li> <p> <b>Deleted</b>: In this state, a private virtual interface is unable to send traffic over this gateway.</p> </li> </ul>",
|
||||
"refs": {
|
||||
@@ -848,7 +1055,9 @@
|
||||
"CreateBGPPeerRequest$virtualInterfaceId": "<p>The ID of the virtual interface on which the BGP peer will be provisioned.</p> <p>Example: dxvif-456abc78</p> <p>Default: None</p>",
|
||||
"DeleteBGPPeerRequest$virtualInterfaceId": "<p>The ID of the virtual interface from which the BGP peer will be deleted.</p> <p>Example: dxvif-456abc78</p> <p>Default: None</p>",
|
||||
"DeleteVirtualInterfaceRequest$virtualInterfaceId": null,
|
||||
"DescribeDirectConnectGatewayAttachmentsRequest$virtualInterfaceId": "<p>The ID of the virtual interface.</p> <p>Example: \"dxvif-abc123ef\"</p> <p>Default: None</p>",
|
||||
"DescribeVirtualInterfacesRequest$virtualInterfaceId": null,
|
||||
"DirectConnectGatewayAttachment$virtualInterfaceId": null,
|
||||
"VirtualInterface$virtualInterfaceId": null
|
||||
}
|
||||
},
|
||||
@@ -868,6 +1077,12 @@
|
||||
"VirtualInterface$virtualInterfaceName": null
|
||||
}
|
||||
},
|
||||
"VirtualInterfaceRegion": {
|
||||
"base": "<p>The region in which the virtual interface is located.</p> <p>Example: us-east-1</p>",
|
||||
"refs": {
|
||||
"DirectConnectGatewayAttachment$virtualInterfaceRegion": null
|
||||
}
|
||||
},
|
||||
"VirtualInterfaceState": {
|
||||
"base": "<p>State of the virtual interface.</p> <ul> <li> <p> <b>Confirming</b>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</p> </li> <li> <p> <b>Verifying</b>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</p> </li> <li> <p> <b>Pending</b>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</p> </li> <li> <p> <b>Available</b>: A virtual interface that is able to forward traffic.</p> </li> <li> <p> <b>Down</b>: A virtual interface that is BGP down.</p> </li> <li> <p> <b>Deleting</b>: A virtual interface is in this state immediately after calling <a>DeleteVirtualInterface</a> until it can no longer forward traffic.</p> </li> <li> <p> <b>Deleted</b>: A virtual interface that cannot forward traffic.</p> </li> <li> <p> <b>Rejected</b>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.</p> </li> </ul>",
|
||||
"refs": {
|
||||
|
||||
+4
-12
@@ -6,6 +6,7 @@
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceFullName":"AWS Application Discovery Service",
|
||||
"serviceId":"Application Discovery Service",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"AWSPoseidonService_V2015_11_01",
|
||||
"uid":"discovery-2015-11-01"
|
||||
@@ -429,10 +430,7 @@
|
||||
},
|
||||
"ConfigurationTagSet":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"ConfigurationTag",
|
||||
"locationName":"item"
|
||||
}
|
||||
"member":{"shape":"ConfigurationTag"}
|
||||
},
|
||||
"Configurations":{
|
||||
"type":"list",
|
||||
@@ -725,10 +723,7 @@
|
||||
"FilterValue":{"type":"string"},
|
||||
"FilterValues":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"FilterValue",
|
||||
"locationName":"item"
|
||||
}
|
||||
"member":{"shape":"FilterValue"}
|
||||
},
|
||||
"Filters":{
|
||||
"type":"list",
|
||||
@@ -930,10 +925,7 @@
|
||||
"TagKey":{"type":"string"},
|
||||
"TagSet":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"Tag",
|
||||
"locationName":"item"
|
||||
}
|
||||
"member":{"shape":"Tag"}
|
||||
},
|
||||
"TagValue":{"type":"string"},
|
||||
"TimeStamp":{"type":"timestamp"},
|
||||
|
||||
+3
-3
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<fullname>AWS Application Discovery Service</fullname> <p>AWS Application Discovery Service helps you plan application migration projects by automatically identifying servers, virtual machines (VMs), software, and software dependencies running in your on-premises data centers. Application Discovery Service also collects application performance data, which can help you assess the outcome of your migration. The data collected by Application Discovery Service is securely retained in an Amazon-hosted and managed database in the cloud. You can export the data as a CSV or XML file into your preferred visualization tool or cloud-migration solution to plan your migration. For more information, see the Application Discovery Service <a href=\"http://aws.amazon.com/application-discovery/faqs/\">FAQ</a>.</p> <p>Application Discovery Service offers two modes of operation.</p> <ul> <li> <p> <b>Agentless discovery</b> mode is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. Agentless discovery gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment. Agentless discovery doesn't collect information about software and software dependencies. It also doesn't work in non-VMware environments. We recommend that you use agent-based discovery for non-VMware environments and if you want to collect information about software and software dependencies. You can also run agent-based and agentless discovery simultaneously. Use agentless discovery to quickly complete the initial infrastructure assessment and then install agents on select hosts to gather information about software and software dependencies.</p> </li> <li> <p> <b>Agent-based discovery</b> mode collects a richer set of data than agentless discovery by using Amazon software, the AWS Application Discovery Agent, which you install on one or more hosts in your data center. The agent captures infrastructure and application information, including an inventory of installed software applications, system and process performance, resource utilization, and network dependencies between workloads. The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud. </p> </li> </ul> <p>Application Discovery Service integrates with application discovery solutions from AWS Partner Network (APN) partners. Third-party application discovery tools can query Application Discovery Service and write to the Application Discovery Service database using a public API. You can then import the data into either a visualization tool or cloud-migration solution.</p> <important> <p>Application Discovery Service doesn't gather sensitive information. All data is handled according to the <a href=\"http://aws.amazon.com/privacy/\">AWS Privacy Policy</a>. You can operate Application Discovery Service using offline mode to inspect collected data before it is shared with the service.</p> </important> <p>Your AWS account must be granted access to Application Discovery Service, a process called <i>whitelisting</i>. This is true for AWS partners and customers alike. To request access, sign up for AWS Application Discovery Service <a href=\"http://aws.amazon.com/application-discovery/preview/\">here</a>. We send you information about how to get started.</p> <p>This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see <a href=\"http://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p> <p>This guide is intended for use with the <a href=\"http://docs.aws.amazon.com/application-discovery/latest/userguide/\"> <i>AWS Application Discovery Service User Guide</i> </a>.</p>",
|
||||
"service": "<fullname>AWS Application Discovery Service</fullname> <p>AWS Application Discovery Service helps you plan application migration projects by automatically identifying servers, virtual machines (VMs), software, and software dependencies running in your on-premises data centers. Application Discovery Service also collects application performance data, which can help you assess the outcome of your migration. The data collected by Application Discovery Service is securely retained in an AWS-hosted and managed database in the cloud. You can export the data as a CSV or XML file into your preferred visualization tool or cloud-migration solution to plan your migration. For more information, see <a href=\"http://aws.amazon.com/application-discovery/faqs/\">AWS Application Discovery Service FAQ</a>.</p> <p>Application Discovery Service offers two modes of operation:</p> <ul> <li> <p> <b>Agentless discovery</b> mode is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. Agentless discovery gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment. Agentless discovery doesn't collect information about software and software dependencies. It also doesn't work in non-VMware environments. </p> </li> <li> <p> <b>Agent-based discovery</b> mode collects a richer set of data than agentless discovery by using the AWS Application Discovery Agent, which you install on one or more hosts in your data center. The agent captures infrastructure and application information, including an inventory of installed software applications, system and process performance, resource utilization, and network dependencies between workloads. The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud. </p> </li> </ul> <p>We recommend that you use agent-based discovery for non-VMware environments and to collect information about software and software dependencies. You can also run agent-based and agentless discovery simultaneously. Use agentless discovery to quickly complete the initial infrastructure assessment and then install agents on select hosts.</p> <p>Application Discovery Service integrates with application discovery solutions from AWS Partner Network (APN) partners. Third-party application discovery tools can query Application Discovery Service and write to the Application Discovery Service database using a public API. You can then import the data into either a visualization tool or cloud-migration solution.</p> <important> <p>Application Discovery Service doesn't gather sensitive information. All data is handled according to the <a href=\"http://aws.amazon.com/privacy/\">AWS Privacy Policy</a>. You can operate Application Discovery Service offline to inspect collected data before it is shared with the service.</p> </important> <p>Your AWS account must be granted access to Application Discovery Service, a process called <i>whitelisting</i>. This is true for AWS partners and customers alike. To request access, <a href=\"http://aws.amazon.com/application-discovery/\">sign up for Application Discovery Service</a>. </p> <p>This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see <a href=\"http://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p> <p>This guide is intended for use with the <a href=\"http://docs.aws.amazon.com/application-discovery/latest/userguide/\"> <i>AWS Application Discovery Service User Guide</i> </a>.</p>",
|
||||
"operations": {
|
||||
"AssociateConfigurationItemsToApplication": "<p>Associates one or more configuration items with an application.</p>",
|
||||
"CreateApplication": "<p>Creates an application with the given name and description.</p>",
|
||||
@@ -18,7 +18,7 @@
|
||||
"ListConfigurations": "<p>Retrieves a list of configuration items according to criteria that you specify in a filter. The filter criteria identifies the relationship requirements.</p>",
|
||||
"ListServerNeighbors": "<p>Retrieves a list of servers that are one network hop away from a specified server.</p>",
|
||||
"StartDataCollectionByAgentIds": "<p>Instructs the specified agents or connectors to start collecting data.</p>",
|
||||
"StartExportTask": "<p> Begins the export of discovered data to an S3 bucket.</p> <p> If you specify <code>agentId</code> in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using <code>startTime</code> and <code>endTime</code>. Export of detailed agent data is limited to five concurrently running exports. </p> <p> If you do not include an <code>agentId</code> filter, summary data is exported that includes both AWS Agentless Discovery Connector data and summary data from AWS Discovery Agents. Export of summary data is limited to two exports per day. </p>",
|
||||
"StartExportTask": "<p> Begins the export of discovered data to an S3 bucket.</p> <p> If you specify <code>agentIds</code> in a filter, the task exports up to 72 hours of detailed data collected by the identified Application Discovery Agent, including network, process, and performance details. A time range for exported agent data may be set by using <code>startTime</code> and <code>endTime</code>. Export of detailed agent data is limited to five concurrently running exports. </p> <p> If you do not include an <code>agentIds</code> filter, summary data is exported that includes both AWS Agentless Discovery Connector data and summary data from AWS Discovery Agents. Export of summary data is limited to two exports per day. </p>",
|
||||
"StopDataCollectionByAgentIds": "<p>Instructs the specified agents or connectors to stop collecting data.</p>",
|
||||
"UpdateApplication": "<p>Updates metadata about an application.</p>"
|
||||
},
|
||||
@@ -337,7 +337,7 @@
|
||||
"ExportDataFormats": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StartExportTaskRequest$exportDataFormat": "<p>The file format for the returned export data. Default value is <code>CSV</code>.</p>"
|
||||
"StartExportTaskRequest$exportDataFormat": "<p>The file format for the returned export data. Default value is <code>CSV</code>. <b>Note:</b> <i>The</i> <code>GRAPHML</code> <i>option has been deprecated.</i> </p>"
|
||||
}
|
||||
},
|
||||
"ExportFilter": {
|
||||
|
||||
+169
-86
@@ -6,6 +6,7 @@
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceFullName":"AWS Database Migration Service",
|
||||
"serviceId":"Database Migration Service",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"AmazonDMSv20160101",
|
||||
"uid":"dms-2016-01-01"
|
||||
@@ -295,6 +296,19 @@
|
||||
{"shape":"ResourceNotFoundFault"}
|
||||
]
|
||||
},
|
||||
"DescribeReplicationInstanceTaskLogs":{
|
||||
"name":"DescribeReplicationInstanceTaskLogs",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeReplicationInstanceTaskLogsMessage"},
|
||||
"output":{"shape":"DescribeReplicationInstanceTaskLogsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundFault"},
|
||||
{"shape":"InvalidResourceStateFault"}
|
||||
]
|
||||
},
|
||||
"DescribeReplicationInstances":{
|
||||
"name":"DescribeReplicationInstances",
|
||||
"http":{
|
||||
@@ -319,6 +333,18 @@
|
||||
{"shape":"ResourceNotFoundFault"}
|
||||
]
|
||||
},
|
||||
"DescribeReplicationTaskAssessmentResults":{
|
||||
"name":"DescribeReplicationTaskAssessmentResults",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeReplicationTaskAssessmentResultsMessage"},
|
||||
"output":{"shape":"DescribeReplicationTaskAssessmentResultsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundFault"}
|
||||
]
|
||||
},
|
||||
"DescribeReplicationTasks":{
|
||||
"name":"DescribeReplicationTasks",
|
||||
"http":{
|
||||
@@ -367,7 +393,8 @@
|
||||
"output":{"shape":"ImportCertificateResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceAlreadyExistsFault"},
|
||||
{"shape":"InvalidCertificateFault"}
|
||||
{"shape":"InvalidCertificateFault"},
|
||||
{"shape":"ResourceQuotaExceededFault"}
|
||||
]
|
||||
},
|
||||
"ListTagsForResource":{
|
||||
@@ -462,6 +489,19 @@
|
||||
{"shape":"KMSKeyNotAccessibleFault"}
|
||||
]
|
||||
},
|
||||
"RebootReplicationInstance":{
|
||||
"name":"RebootReplicationInstance",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"RebootReplicationInstanceMessage"},
|
||||
"output":{"shape":"RebootReplicationInstanceResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundFault"},
|
||||
{"shape":"InvalidResourceStateFault"}
|
||||
]
|
||||
},
|
||||
"RefreshSchemas":{
|
||||
"name":"RefreshSchemas",
|
||||
"http":{
|
||||
@@ -515,6 +555,19 @@
|
||||
{"shape":"InvalidResourceStateFault"}
|
||||
]
|
||||
},
|
||||
"StartReplicationTaskAssessment":{
|
||||
"name":"StartReplicationTaskAssessment",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StartReplicationTaskAssessmentMessage"},
|
||||
"output":{"shape":"StartReplicationTaskAssessmentResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidResourceStateFault"},
|
||||
{"shape":"ResourceNotFoundFault"}
|
||||
]
|
||||
},
|
||||
"StopReplicationTask":{
|
||||
"name":"StopReplicationTask",
|
||||
"http":{
|
||||
@@ -562,10 +615,7 @@
|
||||
},
|
||||
"AccountQuotaList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"AccountQuota",
|
||||
"locationName":"AccountQuota"
|
||||
}
|
||||
"member":{"shape":"AccountQuota"}
|
||||
},
|
||||
"AddTagsToResourceMessage":{
|
||||
"type":"structure",
|
||||
@@ -623,10 +673,7 @@
|
||||
},
|
||||
"CertificateList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"Certificate",
|
||||
"locationName":"Certificate"
|
||||
}
|
||||
"member":{"shape":"Certificate"}
|
||||
},
|
||||
"CertificateWallet":{"type":"blob"},
|
||||
"CompressionTypeValue":{
|
||||
@@ -649,10 +696,7 @@
|
||||
},
|
||||
"ConnectionList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"Connection",
|
||||
"locationName":"Connection"
|
||||
}
|
||||
"member":{"shape":"Connection"}
|
||||
},
|
||||
"CreateEndpointMessage":{
|
||||
"type":"structure",
|
||||
@@ -1009,6 +1053,23 @@
|
||||
"RefreshSchemasStatus":{"shape":"RefreshSchemasStatus"}
|
||||
}
|
||||
},
|
||||
"DescribeReplicationInstanceTaskLogsMessage":{
|
||||
"type":"structure",
|
||||
"required":["ReplicationInstanceArn"],
|
||||
"members":{
|
||||
"ReplicationInstanceArn":{"shape":"String"},
|
||||
"MaxRecords":{"shape":"IntegerOptional"},
|
||||
"Marker":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeReplicationInstanceTaskLogsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ReplicationInstanceArn":{"shape":"String"},
|
||||
"ReplicationInstanceTaskLogs":{"shape":"ReplicationInstanceTaskLogsList"},
|
||||
"Marker":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeReplicationInstancesMessage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1039,6 +1100,22 @@
|
||||
"ReplicationSubnetGroups":{"shape":"ReplicationSubnetGroups"}
|
||||
}
|
||||
},
|
||||
"DescribeReplicationTaskAssessmentResultsMessage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ReplicationTaskArn":{"shape":"String"},
|
||||
"MaxRecords":{"shape":"IntegerOptional"},
|
||||
"Marker":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeReplicationTaskAssessmentResultsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Marker":{"shape":"String"},
|
||||
"BucketName":{"shape":"String"},
|
||||
"ReplicationTaskAssessmentResults":{"shape":"ReplicationTaskAssessmentResultList"}
|
||||
}
|
||||
},
|
||||
"DescribeReplicationTasksMessage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1076,7 +1153,8 @@
|
||||
"members":{
|
||||
"ReplicationTaskArn":{"shape":"String"},
|
||||
"MaxRecords":{"shape":"IntegerOptional"},
|
||||
"Marker":{"shape":"String"}
|
||||
"Marker":{"shape":"String"},
|
||||
"Filters":{"shape":"FilterList"}
|
||||
}
|
||||
},
|
||||
"DescribeTableStatisticsResponse":{
|
||||
@@ -1127,10 +1205,7 @@
|
||||
},
|
||||
"EndpointList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"Endpoint",
|
||||
"locationName":"Endpoint"
|
||||
}
|
||||
"member":{"shape":"Endpoint"}
|
||||
},
|
||||
"Event":{
|
||||
"type":"structure",
|
||||
@@ -1144,10 +1219,7 @@
|
||||
},
|
||||
"EventCategoriesList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"String",
|
||||
"locationName":"EventCategory"
|
||||
}
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"EventCategoryGroup":{
|
||||
"type":"structure",
|
||||
@@ -1158,17 +1230,11 @@
|
||||
},
|
||||
"EventCategoryGroupList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"EventCategoryGroup",
|
||||
"locationName":"EventCategoryGroup"
|
||||
}
|
||||
"member":{"shape":"EventCategoryGroup"}
|
||||
},
|
||||
"EventList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"Event",
|
||||
"locationName":"Event"
|
||||
}
|
||||
"member":{"shape":"Event"}
|
||||
},
|
||||
"EventSubscription":{
|
||||
"type":"structure",
|
||||
@@ -1186,10 +1252,7 @@
|
||||
},
|
||||
"EventSubscriptionsList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"EventSubscription",
|
||||
"locationName":"EventSubscription"
|
||||
}
|
||||
"member":{"shape":"EventSubscription"}
|
||||
},
|
||||
"ExceptionMessage":{"type":"string"},
|
||||
"Filter":{
|
||||
@@ -1205,17 +1268,11 @@
|
||||
},
|
||||
"FilterList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"Filter",
|
||||
"locationName":"Filter"
|
||||
}
|
||||
"member":{"shape":"Filter"}
|
||||
},
|
||||
"FilterValueList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"String",
|
||||
"locationName":"Value"
|
||||
}
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"ImportCertificateMessage":{
|
||||
"type":"structure",
|
||||
@@ -1436,9 +1493,20 @@
|
||||
},
|
||||
"OrderableReplicationInstanceList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"OrderableReplicationInstance",
|
||||
"locationName":"OrderableReplicationInstance"
|
||||
"member":{"shape":"OrderableReplicationInstance"}
|
||||
},
|
||||
"RebootReplicationInstanceMessage":{
|
||||
"type":"structure",
|
||||
"required":["ReplicationInstanceArn"],
|
||||
"members":{
|
||||
"ReplicationInstanceArn":{"shape":"String"},
|
||||
"ForceFailover":{"shape":"BooleanOptional"}
|
||||
}
|
||||
},
|
||||
"RebootReplicationInstanceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ReplicationInstance":{"shape":"ReplicationInstance"}
|
||||
}
|
||||
},
|
||||
"RefreshSchemasMessage":{
|
||||
@@ -1550,10 +1618,7 @@
|
||||
},
|
||||
"ReplicationInstanceList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"ReplicationInstance",
|
||||
"locationName":"ReplicationInstance"
|
||||
}
|
||||
"member":{"shape":"ReplicationInstance"}
|
||||
},
|
||||
"ReplicationInstancePrivateIpAddressList":{
|
||||
"type":"list",
|
||||
@@ -1563,6 +1628,18 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"ReplicationInstanceTaskLog":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ReplicationTaskName":{"shape":"String"},
|
||||
"ReplicationTaskArn":{"shape":"String"},
|
||||
"ReplicationInstanceTaskLogSize":{"shape":"Long"}
|
||||
}
|
||||
},
|
||||
"ReplicationInstanceTaskLogsList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ReplicationInstanceTaskLog"}
|
||||
},
|
||||
"ReplicationPendingModifiedValues":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1591,10 +1668,7 @@
|
||||
},
|
||||
"ReplicationSubnetGroups":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"ReplicationSubnetGroup",
|
||||
"locationName":"ReplicationSubnetGroup"
|
||||
}
|
||||
"member":{"shape":"ReplicationSubnetGroup"}
|
||||
},
|
||||
"ReplicationTask":{
|
||||
"type":"structure",
|
||||
@@ -1615,12 +1689,25 @@
|
||||
"ReplicationTaskStats":{"shape":"ReplicationTaskStats"}
|
||||
}
|
||||
},
|
||||
"ReplicationTaskAssessmentResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ReplicationTaskIdentifier":{"shape":"String"},
|
||||
"ReplicationTaskArn":{"shape":"String"},
|
||||
"ReplicationTaskLastAssessmentDate":{"shape":"TStamp"},
|
||||
"AssessmentStatus":{"shape":"String"},
|
||||
"AssessmentResultsFile":{"shape":"String"},
|
||||
"AssessmentResults":{"shape":"String"},
|
||||
"S3ObjectUrl":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ReplicationTaskAssessmentResultList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ReplicationTaskAssessmentResult"}
|
||||
},
|
||||
"ReplicationTaskList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"ReplicationTask",
|
||||
"locationName":"ReplicationTask"
|
||||
}
|
||||
"member":{"shape":"ReplicationTask"}
|
||||
},
|
||||
"ReplicationTaskStats":{
|
||||
"type":"structure",
|
||||
@@ -1690,15 +1777,25 @@
|
||||
},
|
||||
"SourceIdsList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"String",
|
||||
"locationName":"SourceId"
|
||||
}
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"SourceType":{
|
||||
"type":"string",
|
||||
"enum":["replication-instance"]
|
||||
},
|
||||
"StartReplicationTaskAssessmentMessage":{
|
||||
"type":"structure",
|
||||
"required":["ReplicationTaskArn"],
|
||||
"members":{
|
||||
"ReplicationTaskArn":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"StartReplicationTaskAssessmentResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ReplicationTask":{"shape":"ReplicationTask"}
|
||||
}
|
||||
},
|
||||
"StartReplicationTaskMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -1763,17 +1860,11 @@
|
||||
},
|
||||
"SubnetIdentifierList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"String",
|
||||
"locationName":"SubnetIdentifier"
|
||||
}
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"SubnetList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"Subnet",
|
||||
"locationName":"Subnet"
|
||||
}
|
||||
"member":{"shape":"Subnet"}
|
||||
},
|
||||
"SupportedEndpointType":{
|
||||
"type":"structure",
|
||||
@@ -1785,10 +1876,7 @@
|
||||
},
|
||||
"SupportedEndpointTypeList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"SupportedEndpointType",
|
||||
"locationName":"SupportedEndpointType"
|
||||
}
|
||||
"member":{"shape":"SupportedEndpointType"}
|
||||
},
|
||||
"TStamp":{"type":"timestamp"},
|
||||
"TableListToReload":{
|
||||
@@ -1808,7 +1896,11 @@
|
||||
"FullLoadCondtnlChkFailedRows":{"shape":"Long"},
|
||||
"FullLoadErrorRows":{"shape":"Long"},
|
||||
"LastUpdateTime":{"shape":"TStamp"},
|
||||
"TableState":{"shape":"String"}
|
||||
"TableState":{"shape":"String"},
|
||||
"ValidationPendingRecords":{"shape":"Long"},
|
||||
"ValidationFailedRecords":{"shape":"Long"},
|
||||
"ValidationSuspendedRecords":{"shape":"Long"},
|
||||
"ValidationState":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"TableStatisticsList":{
|
||||
@@ -1831,10 +1923,7 @@
|
||||
},
|
||||
"TagList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"Tag",
|
||||
"locationName":"Tag"
|
||||
}
|
||||
"member":{"shape":"Tag"}
|
||||
},
|
||||
"TestConnectionMessage":{
|
||||
"type":"structure",
|
||||
@@ -1862,10 +1951,7 @@
|
||||
},
|
||||
"VpcSecurityGroupIdList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"String",
|
||||
"locationName":"VpcSecurityGroupId"
|
||||
}
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"VpcSecurityGroupMembership":{
|
||||
"type":"structure",
|
||||
@@ -1876,10 +1962,7 @@
|
||||
},
|
||||
"VpcSecurityGroupMembershipList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"VpcSecurityGroupMembership",
|
||||
"locationName":"VpcSecurityGroupMembership"
|
||||
}
|
||||
"member":{"shape":"VpcSecurityGroupMembership"}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+111
-13
@@ -24,11 +24,13 @@
|
||||
"DescribeEvents": "<p> Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on AWS DMS events, see <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html\"> Working with Events and Notifications </a>. </p>",
|
||||
"DescribeOrderableReplicationInstances": "<p>Returns information about the replication instance types that can be created in the specified region.</p>",
|
||||
"DescribeRefreshSchemasStatus": "<p>Returns the status of the RefreshSchemas operation.</p>",
|
||||
"DescribeReplicationInstanceTaskLogs": "<p>Returns information about the task logs for the specified task.</p>",
|
||||
"DescribeReplicationInstances": "<p>Returns information about replication instances for your account in the current region.</p>",
|
||||
"DescribeReplicationSubnetGroups": "<p>Returns information about the replication subnet groups.</p>",
|
||||
"DescribeReplicationTaskAssessmentResults": "<p>Returns the task assessment results from Amazon S3. This action always returns the latest results.</p>",
|
||||
"DescribeReplicationTasks": "<p>Returns information about replication tasks for your account in the current region.</p>",
|
||||
"DescribeSchemas": "<p>Returns information about the schema for the specified endpoint.</p> <p/>",
|
||||
"DescribeTableStatistics": "<p>Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.</p>",
|
||||
"DescribeTableStatistics": "<p>Returns table statistics on the database migration task, including table name, rows inserted, rows updated, and rows deleted.</p> <p>Note that the \"last updated\" column the DMS console only indicates the time that AWS DMS last updated the table statistics record for a table. It does not indicate the time of the last update to the table.</p>",
|
||||
"ImportCertificate": "<p>Uploads the specified certificate.</p>",
|
||||
"ListTagsForResource": "<p>Lists all tags for an AWS DMS resource.</p>",
|
||||
"ModifyEndpoint": "<p>Modifies the specified endpoint.</p>",
|
||||
@@ -36,10 +38,12 @@
|
||||
"ModifyReplicationInstance": "<p>Modifies the replication instance to apply new settings. You can change one or more parameters by specifying these parameters and the new values in the request.</p> <p>Some settings are applied during the maintenance window.</p> <p/>",
|
||||
"ModifyReplicationSubnetGroup": "<p>Modifies the settings for the specified replication subnet group.</p>",
|
||||
"ModifyReplicationTask": "<p>Modifies the specified replication task.</p> <p>You can't modify the task endpoints. The task must be stopped before you can modify it. </p> <p>For more information about AWS DMS tasks, see the AWS DMS user guide at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html\"> Working with Migration Tasks </a> </p>",
|
||||
"RebootReplicationInstance": "<p>Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.</p>",
|
||||
"RefreshSchemas": "<p>Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation.</p>",
|
||||
"ReloadTables": "<p>Reloads the target database table with the source data. </p>",
|
||||
"RemoveTagsFromResource": "<p>Removes metadata tags from a DMS resource.</p>",
|
||||
"StartReplicationTask": "<p>Starts the replication task.</p> <p>For more information about AWS DMS tasks, see the AWS DMS user guide at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html\"> Working with Migration Tasks </a> </p>",
|
||||
"StartReplicationTaskAssessment": "<p> Starts the replication task assessment for unsupported data types in the source database. </p>",
|
||||
"StopReplicationTask": "<p>Stops the replication task.</p> <p/>",
|
||||
"TestConnection": "<p>Tests the connection between the replication instance and the endpoint.</p>"
|
||||
},
|
||||
@@ -111,6 +115,7 @@
|
||||
"ModifyEventSubscriptionMessage$Enabled": "<p> A Boolean value; set to <b>true</b> to activate the subscription. </p>",
|
||||
"ModifyReplicationInstanceMessage$MultiAZ": "<p> Specifies if the replication instance is a Multi-AZ deployment. You cannot set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>. </p>",
|
||||
"ModifyReplicationInstanceMessage$AutoMinorVersionUpgrade": "<p> Indicates that minor version upgrades will be applied automatically to the replication instance during the maintenance window. Changing this parameter does not result in an outage except in the following case and the change is asynchronously applied as soon as possible. An outage will result if this parameter is set to <code>true</code> during the maintenance window, and a newer minor version is available, and AWS DMS has enabled auto patching for that engine version. </p>",
|
||||
"RebootReplicationInstanceMessage$ForceFailover": "<p>If this parameter is <code>true</code>, the reboot is conducted through a Multi-AZ failover. (If the instance isn't configured for Multi-AZ, then you can't specify <code>true</code>.)</p>",
|
||||
"ReplicationPendingModifiedValues$MultiAZ": "<p> Specifies if the replication instance is a Multi-AZ deployment. You cannot set the <code>AvailabilityZone</code> parameter if the Multi-AZ parameter is set to <code>true</code>. </p>"
|
||||
}
|
||||
},
|
||||
@@ -364,6 +369,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeReplicationInstanceTaskLogsMessage": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeReplicationInstanceTaskLogsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeReplicationInstancesMessage": {
|
||||
"base": "<p/>",
|
||||
"refs": {
|
||||
@@ -384,6 +399,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeReplicationTaskAssessmentResultsMessage": {
|
||||
"base": "<p/>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeReplicationTaskAssessmentResultsResponse": {
|
||||
"base": "<p/>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeReplicationTasksMessage": {
|
||||
"base": "<p/>",
|
||||
"refs": {
|
||||
@@ -533,7 +558,8 @@
|
||||
"DescribeEventsMessage$Filters": "<p>Filters applied to the action.</p>",
|
||||
"DescribeReplicationInstancesMessage$Filters": "<p>Filters applied to the describe action.</p> <p>Valid filter names: replication-instance-arn | replication-instance-id | replication-instance-class | engine-version</p>",
|
||||
"DescribeReplicationSubnetGroupsMessage$Filters": "<p>Filters applied to the describe action.</p>",
|
||||
"DescribeReplicationTasksMessage$Filters": "<p>Filters applied to the describe action.</p> <p>Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn</p>"
|
||||
"DescribeReplicationTasksMessage$Filters": "<p>Filters applied to the describe action.</p> <p>Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn</p>",
|
||||
"DescribeTableStatisticsMessage$Filters": "<p>Filters applied to the describe table statistics action.</p> <p>Valid filter names: schema-name | table-name | table-state</p> <p>A combination of filters creates an AND condition where each record matches all specified filters.</p>"
|
||||
}
|
||||
},
|
||||
"FilterValueList": {
|
||||
@@ -586,11 +612,13 @@
|
||||
"DescribeEventsMessage$Duration": "<p>The duration of the events to be listed.</p>",
|
||||
"DescribeEventsMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
|
||||
"DescribeOrderableReplicationInstancesMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
|
||||
"DescribeReplicationInstanceTaskLogsMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
|
||||
"DescribeReplicationInstancesMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
|
||||
"DescribeReplicationSubnetGroupsMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
|
||||
"DescribeReplicationTaskAssessmentResultsMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
|
||||
"DescribeReplicationTasksMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
|
||||
"DescribeSchemasMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
|
||||
"DescribeTableStatisticsMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>",
|
||||
"DescribeTableStatisticsMessage$MaxRecords": "<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 500.</p>",
|
||||
"Endpoint$Port": "<p>The port value used to access the endpoint.</p>",
|
||||
"ModifyEndpointMessage$Port": "<p>The port used by the endpoint database.</p>",
|
||||
"ModifyReplicationInstanceMessage$AllocatedStorage": "<p>The amount of storage (in gigabytes) to be allocated for the replication instance.</p>",
|
||||
@@ -639,6 +667,7 @@
|
||||
"refs": {
|
||||
"AccountQuota$Used": "<p>The amount currently used toward the quota maximum.</p>",
|
||||
"AccountQuota$Max": "<p>The maximum allowed value for the quota.</p>",
|
||||
"ReplicationInstanceTaskLog$ReplicationInstanceTaskLogSize": "<p>The size, in bytes, of the replication task log.</p>",
|
||||
"ReplicationTaskStats$ElapsedTimeMillis": "<p>The elapsed time of the task, in milliseconds.</p>",
|
||||
"TableStatistics$Inserts": "<p>The number of insert actions performed on a table.</p>",
|
||||
"TableStatistics$Deletes": "<p>The number of delete actions performed on a table.</p>",
|
||||
@@ -646,7 +675,10 @@
|
||||
"TableStatistics$Ddls": "<p>The Data Definition Language (DDL) used to build and modify the structure of your tables.</p>",
|
||||
"TableStatistics$FullLoadRows": "<p>The number of rows added during the Full Load operation.</p>",
|
||||
"TableStatistics$FullLoadCondtnlChkFailedRows": "<p>The number of rows that failed conditional checks during the Full Load operation (valid only for DynamoDB as a target migrations).</p>",
|
||||
"TableStatistics$FullLoadErrorRows": "<p>The number of rows that failed to load during the Full Load operation (valid only for DynamoDB as a target migrations).</p>"
|
||||
"TableStatistics$FullLoadErrorRows": "<p>The number of rows that failed to load during the Full Load operation (valid only for DynamoDB as a target migrations).</p>",
|
||||
"TableStatistics$ValidationPendingRecords": "<p>The number of records that have yet to be validated.</p>",
|
||||
"TableStatistics$ValidationFailedRecords": "<p>The number of records that failed validation.</p>",
|
||||
"TableStatistics$ValidationSuspendedRecords": "<p>The number of records that could not be validated.</p>"
|
||||
}
|
||||
},
|
||||
"MigrationTypeValue": {
|
||||
@@ -733,6 +765,16 @@
|
||||
"DescribeOrderableReplicationInstancesResponse$OrderableReplicationInstances": "<p>The order-able replication instances available.</p>"
|
||||
}
|
||||
},
|
||||
"RebootReplicationInstanceMessage": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"RebootReplicationInstanceResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"RefreshSchemasMessage": {
|
||||
"base": "<p/>",
|
||||
"refs": {
|
||||
@@ -791,6 +833,7 @@
|
||||
"CreateReplicationInstanceResponse$ReplicationInstance": "<p>The replication instance that was created.</p>",
|
||||
"DeleteReplicationInstanceResponse$ReplicationInstance": "<p>The replication instance that was deleted.</p>",
|
||||
"ModifyReplicationInstanceResponse$ReplicationInstance": "<p>The modified replication instance.</p>",
|
||||
"RebootReplicationInstanceResponse$ReplicationInstance": "<p>The replication instance that is being rebooted. </p>",
|
||||
"ReplicationInstanceList$member": null
|
||||
}
|
||||
},
|
||||
@@ -812,6 +855,18 @@
|
||||
"ReplicationInstance$ReplicationInstancePublicIpAddresses": "<p>The public IP address of the replication instance.</p>"
|
||||
}
|
||||
},
|
||||
"ReplicationInstanceTaskLog": {
|
||||
"base": "<p>Contains metadata for a replication instance task log.</p>",
|
||||
"refs": {
|
||||
"ReplicationInstanceTaskLogsList$member": null
|
||||
}
|
||||
},
|
||||
"ReplicationInstanceTaskLogsList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeReplicationInstanceTaskLogsResponse$ReplicationInstanceTaskLogs": "<p>An array of replication task log metadata. Each member of the array contains the replication task name, ARN, and task log size (in bytes).</p>"
|
||||
}
|
||||
},
|
||||
"ReplicationPendingModifiedValues": {
|
||||
"base": "<p/>",
|
||||
"refs": {
|
||||
@@ -845,10 +900,23 @@
|
||||
"DeleteReplicationTaskResponse$ReplicationTask": "<p>The deleted replication task.</p>",
|
||||
"ModifyReplicationTaskResponse$ReplicationTask": "<p>The replication task that was modified.</p>",
|
||||
"ReplicationTaskList$member": null,
|
||||
"StartReplicationTaskAssessmentResponse$ReplicationTask": "<p> The assessed replication task. </p>",
|
||||
"StartReplicationTaskResponse$ReplicationTask": "<p>The replication task started.</p>",
|
||||
"StopReplicationTaskResponse$ReplicationTask": "<p>The replication task stopped.</p>"
|
||||
}
|
||||
},
|
||||
"ReplicationTaskAssessmentResult": {
|
||||
"base": "<p> The task assessment report in JSON format. </p>",
|
||||
"refs": {
|
||||
"ReplicationTaskAssessmentResultList$member": null
|
||||
}
|
||||
},
|
||||
"ReplicationTaskAssessmentResultList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeReplicationTaskAssessmentResultsResponse$ReplicationTaskAssessmentResults": "<p> The task assessment report. </p>"
|
||||
}
|
||||
},
|
||||
"ReplicationTaskList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -922,6 +990,16 @@
|
||||
"Event$SourceType": "<p> The type of AWS DMS resource that generates events. </p> <p>Valid values: replication-instance | endpoint | migration-task</p>"
|
||||
}
|
||||
},
|
||||
"StartReplicationTaskAssessmentMessage": {
|
||||
"base": "<p/>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"StartReplicationTaskAssessmentResponse": {
|
||||
"base": "<p/>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"StartReplicationTaskMessage": {
|
||||
"base": "<p/>",
|
||||
"refs": {
|
||||
@@ -971,13 +1049,13 @@
|
||||
"Connection$EndpointIdentifier": "<p>The identifier of the endpoint. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.</p>",
|
||||
"Connection$ReplicationInstanceIdentifier": "<p>The replication instance identifier. This parameter is stored as a lowercase string.</p>",
|
||||
"CreateEndpointMessage$EndpointIdentifier": "<p>The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.</p>",
|
||||
"CreateEndpointMessage$EngineName": "<p>The type of engine for the endpoint. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.</p>",
|
||||
"CreateEndpointMessage$EngineName": "<p>The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, redshift, S3, sybase, dynamodb, mongodb, and sqlserver.</p>",
|
||||
"CreateEndpointMessage$Username": "<p>The user name to be used to login to the endpoint database.</p>",
|
||||
"CreateEndpointMessage$ServerName": "<p>The name of the server where the endpoint database resides.</p>",
|
||||
"CreateEndpointMessage$DatabaseName": "<p>The name of the endpoint database.</p>",
|
||||
"CreateEndpointMessage$ExtraConnectionAttributes": "<p>Additional attributes associated with the connection.</p>",
|
||||
"CreateEndpointMessage$KmsKeyId": "<p>The KMS key identifier that will be used to encrypt the connection parameters. If you do not specify a value for the KmsKeyId parameter, then AWS DMS will use your default encryption key. AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS region.</p>",
|
||||
"CreateEndpointMessage$CertificateArn": "<p>The Amazon Resource Number (ARN) for the certificate.</p>",
|
||||
"CreateEndpointMessage$CertificateArn": "<p>The Amazon Resource Name (ARN) for the certificate.</p>",
|
||||
"CreateEventSubscriptionMessage$SubscriptionName": "<p>The name of the DMS event notification subscription. </p> <p>Constraints: The name must be less than 255 characters. </p>",
|
||||
"CreateEventSubscriptionMessage$SnsTopicArn": "<p> The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. </p>",
|
||||
"CreateEventSubscriptionMessage$SourceType": "<p> The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to <code>replication-instance</code>. If this value is not specified, all events are returned. </p> <p>Valid values: replication-instance | migration-task</p>",
|
||||
@@ -1020,10 +1098,18 @@
|
||||
"DescribeOrderableReplicationInstancesMessage$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>",
|
||||
"DescribeOrderableReplicationInstancesResponse$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>",
|
||||
"DescribeRefreshSchemasStatusMessage$EndpointArn": "<p>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</p>",
|
||||
"DescribeReplicationInstanceTaskLogsMessage$ReplicationInstanceArn": "<p>The Amazon Resource Name (ARN) of the replication instance.</p>",
|
||||
"DescribeReplicationInstanceTaskLogsMessage$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>",
|
||||
"DescribeReplicationInstanceTaskLogsResponse$ReplicationInstanceArn": "<p>The Amazon Resource Name (ARN) of the replication instance.</p>",
|
||||
"DescribeReplicationInstanceTaskLogsResponse$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>",
|
||||
"DescribeReplicationInstancesMessage$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>",
|
||||
"DescribeReplicationInstancesResponse$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>",
|
||||
"DescribeReplicationSubnetGroupsMessage$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>",
|
||||
"DescribeReplicationSubnetGroupsResponse$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>",
|
||||
"DescribeReplicationTaskAssessmentResultsMessage$ReplicationTaskArn": "<p>- The Amazon Resource Name (ARN) string that uniquely identifies the task. When this input parameter is specified the API will return only one result and ignore the values of the max-records and marker parameters. </p>",
|
||||
"DescribeReplicationTaskAssessmentResultsMessage$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>",
|
||||
"DescribeReplicationTaskAssessmentResultsResponse$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>",
|
||||
"DescribeReplicationTaskAssessmentResultsResponse$BucketName": "<p>- The Amazon S3 bucket where the task assessment report is located. </p>",
|
||||
"DescribeReplicationTasksMessage$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>",
|
||||
"DescribeReplicationTasksResponse$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>",
|
||||
"DescribeSchemasMessage$EndpointArn": "<p>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</p>",
|
||||
@@ -1035,7 +1121,7 @@
|
||||
"DescribeTableStatisticsResponse$Marker": "<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>",
|
||||
"DynamoDbSettings$ServiceAccessRoleArn": "<p> The Amazon Resource Name (ARN) used by the service access IAM role. </p>",
|
||||
"Endpoint$EndpointIdentifier": "<p>The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.</p>",
|
||||
"Endpoint$EngineName": "<p>The database engine name. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.</p>",
|
||||
"Endpoint$EngineName": "<p>The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, redshift, S3, sybase, dynamodb, mongodb, and sqlserver.</p>",
|
||||
"Endpoint$Username": "<p>The user name used to connect to the endpoint.</p>",
|
||||
"Endpoint$ServerName": "<p>The name of the server at the endpoint.</p>",
|
||||
"Endpoint$DatabaseName": "<p>The name of the database at the endpoint.</p>",
|
||||
@@ -1063,11 +1149,11 @@
|
||||
"ListTagsForResourceMessage$ResourceArn": "<p>The Amazon Resource Name (ARN) string that uniquely identifies the AWS DMS resource.</p>",
|
||||
"ModifyEndpointMessage$EndpointArn": "<p>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</p>",
|
||||
"ModifyEndpointMessage$EndpointIdentifier": "<p>The database endpoint identifier. Identifiers must begin with a letter; must contain only ASCII letters, digits, and hyphens; and must not end with a hyphen or contain two consecutive hyphens.</p>",
|
||||
"ModifyEndpointMessage$EngineName": "<p>The type of engine for the endpoint. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, DYNAMODB, MONGODB, SYBASE, and SQLSERVER.</p>",
|
||||
"ModifyEndpointMessage$EngineName": "<p>The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, redshift, S3, sybase, dynamodb, mongodb, and sqlserver.</p>",
|
||||
"ModifyEndpointMessage$Username": "<p>The user name to be used to login to the endpoint database.</p>",
|
||||
"ModifyEndpointMessage$ServerName": "<p>The name of the server where the endpoint database resides.</p>",
|
||||
"ModifyEndpointMessage$DatabaseName": "<p>The name of the endpoint database.</p>",
|
||||
"ModifyEndpointMessage$ExtraConnectionAttributes": "<p>Additional attributes associated with the connection.</p>",
|
||||
"ModifyEndpointMessage$ExtraConnectionAttributes": "<p>Additional attributes associated with the connection. To reset this parameter, pass the empty string (\"\") as an argument.</p>",
|
||||
"ModifyEndpointMessage$CertificateArn": "<p>The Amazon Resource Name (ARN) of the certificate used for SSL connection.</p>",
|
||||
"ModifyEventSubscriptionMessage$SubscriptionName": "<p>The name of the AWS DMS event notification subscription to be modified.</p>",
|
||||
"ModifyEventSubscriptionMessage$SnsTopicArn": "<p> The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.</p>",
|
||||
@@ -1092,6 +1178,7 @@
|
||||
"OrderableReplicationInstance$EngineVersion": "<p>The version of the replication engine.</p>",
|
||||
"OrderableReplicationInstance$ReplicationInstanceClass": "<p>The compute and memory capacity of the replication instance.</p> <p> Valid Values: <code>dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge </code> </p>",
|
||||
"OrderableReplicationInstance$StorageType": "<p>The type of storage used by the replication instance.</p>",
|
||||
"RebootReplicationInstanceMessage$ReplicationInstanceArn": "<p>The Amazon Resource Name (ARN) of the replication instance.</p>",
|
||||
"RefreshSchemasMessage$EndpointArn": "<p>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</p>",
|
||||
"RefreshSchemasMessage$ReplicationInstanceArn": "<p>The Amazon Resource Name (ARN) of the replication instance.</p>",
|
||||
"RefreshSchemasStatus$EndpointArn": "<p>The Amazon Resource Name (ARN) string that uniquely identifies the endpoint.</p>",
|
||||
@@ -1113,6 +1200,8 @@
|
||||
"ReplicationInstance$SecondaryAvailabilityZone": "<p>The availability zone of the standby replication instance in a Multi-AZ deployment.</p>",
|
||||
"ReplicationInstancePrivateIpAddressList$member": null,
|
||||
"ReplicationInstancePublicIpAddressList$member": null,
|
||||
"ReplicationInstanceTaskLog$ReplicationTaskName": "<p>The name of the replication task.</p>",
|
||||
"ReplicationInstanceTaskLog$ReplicationTaskArn": "<p>The Amazon Resource Name (ARN) of the replication task.</p>",
|
||||
"ReplicationPendingModifiedValues$ReplicationInstanceClass": "<p>The compute and memory capacity of the replication instance.</p> <p> Valid Values: <code>dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge </code> </p>",
|
||||
"ReplicationPendingModifiedValues$EngineVersion": "<p>The engine version number of the replication instance.</p>",
|
||||
"ReplicationSubnetGroup$ReplicationSubnetGroupIdentifier": "<p>The identifier of the replication instance subnet group.</p>",
|
||||
@@ -1129,6 +1218,12 @@
|
||||
"ReplicationTask$LastFailureMessage": "<p>The last error (failure) message generated for the replication instance.</p>",
|
||||
"ReplicationTask$StopReason": "<p>The reason the replication task was stopped.</p>",
|
||||
"ReplicationTask$ReplicationTaskArn": "<p>The Amazon Resource Name (ARN) of the replication task.</p>",
|
||||
"ReplicationTaskAssessmentResult$ReplicationTaskIdentifier": "<p> The replication task identifier of the task on which the task assessment was run. </p>",
|
||||
"ReplicationTaskAssessmentResult$ReplicationTaskArn": "<p>The Amazon Resource Name (ARN) of the replication task. </p>",
|
||||
"ReplicationTaskAssessmentResult$AssessmentStatus": "<p> The status of the task assessment. </p>",
|
||||
"ReplicationTaskAssessmentResult$AssessmentResultsFile": "<p> The file containing the results of the task assessment. </p>",
|
||||
"ReplicationTaskAssessmentResult$AssessmentResults": "<p> The task assessment results in JSON format. </p>",
|
||||
"ReplicationTaskAssessmentResult$S3ObjectUrl": "<p> The URL of the S3 object containing the task assessment results. </p>",
|
||||
"S3Settings$ServiceAccessRoleArn": "<p> The Amazon Resource Name (ARN) used by the service access IAM role. </p>",
|
||||
"S3Settings$ExternalTableDefinition": "<p> </p>",
|
||||
"S3Settings$CsvRowDelimiter": "<p> The delimiter used to separate rows in the source files. The default is a carriage return (\\n). </p>",
|
||||
@@ -1137,15 +1232,17 @@
|
||||
"S3Settings$BucketName": "<p> The name of the S3 bucket. </p>",
|
||||
"SchemaList$member": null,
|
||||
"SourceIdsList$member": null,
|
||||
"StartReplicationTaskMessage$ReplicationTaskArn": "<p>The Amazon Resource Number (ARN) of the replication task to be started.</p>",
|
||||
"StopReplicationTaskMessage$ReplicationTaskArn": "<p>The Amazon Resource Number(ARN) of the replication task to be stopped.</p>",
|
||||
"StartReplicationTaskAssessmentMessage$ReplicationTaskArn": "<p> The Amazon Resource Name (ARN) of the replication task. </p>",
|
||||
"StartReplicationTaskMessage$ReplicationTaskArn": "<p>The Amazon Resource Name (ARN) of the replication task to be started.</p>",
|
||||
"StopReplicationTaskMessage$ReplicationTaskArn": "<p>The Amazon Resource Name(ARN) of the replication task to be stopped.</p>",
|
||||
"Subnet$SubnetIdentifier": "<p>The subnet identifier.</p>",
|
||||
"Subnet$SubnetStatus": "<p>The status of the subnet.</p>",
|
||||
"SubnetIdentifierList$member": null,
|
||||
"SupportedEndpointType$EngineName": "<p>The database engine name. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.</p>",
|
||||
"SupportedEndpointType$EngineName": "<p>The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, redshift, S3, sybase, dynamodb, mongodb, and sqlserver.</p>",
|
||||
"TableStatistics$SchemaName": "<p>The schema name.</p>",
|
||||
"TableStatistics$TableName": "<p>The name of the table.</p>",
|
||||
"TableStatistics$TableState": "<p>The state of the table.</p>",
|
||||
"TableStatistics$TableState": "<p>The state of the tables described.</p> <p>Valid states: Table does not exist | Before load | Full load | Table completed | Table cancelled | Table error | Table all | Table updates | Table is being reloaded</p>",
|
||||
"TableStatistics$ValidationState": "<p>The validation state of the table.</p> <p>The parameter can have the following values</p> <ul> <li> <p>Not enabled—Validation is not enabled for the table in the migration task.</p> </li> <li> <p>Pending records—Some records in the table are waiting for validation.</p> </li> <li> <p>Mismatched records—Some records in the table do not match between the source and target.</p> </li> <li> <p>Suspended records—Some records in the table could not be validated.</p> </li> <li> <p>No primary key—The table could not be validated because it had no primary key.</p> </li> <li> <p>Table error—The table was not validated because it was in an error state and some data was not migrated.</p> </li> <li> <p>Validated—All rows in the table were validated. If the table is updated, the status can change from Validated.</p> </li> <li> <p>Error—The table could not be validated because of an unexpected error.</p> </li> </ul>",
|
||||
"TableToReload$SchemaName": "<p>The schema name of the table to be reloaded.</p>",
|
||||
"TableToReload$TableName": "<p>The table name of the table to be reloaded.</p>",
|
||||
"Tag$Key": "<p>A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and cannot be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").</p>",
|
||||
@@ -1208,6 +1305,7 @@
|
||||
"ReplicationInstance$InstanceCreateTime": "<p>The time the replication instance was created.</p>",
|
||||
"ReplicationTask$ReplicationTaskCreationDate": "<p>The date the replication task was created.</p>",
|
||||
"ReplicationTask$ReplicationTaskStartDate": "<p>The date the replication task is scheduled to start.</p>",
|
||||
"ReplicationTaskAssessmentResult$ReplicationTaskLastAssessmentDate": "<p>The date the task assessment was completed. </p>",
|
||||
"StartReplicationTaskMessage$CdcStartTime": "<p>The start time for the Change Data Capture (CDC) operation.</p>",
|
||||
"TableStatistics$LastUpdateTime": "<p>The last time the table was updated.</p>"
|
||||
}
|
||||
|
||||
+10
@@ -35,6 +35,11 @@
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords"
|
||||
},
|
||||
"DescribeReplicationInstanceTaskLogs": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords"
|
||||
},
|
||||
"DescribeReplicationInstances": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
@@ -45,6 +50,11 @@
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords"
|
||||
},
|
||||
"DescribeReplicationTaskAssessmentResults": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
"limit_key": "MaxRecords"
|
||||
},
|
||||
"DescribeReplicationTasks": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "Marker",
|
||||
|
||||
+18
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"version": 1,
|
||||
"defaultRegion": "us-west-2",
|
||||
"testCases": [
|
||||
{
|
||||
"operationName": "DescribeEndpoints",
|
||||
"input": {},
|
||||
"errorExpectedFromService": false
|
||||
},
|
||||
{
|
||||
"operationName": "DescribeTableStatistics",
|
||||
"input": {
|
||||
"ReplicationTaskArn": "arn:aws:acm:region:123456789012"
|
||||
},
|
||||
"errorExpectedFromService": true
|
||||
}
|
||||
]
|
||||
}
|
||||
+14
-4
@@ -7,6 +7,7 @@
|
||||
"protocol":"json",
|
||||
"serviceAbbreviation":"Directory Service",
|
||||
"serviceFullName":"AWS Directory Service",
|
||||
"serviceId":"Directory Service",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"DirectoryService_20150416",
|
||||
"uid":"ds-2015-04-16"
|
||||
@@ -910,7 +911,8 @@
|
||||
"ShortName":{"shape":"DirectoryShortName"},
|
||||
"Password":{"shape":"Password"},
|
||||
"Description":{"shape":"Description"},
|
||||
"VpcSettings":{"shape":"DirectoryVpcSettings"}
|
||||
"VpcSettings":{"shape":"DirectoryVpcSettings"},
|
||||
"Edition":{"shape":"DirectoryEdition"}
|
||||
}
|
||||
},
|
||||
"CreateMicrosoftADResult":{
|
||||
@@ -1165,6 +1167,7 @@
|
||||
"Name":{"shape":"DirectoryName"},
|
||||
"ShortName":{"shape":"DirectoryShortName"},
|
||||
"Size":{"shape":"DirectorySize"},
|
||||
"Edition":{"shape":"DirectoryEdition"},
|
||||
"Alias":{"shape":"AliasName"},
|
||||
"AccessUrl":{"shape":"AccessUrl"},
|
||||
"Description":{"shape":"Description"},
|
||||
@@ -1186,6 +1189,13 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"DirectoryDescription"}
|
||||
},
|
||||
"DirectoryEdition":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"Enterprise",
|
||||
"Standard"
|
||||
]
|
||||
},
|
||||
"DirectoryId":{
|
||||
"type":"string",
|
||||
"pattern":"^d-[0-9a-f]{10}$"
|
||||
@@ -1775,7 +1785,7 @@
|
||||
},
|
||||
"SecurityGroupId":{
|
||||
"type":"string",
|
||||
"pattern":"^(sg-[0-9a-f]{8})$"
|
||||
"pattern":"^(sg-[0-9a-f]{8}|sg-[0-9a-f]{17})$"
|
||||
},
|
||||
"Server":{
|
||||
"type":"string",
|
||||
@@ -1883,7 +1893,7 @@
|
||||
"StateLastUpdatedDateTime":{"type":"timestamp"},
|
||||
"SubnetId":{
|
||||
"type":"string",
|
||||
"pattern":"^(subnet-[0-9a-f]{8})$"
|
||||
"pattern":"^(subnet-[0-9a-f]{8}|subnet-[0-9a-f]{17})$"
|
||||
},
|
||||
"SubnetIds":{
|
||||
"type":"list",
|
||||
@@ -2087,7 +2097,7 @@
|
||||
},
|
||||
"VpcId":{
|
||||
"type":"string",
|
||||
"pattern":"^(vpc-[0-9a-f]{8})$"
|
||||
"pattern":"^(vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+8
-1
@@ -462,6 +462,13 @@
|
||||
"DescribeDirectoriesResult$DirectoryDescriptions": "<p>The list of <a>DirectoryDescription</a> objects that were retrieved.</p> <p>It is possible that this list contains less than the number of items specified in the <i>Limit</i> member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.</p>"
|
||||
}
|
||||
},
|
||||
"DirectoryEdition": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateMicrosoftADRequest$Edition": "<p>AWS Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.</p>",
|
||||
"DirectoryDescription$Edition": "<p>The edition associated with this directory.</p>"
|
||||
}
|
||||
},
|
||||
"DirectoryId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -1105,7 +1112,7 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DirectoryConnectSettingsDescription$SecurityGroupId": "<p>The security group identifier for the AD Connector directory.</p>",
|
||||
"DirectoryVpcSettingsDescription$SecurityGroupId": "<p>The security group identifier for the directory. If the directory was created before 8/1/2014, this is the identifier of the directory members security group that was created when the directory was created. If the directory was created after this date, this value is null.</p>"
|
||||
"DirectoryVpcSettingsDescription$SecurityGroupId": "<p>The domain controller security group identifier for the directory.</p>"
|
||||
}
|
||||
},
|
||||
"Server": {
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user