mirror of
https://github.com/aptly-dev/aptly.git
synced 2026-05-06 22:18:28 +00:00
Conver to regular Go vendor + dep tool
This commit is contained in:
Andrey Smirnov
+595
@@ -0,0 +1,595 @@
|
||||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"apiVersion":"2015-12-08",
|
||||
"endpointPrefix":"acm",
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceAbbreviation":"ACM",
|
||||
"serviceFullName":"AWS Certificate Manager",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"CertificateManager",
|
||||
"uid":"acm-2015-12-08"
|
||||
},
|
||||
"operations":{
|
||||
"AddTagsToCertificate":{
|
||||
"name":"AddTagsToCertificate",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"AddTagsToCertificateRequest"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"InvalidTagException"},
|
||||
{"shape":"TooManyTagsException"}
|
||||
]
|
||||
},
|
||||
"DeleteCertificate":{
|
||||
"name":"DeleteCertificate",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteCertificateRequest"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ResourceInUseException"},
|
||||
{"shape":"InvalidArnException"}
|
||||
]
|
||||
},
|
||||
"DescribeCertificate":{
|
||||
"name":"DescribeCertificate",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeCertificateRequest"},
|
||||
"output":{"shape":"DescribeCertificateResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidArnException"}
|
||||
]
|
||||
},
|
||||
"GetCertificate":{
|
||||
"name":"GetCertificate",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetCertificateRequest"},
|
||||
"output":{"shape":"GetCertificateResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"RequestInProgressException"},
|
||||
{"shape":"InvalidArnException"}
|
||||
]
|
||||
},
|
||||
"ImportCertificate":{
|
||||
"name":"ImportCertificate",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ImportCertificateRequest"},
|
||||
"output":{"shape":"ImportCertificateResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
]
|
||||
},
|
||||
"ListCertificates":{
|
||||
"name":"ListCertificates",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListCertificatesRequest"},
|
||||
"output":{"shape":"ListCertificatesResponse"}
|
||||
},
|
||||
"ListTagsForCertificate":{
|
||||
"name":"ListTagsForCertificate",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListTagsForCertificateRequest"},
|
||||
"output":{"shape":"ListTagsForCertificateResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidArnException"}
|
||||
]
|
||||
},
|
||||
"RemoveTagsFromCertificate":{
|
||||
"name":"RemoveTagsFromCertificate",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"RemoveTagsFromCertificateRequest"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"InvalidTagException"}
|
||||
]
|
||||
},
|
||||
"RequestCertificate":{
|
||||
"name":"RequestCertificate",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"RequestCertificateRequest"},
|
||||
"output":{"shape":"RequestCertificateResponse"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidDomainValidationOptionsException"}
|
||||
]
|
||||
},
|
||||
"ResendValidationEmail":{
|
||||
"name":"ResendValidationEmail",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ResendValidationEmailRequest"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidStateException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"InvalidDomainValidationOptionsException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AddTagsToCertificateRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"CertificateArn",
|
||||
"Tags"
|
||||
],
|
||||
"members":{
|
||||
"CertificateArn":{"shape":"Arn"},
|
||||
"Tags":{"shape":"TagList"}
|
||||
}
|
||||
},
|
||||
"Arn":{
|
||||
"type":"string",
|
||||
"max":2048,
|
||||
"min":20,
|
||||
"pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=/,.@-]+)*"
|
||||
},
|
||||
"CertificateBody":{
|
||||
"type":"string",
|
||||
"max":32768,
|
||||
"min":1,
|
||||
"pattern":"-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?"
|
||||
},
|
||||
"CertificateBodyBlob":{
|
||||
"type":"blob",
|
||||
"max":32768,
|
||||
"min":1
|
||||
},
|
||||
"CertificateChain":{
|
||||
"type":"string",
|
||||
"max":2097152,
|
||||
"min":1,
|
||||
"pattern":"(-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}\\u000D?\\u000A)*-{5}BEGIN CERTIFICATE-{5}\\u000D?\\u000A([A-Za-z0-9/+]{64}\\u000D?\\u000A)*[A-Za-z0-9/+]{1,64}={0,2}\\u000D?\\u000A-{5}END CERTIFICATE-{5}(\\u000D?\\u000A)?"
|
||||
},
|
||||
"CertificateChainBlob":{
|
||||
"type":"blob",
|
||||
"max":2097152,
|
||||
"min":1
|
||||
},
|
||||
"CertificateDetail":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CertificateArn":{"shape":"Arn"},
|
||||
"DomainName":{"shape":"DomainNameString"},
|
||||
"SubjectAlternativeNames":{"shape":"DomainList"},
|
||||
"DomainValidationOptions":{"shape":"DomainValidationList"},
|
||||
"Serial":{"shape":"String"},
|
||||
"Subject":{"shape":"String"},
|
||||
"Issuer":{"shape":"String"},
|
||||
"CreatedAt":{"shape":"TStamp"},
|
||||
"IssuedAt":{"shape":"TStamp"},
|
||||
"ImportedAt":{"shape":"TStamp"},
|
||||
"Status":{"shape":"CertificateStatus"},
|
||||
"RevokedAt":{"shape":"TStamp"},
|
||||
"RevocationReason":{"shape":"RevocationReason"},
|
||||
"NotBefore":{"shape":"TStamp"},
|
||||
"NotAfter":{"shape":"TStamp"},
|
||||
"KeyAlgorithm":{"shape":"KeyAlgorithm"},
|
||||
"SignatureAlgorithm":{"shape":"String"},
|
||||
"InUseBy":{"shape":"InUseList"},
|
||||
"FailureReason":{"shape":"FailureReason"},
|
||||
"Type":{"shape":"CertificateType"},
|
||||
"RenewalSummary":{"shape":"RenewalSummary"}
|
||||
}
|
||||
},
|
||||
"CertificateStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"PENDING_VALIDATION",
|
||||
"ISSUED",
|
||||
"INACTIVE",
|
||||
"EXPIRED",
|
||||
"VALIDATION_TIMED_OUT",
|
||||
"REVOKED",
|
||||
"FAILED"
|
||||
]
|
||||
},
|
||||
"CertificateStatuses":{
|
||||
"type":"list",
|
||||
"member":{"shape":"CertificateStatus"}
|
||||
},
|
||||
"CertificateSummary":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CertificateArn":{"shape":"Arn"},
|
||||
"DomainName":{"shape":"DomainNameString"}
|
||||
}
|
||||
},
|
||||
"CertificateSummaryList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"CertificateSummary"}
|
||||
},
|
||||
"CertificateType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"IMPORTED",
|
||||
"AMAZON_ISSUED"
|
||||
]
|
||||
},
|
||||
"DeleteCertificateRequest":{
|
||||
"type":"structure",
|
||||
"required":["CertificateArn"],
|
||||
"members":{
|
||||
"CertificateArn":{"shape":"Arn"}
|
||||
}
|
||||
},
|
||||
"DescribeCertificateRequest":{
|
||||
"type":"structure",
|
||||
"required":["CertificateArn"],
|
||||
"members":{
|
||||
"CertificateArn":{"shape":"Arn"}
|
||||
}
|
||||
},
|
||||
"DescribeCertificateResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Certificate":{"shape":"CertificateDetail"}
|
||||
}
|
||||
},
|
||||
"DomainList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"DomainNameString"},
|
||||
"max":100,
|
||||
"min":1
|
||||
},
|
||||
"DomainNameString":{
|
||||
"type":"string",
|
||||
"max":253,
|
||||
"min":1,
|
||||
"pattern":"^(\\*\\.)?(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\\.)+((?!-)[A-Za-z0-9-]{1,62}[A-Za-z0-9])$"
|
||||
},
|
||||
"DomainStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"PENDING_VALIDATION",
|
||||
"SUCCESS",
|
||||
"FAILED"
|
||||
]
|
||||
},
|
||||
"DomainValidation":{
|
||||
"type":"structure",
|
||||
"required":["DomainName"],
|
||||
"members":{
|
||||
"DomainName":{"shape":"DomainNameString"},
|
||||
"ValidationEmails":{"shape":"ValidationEmailList"},
|
||||
"ValidationDomain":{"shape":"DomainNameString"},
|
||||
"ValidationStatus":{"shape":"DomainStatus"}
|
||||
}
|
||||
},
|
||||
"DomainValidationList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"DomainValidation"},
|
||||
"max":1000,
|
||||
"min":1
|
||||
},
|
||||
"DomainValidationOption":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DomainName",
|
||||
"ValidationDomain"
|
||||
],
|
||||
"members":{
|
||||
"DomainName":{"shape":"DomainNameString"},
|
||||
"ValidationDomain":{"shape":"DomainNameString"}
|
||||
}
|
||||
},
|
||||
"DomainValidationOptionList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"DomainValidationOption"},
|
||||
"max":100,
|
||||
"min":1
|
||||
},
|
||||
"FailureReason":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"NO_AVAILABLE_CONTACTS",
|
||||
"ADDITIONAL_VERIFICATION_REQUIRED",
|
||||
"DOMAIN_NOT_ALLOWED",
|
||||
"INVALID_PUBLIC_DOMAIN",
|
||||
"OTHER"
|
||||
]
|
||||
},
|
||||
"GetCertificateRequest":{
|
||||
"type":"structure",
|
||||
"required":["CertificateArn"],
|
||||
"members":{
|
||||
"CertificateArn":{"shape":"Arn"}
|
||||
}
|
||||
},
|
||||
"GetCertificateResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Certificate":{"shape":"CertificateBody"},
|
||||
"CertificateChain":{"shape":"CertificateChain"}
|
||||
}
|
||||
},
|
||||
"IdempotencyToken":{
|
||||
"type":"string",
|
||||
"max":32,
|
||||
"min":1,
|
||||
"pattern":"\\w+"
|
||||
},
|
||||
"ImportCertificateRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Certificate",
|
||||
"PrivateKey"
|
||||
],
|
||||
"members":{
|
||||
"CertificateArn":{"shape":"Arn"},
|
||||
"Certificate":{"shape":"CertificateBodyBlob"},
|
||||
"PrivateKey":{"shape":"PrivateKeyBlob"},
|
||||
"CertificateChain":{"shape":"CertificateChainBlob"}
|
||||
}
|
||||
},
|
||||
"ImportCertificateResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CertificateArn":{"shape":"Arn"}
|
||||
}
|
||||
},
|
||||
"InUseList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"InvalidArnException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidDomainValidationOptionsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidStateException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidTagException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"KeyAlgorithm":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"RSA_2048",
|
||||
"RSA_1024",
|
||||
"EC_prime256v1"
|
||||
]
|
||||
},
|
||||
"LimitExceededException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ListCertificatesRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CertificateStatuses":{"shape":"CertificateStatuses"},
|
||||
"NextToken":{"shape":"NextToken"},
|
||||
"MaxItems":{"shape":"MaxItems"}
|
||||
}
|
||||
},
|
||||
"ListCertificatesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{"shape":"NextToken"},
|
||||
"CertificateSummaryList":{"shape":"CertificateSummaryList"}
|
||||
}
|
||||
},
|
||||
"ListTagsForCertificateRequest":{
|
||||
"type":"structure",
|
||||
"required":["CertificateArn"],
|
||||
"members":{
|
||||
"CertificateArn":{"shape":"Arn"}
|
||||
}
|
||||
},
|
||||
"ListTagsForCertificateResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Tags":{"shape":"TagList"}
|
||||
}
|
||||
},
|
||||
"MaxItems":{
|
||||
"type":"integer",
|
||||
"max":1000,
|
||||
"min":1
|
||||
},
|
||||
"NextToken":{
|
||||
"type":"string",
|
||||
"max":320,
|
||||
"min":1,
|
||||
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]*"
|
||||
},
|
||||
"PrivateKeyBlob":{
|
||||
"type":"blob",
|
||||
"max":524288,
|
||||
"min":1,
|
||||
"sensitive":true
|
||||
},
|
||||
"RemoveTagsFromCertificateRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"CertificateArn",
|
||||
"Tags"
|
||||
],
|
||||
"members":{
|
||||
"CertificateArn":{"shape":"Arn"},
|
||||
"Tags":{"shape":"TagList"}
|
||||
}
|
||||
},
|
||||
"RenewalStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"PENDING_AUTO_RENEWAL",
|
||||
"PENDING_VALIDATION",
|
||||
"SUCCESS",
|
||||
"FAILED"
|
||||
]
|
||||
},
|
||||
"RenewalSummary":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"RenewalStatus",
|
||||
"DomainValidationOptions"
|
||||
],
|
||||
"members":{
|
||||
"RenewalStatus":{"shape":"RenewalStatus"},
|
||||
"DomainValidationOptions":{"shape":"DomainValidationList"}
|
||||
}
|
||||
},
|
||||
"RequestCertificateRequest":{
|
||||
"type":"structure",
|
||||
"required":["DomainName"],
|
||||
"members":{
|
||||
"DomainName":{"shape":"DomainNameString"},
|
||||
"SubjectAlternativeNames":{"shape":"DomainList"},
|
||||
"IdempotencyToken":{"shape":"IdempotencyToken"},
|
||||
"DomainValidationOptions":{"shape":"DomainValidationOptionList"}
|
||||
}
|
||||
},
|
||||
"RequestCertificateResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CertificateArn":{"shape":"Arn"}
|
||||
}
|
||||
},
|
||||
"RequestInProgressException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ResendValidationEmailRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"CertificateArn",
|
||||
"Domain",
|
||||
"ValidationDomain"
|
||||
],
|
||||
"members":{
|
||||
"CertificateArn":{"shape":"Arn"},
|
||||
"Domain":{"shape":"DomainNameString"},
|
||||
"ValidationDomain":{"shape":"DomainNameString"}
|
||||
}
|
||||
},
|
||||
"ResourceInUseException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ResourceNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"RevocationReason":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"UNSPECIFIED",
|
||||
"KEY_COMPROMISE",
|
||||
"CA_COMPROMISE",
|
||||
"AFFILIATION_CHANGED",
|
||||
"SUPERCEDED",
|
||||
"CESSATION_OF_OPERATION",
|
||||
"CERTIFICATE_HOLD",
|
||||
"REMOVE_FROM_CRL",
|
||||
"PRIVILEGE_WITHDRAWN",
|
||||
"A_A_COMPROMISE"
|
||||
]
|
||||
},
|
||||
"String":{"type":"string"},
|
||||
"TStamp":{"type":"timestamp"},
|
||||
"Tag":{
|
||||
"type":"structure",
|
||||
"required":["Key"],
|
||||
"members":{
|
||||
"Key":{"shape":"TagKey"},
|
||||
"Value":{"shape":"TagValue"}
|
||||
}
|
||||
},
|
||||
"TagKey":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":1,
|
||||
"pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*"
|
||||
},
|
||||
"TagList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Tag"},
|
||||
"max":50,
|
||||
"min":1
|
||||
},
|
||||
"TagValue":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":0,
|
||||
"pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*"
|
||||
},
|
||||
"TooManyTagsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ValidationEmailList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
}
|
||||
}
|
||||
}
|
||||
+398
@@ -0,0 +1,398 @@
|
||||
{
|
||||
"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>",
|
||||
"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.</p>"
|
||||
},
|
||||
"shapes": {
|
||||
"AddTagsToCertificateRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Arn": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AddTagsToCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM Certificate to which the tag is to be applied. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
|
||||
"CertificateDetail$CertificateArn": "<p>The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>",
|
||||
"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>",
|
||||
"GetCertificateRequest$CertificateArn": "<p>String that contains a certificate ARN in the following format:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
|
||||
"ImportCertificateRequest$CertificateArn": "<p>The <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of an imported certificate to replace. To import a new certificate, omit this field.</p>",
|
||||
"ImportCertificateResponse$CertificateArn": "<p>The <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>",
|
||||
"ListTagsForCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM Certificate for which you want to list the tags. This 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>",
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"CertificateBody": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"CertificateChain": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"CertificateDetail": {
|
||||
"base": "<p>Contains metadata about an ACM certificate. This structure is returned in the response to a <a>DescribeCertificate</a> request.</p>",
|
||||
"refs": {
|
||||
"DescribeCertificateResponse$Certificate": "<p>Metadata about an ACM certificate.</p>"
|
||||
}
|
||||
},
|
||||
"CertificateStatus": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CertificateDetail$Status": "<p>The status of the certificate.</p>",
|
||||
"CertificateStatuses$member": null
|
||||
}
|
||||
},
|
||||
"CertificateStatuses": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListCertificatesRequest$CertificateStatuses": "<p>The status or statuses on which to filter the list of ACM Certificates.</p>"
|
||||
}
|
||||
},
|
||||
"CertificateSummary": {
|
||||
"base": "<p>This structure is returned in the response object of <a>ListCertificates</a> action.</p>",
|
||||
"refs": {
|
||||
"CertificateSummaryList$member": null
|
||||
}
|
||||
},
|
||||
"CertificateSummaryList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListCertificatesResponse$CertificateSummaryList": "<p>A list of ACM Certificates.</p>"
|
||||
}
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"DeleteCertificateRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeCertificateRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeCertificateResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DomainList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CertificateDetail$SubjectAlternativeNames": "<p>One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website.</p>",
|
||||
"RequestCertificateRequest$SubjectAlternativeNames": "<p>Additional FQDNs to be included in the Subject Alternative Name extension of the ACM Certificate. For example, add the name www.example.net to a certificate for which the <code>DomainName</code> field is www.example.com if users can reach your site by using either name.</p>"
|
||||
}
|
||||
},
|
||||
"DomainNameString": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CertificateDetail$DomainName": "<p>The fully qualified domain name for the certificate, such as www.example.com or example.com.</p>",
|
||||
"CertificateSummary$DomainName": "<p>Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.</p>",
|
||||
"DomainList$member": null,
|
||||
"DomainValidation$DomainName": "<p>A fully qualified domain name (FQDN) in the certificate. For example, <code>www.example.com</code> or <code>example.com</code>.</p>",
|
||||
"DomainValidation$ValidationDomain": "<p>The domain name that ACM used to send domain validation emails.</p>",
|
||||
"DomainValidationOption$DomainName": "<p>A fully qualified domain name (FQDN) in the certificate request.</p>",
|
||||
"DomainValidationOption$ValidationDomain": "<p>The domain name that you want ACM to use to send you validation emails. This domain name is the suffix of the email addresses that you want ACM to use. This must be the same as the <code>DomainName</code> value or a superdomain of the <code>DomainName</code> value. For example, if you request a certificate for <code>testing.example.com</code>, you can specify <code>example.com</code> for this value. In that case, ACM sends domain validation emails to the following five addresses:</p> <ul> <li> <p>admin@example.com</p> </li> <li> <p>administrator@example.com</p> </li> <li> <p>hostmaster@example.com</p> </li> <li> <p>postmaster@example.com</p> </li> <li> <p>webmaster@example.com</p> </li> </ul>",
|
||||
"RequestCertificateRequest$DomainName": "<p>Fully qualified domain name (FQDN), such as www.example.com, of the site that you want to secure with an ACM Certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com.</p>",
|
||||
"ResendValidationEmailRequest$Domain": "<p>The fully qualified domain name (FQDN) of the certificate that needs to be validated.</p>",
|
||||
"ResendValidationEmailRequest$ValidationDomain": "<p>The base validation domain that will act as the suffix of the email addresses that are used to send the emails. This must be the same as the <code>Domain</code> value or a superdomain of the <code>Domain</code> value. For example, if you requested a certificate for <code>site.subdomain.example.com</code> and specify a <b>ValidationDomain</b> of <code>subdomain.example.com</code>, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses:</p> <ul> <li> <p>admin@subdomain.example.com</p> </li> <li> <p>administrator@subdomain.example.com</p> </li> <li> <p>hostmaster@subdomain.example.com</p> </li> <li> <p>postmaster@subdomain.example.com</p> </li> <li> <p>webmaster@subdomain.example.com</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"DomainStatus": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DomainValidation$ValidationStatus": "<p>The validation status of the domain name.</p>"
|
||||
}
|
||||
},
|
||||
"DomainValidation": {
|
||||
"base": "<p>Contains information about the validation of each domain name in the certificate.</p>",
|
||||
"refs": {
|
||||
"DomainValidationList$member": null
|
||||
}
|
||||
},
|
||||
"DomainValidationList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CertificateDetail$DomainValidationOptions": "<p>Contains information about the initial validation of each domain name that occurs as a result of the <a>RequestCertificate</a> request. This field exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>",
|
||||
"RenewalSummary$DomainValidationOptions": "<p>Contains information about the validation of each domain name in the certificate, as it pertains to ACM's <a href=\"http://docs.aws.amazon.com/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>"
|
||||
}
|
||||
},
|
||||
"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>",
|
||||
"refs": {
|
||||
"DomainValidationOptionList$member": null
|
||||
}
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"GetCertificateRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetCertificateResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"IdempotencyToken": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"RequestCertificateRequest$IdempotencyToken": "<p>Customer chosen string that can be used to distinguish between calls to <code>RequestCertificate</code>. Idempotency tokens time out after one hour. Therefore, if you call <code>RequestCertificate</code> multiple times with the same idempotency token within one hour, ACM recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, ACM recognizes that you are requesting multiple certificates.</p>"
|
||||
}
|
||||
},
|
||||
"ImportCertificateRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ImportCertificateResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InUseList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CertificateDetail$InUseBy": "<p>A list of ARNs for the AWS resources that are using the certificate. A certificate can be used by multiple AWS resources.</p>"
|
||||
}
|
||||
},
|
||||
"InvalidArnException": {
|
||||
"base": "<p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidDomainValidationOptionsException": {
|
||||
"base": "<p>One or more values in the <a>DomainValidationOption</a> structure is incorrect.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidStateException": {
|
||||
"base": "<p>Processing has reached an invalid state. 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>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidTagException": {
|
||||
"base": "<p>One or both of the values that make up the key-value pair is not valid. For example, you cannot specify a tag value that begins with <code>aws:</code>.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"KeyAlgorithm": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CertificateDetail$KeyAlgorithm": "<p>The algorithm that was used to generate the key pair (the public and private key).</p>"
|
||||
}
|
||||
},
|
||||
"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>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListCertificatesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListCertificatesResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListTagsForCertificateRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListTagsForCertificateResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"MaxItems": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListCertificatesRequest$MaxItems": "<p>Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the <code>NextToken</code> element is sent in the response. Use this <code>NextToken</code> value in a subsequent request to retrieve additional items.</p>"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListCertificatesRequest$NextToken": "<p>Use this parameter only when paginating results and only in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextToken</code> from the response you just received.</p>",
|
||||
"ListCertificatesResponse$NextToken": "<p>When the list is truncated, this value is present and contains the value to use for the <code>NextToken</code> parameter in a subsequent pagination request.</p>"
|
||||
}
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"RemoveTagsFromCertificateRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"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": {
|
||||
"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>",
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"RequestCertificateRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"RequestCertificateResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"RequestInProgressException": {
|
||||
"base": "<p>The certificate request is in process and the certificate in your account has not yet been issued.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ResendValidationEmailRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ResourceInUseException": {
|
||||
"base": "<p>The certificate is in use by another AWS service in the caller's account. Remove the association and try again.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ResourceNotFoundException": {
|
||||
"base": "<p>The specified certificate cannot be found in the caller's account, or the caller's account cannot be found.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"RevocationReason": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CertificateDetail$RevocationReason": "<p>The reason the certificate was revoked. This value exists only when the certificate status is <code>REVOKED</code>.</p>"
|
||||
}
|
||||
},
|
||||
"String": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CertificateDetail$Serial": "<p>The serial number of the certificate.</p>",
|
||||
"CertificateDetail$Subject": "<p>The name of the entity that is associated with the public key contained in the certificate.</p>",
|
||||
"CertificateDetail$Issuer": "<p>The name of the certificate authority that issued and signed the certificate.</p>",
|
||||
"CertificateDetail$SignatureAlgorithm": "<p>The algorithm that was used to sign the certificate.</p>",
|
||||
"InUseList$member": null,
|
||||
"InvalidArnException$message": null,
|
||||
"InvalidDomainValidationOptionsException$message": null,
|
||||
"InvalidStateException$message": null,
|
||||
"InvalidTagException$message": null,
|
||||
"LimitExceededException$message": null,
|
||||
"RequestInProgressException$message": null,
|
||||
"ResourceInUseException$message": null,
|
||||
"ResourceNotFoundException$message": null,
|
||||
"TooManyTagsException$message": null,
|
||||
"ValidationEmailList$member": null
|
||||
}
|
||||
},
|
||||
"TStamp": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CertificateDetail$CreatedAt": "<p>The time at which the certificate was requested. This value exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>",
|
||||
"CertificateDetail$IssuedAt": "<p>The time at which the certificate was issued. This value exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>",
|
||||
"CertificateDetail$ImportedAt": "<p>The date and time at which the certificate was imported. This value exists only when the certificate type is <code>IMPORTED</code>.</p>",
|
||||
"CertificateDetail$RevokedAt": "<p>The time at which the certificate was revoked. This value exists only when the certificate status is <code>REVOKED</code>.</p>",
|
||||
"CertificateDetail$NotBefore": "<p>The time before which the certificate is not valid.</p>",
|
||||
"CertificateDetail$NotAfter": "<p>The time after which the certificate is not valid.</p>"
|
||||
}
|
||||
},
|
||||
"Tag": {
|
||||
"base": "<p>A key-value pair that identifies or specifies metadata about an ACM resource.</p>",
|
||||
"refs": {
|
||||
"TagList$member": null
|
||||
}
|
||||
},
|
||||
"TagKey": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Tag$Key": "<p>The key of the tag.</p>"
|
||||
}
|
||||
},
|
||||
"TagList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AddTagsToCertificateRequest$Tags": "<p>The key-value pair that defines the tag. The tag value is optional.</p>",
|
||||
"ListTagsForCertificateResponse$Tags": "<p>The key-value pairs that define the applied tags.</p>",
|
||||
"RemoveTagsFromCertificateRequest$Tags": "<p>The key-value pair that defines the tag to remove.</p>"
|
||||
}
|
||||
},
|
||||
"TagValue": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Tag$Value": "<p>The value of the tag.</p>"
|
||||
}
|
||||
},
|
||||
"TooManyTagsException": {
|
||||
"base": "<p>The request contains too many tags. Try the request again with fewer tags.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ValidationEmailList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DomainValidation$ValidationEmails": "<p>A list of email addresses that ACM used to send domain validation emails.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
+10
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"pagination": {
|
||||
"ListCertificates": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxItems",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "CertificateSummaryList"
|
||||
}
|
||||
}
|
||||
}
|
||||
+4523
File diff suppressed because it is too large
Load Diff
+1803
File diff suppressed because one or more lines are too long
Generated
Vendored
+5
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+70
@@ -0,0 +1,70 @@
|
||||
{
|
||||
"pagination": {
|
||||
"GetApiKeys": {
|
||||
"input_token": "position",
|
||||
"limit_key": "limit",
|
||||
"output_token": "position",
|
||||
"result_key": "items"
|
||||
},
|
||||
"GetBasePathMappings": {
|
||||
"input_token": "position",
|
||||
"limit_key": "limit",
|
||||
"output_token": "position",
|
||||
"result_key": "items"
|
||||
},
|
||||
"GetClientCertificates": {
|
||||
"input_token": "position",
|
||||
"limit_key": "limit",
|
||||
"output_token": "position",
|
||||
"result_key": "items"
|
||||
},
|
||||
"GetDeployments": {
|
||||
"input_token": "position",
|
||||
"limit_key": "limit",
|
||||
"output_token": "position",
|
||||
"result_key": "items"
|
||||
},
|
||||
"GetDomainNames": {
|
||||
"input_token": "position",
|
||||
"limit_key": "limit",
|
||||
"output_token": "position",
|
||||
"result_key": "items"
|
||||
},
|
||||
"GetModels": {
|
||||
"input_token": "position",
|
||||
"limit_key": "limit",
|
||||
"output_token": "position",
|
||||
"result_key": "items"
|
||||
},
|
||||
"GetResources": {
|
||||
"input_token": "position",
|
||||
"limit_key": "limit",
|
||||
"output_token": "position",
|
||||
"result_key": "items"
|
||||
},
|
||||
"GetRestApis": {
|
||||
"input_token": "position",
|
||||
"limit_key": "limit",
|
||||
"output_token": "position",
|
||||
"result_key": "items"
|
||||
},
|
||||
"GetUsage": {
|
||||
"input_token": "position",
|
||||
"limit_key": "limit",
|
||||
"output_token": "position",
|
||||
"result_key": "items"
|
||||
},
|
||||
"GetUsagePlanKeys": {
|
||||
"input_token": "position",
|
||||
"limit_key": "limit",
|
||||
"output_token": "position",
|
||||
"result_key": "items"
|
||||
},
|
||||
"GetUsagePlans": {
|
||||
"input_token": "position",
|
||||
"limit_key": "limit",
|
||||
"output_token": "position",
|
||||
"result_key": "items"
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+511
@@ -0,0 +1,511 @@
|
||||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"apiVersion":"2016-02-06",
|
||||
"endpointPrefix":"autoscaling",
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceFullName":"Application Auto Scaling",
|
||||
"signatureVersion":"v4",
|
||||
"signingName":"application-autoscaling",
|
||||
"targetPrefix":"AnyScaleFrontendService",
|
||||
"uid":"application-autoscaling-2016-02-06"
|
||||
},
|
||||
"operations":{
|
||||
"DeleteScalingPolicy":{
|
||||
"name":"DeleteScalingPolicy",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteScalingPolicyRequest"},
|
||||
"output":{"shape":"DeleteScalingPolicyResponse"},
|
||||
"errors":[
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ObjectNotFoundException"},
|
||||
{"shape":"ConcurrentUpdateException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
]
|
||||
},
|
||||
"DeregisterScalableTarget":{
|
||||
"name":"DeregisterScalableTarget",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeregisterScalableTargetRequest"},
|
||||
"output":{"shape":"DeregisterScalableTargetResponse"},
|
||||
"errors":[
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ObjectNotFoundException"},
|
||||
{"shape":"ConcurrentUpdateException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
]
|
||||
},
|
||||
"DescribeScalableTargets":{
|
||||
"name":"DescribeScalableTargets",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeScalableTargetsRequest"},
|
||||
"output":{"shape":"DescribeScalableTargetsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ConcurrentUpdateException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
]
|
||||
},
|
||||
"DescribeScalingActivities":{
|
||||
"name":"DescribeScalingActivities",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeScalingActivitiesRequest"},
|
||||
"output":{"shape":"DescribeScalingActivitiesResponse"},
|
||||
"errors":[
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ConcurrentUpdateException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
]
|
||||
},
|
||||
"DescribeScalingPolicies":{
|
||||
"name":"DescribeScalingPolicies",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeScalingPoliciesRequest"},
|
||||
"output":{"shape":"DescribeScalingPoliciesResponse"},
|
||||
"errors":[
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"FailedResourceAccessException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ConcurrentUpdateException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
]
|
||||
},
|
||||
"PutScalingPolicy":{
|
||||
"name":"PutScalingPolicy",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"PutScalingPolicyRequest"},
|
||||
"output":{"shape":"PutScalingPolicyResponse"},
|
||||
"errors":[
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ObjectNotFoundException"},
|
||||
{"shape":"ConcurrentUpdateException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
]
|
||||
},
|
||||
"RegisterScalableTarget":{
|
||||
"name":"RegisterScalableTarget",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"RegisterScalableTargetRequest"},
|
||||
"output":{"shape":"RegisterScalableTargetResponse"},
|
||||
"errors":[
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ConcurrentUpdateException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AdjustmentType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ChangeInCapacity",
|
||||
"PercentChangeInCapacity",
|
||||
"ExactCapacity"
|
||||
]
|
||||
},
|
||||
"Alarm":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AlarmName",
|
||||
"AlarmARN"
|
||||
],
|
||||
"members":{
|
||||
"AlarmName":{"shape":"ResourceId"},
|
||||
"AlarmARN":{"shape":"ResourceId"}
|
||||
}
|
||||
},
|
||||
"Alarms":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Alarm"}
|
||||
},
|
||||
"ConcurrentUpdateException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"Cooldown":{"type":"integer"},
|
||||
"DeleteScalingPolicyRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"PolicyName",
|
||||
"ServiceNamespace",
|
||||
"ResourceId",
|
||||
"ScalableDimension"
|
||||
],
|
||||
"members":{
|
||||
"PolicyName":{"shape":"ResourceIdMaxLen1600"},
|
||||
"ServiceNamespace":{"shape":"ServiceNamespace"},
|
||||
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
|
||||
"ScalableDimension":{"shape":"ScalableDimension"}
|
||||
}
|
||||
},
|
||||
"DeleteScalingPolicyResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeregisterScalableTargetRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ServiceNamespace",
|
||||
"ResourceId",
|
||||
"ScalableDimension"
|
||||
],
|
||||
"members":{
|
||||
"ServiceNamespace":{"shape":"ServiceNamespace"},
|
||||
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
|
||||
"ScalableDimension":{"shape":"ScalableDimension"}
|
||||
}
|
||||
},
|
||||
"DeregisterScalableTargetResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DescribeScalableTargetsRequest":{
|
||||
"type":"structure",
|
||||
"required":["ServiceNamespace"],
|
||||
"members":{
|
||||
"ServiceNamespace":{"shape":"ServiceNamespace"},
|
||||
"ResourceIds":{"shape":"ResourceIdsMaxLen1600"},
|
||||
"ScalableDimension":{"shape":"ScalableDimension"},
|
||||
"MaxResults":{"shape":"MaxResults"},
|
||||
"NextToken":{"shape":"XmlString"}
|
||||
}
|
||||
},
|
||||
"DescribeScalableTargetsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ScalableTargets":{"shape":"ScalableTargets"},
|
||||
"NextToken":{"shape":"XmlString"}
|
||||
}
|
||||
},
|
||||
"DescribeScalingActivitiesRequest":{
|
||||
"type":"structure",
|
||||
"required":["ServiceNamespace"],
|
||||
"members":{
|
||||
"ServiceNamespace":{"shape":"ServiceNamespace"},
|
||||
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
|
||||
"ScalableDimension":{"shape":"ScalableDimension"},
|
||||
"MaxResults":{"shape":"MaxResults"},
|
||||
"NextToken":{"shape":"XmlString"}
|
||||
}
|
||||
},
|
||||
"DescribeScalingActivitiesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ScalingActivities":{"shape":"ScalingActivities"},
|
||||
"NextToken":{"shape":"XmlString"}
|
||||
}
|
||||
},
|
||||
"DescribeScalingPoliciesRequest":{
|
||||
"type":"structure",
|
||||
"required":["ServiceNamespace"],
|
||||
"members":{
|
||||
"PolicyNames":{"shape":"ResourceIdsMaxLen1600"},
|
||||
"ServiceNamespace":{"shape":"ServiceNamespace"},
|
||||
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
|
||||
"ScalableDimension":{"shape":"ScalableDimension"},
|
||||
"MaxResults":{"shape":"MaxResults"},
|
||||
"NextToken":{"shape":"XmlString"}
|
||||
}
|
||||
},
|
||||
"DescribeScalingPoliciesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ScalingPolicies":{"shape":"ScalingPolicies"},
|
||||
"NextToken":{"shape":"XmlString"}
|
||||
}
|
||||
},
|
||||
"ErrorMessage":{"type":"string"},
|
||||
"FailedResourceAccessException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InternalServiceException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidNextTokenException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"LimitExceededException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"MaxResults":{"type":"integer"},
|
||||
"MetricAggregationType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"Average",
|
||||
"Minimum",
|
||||
"Maximum"
|
||||
]
|
||||
},
|
||||
"MetricScale":{"type":"double"},
|
||||
"MinAdjustmentMagnitude":{"type":"integer"},
|
||||
"ObjectNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"PolicyName":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":1,
|
||||
"pattern":"\\p{Print}+"
|
||||
},
|
||||
"PolicyType":{
|
||||
"type":"string",
|
||||
"enum":["StepScaling"]
|
||||
},
|
||||
"PutScalingPolicyRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"PolicyName",
|
||||
"ServiceNamespace",
|
||||
"ResourceId",
|
||||
"ScalableDimension"
|
||||
],
|
||||
"members":{
|
||||
"PolicyName":{"shape":"PolicyName"},
|
||||
"ServiceNamespace":{"shape":"ServiceNamespace"},
|
||||
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
|
||||
"ScalableDimension":{"shape":"ScalableDimension"},
|
||||
"PolicyType":{"shape":"PolicyType"},
|
||||
"StepScalingPolicyConfiguration":{"shape":"StepScalingPolicyConfiguration"}
|
||||
}
|
||||
},
|
||||
"PutScalingPolicyResponse":{
|
||||
"type":"structure",
|
||||
"required":["PolicyARN"],
|
||||
"members":{
|
||||
"PolicyARN":{"shape":"ResourceIdMaxLen1600"}
|
||||
}
|
||||
},
|
||||
"RegisterScalableTargetRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ServiceNamespace",
|
||||
"ResourceId",
|
||||
"ScalableDimension"
|
||||
],
|
||||
"members":{
|
||||
"ServiceNamespace":{"shape":"ServiceNamespace"},
|
||||
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
|
||||
"ScalableDimension":{"shape":"ScalableDimension"},
|
||||
"MinCapacity":{"shape":"ResourceCapacity"},
|
||||
"MaxCapacity":{"shape":"ResourceCapacity"},
|
||||
"RoleARN":{"shape":"ResourceIdMaxLen1600"}
|
||||
}
|
||||
},
|
||||
"RegisterScalableTargetResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"ResourceCapacity":{"type":"integer"},
|
||||
"ResourceId":{
|
||||
"type":"string",
|
||||
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
|
||||
},
|
||||
"ResourceIdMaxLen1600":{
|
||||
"type":"string",
|
||||
"max":1600,
|
||||
"min":1,
|
||||
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
|
||||
},
|
||||
"ResourceIdsMaxLen1600":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ResourceIdMaxLen1600"}
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ecs:service:DesiredCount",
|
||||
"ec2:spot-fleet-request:TargetCapacity",
|
||||
"elasticmapreduce:instancegroup:InstanceCount"
|
||||
]
|
||||
},
|
||||
"ScalableTarget":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ServiceNamespace",
|
||||
"ResourceId",
|
||||
"ScalableDimension",
|
||||
"MinCapacity",
|
||||
"MaxCapacity",
|
||||
"RoleARN",
|
||||
"CreationTime"
|
||||
],
|
||||
"members":{
|
||||
"ServiceNamespace":{"shape":"ServiceNamespace"},
|
||||
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
|
||||
"ScalableDimension":{"shape":"ScalableDimension"},
|
||||
"MinCapacity":{"shape":"ResourceCapacity"},
|
||||
"MaxCapacity":{"shape":"ResourceCapacity"},
|
||||
"RoleARN":{"shape":"ResourceIdMaxLen1600"},
|
||||
"CreationTime":{"shape":"TimestampType"}
|
||||
}
|
||||
},
|
||||
"ScalableTargets":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ScalableTarget"}
|
||||
},
|
||||
"ScalingActivities":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ScalingActivity"}
|
||||
},
|
||||
"ScalingActivity":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ActivityId",
|
||||
"ServiceNamespace",
|
||||
"ResourceId",
|
||||
"ScalableDimension",
|
||||
"Description",
|
||||
"Cause",
|
||||
"StartTime",
|
||||
"StatusCode"
|
||||
],
|
||||
"members":{
|
||||
"ActivityId":{"shape":"ResourceId"},
|
||||
"ServiceNamespace":{"shape":"ServiceNamespace"},
|
||||
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
|
||||
"ScalableDimension":{"shape":"ScalableDimension"},
|
||||
"Description":{"shape":"XmlString"},
|
||||
"Cause":{"shape":"XmlString"},
|
||||
"StartTime":{"shape":"TimestampType"},
|
||||
"EndTime":{"shape":"TimestampType"},
|
||||
"StatusCode":{"shape":"ScalingActivityStatusCode"},
|
||||
"StatusMessage":{"shape":"XmlString"},
|
||||
"Details":{"shape":"XmlString"}
|
||||
}
|
||||
},
|
||||
"ScalingActivityStatusCode":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"Pending",
|
||||
"InProgress",
|
||||
"Successful",
|
||||
"Overridden",
|
||||
"Unfulfilled",
|
||||
"Failed"
|
||||
]
|
||||
},
|
||||
"ScalingAdjustment":{"type":"integer"},
|
||||
"ScalingPolicies":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ScalingPolicy"}
|
||||
},
|
||||
"ScalingPolicy":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"PolicyARN",
|
||||
"PolicyName",
|
||||
"ServiceNamespace",
|
||||
"ResourceId",
|
||||
"ScalableDimension",
|
||||
"PolicyType",
|
||||
"CreationTime"
|
||||
],
|
||||
"members":{
|
||||
"PolicyARN":{"shape":"ResourceIdMaxLen1600"},
|
||||
"PolicyName":{"shape":"PolicyName"},
|
||||
"ServiceNamespace":{"shape":"ServiceNamespace"},
|
||||
"ResourceId":{"shape":"ResourceIdMaxLen1600"},
|
||||
"ScalableDimension":{"shape":"ScalableDimension"},
|
||||
"PolicyType":{"shape":"PolicyType"},
|
||||
"StepScalingPolicyConfiguration":{"shape":"StepScalingPolicyConfiguration"},
|
||||
"Alarms":{"shape":"Alarms"},
|
||||
"CreationTime":{"shape":"TimestampType"}
|
||||
}
|
||||
},
|
||||
"ServiceNamespace":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ecs",
|
||||
"elasticmapreduce",
|
||||
"ec2"
|
||||
]
|
||||
},
|
||||
"StepAdjustment":{
|
||||
"type":"structure",
|
||||
"required":["ScalingAdjustment"],
|
||||
"members":{
|
||||
"MetricIntervalLowerBound":{"shape":"MetricScale"},
|
||||
"MetricIntervalUpperBound":{"shape":"MetricScale"},
|
||||
"ScalingAdjustment":{"shape":"ScalingAdjustment"}
|
||||
}
|
||||
},
|
||||
"StepAdjustments":{
|
||||
"type":"list",
|
||||
"member":{"shape":"StepAdjustment"}
|
||||
},
|
||||
"StepScalingPolicyConfiguration":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AdjustmentType":{"shape":"AdjustmentType"},
|
||||
"StepAdjustments":{"shape":"StepAdjustments"},
|
||||
"MinAdjustmentMagnitude":{"shape":"MinAdjustmentMagnitude"},
|
||||
"Cooldown":{"shape":"Cooldown"},
|
||||
"MetricAggregationType":{"shape":"MetricAggregationType"}
|
||||
}
|
||||
},
|
||||
"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
+362
@@ -0,0 +1,362 @@
|
||||
{
|
||||
"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> </ul> <p>For a list of supported regions, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#as-app_region\">AWS Regions and Endpoints: Application Auto Scaling</a> in the <i>AWS General Reference</i>.</p>",
|
||||
"operations": {
|
||||
"DeleteScalingPolicy": "<p>Deletes the specified Application Auto Scaling scaling policy.</p> <p>Deleting a policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.</p> <p>To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>.</p>",
|
||||
"DeregisterScalableTarget": "<p>Deregisters a scalable target.</p> <p>Deregistering a scalable target deletes the scaling policies that are associated with it.</p> <p>To create a scalable target or update an existing one, see <a>RegisterScalableTarget</a>.</p>",
|
||||
"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>",
|
||||
"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>"
|
||||
},
|
||||
"shapes": {
|
||||
"AdjustmentType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StepScalingPolicyConfiguration$AdjustmentType": "<p>The adjustment type, which specifies how the <code>ScalingAdjustment</code> parameter in a <a>StepAdjustment</a> is interpreted.</p>"
|
||||
}
|
||||
},
|
||||
"Alarm": {
|
||||
"base": "<p>Represents a CloudWatch alarm associated with a scaling policy.</p>",
|
||||
"refs": {
|
||||
"Alarms$member": null
|
||||
}
|
||||
},
|
||||
"Alarms": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ScalingPolicy$Alarms": "<p>The CloudWatch alarms associated with the scaling policy.</p>"
|
||||
}
|
||||
},
|
||||
"ConcurrentUpdateException": {
|
||||
"base": "<p>Concurrent updates caused an exception, for example, if you request an update to an Application Auto Scaling resource that already has a pending update.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Cooldown": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StepScalingPolicyConfiguration$Cooldown": "<p>The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.</p> <p>For scale out policies, while <code>Cooldown</code> is in effect, the capacity that has been added by the previous scale out event that initiated the <code>Cooldown</code> is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a <code>Cooldown</code> period of 5 minutes starts. During the <code>Cooldown</code> period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.</p> <p>For scale in policies, the <code>Cooldown</code> 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 <code>Cooldown</code> period after a scale-in, Application Auto Scaling scales out your scalable target immediately.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteScalingPolicyRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteScalingPolicyResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeregisterScalableTargetRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeregisterScalableTargetResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeScalableTargetsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeScalableTargetsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeScalingActivitiesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeScalingActivitiesResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeScalingPoliciesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeScalingPoliciesResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ErrorMessage": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ConcurrentUpdateException$Message": null,
|
||||
"FailedResourceAccessException$Message": null,
|
||||
"InternalServiceException$Message": null,
|
||||
"InvalidNextTokenException$Message": null,
|
||||
"LimitExceededException$Message": null,
|
||||
"ObjectNotFoundException$Message": null,
|
||||
"ValidationException$Message": null
|
||||
}
|
||||
},
|
||||
"FailedResourceAccessException": {
|
||||
"base": "<p>Failed access to resources caused an exception. This exception currently only applies to <a>DescribeScalingPolicies</a>. It 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 the proper permissions 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>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InternalServiceException": {
|
||||
"base": "<p>The service encountered an internal error.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidNextTokenException": {
|
||||
"base": "<p>The next token supplied was invalid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"LimitExceededException": {
|
||||
"base": "<p>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>",
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"MetricAggregationType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StepScalingPolicyConfiguration$MetricAggregationType": "<p>The aggregation type for the CloudWatch metrics. Valid values are <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code>.</p>"
|
||||
}
|
||||
},
|
||||
"MetricScale": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StepAdjustment$MetricIntervalLowerBound": "<p>The lower bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the lower bound is inclusive (the metric must be greater than or equal to the threshold plus the lower bound). Otherwise, it is exclusive (the metric must be greater than the threshold plus the lower bound). A null value indicates negative infinity.</p>",
|
||||
"StepAdjustment$MetricIntervalUpperBound": "<p>The upper bound for the difference between the alarm threshold and the CloudWatch metric. If the metric value is above the breach threshold, the upper bound is exclusive (the metric must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the metric must be less than or equal to the threshold plus the upper bound). A null value indicates positive infinity.</p> <p>The upper bound must be greater than the lower bound.</p>"
|
||||
}
|
||||
},
|
||||
"MinAdjustmentMagnitude": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StepScalingPolicyConfiguration$MinAdjustmentMagnitude": "<p>The minimum number to adjust your scalable dimension as a result of a scaling activity. If the adjustment type is <code>PercentChangeInCapacity</code>, the scaling policy changes the scalable dimension of the scalable target by this amount.</p>"
|
||||
}
|
||||
},
|
||||
"ObjectNotFoundException": {
|
||||
"base": "<p>The specified object could not be found. For any <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>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"PolicyName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PutScalingPolicyRequest$PolicyName": "<p>The name of the scaling policy.</p>",
|
||||
"ScalingPolicy$PolicyName": "<p>The name of the scaling policy.</p>"
|
||||
}
|
||||
},
|
||||
"PolicyType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PutScalingPolicyRequest$PolicyType": "<p>The policy type. If you are creating a new policy, this parameter is required. If you are updating a policy, this parameter is not required.</p>",
|
||||
"ScalingPolicy$PolicyType": "<p>The scaling policy type.</p>"
|
||||
}
|
||||
},
|
||||
"PutScalingPolicyRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"PutScalingPolicyResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"RegisterScalableTargetRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"RegisterScalableTargetResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ResourceCapacity": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"RegisterScalableTargetRequest$MinCapacity": "<p>The minimum value to scale to in response to a scale in event. This parameter is required if you are registering a scalable target 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>",
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"ResourceId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Alarm$AlarmName": "<p>The name of the alarm.</p>",
|
||||
"Alarm$AlarmARN": "<p>The Amazon Resource Name (ARN) of the alarm.</p>",
|
||||
"ScalingActivity$ActivityId": "<p>The unique identifier of the scaling activity.</p>"
|
||||
}
|
||||
},
|
||||
"ResourceIdMaxLen1600": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DeleteScalingPolicyRequest$PolicyName": "<p>The name of the scaling policy.</p>",
|
||||
"DeleteScalingPolicyRequest$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> </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> </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> </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> </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> </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> </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>",
|
||||
"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> </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> </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> </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> </ul>",
|
||||
"DescribeScalingPoliciesRequest$PolicyNames": "<p>The names of the scaling policies to describe.</p>"
|
||||
}
|
||||
},
|
||||
"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> </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> </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> </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> </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> </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> </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> </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> </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> </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> </ul>"
|
||||
}
|
||||
},
|
||||
"ScalableTarget": {
|
||||
"base": "<p>Represents a scalable target.</p>",
|
||||
"refs": {
|
||||
"ScalableTargets$member": null
|
||||
}
|
||||
},
|
||||
"ScalableTargets": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeScalableTargetsResponse$ScalableTargets": "<p>The list of scalable targets that matches the request parameters.</p>"
|
||||
}
|
||||
},
|
||||
"ScalingActivities": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeScalingActivitiesResponse$ScalingActivities": "<p>A list of scaling activity objects.</p>"
|
||||
}
|
||||
},
|
||||
"ScalingActivity": {
|
||||
"base": "<p>Represents a scaling activity.</p>",
|
||||
"refs": {
|
||||
"ScalingActivities$member": null
|
||||
}
|
||||
},
|
||||
"ScalingActivityStatusCode": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ScalingActivity$StatusCode": "<p>Indicates the status of the scaling activity.</p>"
|
||||
}
|
||||
},
|
||||
"ScalingAdjustment": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StepAdjustment$ScalingAdjustment": "<p>The amount by which to scale, based on the specified adjustment type. A positive value adds to the current scalable dimension while a negative number removes from the current scalable dimension.</p>"
|
||||
}
|
||||
},
|
||||
"ScalingPolicies": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeScalingPoliciesResponse$ScalingPolicies": "<p>A list of scaling policy objects.</p>"
|
||||
}
|
||||
},
|
||||
"ScalingPolicy": {
|
||||
"base": "<p>Represents a scaling policy.</p>",
|
||||
"refs": {
|
||||
"ScalingPolicies$member": null
|
||||
}
|
||||
},
|
||||
"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>",
|
||||
"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>",
|
||||
"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>",
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"StepAdjustment": {
|
||||
"base": "<p>Represents a step adjustment for a <a>StepScalingPolicyConfiguration</a>. Describes an adjustment based on the difference between the value of the aggregated CloudWatch metric and the breach threshold that you've defined for the alarm. </p> <p>For the following examples, suppose that you have an alarm with a breach threshold of 50:</p> <ul> <li> <p>To trigger the adjustment when the metric is greater than or equal to 50 and less than 60, specify a lower bound of 0 and an upper bound of 10.</p> </li> <li> <p>To trigger the adjustment when the metric is greater than 40 and less than or equal to 50, specify a lower bound of -10 and an upper bound of 0.</p> </li> </ul> <p>There are a few rules for the step adjustments for your step policy:</p> <ul> <li> <p>The ranges of your step adjustments can't overlap or have a gap.</p> </li> <li> <p>At most one step adjustment can have a null lower bound. If one step adjustment has a negative lower bound, then there must be a step adjustment with a null lower bound.</p> </li> <li> <p>At most one step adjustment can have a null upper bound. If one step adjustment has a positive upper bound, then there must be a step adjustment with a null upper bound.</p> </li> <li> <p>The upper and lower bound can't be null in the same step adjustment.</p> </li> </ul>",
|
||||
"refs": {
|
||||
"StepAdjustments$member": null
|
||||
}
|
||||
},
|
||||
"StepAdjustments": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StepScalingPolicyConfiguration$StepAdjustments": "<p>A set of adjustments that enable you to scale based on the size of the alarm breach.</p>"
|
||||
}
|
||||
},
|
||||
"StepScalingPolicyConfiguration": {
|
||||
"base": "<p>Represents a step scaling policy configuration.</p>",
|
||||
"refs": {
|
||||
"PutScalingPolicyRequest$StepScalingPolicyConfiguration": "<p>The configuration for the step scaling policy. If you are creating a new policy, this parameter is required. If you are updating a policy, this parameter is not required. For more information, see <a>StepScalingPolicyConfiguration</a> and <a>StepAdjustment</a>.</p>",
|
||||
"ScalingPolicy$StepScalingPolicyConfiguration": "<p>The configuration for the step scaling policy.</p>"
|
||||
}
|
||||
},
|
||||
"TimestampType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"ValidationException": {
|
||||
"base": "<p>An exception was thrown for a validation issue. Review the available parameters for the API request.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"XmlString": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeScalableTargetsRequest$NextToken": "<p>The token for the next set of results.</p>",
|
||||
"DescribeScalableTargetsResponse$NextToken": "<p>The token required to get the next set of results. This value is <code>null</code> if there are no more results to return.</p>",
|
||||
"DescribeScalingActivitiesRequest$NextToken": "<p>The token for the next set of results.</p>",
|
||||
"DescribeScalingActivitiesResponse$NextToken": "<p>The token required to get the next set of results. This value is <code>null</code> if there are no more results to return.</p>",
|
||||
"DescribeScalingPoliciesRequest$NextToken": "<p>The token for the next set of results.</p>",
|
||||
"DescribeScalingPoliciesResponse$NextToken": "<p>The token required to get the next set of results. This value is <code>null</code> if there are no more results to return.</p>",
|
||||
"ScalingActivity$Description": "<p>A simple description of what action the scaling activity intends to accomplish.</p>",
|
||||
"ScalingActivity$Cause": "<p>A simple description of what caused the scaling activity to happen.</p>",
|
||||
"ScalingActivity$StatusMessage": "<p>A simple message about the current status of the scaling activity.</p>",
|
||||
"ScalingActivity$Details": "<p>The details about the scaling activity.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+257
@@ -0,0 +1,257 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
"DeleteScalingPolicy": [
|
||||
{
|
||||
"input": {
|
||||
"PolicyName": "web-app-cpu-lt-25",
|
||||
"ResourceId": "service/default/web-app",
|
||||
"ScalableDimension": "ecs:service:DesiredCount",
|
||||
"ServiceNamespace": "ecs"
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deletes a scaling policy for the Amazon ECS service called web-app, which is running in the default cluster.",
|
||||
"id": "to-delete-a-scaling-policy-1470863892689",
|
||||
"title": "To delete a scaling policy"
|
||||
}
|
||||
],
|
||||
"DeregisterScalableTarget": [
|
||||
{
|
||||
"input": {
|
||||
"ResourceId": "service/default/web-app",
|
||||
"ScalableDimension": "ecs:service:DesiredCount",
|
||||
"ServiceNamespace": "ecs"
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deregisters a scalable target for an Amazon ECS service called web-app that is running in the default cluster.",
|
||||
"id": "to-deregister-a-scalable-target-1470864164895",
|
||||
"title": "To deregister a scalable target"
|
||||
}
|
||||
],
|
||||
"DescribeScalableTargets": [
|
||||
{
|
||||
"input": {
|
||||
"ServiceNamespace": "ecs"
|
||||
},
|
||||
"output": {
|
||||
"ScalableTargets": [
|
||||
{
|
||||
"CreationTime": "2016-05-06T11:21:46.199Z",
|
||||
"MaxCapacity": 10,
|
||||
"MinCapacity": 1,
|
||||
"ResourceId": "service/default/web-app",
|
||||
"RoleARN": "arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole",
|
||||
"ScalableDimension": "ecs:service:DesiredCount",
|
||||
"ServiceNamespace": "ecs"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the scalable targets for the ecs service namespace.",
|
||||
"id": "to-describe-scalable-targets-1470864286961",
|
||||
"title": "To describe scalable targets"
|
||||
}
|
||||
],
|
||||
"DescribeScalingActivities": [
|
||||
{
|
||||
"input": {
|
||||
"ResourceId": "service/default/web-app",
|
||||
"ScalableDimension": "ecs:service:DesiredCount",
|
||||
"ServiceNamespace": "ecs"
|
||||
},
|
||||
"output": {
|
||||
"ScalingActivities": [
|
||||
{
|
||||
"ActivityId": "e6c5f7d1-dbbb-4a3f-89b2-51f33e766399",
|
||||
"Cause": "monitor alarm web-app-cpu-lt-25 in state ALARM triggered policy web-app-cpu-lt-25",
|
||||
"Description": "Setting desired count to 1.",
|
||||
"EndTime": "2016-05-06T16:04:32.111Z",
|
||||
"ResourceId": "service/default/web-app",
|
||||
"ScalableDimension": "ecs:service:DesiredCount",
|
||||
"ServiceNamespace": "ecs",
|
||||
"StartTime": "2016-05-06T16:03:58.171Z",
|
||||
"StatusCode": "Successful",
|
||||
"StatusMessage": "Successfully set desired count to 1. Change successfully fulfilled by ecs."
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the scaling activities for an Amazon ECS service called web-app that is running in the default cluster.",
|
||||
"id": "to-describe-scaling-activities-for-a-scalable-target-1470864398629",
|
||||
"title": "To describe scaling activities for a scalable target"
|
||||
}
|
||||
],
|
||||
"DescribeScalingPolicies": [
|
||||
{
|
||||
"input": {
|
||||
"ServiceNamespace": "ecs"
|
||||
},
|
||||
"output": {
|
||||
"NextToken": "",
|
||||
"ScalingPolicies": [
|
||||
{
|
||||
"Alarms": [
|
||||
{
|
||||
"AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:web-app-cpu-gt-75",
|
||||
"AlarmName": "web-app-cpu-gt-75"
|
||||
}
|
||||
],
|
||||
"CreationTime": "2016-05-06T12:11:39.230Z",
|
||||
"PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75",
|
||||
"PolicyName": "web-app-cpu-gt-75",
|
||||
"PolicyType": "StepScaling",
|
||||
"ResourceId": "service/default/web-app",
|
||||
"ScalableDimension": "ecs:service:DesiredCount",
|
||||
"ServiceNamespace": "ecs",
|
||||
"StepScalingPolicyConfiguration": {
|
||||
"AdjustmentType": "PercentChangeInCapacity",
|
||||
"Cooldown": 60,
|
||||
"StepAdjustments": [
|
||||
{
|
||||
"MetricIntervalLowerBound": 0,
|
||||
"ScalingAdjustment": 200
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the scaling policies for the ecs service namespace.",
|
||||
"id": "to-describe-scaling-policies-1470864609734",
|
||||
"title": "To describe scaling policies"
|
||||
}
|
||||
],
|
||||
"PutScalingPolicy": [
|
||||
{
|
||||
"input": {
|
||||
"PolicyName": "web-app-cpu-gt-75",
|
||||
"PolicyType": "StepScaling",
|
||||
"ResourceId": "service/default/web-app",
|
||||
"ScalableDimension": "ecs:service:DesiredCount",
|
||||
"ServiceNamespace": "ecs",
|
||||
"StepScalingPolicyConfiguration": {
|
||||
"AdjustmentType": "PercentChangeInCapacity",
|
||||
"Cooldown": 60,
|
||||
"StepAdjustments": [
|
||||
{
|
||||
"MetricIntervalLowerBound": 0,
|
||||
"ScalingAdjustment": 200
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example applies a scaling policy to an Amazon ECS service called web-app in the default cluster. The policy increases the desired count of the service by 200%, with a cool down period of 60 seconds.",
|
||||
"id": "to-apply-a-scaling-policy-to-an-amazon-ecs-service-1470864779862",
|
||||
"title": "To apply a scaling policy to an Amazon ECS service"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"PolicyName": "fleet-cpu-gt-75",
|
||||
"PolicyType": "StepScaling",
|
||||
"ResourceId": "spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3",
|
||||
"ScalableDimension": "ec2:spot-fleet-request:TargetCapacity",
|
||||
"ServiceNamespace": "ec2",
|
||||
"StepScalingPolicyConfiguration": {
|
||||
"AdjustmentType": "PercentChangeInCapacity",
|
||||
"Cooldown": 180,
|
||||
"StepAdjustments": [
|
||||
{
|
||||
"MetricIntervalLowerBound": 0,
|
||||
"ScalingAdjustment": 200
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"PolicyARN": "arn:aws:autoscaling:us-east-1:012345678910:scalingPolicy:89406401-0cb7-4130-b770-d97cca0e446b:resource/ec2/spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3:policyName/fleet-cpu-gt-75"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example applies a scaling policy to an Amazon EC2 Spot fleet. The policy increases the target capacity of the spot fleet by 200%, with a cool down period of 180 seconds.\",\n ",
|
||||
"id": "to-apply-a-scaling-policy-to-an-amazon-ec2-spot-fleet-1472073278469",
|
||||
"title": "To apply a scaling policy to an Amazon EC2 Spot fleet"
|
||||
}
|
||||
],
|
||||
"RegisterScalableTarget": [
|
||||
{
|
||||
"input": {
|
||||
"MaxCapacity": 10,
|
||||
"MinCapacity": 1,
|
||||
"ResourceId": "service/default/web-app",
|
||||
"RoleARN": "arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole",
|
||||
"ScalableDimension": "ecs:service:DesiredCount",
|
||||
"ServiceNamespace": "ecs"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example registers a scalable target from an Amazon ECS service called web-app that is running on the default cluster, with a minimum desired count of 1 task and a maximum desired count of 10 tasks.",
|
||||
"id": "to-register-a-new-scalable-target-1470864910380",
|
||||
"title": "To register an ECS service as a scalable target"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"MaxCapacity": 10,
|
||||
"MinCapacity": 1,
|
||||
"ResourceId": "spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3",
|
||||
"RoleARN": "arn:aws:iam::012345678910:role/ApplicationAutoscalingSpotRole",
|
||||
"ScalableDimension": "ec2:spot-fleet-request:TargetCapacity",
|
||||
"ServiceNamespace": "ec2"
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
},
|
||||
"description": "This example registers a scalable target from an Amazon EC2 Spot fleet with a minimum target capacity of 1 and a maximum of 10.",
|
||||
"id": "to-register-an-ec2-spot-fleet-as-a-scalable-target-1472072899649",
|
||||
"title": "To register an EC2 Spot fleet as a scalable target"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+22
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"pagination": {
|
||||
"DescribeScalableTargets": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"result_key": "ScalableTargets"
|
||||
},
|
||||
"DescribeScalingPolicies": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"result_key": "ScalingPolicies"
|
||||
},
|
||||
"DescribeScalingActivities": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"result_key": "ScalingActivities"
|
||||
}
|
||||
}
|
||||
}
|
||||
+820
@@ -0,0 +1,820 @@
|
||||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"apiVersion":"2016-12-01",
|
||||
"endpointPrefix":"appstream2",
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceFullName":"Amazon AppStream",
|
||||
"signatureVersion":"v4",
|
||||
"signingName":"appstream",
|
||||
"targetPrefix":"PhotonAdminProxyService",
|
||||
"uid":"appstream-2016-12-01"
|
||||
},
|
||||
"operations":{
|
||||
"AssociateFleet":{
|
||||
"name":"AssociateFleet",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"AssociateFleetRequest"},
|
||||
"output":{"shape":"AssociateFleetResult"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"CreateFleet":{
|
||||
"name":"CreateFleet",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateFleetRequest"},
|
||||
"output":{"shape":"CreateFleetResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceAlreadyExistsException"},
|
||||
{"shape":"ResourceNotAvailableException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidRoleException"}
|
||||
]
|
||||
},
|
||||
"CreateStack":{
|
||||
"name":"CreateStack",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateStackRequest"},
|
||||
"output":{"shape":"CreateStackResult"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ResourceAlreadyExistsException"}
|
||||
]
|
||||
},
|
||||
"CreateStreamingURL":{
|
||||
"name":"CreateStreamingURL",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateStreamingURLRequest"},
|
||||
"output":{"shape":"CreateStreamingURLResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ResourceNotAvailableException"},
|
||||
{"shape":"OperationNotPermittedException"}
|
||||
]
|
||||
},
|
||||
"DeleteFleet":{
|
||||
"name":"DeleteFleet",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteFleetRequest"},
|
||||
"output":{"shape":"DeleteFleetResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceInUseException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"DeleteStack":{
|
||||
"name":"DeleteStack",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteStackRequest"},
|
||||
"output":{"shape":"DeleteStackResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceInUseException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"DescribeFleets":{
|
||||
"name":"DescribeFleets",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeFleetsRequest"},
|
||||
"output":{"shape":"DescribeFleetsResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"DescribeImages":{
|
||||
"name":"DescribeImages",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeImagesRequest"},
|
||||
"output":{"shape":"DescribeImagesResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"DescribeSessions":{
|
||||
"name":"DescribeSessions",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeSessionsRequest"},
|
||||
"output":{"shape":"DescribeSessionsResult"}
|
||||
},
|
||||
"DescribeStacks":{
|
||||
"name":"DescribeStacks",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeStacksRequest"},
|
||||
"output":{"shape":"DescribeStacksResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"DisassociateFleet":{
|
||||
"name":"DisassociateFleet",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DisassociateFleetRequest"},
|
||||
"output":{"shape":"DisassociateFleetResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceInUseException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"ExpireSession":{
|
||||
"name":"ExpireSession",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ExpireSessionRequest"},
|
||||
"output":{"shape":"ExpireSessionResult"}
|
||||
},
|
||||
"ListAssociatedFleets":{
|
||||
"name":"ListAssociatedFleets",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListAssociatedFleetsRequest"},
|
||||
"output":{"shape":"ListAssociatedFleetsResult"}
|
||||
},
|
||||
"ListAssociatedStacks":{
|
||||
"name":"ListAssociatedStacks",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListAssociatedStacksRequest"},
|
||||
"output":{"shape":"ListAssociatedStacksResult"}
|
||||
},
|
||||
"StartFleet":{
|
||||
"name":"StartFleet",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StartFleetRequest"},
|
||||
"output":{"shape":"StartFleetResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
]
|
||||
},
|
||||
"StopFleet":{
|
||||
"name":"StopFleet",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StopFleetRequest"},
|
||||
"output":{"shape":"StopFleetResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"UpdateFleet":{
|
||||
"name":"UpdateFleet",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateFleetRequest"},
|
||||
"output":{"shape":"UpdateFleetResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceInUseException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidRoleException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"UpdateStack":{
|
||||
"name":"UpdateStack",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateStackRequest"},
|
||||
"output":{"shape":"UpdateStackResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ResourceInUseException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"Application":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Name":{"shape":"String"},
|
||||
"DisplayName":{"shape":"String"},
|
||||
"IconURL":{"shape":"String"},
|
||||
"LaunchPath":{"shape":"String"},
|
||||
"LaunchParameters":{"shape":"String"},
|
||||
"Enabled":{"shape":"Boolean"},
|
||||
"Metadata":{"shape":"Metadata"}
|
||||
}
|
||||
},
|
||||
"Applications":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Application"}
|
||||
},
|
||||
"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}$"
|
||||
},
|
||||
"AssociateFleetRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"FleetName",
|
||||
"StackName"
|
||||
],
|
||||
"members":{
|
||||
"FleetName":{"shape":"String"},
|
||||
"StackName":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"AssociateFleetResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"Boolean":{"type":"boolean"},
|
||||
"ComputeCapacity":{
|
||||
"type":"structure",
|
||||
"required":["DesiredInstances"],
|
||||
"members":{
|
||||
"DesiredInstances":{"shape":"Integer"}
|
||||
}
|
||||
},
|
||||
"ComputeCapacityStatus":{
|
||||
"type":"structure",
|
||||
"required":["Desired"],
|
||||
"members":{
|
||||
"Desired":{"shape":"Integer"},
|
||||
"Running":{"shape":"Integer"},
|
||||
"InUse":{"shape":"Integer"},
|
||||
"Available":{"shape":"Integer"}
|
||||
}
|
||||
},
|
||||
"CreateFleetRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Name",
|
||||
"ImageName",
|
||||
"InstanceType",
|
||||
"ComputeCapacity"
|
||||
],
|
||||
"members":{
|
||||
"Name":{"shape":"Name"},
|
||||
"ImageName":{"shape":"String"},
|
||||
"InstanceType":{"shape":"String"},
|
||||
"ComputeCapacity":{"shape":"ComputeCapacity"},
|
||||
"VpcConfig":{"shape":"VpcConfig"},
|
||||
"MaxUserDurationInSeconds":{"shape":"Integer"},
|
||||
"DisconnectTimeoutInSeconds":{"shape":"Integer"},
|
||||
"Description":{"shape":"Description"},
|
||||
"DisplayName":{"shape":"DisplayName"}
|
||||
}
|
||||
},
|
||||
"CreateFleetResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Fleet":{"shape":"Fleet"}
|
||||
}
|
||||
},
|
||||
"CreateStackRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{"shape":"String"},
|
||||
"Description":{"shape":"Description"},
|
||||
"DisplayName":{"shape":"DisplayName"}
|
||||
}
|
||||
},
|
||||
"CreateStackResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Stack":{"shape":"Stack"}
|
||||
}
|
||||
},
|
||||
"CreateStreamingURLRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"StackName",
|
||||
"FleetName",
|
||||
"UserId"
|
||||
],
|
||||
"members":{
|
||||
"StackName":{"shape":"String"},
|
||||
"FleetName":{"shape":"String"},
|
||||
"UserId":{"shape":"UserId"},
|
||||
"ApplicationId":{"shape":"String"},
|
||||
"Validity":{"shape":"Long"},
|
||||
"SessionContext":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"CreateStreamingURLResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"StreamingURL":{"shape":"String"},
|
||||
"Expires":{"shape":"Timestamp"}
|
||||
}
|
||||
},
|
||||
"DeleteFleetRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DeleteFleetResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteStackRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DeleteStackResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DescribeFleetsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Names":{"shape":"StringList"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeFleetsResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Fleets":{"shape":"FleetList"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeImagesRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Names":{"shape":"StringList"}
|
||||
}
|
||||
},
|
||||
"DescribeImagesResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Images":{"shape":"ImageList"}
|
||||
}
|
||||
},
|
||||
"DescribeSessionsRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"StackName",
|
||||
"FleetName"
|
||||
],
|
||||
"members":{
|
||||
"StackName":{"shape":"String"},
|
||||
"FleetName":{"shape":"String"},
|
||||
"UserId":{"shape":"UserId"},
|
||||
"NextToken":{"shape":"String"},
|
||||
"Limit":{"shape":"Integer"}
|
||||
}
|
||||
},
|
||||
"DescribeSessionsResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Sessions":{"shape":"SessionList"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeStacksRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Names":{"shape":"StringList"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeStacksResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Stacks":{"shape":"StackList"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"Description":{
|
||||
"type":"string",
|
||||
"max":256
|
||||
},
|
||||
"DisassociateFleetRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"FleetName",
|
||||
"StackName"
|
||||
],
|
||||
"members":{
|
||||
"FleetName":{"shape":"String"},
|
||||
"StackName":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DisassociateFleetResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DisplayName":{
|
||||
"type":"string",
|
||||
"max":100
|
||||
},
|
||||
"ErrorMessage":{"type":"string"},
|
||||
"ExpireSessionRequest":{
|
||||
"type":"structure",
|
||||
"required":["SessionId"],
|
||||
"members":{
|
||||
"SessionId":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ExpireSessionResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"Fleet":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Arn",
|
||||
"Name",
|
||||
"ImageName",
|
||||
"InstanceType",
|
||||
"ComputeCapacityStatus",
|
||||
"State"
|
||||
],
|
||||
"members":{
|
||||
"Arn":{"shape":"Arn"},
|
||||
"Name":{"shape":"String"},
|
||||
"DisplayName":{"shape":"String"},
|
||||
"Description":{"shape":"String"},
|
||||
"ImageName":{"shape":"String"},
|
||||
"InstanceType":{"shape":"String"},
|
||||
"ComputeCapacityStatus":{"shape":"ComputeCapacityStatus"},
|
||||
"MaxUserDurationInSeconds":{"shape":"Integer"},
|
||||
"DisconnectTimeoutInSeconds":{"shape":"Integer"},
|
||||
"State":{"shape":"FleetState"},
|
||||
"VpcConfig":{"shape":"VpcConfig"},
|
||||
"CreatedTime":{"shape":"Timestamp"},
|
||||
"FleetErrors":{"shape":"FleetErrors"}
|
||||
}
|
||||
},
|
||||
"FleetError":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ErrorCode":{"shape":"FleetErrorCode"},
|
||||
"ErrorMessage":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"FleetErrorCode":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION",
|
||||
"IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION",
|
||||
"IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION",
|
||||
"NETWORK_INTERFACE_LIMIT_EXCEEDED",
|
||||
"INTERNAL_SERVICE_ERROR",
|
||||
"IAM_SERVICE_ROLE_IS_MISSING",
|
||||
"SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES",
|
||||
"IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION",
|
||||
"SUBNET_NOT_FOUND",
|
||||
"IMAGE_NOT_FOUND",
|
||||
"INVALID_SUBNET_CONFIGURATION"
|
||||
]
|
||||
},
|
||||
"FleetErrors":{
|
||||
"type":"list",
|
||||
"member":{"shape":"FleetError"}
|
||||
},
|
||||
"FleetList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Fleet"}
|
||||
},
|
||||
"FleetState":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"STARTING",
|
||||
"RUNNING",
|
||||
"STOPPING",
|
||||
"STOPPED"
|
||||
]
|
||||
},
|
||||
"Image":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{"shape":"String"},
|
||||
"Arn":{"shape":"Arn"},
|
||||
"BaseImageArn":{"shape":"Arn"},
|
||||
"DisplayName":{"shape":"String"},
|
||||
"State":{"shape":"ImageState"},
|
||||
"Visibility":{"shape":"VisibilityType"},
|
||||
"Platform":{"shape":"PlatformType"},
|
||||
"Description":{"shape":"String"},
|
||||
"StateChangeReason":{"shape":"ImageStateChangeReason"},
|
||||
"Applications":{"shape":"Applications"},
|
||||
"CreatedTime":{"shape":"Timestamp"}
|
||||
}
|
||||
},
|
||||
"ImageList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Image"}
|
||||
},
|
||||
"ImageState":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"PENDING",
|
||||
"AVAILABLE",
|
||||
"FAILED",
|
||||
"DELETING"
|
||||
]
|
||||
},
|
||||
"ImageStateChangeReason":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Code":{"shape":"ImageStateChangeReasonCode"},
|
||||
"Message":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ImageStateChangeReasonCode":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"INTERNAL_ERROR",
|
||||
"IMAGE_BUILDER_NOT_AVAILABLE"
|
||||
]
|
||||
},
|
||||
"Integer":{"type":"integer"},
|
||||
"InvalidRoleException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"LimitExceededException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ListAssociatedFleetsRequest":{
|
||||
"type":"structure",
|
||||
"required":["StackName"],
|
||||
"members":{
|
||||
"StackName":{"shape":"String"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ListAssociatedFleetsResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Names":{"shape":"StringList"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ListAssociatedStacksRequest":{
|
||||
"type":"structure",
|
||||
"required":["FleetName"],
|
||||
"members":{
|
||||
"FleetName":{"shape":"String"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ListAssociatedStacksResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Names":{"shape":"StringList"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"Long":{"type":"long"},
|
||||
"Metadata":{
|
||||
"type":"map",
|
||||
"key":{"shape":"String"},
|
||||
"value":{"shape":"String"}
|
||||
},
|
||||
"Name":{
|
||||
"type":"string",
|
||||
"pattern":"^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,100}$"
|
||||
},
|
||||
"OperationNotPermittedException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"PlatformType":{
|
||||
"type":"string",
|
||||
"enum":["WINDOWS"]
|
||||
},
|
||||
"ResourceAlreadyExistsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ResourceInUseException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ResourceNotAvailableException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ResourceNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"Session":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Id",
|
||||
"UserId",
|
||||
"StackName",
|
||||
"FleetName",
|
||||
"State"
|
||||
],
|
||||
"members":{
|
||||
"Id":{"shape":"String"},
|
||||
"UserId":{"shape":"UserId"},
|
||||
"StackName":{"shape":"String"},
|
||||
"FleetName":{"shape":"String"},
|
||||
"State":{"shape":"SessionState"}
|
||||
}
|
||||
},
|
||||
"SessionList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Session"}
|
||||
},
|
||||
"SessionState":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ACTIVE",
|
||||
"PENDING",
|
||||
"EXPIRED"
|
||||
]
|
||||
},
|
||||
"Stack":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Arn":{"shape":"Arn"},
|
||||
"Name":{"shape":"String"},
|
||||
"Description":{"shape":"String"},
|
||||
"DisplayName":{"shape":"String"},
|
||||
"CreatedTime":{"shape":"Timestamp"}
|
||||
}
|
||||
},
|
||||
"StackList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Stack"}
|
||||
},
|
||||
"StartFleetRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"StartFleetResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"StopFleetRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"StopFleetResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"String":{
|
||||
"type":"string",
|
||||
"min":1
|
||||
},
|
||||
"StringList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"SubnetIdList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"},
|
||||
"min":1
|
||||
},
|
||||
"Timestamp":{"type":"timestamp"},
|
||||
"UpdateFleetRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"ImageName":{"shape":"String"},
|
||||
"Name":{"shape":"String"},
|
||||
"InstanceType":{"shape":"String"},
|
||||
"ComputeCapacity":{"shape":"ComputeCapacity"},
|
||||
"VpcConfig":{"shape":"VpcConfig"},
|
||||
"MaxUserDurationInSeconds":{"shape":"Integer"},
|
||||
"DisconnectTimeoutInSeconds":{"shape":"Integer"},
|
||||
"DeleteVpcConfig":{"shape":"Boolean"},
|
||||
"Description":{"shape":"Description"},
|
||||
"DisplayName":{"shape":"DisplayName"}
|
||||
}
|
||||
},
|
||||
"UpdateFleetResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Fleet":{"shape":"Fleet"}
|
||||
}
|
||||
},
|
||||
"UpdateStackRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"DisplayName":{"shape":"DisplayName"},
|
||||
"Description":{"shape":"Description"},
|
||||
"Name":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"UpdateStackResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Stack":{"shape":"Stack"}
|
||||
}
|
||||
},
|
||||
"UserId":{
|
||||
"type":"string",
|
||||
"max":32,
|
||||
"min":2
|
||||
},
|
||||
"VisibilityType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"PUBLIC",
|
||||
"PRIVATE"
|
||||
]
|
||||
},
|
||||
"VpcConfig":{
|
||||
"type":"structure",
|
||||
"required":["SubnetIds"],
|
||||
"members":{
|
||||
"SubnetIds":{"shape":"SubnetIdList"}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+565
@@ -0,0 +1,565 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<fullname>Amazon AppStream 2.0</fullname> <p>API documentation for Amazon AppStream 2.0.</p>",
|
||||
"operations": {
|
||||
"AssociateFleet": "<p>Associate a fleet to a stack.</p>",
|
||||
"CreateFleet": "<p>Creates a new fleet.</p>",
|
||||
"CreateStack": "<p>Create a new stack.</p>",
|
||||
"CreateStreamingURL": "<p>Creates a URL to start an AppStream 2.0 streaming session for a user. By default, the URL is valid only for 1 minute from the time that it is generated.</p>",
|
||||
"DeleteFleet": "<p>Deletes a fleet.</p>",
|
||||
"DeleteStack": "<p>Deletes the stack. After this operation completes, the environment can no longer be activated, and any reservations made for the stack are released.</p>",
|
||||
"DescribeFleets": "<p>If fleet names are provided, this operation describes the specified fleets; otherwise, all the fleets in the account are described.</p>",
|
||||
"DescribeImages": "<p>Describes the images. If a list of names is not provided, all images in your account are returned. This operation does not return a paginated result.</p>",
|
||||
"DescribeSessions": "<p>Describes the streaming sessions for a stack and a fleet. If a user ID is provided, this operation returns streaming sessions for only that user. Pass this value for the <code>nextToken</code> parameter in a subsequent call to this operation to retrieve the next set of items.</p>",
|
||||
"DescribeStacks": "<p>If stack names are not provided, this operation describes the specified stacks; otherwise, all stacks in the account are described. Pass the <code>nextToken</code> value in a subsequent call to this operation to retrieve the next set of items.</p>",
|
||||
"DisassociateFleet": "<p>Disassociates a fleet from a stack.</p>",
|
||||
"ExpireSession": "<p>This operation immediately stops a streaming session.</p>",
|
||||
"ListAssociatedFleets": "<p>Lists all fleets associated with the stack.</p>",
|
||||
"ListAssociatedStacks": "<p>Lists all stacks to which the specified fleet is associated.</p>",
|
||||
"StartFleet": "<p>Starts a fleet.</p>",
|
||||
"StopFleet": "<p>Stops a fleet.</p>",
|
||||
"UpdateFleet": "<p>Updates an existing fleet. All the attributes except the fleet name can be updated in the <b>STOPPED</b> state. Only <b>ComputeCapacity</b> and <b>ImageName</b> can be updated in any other state. </p>",
|
||||
"UpdateStack": "<p>Updates the specified fields in the stack with the specified name.</p>"
|
||||
},
|
||||
"shapes": {
|
||||
"Application": {
|
||||
"base": "<p>An entry for a single application in the application catalog.</p>",
|
||||
"refs": {
|
||||
"Applications$member": null
|
||||
}
|
||||
},
|
||||
"Applications": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Image$Applications": "<p>The applications associated with an image.</p>"
|
||||
}
|
||||
},
|
||||
"Arn": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Fleet$Arn": "<p>The ARN for the fleet.</p>",
|
||||
"Image$Arn": "<p>The ARN for the image.</p>",
|
||||
"Image$BaseImageArn": "<p>The source image ARN from which this image was created.</p>",
|
||||
"Stack$Arn": "<p>The ARN of the stack.</p>"
|
||||
}
|
||||
},
|
||||
"AssociateFleetRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"AssociateFleetResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Boolean": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Application$Enabled": "<p>An application can be disabled after image creation if there is a problem.</p>",
|
||||
"UpdateFleetRequest$DeleteVpcConfig": "<p>Delete the VPC association for the specified fleet.</p>"
|
||||
}
|
||||
},
|
||||
"ComputeCapacity": {
|
||||
"base": "<p>The capacity configuration for the fleet.</p>",
|
||||
"refs": {
|
||||
"CreateFleetRequest$ComputeCapacity": "<p>The parameters for the capacity allocated to the fleet.</p>",
|
||||
"UpdateFleetRequest$ComputeCapacity": "<p>The parameters for the capacity allocated to the fleet. </p>"
|
||||
}
|
||||
},
|
||||
"ComputeCapacityStatus": {
|
||||
"base": "<p>The capacity information for the fleet.</p>",
|
||||
"refs": {
|
||||
"Fleet$ComputeCapacityStatus": "<p>The capacity information for the fleet.</p>"
|
||||
}
|
||||
},
|
||||
"CreateFleetRequest": {
|
||||
"base": "<p>Contains the parameters for the new fleet to create.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateFleetResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateStackRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateStackResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateStreamingURLRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateStreamingURLResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteFleetRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteFleetResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteStackRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteStackResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeFleetsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeFleetsResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeImagesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeImagesResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeSessionsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeSessionsResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeStacksRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeStacksResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Description": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateFleetRequest$Description": "<p>The description of the fleet.</p>",
|
||||
"CreateStackRequest$Description": "<p>The description displayed to end users on the AppStream 2.0 portal.</p>",
|
||||
"UpdateFleetRequest$Description": "<p>The description displayed to end users on the AppStream 2.0 portal.</p>",
|
||||
"UpdateStackRequest$Description": "<p>The description displayed to end users on the AppStream 2.0 portal.</p>"
|
||||
}
|
||||
},
|
||||
"DisassociateFleetRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DisassociateFleetResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DisplayName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateFleetRequest$DisplayName": "<p>The display name of the fleet.</p>",
|
||||
"CreateStackRequest$DisplayName": "<p>The name displayed to end users on the AppStream 2.0 portal.</p>",
|
||||
"UpdateFleetRequest$DisplayName": "<p>The name displayed to end users on the AppStream 2.0 portal.</p>",
|
||||
"UpdateStackRequest$DisplayName": "<p>The name displayed to end users on the AppStream 2.0 portal.</p>"
|
||||
}
|
||||
},
|
||||
"ErrorMessage": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"InvalidRoleException$Message": null,
|
||||
"LimitExceededException$Message": null,
|
||||
"OperationNotPermittedException$Message": null,
|
||||
"ResourceAlreadyExistsException$Message": null,
|
||||
"ResourceInUseException$Message": null,
|
||||
"ResourceNotAvailableException$Message": null,
|
||||
"ResourceNotFoundException$Message": null
|
||||
}
|
||||
},
|
||||
"ExpireSessionRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ExpireSessionResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Fleet": {
|
||||
"base": "<p>Contains the parameters for a fleet.</p>",
|
||||
"refs": {
|
||||
"CreateFleetResult$Fleet": "<p>The details for the created fleet.</p>",
|
||||
"FleetList$member": null,
|
||||
"UpdateFleetResult$Fleet": "<p>A list of fleet details.</p>"
|
||||
}
|
||||
},
|
||||
"FleetError": {
|
||||
"base": "<p>The details of the fleet error.</p>",
|
||||
"refs": {
|
||||
"FleetErrors$member": null
|
||||
}
|
||||
},
|
||||
"FleetErrorCode": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"FleetError$ErrorCode": "<p>The error code for the fleet error.</p>"
|
||||
}
|
||||
},
|
||||
"FleetErrors": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Fleet$FleetErrors": "<p>The list of fleet errors is appended to this list.</p>"
|
||||
}
|
||||
},
|
||||
"FleetList": {
|
||||
"base": "<p>A list of fleets.</p>",
|
||||
"refs": {
|
||||
"DescribeFleetsResult$Fleets": "<p>The list of fleet details.</p>"
|
||||
}
|
||||
},
|
||||
"FleetState": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Fleet$State": "<p>The current state for the fleet.</p>"
|
||||
}
|
||||
},
|
||||
"Image": {
|
||||
"base": "<p>New streaming instances are booted from images. The image stores the application catalog and is connected to fleets.</p>",
|
||||
"refs": {
|
||||
"ImageList$member": null
|
||||
}
|
||||
},
|
||||
"ImageList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeImagesResult$Images": "<p>The list of images.</p>"
|
||||
}
|
||||
},
|
||||
"ImageState": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Image$State": "<p>The image starts in the <b>PENDING</b> state, and then moves to <b>AVAILABLE</b> if image creation succeeds and <b>FAILED</b> if image creation has failed.</p>"
|
||||
}
|
||||
},
|
||||
"ImageStateChangeReason": {
|
||||
"base": "<p>The reason why the last state change occurred.</p>",
|
||||
"refs": {
|
||||
"Image$StateChangeReason": "<p>The reason why the last state change occurred.</p>"
|
||||
}
|
||||
},
|
||||
"ImageStateChangeReasonCode": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ImageStateChangeReason$Code": "<p>The state change reason code of the image.</p>"
|
||||
}
|
||||
},
|
||||
"Integer": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ComputeCapacity$DesiredInstances": "<p>The desired number of streaming instances.</p>",
|
||||
"ComputeCapacityStatus$Desired": "<p>The desired number of streaming instances.</p>",
|
||||
"ComputeCapacityStatus$Running": "<p>The total number of simultaneous streaming instances that are running.</p>",
|
||||
"ComputeCapacityStatus$InUse": "<p>The number of instances that are being used for streaming.</p>",
|
||||
"ComputeCapacityStatus$Available": "<p>The number of currently available instances that can be used to stream sessions.</p>",
|
||||
"CreateFleetRequest$MaxUserDurationInSeconds": "<p>The maximum time up to which a streaming session can run.</p>",
|
||||
"CreateFleetRequest$DisconnectTimeoutInSeconds": "<p>The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to his/her previous session. </p>",
|
||||
"DescribeSessionsRequest$Limit": "<p>The size of each page of results. The default value is 20 and the maximum supported value is 50.</p>",
|
||||
"Fleet$MaxUserDurationInSeconds": "<p>The maximum time during which a streaming session can run.</p>",
|
||||
"Fleet$DisconnectTimeoutInSeconds": "<p>The time after disconnection when a session is considered to have ended. When a user reconnects after a disconnection, the user is connected to the same session and instance within this time interval.</p>",
|
||||
"UpdateFleetRequest$MaxUserDurationInSeconds": "<p>The maximum time during which a streaming session can run.</p>",
|
||||
"UpdateFleetRequest$DisconnectTimeoutInSeconds": "<p>The time after disconnection when a session is considered to have ended. When the user reconnects after a disconnection, the user is connected to the same instance within this time interval.</p>"
|
||||
}
|
||||
},
|
||||
"InvalidRoleException": {
|
||||
"base": "<p>The specified role is invalid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"LimitExceededException": {
|
||||
"base": "<p>The requested limit exceeds the permitted limit for an account.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListAssociatedFleetsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListAssociatedFleetsResult": {
|
||||
"base": "<p>The response from a successful operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListAssociatedStacksRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListAssociatedStacksResult": {
|
||||
"base": "<p>The response from a successful operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Long": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateStreamingURLRequest$Validity": "<p>The validity duration of the URL in seconds. After this duration, the URL returned by this operation becomes invalid.</p>"
|
||||
}
|
||||
},
|
||||
"Metadata": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Application$Metadata": "<p>Additional attributes that describes the application.</p>"
|
||||
}
|
||||
},
|
||||
"Name": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateFleetRequest$Name": "<p>A unique identifier for the fleet.</p>"
|
||||
}
|
||||
},
|
||||
"OperationNotPermittedException": {
|
||||
"base": "<p>The attempted operation is not permitted.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"PlatformType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Image$Platform": "<p>The operating system platform of the image.</p>"
|
||||
}
|
||||
},
|
||||
"ResourceAlreadyExistsException": {
|
||||
"base": "<p>The specified resource already exists.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ResourceInUseException": {
|
||||
"base": "<p>The specified resource is in use.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ResourceNotAvailableException": {
|
||||
"base": "<p>The specified resource exists and is not in use, but isn't available.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ResourceNotFoundException": {
|
||||
"base": "<p>The specified resource was not found.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Session": {
|
||||
"base": "<p>Contains the parameters for a streaming session.</p>",
|
||||
"refs": {
|
||||
"SessionList$member": null
|
||||
}
|
||||
},
|
||||
"SessionList": {
|
||||
"base": "<p>List of sessions.</p>",
|
||||
"refs": {
|
||||
"DescribeSessionsResult$Sessions": "<p>The list of streaming sessions.</p>"
|
||||
}
|
||||
},
|
||||
"SessionState": {
|
||||
"base": "<p>Possible values for the state of a streaming session.</p>",
|
||||
"refs": {
|
||||
"Session$State": "<p>The current state of the streaming session.</p>"
|
||||
}
|
||||
},
|
||||
"Stack": {
|
||||
"base": "<p>Details about a stack.</p>",
|
||||
"refs": {
|
||||
"CreateStackResult$Stack": "<p>The details for the created stack.</p>",
|
||||
"StackList$member": null,
|
||||
"UpdateStackResult$Stack": "<p>A list of stack details.</p>"
|
||||
}
|
||||
},
|
||||
"StackList": {
|
||||
"base": "<p>A list of stacks.</p>",
|
||||
"refs": {
|
||||
"DescribeStacksResult$Stacks": "<p>The list of stack details.</p>"
|
||||
}
|
||||
},
|
||||
"StartFleetRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"StartFleetResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"StopFleetRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"StopFleetResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"String": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Application$Name": "<p>The unique identifier for the application.</p>",
|
||||
"Application$DisplayName": "<p>The name of the application shown to the end users.</p>",
|
||||
"Application$IconURL": "<p>The URL for the application icon. This URL may be time-limited.</p>",
|
||||
"Application$LaunchPath": "<p>The path to the application executable in the instance.</p>",
|
||||
"Application$LaunchParameters": "<p>A list of arguments that are passed to the application at launch.</p>",
|
||||
"AssociateFleetRequest$FleetName": "<p>The name of the fleet to associate.</p>",
|
||||
"AssociateFleetRequest$StackName": "<p>The name of the stack to which the fleet is associated.</p>",
|
||||
"CreateFleetRequest$ImageName": "<p>Unique name of the image used by the fleet.</p>",
|
||||
"CreateFleetRequest$InstanceType": "<p>The instance type of compute resources for the fleet. Fleet instances are launched from this instance type.</p>",
|
||||
"CreateStackRequest$Name": "<p>The unique identifier for this stack.</p>",
|
||||
"CreateStreamingURLRequest$StackName": "<p>The stack for which the URL is generated.</p>",
|
||||
"CreateStreamingURLRequest$FleetName": "<p>The fleet for which the URL is generated.</p>",
|
||||
"CreateStreamingURLRequest$ApplicationId": "<p>The ID of the application that must be launched after the session starts.</p>",
|
||||
"CreateStreamingURLRequest$SessionContext": "<p>The sessionContext of the streaming URL.</p>",
|
||||
"CreateStreamingURLResult$StreamingURL": "<p>The URL to start the AppStream 2.0 streaming session.</p>",
|
||||
"DeleteFleetRequest$Name": "<p>The name of the fleet to be deleted.</p>",
|
||||
"DeleteStackRequest$Name": "<p>The name of the stack to delete.</p>",
|
||||
"DescribeFleetsRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>",
|
||||
"DescribeFleetsResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>",
|
||||
"DescribeSessionsRequest$StackName": "<p>The name of the stack for which to list sessions.</p>",
|
||||
"DescribeSessionsRequest$FleetName": "<p>The name of the fleet for which to list sessions.</p>",
|
||||
"DescribeSessionsRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>",
|
||||
"DescribeSessionsResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>",
|
||||
"DescribeStacksRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>",
|
||||
"DescribeStacksResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>",
|
||||
"DisassociateFleetRequest$FleetName": "<p>The name of the fleet to disassociate.</p>",
|
||||
"DisassociateFleetRequest$StackName": "<p>The name of the stack with which the fleet is associated.</p>",
|
||||
"ExpireSessionRequest$SessionId": "<p>The unique identifier of the streaming session to be stopped.</p>",
|
||||
"Fleet$Name": "<p>The name of the fleet.</p>",
|
||||
"Fleet$DisplayName": "<p>The name displayed to end users on the AppStream 2.0 portal.</p>",
|
||||
"Fleet$Description": "<p>The description displayed to end users on the AppStream 2.0 portal.</p>",
|
||||
"Fleet$ImageName": "<p>The image used by the fleet.</p>",
|
||||
"Fleet$InstanceType": "<p>The instance type of compute resources for the fleet. The fleet instances are launched from this instance type. </p>",
|
||||
"FleetError$ErrorMessage": "<p>The error message generated when the fleet has errors.</p>",
|
||||
"Image$Name": "<p>The unique identifier for the image.</p>",
|
||||
"Image$DisplayName": "<p>The display name for the image.</p>",
|
||||
"Image$Description": "<p>A meaningful description for the image.</p>",
|
||||
"ImageStateChangeReason$Message": "<p>The state change reason message to the end user.</p>",
|
||||
"ListAssociatedFleetsRequest$StackName": "<p>The name of the stack whose associated fleets are listed.</p>",
|
||||
"ListAssociatedFleetsRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>",
|
||||
"ListAssociatedFleetsResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>",
|
||||
"ListAssociatedStacksRequest$FleetName": "<p>The name of the fleet whose associated stacks are listed.</p>",
|
||||
"ListAssociatedStacksRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>",
|
||||
"ListAssociatedStacksResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>",
|
||||
"Metadata$key": null,
|
||||
"Metadata$value": null,
|
||||
"Session$Id": "<p>The unique ID for a streaming session.</p>",
|
||||
"Session$StackName": "<p>The name of the stack for which the streaming session was created.</p>",
|
||||
"Session$FleetName": "<p>The name of the fleet for which the streaming session was created.</p>",
|
||||
"Stack$Name": "<p>The unique identifier of the stack.</p>",
|
||||
"Stack$Description": "<p>A meaningful description for the stack.</p>",
|
||||
"Stack$DisplayName": "<p>A display name for the stack.</p>",
|
||||
"StartFleetRequest$Name": "<p>The name of the fleet to start.</p>",
|
||||
"StopFleetRequest$Name": "<p>The name of the fleet to stop.</p>",
|
||||
"StringList$member": null,
|
||||
"SubnetIdList$member": null,
|
||||
"UpdateFleetRequest$ImageName": "<p>The image name from which a fleet is created.</p>",
|
||||
"UpdateFleetRequest$Name": "<p>The name of the fleet.</p>",
|
||||
"UpdateFleetRequest$InstanceType": "<p>The instance type of compute resources for the fleet. Fleet instances are launched from this instance type.</p>",
|
||||
"UpdateStackRequest$Name": "<p>The name of the stack to update.</p>"
|
||||
}
|
||||
},
|
||||
"StringList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeFleetsRequest$Names": "<p>The fleet names to describe. Use null to describe all the fleets for the AWS account.</p>",
|
||||
"DescribeImagesRequest$Names": "<p>A specific list of images to describe.</p>",
|
||||
"DescribeStacksRequest$Names": "<p>The stack names to describe. Use null to describe all the stacks for the AWS account.</p>",
|
||||
"ListAssociatedFleetsResult$Names": "<p>The names of associated fleets.</p>",
|
||||
"ListAssociatedStacksResult$Names": "<p>The names of associated stacks.</p>"
|
||||
}
|
||||
},
|
||||
"SubnetIdList": {
|
||||
"base": "<p>A list of subnet IDs.</p>",
|
||||
"refs": {
|
||||
"VpcConfig$SubnetIds": "<p>The list of subnets to which a network interface is established from the fleet instance.</p>"
|
||||
}
|
||||
},
|
||||
"Timestamp": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateStreamingURLResult$Expires": "<p>Elapsed seconds after the Unix epoch, at which time this URL expires.</p>",
|
||||
"Fleet$CreatedTime": "<p>The time at which the fleet was created.</p>",
|
||||
"Image$CreatedTime": "<p>The timestamp when the image was created.</p>",
|
||||
"Stack$CreatedTime": "<p>The timestamp when the stack was created.</p>"
|
||||
}
|
||||
},
|
||||
"UpdateFleetRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateFleetResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateStackRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateStackResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UserId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateStreamingURLRequest$UserId": "<p>A unique user ID for whom the URL is generated.</p>",
|
||||
"DescribeSessionsRequest$UserId": "<p>The user for whom to list sessions. Use null to describe all the sessions for the stack and fleet.</p>",
|
||||
"Session$UserId": "<p>The identifier of the user for whom the session was created.</p>"
|
||||
}
|
||||
},
|
||||
"VisibilityType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Image$Visibility": "<p>The visibility of an image to the user; images can be public or private.</p>"
|
||||
}
|
||||
},
|
||||
"VpcConfig": {
|
||||
"base": "<p>The VPC in which the fleet is launched.</p>",
|
||||
"refs": {
|
||||
"CreateFleetRequest$VpcConfig": "<p>The VPC configuration for the fleet.</p>",
|
||||
"Fleet$VpcConfig": "<p>The VPC configuration for the fleet.</p>",
|
||||
"UpdateFleetRequest$VpcConfig": "<p>The VPC configuration for the fleet.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+5
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
+55
@@ -0,0 +1,55 @@
|
||||
{
|
||||
"version": 2,
|
||||
"waiters": {
|
||||
"FleetStarted": {
|
||||
"delay": 30,
|
||||
"maxAttempts": 40,
|
||||
"operation": "DescribeFleets",
|
||||
"acceptors": [
|
||||
{
|
||||
"state": "success",
|
||||
"matcher": "pathAll",
|
||||
"argument": "fleets[].state",
|
||||
"expected": "ACTIVE"
|
||||
},
|
||||
{
|
||||
"state": "failure",
|
||||
"matcher": "pathAny",
|
||||
"argument": "fleets[].state",
|
||||
"expected": "PENDING_DEACTIVATE"
|
||||
},
|
||||
{
|
||||
"state": "failure",
|
||||
"matcher": "pathAny",
|
||||
"argument": "fleets[].state",
|
||||
"expected": "INACTIVE"
|
||||
}
|
||||
]
|
||||
},
|
||||
"FleetStopped": {
|
||||
"delay": 30,
|
||||
"maxAttempts": 40,
|
||||
"operation": "DescribeFleets",
|
||||
"acceptors": [
|
||||
{
|
||||
"state": "success",
|
||||
"matcher": "pathAll",
|
||||
"argument": "fleets[].state",
|
||||
"expected": "INACTIVE"
|
||||
},
|
||||
{
|
||||
"state": "failure",
|
||||
"matcher": "pathAny",
|
||||
"argument": "fleets[].state",
|
||||
"expected": "PENDING_ACTIVATE"
|
||||
},
|
||||
{
|
||||
"state": "failure",
|
||||
"matcher": "pathAny",
|
||||
"argument": "fleets[].state",
|
||||
"expected": "ACTIVE"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
+2172
File diff suppressed because it is too large
Load Diff
+1483
File diff suppressed because it is too large
Load Diff
Generated
Vendored
+1395
File diff suppressed because it is too large
Load Diff
Generated
Vendored
+52
@@ -0,0 +1,52 @@
|
||||
{
|
||||
"pagination": {
|
||||
"DescribeAutoScalingGroups": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "AutoScalingGroups"
|
||||
},
|
||||
"DescribeAutoScalingInstances": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "AutoScalingInstances"
|
||||
},
|
||||
"DescribeLaunchConfigurations": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "LaunchConfigurations"
|
||||
},
|
||||
"DescribeNotificationConfigurations": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "NotificationConfigurations"
|
||||
},
|
||||
"DescribePolicies": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "ScalingPolicies"
|
||||
},
|
||||
"DescribeScalingActivities": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "Activities"
|
||||
},
|
||||
"DescribeScheduledActions": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "ScheduledUpdateGroupActions"
|
||||
},
|
||||
"DescribeTags": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxRecords",
|
||||
"result_key": "Tags"
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+62
@@ -0,0 +1,62 @@
|
||||
{
|
||||
"version": 2,
|
||||
"waiters": {
|
||||
"GroupExists": {
|
||||
"acceptors": [
|
||||
{
|
||||
"argument": "length(AutoScalingGroups) > `0`",
|
||||
"expected": true,
|
||||
"matcher": "path",
|
||||
"state": "success"
|
||||
},
|
||||
{
|
||||
"argument": "length(AutoScalingGroups) > `0`",
|
||||
"expected": false,
|
||||
"matcher": "path",
|
||||
"state": "retry"
|
||||
}
|
||||
],
|
||||
"delay": 5,
|
||||
"maxAttempts": 10,
|
||||
"operation": "DescribeAutoScalingGroups"
|
||||
},
|
||||
"GroupInService": {
|
||||
"acceptors": [
|
||||
{
|
||||
"argument": "contains(AutoScalingGroups[].[length(Instances[?LifecycleState=='InService']) >= MinSize][], `false`)",
|
||||
"expected": false,
|
||||
"matcher": "path",
|
||||
"state": "success"
|
||||
},
|
||||
{
|
||||
"argument": "contains(AutoScalingGroups[].[length(Instances[?LifecycleState=='InService']) >= MinSize][], `false`)",
|
||||
"expected": true,
|
||||
"matcher": "path",
|
||||
"state": "retry"
|
||||
}
|
||||
],
|
||||
"delay": 15,
|
||||
"maxAttempts": 40,
|
||||
"operation": "DescribeAutoScalingGroups"
|
||||
},
|
||||
"GroupNotExists": {
|
||||
"acceptors": [
|
||||
{
|
||||
"argument": "length(AutoScalingGroups) > `0`",
|
||||
"expected": false,
|
||||
"matcher": "path",
|
||||
"state": "success"
|
||||
},
|
||||
{
|
||||
"argument": "length(AutoScalingGroups) > `0`",
|
||||
"expected": true,
|
||||
"matcher": "path",
|
||||
"state": "retry"
|
||||
}
|
||||
],
|
||||
"delay": 15,
|
||||
"maxAttempts": 40,
|
||||
"operation": "DescribeAutoScalingGroups"
|
||||
}
|
||||
}
|
||||
}
|
||||
+885
@@ -0,0 +1,885 @@
|
||||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"apiVersion":"2016-08-10",
|
||||
"endpointPrefix":"batch",
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"rest-json",
|
||||
"serviceAbbreviation":"AWS Batch",
|
||||
"serviceFullName":"AWS Batch",
|
||||
"signatureVersion":"v4",
|
||||
"uid":"batch-2016-08-10"
|
||||
},
|
||||
"operations":{
|
||||
"CancelJob":{
|
||||
"name":"CancelJob",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/v1/canceljob"
|
||||
},
|
||||
"input":{"shape":"CancelJobRequest"},
|
||||
"output":{"shape":"CancelJobResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClientException"},
|
||||
{"shape":"ServerException"}
|
||||
]
|
||||
},
|
||||
"CreateComputeEnvironment":{
|
||||
"name":"CreateComputeEnvironment",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/v1/createcomputeenvironment"
|
||||
},
|
||||
"input":{"shape":"CreateComputeEnvironmentRequest"},
|
||||
"output":{"shape":"CreateComputeEnvironmentResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClientException"},
|
||||
{"shape":"ServerException"}
|
||||
]
|
||||
},
|
||||
"CreateJobQueue":{
|
||||
"name":"CreateJobQueue",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/v1/createjobqueue"
|
||||
},
|
||||
"input":{"shape":"CreateJobQueueRequest"},
|
||||
"output":{"shape":"CreateJobQueueResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClientException"},
|
||||
{"shape":"ServerException"}
|
||||
]
|
||||
},
|
||||
"DeleteComputeEnvironment":{
|
||||
"name":"DeleteComputeEnvironment",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/v1/deletecomputeenvironment"
|
||||
},
|
||||
"input":{"shape":"DeleteComputeEnvironmentRequest"},
|
||||
"output":{"shape":"DeleteComputeEnvironmentResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClientException"},
|
||||
{"shape":"ServerException"}
|
||||
]
|
||||
},
|
||||
"DeleteJobQueue":{
|
||||
"name":"DeleteJobQueue",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/v1/deletejobqueue"
|
||||
},
|
||||
"input":{"shape":"DeleteJobQueueRequest"},
|
||||
"output":{"shape":"DeleteJobQueueResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClientException"},
|
||||
{"shape":"ServerException"}
|
||||
]
|
||||
},
|
||||
"DeregisterJobDefinition":{
|
||||
"name":"DeregisterJobDefinition",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/v1/deregisterjobdefinition"
|
||||
},
|
||||
"input":{"shape":"DeregisterJobDefinitionRequest"},
|
||||
"output":{"shape":"DeregisterJobDefinitionResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClientException"},
|
||||
{"shape":"ServerException"}
|
||||
]
|
||||
},
|
||||
"DescribeComputeEnvironments":{
|
||||
"name":"DescribeComputeEnvironments",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/v1/describecomputeenvironments"
|
||||
},
|
||||
"input":{"shape":"DescribeComputeEnvironmentsRequest"},
|
||||
"output":{"shape":"DescribeComputeEnvironmentsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClientException"},
|
||||
{"shape":"ServerException"}
|
||||
]
|
||||
},
|
||||
"DescribeJobDefinitions":{
|
||||
"name":"DescribeJobDefinitions",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/v1/describejobdefinitions"
|
||||
},
|
||||
"input":{"shape":"DescribeJobDefinitionsRequest"},
|
||||
"output":{"shape":"DescribeJobDefinitionsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClientException"},
|
||||
{"shape":"ServerException"}
|
||||
]
|
||||
},
|
||||
"DescribeJobQueues":{
|
||||
"name":"DescribeJobQueues",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/v1/describejobqueues"
|
||||
},
|
||||
"input":{"shape":"DescribeJobQueuesRequest"},
|
||||
"output":{"shape":"DescribeJobQueuesResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClientException"},
|
||||
{"shape":"ServerException"}
|
||||
]
|
||||
},
|
||||
"DescribeJobs":{
|
||||
"name":"DescribeJobs",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/v1/describejobs"
|
||||
},
|
||||
"input":{"shape":"DescribeJobsRequest"},
|
||||
"output":{"shape":"DescribeJobsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClientException"},
|
||||
{"shape":"ServerException"}
|
||||
]
|
||||
},
|
||||
"ListJobs":{
|
||||
"name":"ListJobs",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/v1/listjobs"
|
||||
},
|
||||
"input":{"shape":"ListJobsRequest"},
|
||||
"output":{"shape":"ListJobsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClientException"},
|
||||
{"shape":"ServerException"}
|
||||
]
|
||||
},
|
||||
"RegisterJobDefinition":{
|
||||
"name":"RegisterJobDefinition",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/v1/registerjobdefinition"
|
||||
},
|
||||
"input":{"shape":"RegisterJobDefinitionRequest"},
|
||||
"output":{"shape":"RegisterJobDefinitionResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClientException"},
|
||||
{"shape":"ServerException"}
|
||||
]
|
||||
},
|
||||
"SubmitJob":{
|
||||
"name":"SubmitJob",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/v1/submitjob"
|
||||
},
|
||||
"input":{"shape":"SubmitJobRequest"},
|
||||
"output":{"shape":"SubmitJobResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClientException"},
|
||||
{"shape":"ServerException"}
|
||||
]
|
||||
},
|
||||
"TerminateJob":{
|
||||
"name":"TerminateJob",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/v1/terminatejob"
|
||||
},
|
||||
"input":{"shape":"TerminateJobRequest"},
|
||||
"output":{"shape":"TerminateJobResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClientException"},
|
||||
{"shape":"ServerException"}
|
||||
]
|
||||
},
|
||||
"UpdateComputeEnvironment":{
|
||||
"name":"UpdateComputeEnvironment",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/v1/updatecomputeenvironment"
|
||||
},
|
||||
"input":{"shape":"UpdateComputeEnvironmentRequest"},
|
||||
"output":{"shape":"UpdateComputeEnvironmentResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClientException"},
|
||||
{"shape":"ServerException"}
|
||||
]
|
||||
},
|
||||
"UpdateJobQueue":{
|
||||
"name":"UpdateJobQueue",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/v1/updatejobqueue"
|
||||
},
|
||||
"input":{"shape":"UpdateJobQueueRequest"},
|
||||
"output":{"shape":"UpdateJobQueueResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClientException"},
|
||||
{"shape":"ServerException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"Boolean":{"type":"boolean"},
|
||||
"CEState":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ENABLED",
|
||||
"DISABLED"
|
||||
]
|
||||
},
|
||||
"CEStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"CREATING",
|
||||
"UPDATING",
|
||||
"DELETING",
|
||||
"DELETED",
|
||||
"VALID",
|
||||
"INVALID"
|
||||
]
|
||||
},
|
||||
"CEType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"MANAGED",
|
||||
"UNMANAGED"
|
||||
]
|
||||
},
|
||||
"CRType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"EC2",
|
||||
"SPOT"
|
||||
]
|
||||
},
|
||||
"CancelJobRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"jobId",
|
||||
"reason"
|
||||
],
|
||||
"members":{
|
||||
"jobId":{"shape":"String"},
|
||||
"reason":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"CancelJobResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"ClientException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"ComputeEnvironmentDetail":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"computeEnvironmentName",
|
||||
"computeEnvironmentArn",
|
||||
"ecsClusterArn"
|
||||
],
|
||||
"members":{
|
||||
"computeEnvironmentName":{"shape":"String"},
|
||||
"computeEnvironmentArn":{"shape":"String"},
|
||||
"ecsClusterArn":{"shape":"String"},
|
||||
"type":{"shape":"CEType"},
|
||||
"state":{"shape":"CEState"},
|
||||
"status":{"shape":"CEStatus"},
|
||||
"statusReason":{"shape":"String"},
|
||||
"computeResources":{"shape":"ComputeResource"},
|
||||
"serviceRole":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ComputeEnvironmentDetailList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ComputeEnvironmentDetail"}
|
||||
},
|
||||
"ComputeEnvironmentOrder":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"order",
|
||||
"computeEnvironment"
|
||||
],
|
||||
"members":{
|
||||
"order":{"shape":"Integer"},
|
||||
"computeEnvironment":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ComputeEnvironmentOrders":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ComputeEnvironmentOrder"}
|
||||
},
|
||||
"ComputeResource":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"type",
|
||||
"minvCpus",
|
||||
"maxvCpus",
|
||||
"instanceTypes",
|
||||
"subnets",
|
||||
"securityGroupIds",
|
||||
"instanceRole"
|
||||
],
|
||||
"members":{
|
||||
"type":{"shape":"CRType"},
|
||||
"minvCpus":{"shape":"Integer"},
|
||||
"maxvCpus":{"shape":"Integer"},
|
||||
"desiredvCpus":{"shape":"Integer"},
|
||||
"instanceTypes":{"shape":"StringList"},
|
||||
"subnets":{"shape":"StringList"},
|
||||
"securityGroupIds":{"shape":"StringList"},
|
||||
"ec2KeyPair":{"shape":"String"},
|
||||
"instanceRole":{"shape":"String"},
|
||||
"tags":{"shape":"TagsMap"},
|
||||
"bidPercentage":{"shape":"Integer"},
|
||||
"spotIamFleetRole":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ComputeResourceUpdate":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"minvCpus":{"shape":"Integer"},
|
||||
"maxvCpus":{"shape":"Integer"},
|
||||
"desiredvCpus":{"shape":"Integer"}
|
||||
}
|
||||
},
|
||||
"ContainerDetail":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"image":{"shape":"String"},
|
||||
"vcpus":{"shape":"Integer"},
|
||||
"memory":{"shape":"Integer"},
|
||||
"command":{"shape":"StringList"},
|
||||
"jobRoleArn":{"shape":"String"},
|
||||
"volumes":{"shape":"Volumes"},
|
||||
"environment":{"shape":"EnvironmentVariables"},
|
||||
"mountPoints":{"shape":"MountPoints"},
|
||||
"readonlyRootFilesystem":{"shape":"Boolean"},
|
||||
"ulimits":{"shape":"Ulimits"},
|
||||
"privileged":{"shape":"Boolean"},
|
||||
"user":{"shape":"String"},
|
||||
"exitCode":{"shape":"Integer"},
|
||||
"reason":{"shape":"String"},
|
||||
"containerInstanceArn":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ContainerOverrides":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"vcpus":{"shape":"Integer"},
|
||||
"memory":{"shape":"Integer"},
|
||||
"command":{"shape":"StringList"},
|
||||
"environment":{"shape":"EnvironmentVariables"}
|
||||
}
|
||||
},
|
||||
"ContainerProperties":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"image",
|
||||
"vcpus",
|
||||
"memory"
|
||||
],
|
||||
"members":{
|
||||
"image":{"shape":"String"},
|
||||
"vcpus":{"shape":"Integer"},
|
||||
"memory":{"shape":"Integer"},
|
||||
"command":{"shape":"StringList"},
|
||||
"jobRoleArn":{"shape":"String"},
|
||||
"volumes":{"shape":"Volumes"},
|
||||
"environment":{"shape":"EnvironmentVariables"},
|
||||
"mountPoints":{"shape":"MountPoints"},
|
||||
"readonlyRootFilesystem":{"shape":"Boolean"},
|
||||
"privileged":{"shape":"Boolean"},
|
||||
"ulimits":{"shape":"Ulimits"},
|
||||
"user":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"CreateComputeEnvironmentRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"computeEnvironmentName",
|
||||
"type",
|
||||
"serviceRole"
|
||||
],
|
||||
"members":{
|
||||
"computeEnvironmentName":{"shape":"String"},
|
||||
"type":{"shape":"CEType"},
|
||||
"state":{"shape":"CEState"},
|
||||
"computeResources":{"shape":"ComputeResource"},
|
||||
"serviceRole":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"CreateComputeEnvironmentResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"computeEnvironmentName":{"shape":"String"},
|
||||
"computeEnvironmentArn":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"CreateJobQueueRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"jobQueueName",
|
||||
"priority",
|
||||
"computeEnvironmentOrder"
|
||||
],
|
||||
"members":{
|
||||
"jobQueueName":{"shape":"String"},
|
||||
"state":{"shape":"JQState"},
|
||||
"priority":{"shape":"Integer"},
|
||||
"computeEnvironmentOrder":{"shape":"ComputeEnvironmentOrders"}
|
||||
}
|
||||
},
|
||||
"CreateJobQueueResponse":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"jobQueueName",
|
||||
"jobQueueArn"
|
||||
],
|
||||
"members":{
|
||||
"jobQueueName":{"shape":"String"},
|
||||
"jobQueueArn":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DeleteComputeEnvironmentRequest":{
|
||||
"type":"structure",
|
||||
"required":["computeEnvironment"],
|
||||
"members":{
|
||||
"computeEnvironment":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DeleteComputeEnvironmentResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteJobQueueRequest":{
|
||||
"type":"structure",
|
||||
"required":["jobQueue"],
|
||||
"members":{
|
||||
"jobQueue":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DeleteJobQueueResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeregisterJobDefinitionRequest":{
|
||||
"type":"structure",
|
||||
"required":["jobDefinition"],
|
||||
"members":{
|
||||
"jobDefinition":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DeregisterJobDefinitionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DescribeComputeEnvironmentsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"computeEnvironments":{"shape":"StringList"},
|
||||
"maxResults":{"shape":"Integer"},
|
||||
"nextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeComputeEnvironmentsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"computeEnvironments":{"shape":"ComputeEnvironmentDetailList"},
|
||||
"nextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeJobDefinitionsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"jobDefinitions":{"shape":"StringList"},
|
||||
"maxResults":{"shape":"Integer"},
|
||||
"jobDefinitionName":{"shape":"String"},
|
||||
"status":{"shape":"String"},
|
||||
"nextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeJobDefinitionsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"jobDefinitions":{"shape":"JobDefinitionList"},
|
||||
"nextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeJobQueuesRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"jobQueues":{"shape":"StringList"},
|
||||
"maxResults":{"shape":"Integer"},
|
||||
"nextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeJobQueuesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"jobQueues":{"shape":"JobQueueDetailList"},
|
||||
"nextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeJobsRequest":{
|
||||
"type":"structure",
|
||||
"required":["jobs"],
|
||||
"members":{
|
||||
"jobs":{"shape":"StringList"}
|
||||
}
|
||||
},
|
||||
"DescribeJobsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"jobs":{"shape":"JobDetailList"}
|
||||
}
|
||||
},
|
||||
"EnvironmentVariables":{
|
||||
"type":"list",
|
||||
"member":{"shape":"KeyValuePair"}
|
||||
},
|
||||
"Host":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"sourcePath":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"Integer":{"type":"integer"},
|
||||
"JQState":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ENABLED",
|
||||
"DISABLED"
|
||||
]
|
||||
},
|
||||
"JQStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"CREATING",
|
||||
"UPDATING",
|
||||
"DELETING",
|
||||
"DELETED",
|
||||
"VALID",
|
||||
"INVALID"
|
||||
]
|
||||
},
|
||||
"JobDefinition":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"jobDefinitionName",
|
||||
"jobDefinitionArn",
|
||||
"revision",
|
||||
"type"
|
||||
],
|
||||
"members":{
|
||||
"jobDefinitionName":{"shape":"String"},
|
||||
"jobDefinitionArn":{"shape":"String"},
|
||||
"revision":{"shape":"Integer"},
|
||||
"status":{"shape":"String"},
|
||||
"type":{"shape":"String"},
|
||||
"parameters":{"shape":"ParametersMap"},
|
||||
"containerProperties":{"shape":"ContainerProperties"}
|
||||
}
|
||||
},
|
||||
"JobDefinitionList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"JobDefinition"}
|
||||
},
|
||||
"JobDefinitionType":{
|
||||
"type":"string",
|
||||
"enum":["container"]
|
||||
},
|
||||
"JobDependency":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"jobId":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"JobDependencyList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"JobDependency"}
|
||||
},
|
||||
"JobDetail":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"jobName",
|
||||
"jobId",
|
||||
"jobQueue",
|
||||
"status",
|
||||
"startedAt",
|
||||
"jobDefinition"
|
||||
],
|
||||
"members":{
|
||||
"jobName":{"shape":"String"},
|
||||
"jobId":{"shape":"String"},
|
||||
"jobQueue":{"shape":"String"},
|
||||
"status":{"shape":"JobStatus"},
|
||||
"statusReason":{"shape":"String"},
|
||||
"createdAt":{"shape":"Long"},
|
||||
"startedAt":{"shape":"Long"},
|
||||
"stoppedAt":{"shape":"Long"},
|
||||
"dependsOn":{"shape":"JobDependencyList"},
|
||||
"jobDefinition":{"shape":"String"},
|
||||
"parameters":{"shape":"ParametersMap"},
|
||||
"container":{"shape":"ContainerDetail"}
|
||||
}
|
||||
},
|
||||
"JobDetailList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"JobDetail"}
|
||||
},
|
||||
"JobQueueDetail":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"jobQueueName",
|
||||
"jobQueueArn",
|
||||
"state",
|
||||
"priority",
|
||||
"computeEnvironmentOrder"
|
||||
],
|
||||
"members":{
|
||||
"jobQueueName":{"shape":"String"},
|
||||
"jobQueueArn":{"shape":"String"},
|
||||
"state":{"shape":"JQState"},
|
||||
"status":{"shape":"JQStatus"},
|
||||
"statusReason":{"shape":"String"},
|
||||
"priority":{"shape":"Integer"},
|
||||
"computeEnvironmentOrder":{"shape":"ComputeEnvironmentOrders"}
|
||||
}
|
||||
},
|
||||
"JobQueueDetailList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"JobQueueDetail"}
|
||||
},
|
||||
"JobStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"SUBMITTED",
|
||||
"PENDING",
|
||||
"RUNNABLE",
|
||||
"STARTING",
|
||||
"RUNNING",
|
||||
"SUCCEEDED",
|
||||
"FAILED"
|
||||
]
|
||||
},
|
||||
"JobSummary":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"jobId",
|
||||
"jobName"
|
||||
],
|
||||
"members":{
|
||||
"jobId":{"shape":"String"},
|
||||
"jobName":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"JobSummaryList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"JobSummary"}
|
||||
},
|
||||
"KeyValuePair":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"name":{"shape":"String"},
|
||||
"value":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ListJobsRequest":{
|
||||
"type":"structure",
|
||||
"required":["jobQueue"],
|
||||
"members":{
|
||||
"jobQueue":{"shape":"String"},
|
||||
"jobStatus":{"shape":"JobStatus"},
|
||||
"maxResults":{"shape":"Integer"},
|
||||
"nextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ListJobsResponse":{
|
||||
"type":"structure",
|
||||
"required":["jobSummaryList"],
|
||||
"members":{
|
||||
"jobSummaryList":{"shape":"JobSummaryList"},
|
||||
"nextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"Long":{"type":"long"},
|
||||
"MountPoint":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"containerPath":{"shape":"String"},
|
||||
"readOnly":{"shape":"Boolean"},
|
||||
"sourceVolume":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"MountPoints":{
|
||||
"type":"list",
|
||||
"member":{"shape":"MountPoint"}
|
||||
},
|
||||
"ParametersMap":{
|
||||
"type":"map",
|
||||
"key":{"shape":"String"},
|
||||
"value":{"shape":"String"}
|
||||
},
|
||||
"RegisterJobDefinitionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"jobDefinitionName",
|
||||
"type"
|
||||
],
|
||||
"members":{
|
||||
"jobDefinitionName":{"shape":"String"},
|
||||
"type":{"shape":"JobDefinitionType"},
|
||||
"parameters":{"shape":"ParametersMap"},
|
||||
"containerProperties":{"shape":"ContainerProperties"}
|
||||
}
|
||||
},
|
||||
"RegisterJobDefinitionResponse":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"jobDefinitionName",
|
||||
"jobDefinitionArn",
|
||||
"revision"
|
||||
],
|
||||
"members":{
|
||||
"jobDefinitionName":{"shape":"String"},
|
||||
"jobDefinitionArn":{"shape":"String"},
|
||||
"revision":{"shape":"Integer"}
|
||||
}
|
||||
},
|
||||
"ServerException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"error":{"httpStatusCode":500},
|
||||
"exception":true,
|
||||
"fault":true
|
||||
},
|
||||
"String":{"type":"string"},
|
||||
"StringList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"SubmitJobRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"jobName",
|
||||
"jobQueue",
|
||||
"jobDefinition"
|
||||
],
|
||||
"members":{
|
||||
"jobName":{"shape":"String"},
|
||||
"jobQueue":{"shape":"String"},
|
||||
"dependsOn":{"shape":"JobDependencyList"},
|
||||
"jobDefinition":{"shape":"String"},
|
||||
"parameters":{"shape":"ParametersMap"},
|
||||
"containerOverrides":{"shape":"ContainerOverrides"}
|
||||
}
|
||||
},
|
||||
"SubmitJobResponse":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"jobName",
|
||||
"jobId"
|
||||
],
|
||||
"members":{
|
||||
"jobName":{"shape":"String"},
|
||||
"jobId":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"TagsMap":{
|
||||
"type":"map",
|
||||
"key":{"shape":"String"},
|
||||
"value":{"shape":"String"}
|
||||
},
|
||||
"TerminateJobRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"jobId",
|
||||
"reason"
|
||||
],
|
||||
"members":{
|
||||
"jobId":{"shape":"String"},
|
||||
"reason":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"TerminateJobResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"Ulimit":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"hardLimit",
|
||||
"name",
|
||||
"softLimit"
|
||||
],
|
||||
"members":{
|
||||
"hardLimit":{"shape":"Integer"},
|
||||
"name":{"shape":"String"},
|
||||
"softLimit":{"shape":"Integer"}
|
||||
}
|
||||
},
|
||||
"Ulimits":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Ulimit"}
|
||||
},
|
||||
"UpdateComputeEnvironmentRequest":{
|
||||
"type":"structure",
|
||||
"required":["computeEnvironment"],
|
||||
"members":{
|
||||
"computeEnvironment":{"shape":"String"},
|
||||
"state":{"shape":"CEState"},
|
||||
"computeResources":{"shape":"ComputeResourceUpdate"},
|
||||
"serviceRole":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"UpdateComputeEnvironmentResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"computeEnvironmentName":{"shape":"String"},
|
||||
"computeEnvironmentArn":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"UpdateJobQueueRequest":{
|
||||
"type":"structure",
|
||||
"required":["jobQueue"],
|
||||
"members":{
|
||||
"jobQueue":{"shape":"String"},
|
||||
"state":{"shape":"JQState"},
|
||||
"priority":{"shape":"Integer"},
|
||||
"computeEnvironmentOrder":{"shape":"ComputeEnvironmentOrders"}
|
||||
}
|
||||
},
|
||||
"UpdateJobQueueResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"jobQueueName":{"shape":"String"},
|
||||
"jobQueueArn":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"Volume":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"host":{"shape":"Host"},
|
||||
"name":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"Volumes":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Volume"}
|
||||
}
|
||||
}
|
||||
}
|
||||
+596
@@ -0,0 +1,596 @@
|
||||
{
|
||||
"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 the latest Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand instances in your managed compute environment, or you can use Amazon EC2 Spot instances that only launch when the Spot bid price is below a specified percentage of the On-Demand price.</p> <p>In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html\">Container Instance AMIs</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. After you have created your unmanaged compute environment, you can use the <a>DescribeComputeEnvironments</a> operation to find the Amazon ECS cluster that is associated with it and then manually launch your container instances into that Amazon ECS cluster. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html\">Launching an Amazon ECS Container Instance</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p>",
|
||||
"CreateJobQueue": "<p>Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.</p> <p>You also set a priority to the job queue that determines the order in which the AWS Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.</p>",
|
||||
"DeleteComputeEnvironment": "<p>Deletes an AWS Batch compute environment.</p> <p>Before you can delete a compute environment, you must set its state to <code>DISABLED</code> with the <a>UpdateComputeEnvironment</a> API operation and disassociate it from any job queues with the <a>UpdateJobQueue</a> API operation.</p>",
|
||||
"DeleteJobQueue": "<p>Deletes the specified job queue. You must first disable submissions for a queue with the <a>UpdateJobQueue</a> operation and terminate any jobs that have not completed with the <a>TerminateJob</a>.</p> <p>It is not necessary to disassociate compute environments from a queue before submitting a <code>DeleteJobQueue</code> request. </p>",
|
||||
"DeregisterJobDefinition": "<p>Deregisters an AWS Batch job definition.</p>",
|
||||
"DescribeComputeEnvironments": "<p>Describes one or more of your compute environments.</p> <p>If you are using an unmanaged compute environment, you can use the <code>DescribeComputeEnvironment</code> operation to determine the <code>ecsClusterArn</code> that you should launch your Amazon ECS container instances into.</p>",
|
||||
"DescribeJobDefinitions": "<p>Describes a list of job definitions. You can specify a <code>status</code> (such as <code>ACTIVE</code>) to only return job definitions that match that status.</p>",
|
||||
"DescribeJobQueues": "<p>Describes one or more of your job queues.</p>",
|
||||
"DescribeJobs": "<p>Describes a list of AWS Batch jobs.</p>",
|
||||
"ListJobs": "<p>Returns a list of task jobs for a specified job queue. You can filter the results by job status with the <code>jobStatus</code> parameter.</p>",
|
||||
"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>",
|
||||
"UpdateComputeEnvironment": "<p>Updates an AWS Batch compute environment.</p>",
|
||||
"UpdateJobQueue": "<p>Updates a job queue.</p>"
|
||||
},
|
||||
"shapes": {
|
||||
"Boolean": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ContainerDetail$readonlyRootFilesystem": "<p>When this parameter is true, the container is given read-only access to its root file system.</p>",
|
||||
"ContainerDetail$privileged": "<p>When this parameter is true, the container is given elevated privileges on the host container instance (similar to the <code>root</code> user).</p>",
|
||||
"ContainerProperties$readonlyRootFilesystem": "<p>When this parameter is true, the container is given read-only access to its root file system. This parameter maps to <code>ReadonlyRootfs</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--read-only</code> option to <code>docker run</code>.</p>",
|
||||
"ContainerProperties$privileged": "<p>When this parameter is true, the container is given elevated privileges on the host container instance (similar to the <code>root</code> user). This parameter maps to <code>Privileged</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--privileged</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>",
|
||||
"MountPoint$readOnly": "<p>If this value is <code>true</code>, the container has read-only access to the volume; otherwise, the container can write to the volume. The default value is <code>false</code>.</p>"
|
||||
}
|
||||
},
|
||||
"CEState": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ComputeEnvironmentDetail$state": "<p>The state of the compute environment. The valid values are <code>ENABLED</code> or <code>DISABLED</code>. An <code>ENABLED</code> state indicates that you can register instances with the compute environment and that the associated instances can accept jobs. </p>",
|
||||
"CreateComputeEnvironmentRequest$state": "<p>The state of the compute environment. If the state is <code>ENABLED</code>, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.</p>",
|
||||
"UpdateComputeEnvironmentRequest$state": "<p>The state of the compute environment. Compute environments in the <code>ENABLED</code> state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.</p>"
|
||||
}
|
||||
},
|
||||
"CEStatus": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ComputeEnvironmentDetail$status": "<p>The current status of the compute environment (for example, <code>CREATING</code> or <code>VALID</code>).</p>"
|
||||
}
|
||||
},
|
||||
"CEType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ComputeEnvironmentDetail$type": "<p>The type of the compute environment.</p>",
|
||||
"CreateComputeEnvironmentRequest$type": "<p>The type of the compute environment. </p>"
|
||||
}
|
||||
},
|
||||
"CRType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ComputeResource$type": "<p>The type of compute environment.</p>"
|
||||
}
|
||||
},
|
||||
"CancelJobRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CancelJobResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ClientException": {
|
||||
"base": "<p>These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permission to use the action or resource, or specifying an identifier that is not valid. </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ComputeEnvironmentDetail": {
|
||||
"base": "<p>An object representing an AWS Batch compute environment.</p>",
|
||||
"refs": {
|
||||
"ComputeEnvironmentDetailList$member": null
|
||||
}
|
||||
},
|
||||
"ComputeEnvironmentDetailList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeComputeEnvironmentsResponse$computeEnvironments": "<p>The list of compute environments.</p>"
|
||||
}
|
||||
},
|
||||
"ComputeEnvironmentOrder": {
|
||||
"base": "<p>The order in which compute environments are tried for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.</p>",
|
||||
"refs": {
|
||||
"ComputeEnvironmentOrders$member": null
|
||||
}
|
||||
},
|
||||
"ComputeEnvironmentOrders": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateJobQueueRequest$computeEnvironmentOrder": "<p>The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment should execute a given job. Compute environments must be in the <code>VALID</code> state before you can associate them with a job queue. You can associate up to 3 compute environments with a job queue.</p>",
|
||||
"JobQueueDetail$computeEnvironmentOrder": "<p>The compute environments that are attached to the job queue and the order in which job placement is preferred. Compute environments are selected for job placement in ascending order.</p>",
|
||||
"UpdateJobQueueRequest$computeEnvironmentOrder": "<p>Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment should execute a given job. </p>"
|
||||
}
|
||||
},
|
||||
"ComputeResource": {
|
||||
"base": "<p>An object representing an AWS Batch compute resource.</p>",
|
||||
"refs": {
|
||||
"ComputeEnvironmentDetail$computeResources": "<p>The compute resources defined for the compute environment. </p>",
|
||||
"CreateComputeEnvironmentRequest$computeResources": "<p>Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments.</p>"
|
||||
}
|
||||
},
|
||||
"ComputeResourceUpdate": {
|
||||
"base": "<p>An object representing the attributes of a compute environment that can be updated.</p>",
|
||||
"refs": {
|
||||
"UpdateComputeEnvironmentRequest$computeResources": "<p>Details of the compute resources managed by the compute environment. Required for a managed compute environment.</p>"
|
||||
}
|
||||
},
|
||||
"ContainerDetail": {
|
||||
"base": "<p>An object representing the details of a container that is part of a job.</p>",
|
||||
"refs": {
|
||||
"JobDetail$container": "<p>An object representing the details of the container that is associated with the job.</p>"
|
||||
}
|
||||
},
|
||||
"ContainerOverrides": {
|
||||
"base": "<p>The overrides that should be sent to a container.</p>",
|
||||
"refs": {
|
||||
"SubmitJobRequest$containerOverrides": "<p>A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a <code>command</code> override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an <code>environment</code> override.</p>"
|
||||
}
|
||||
},
|
||||
"ContainerProperties": {
|
||||
"base": "<p>Container properties are used in job definitions to describe the container that is launched as part of a job.</p>",
|
||||
"refs": {
|
||||
"JobDefinition$containerProperties": "<p>An object with various properties specific to container-based jobs. </p>",
|
||||
"RegisterJobDefinitionRequest$containerProperties": "<p>An object with various properties specific for container-based jobs. This parameter is required if the <code>type</code> parameter is <code>container</code>.</p>"
|
||||
}
|
||||
},
|
||||
"CreateComputeEnvironmentRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateComputeEnvironmentResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateJobQueueRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateJobQueueResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteComputeEnvironmentRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteComputeEnvironmentResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteJobQueueRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteJobQueueResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeregisterJobDefinitionRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeregisterJobDefinitionResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeComputeEnvironmentsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeComputeEnvironmentsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeJobDefinitionsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeJobDefinitionsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeJobQueuesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeJobQueuesResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeJobsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeJobsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"EnvironmentVariables": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ContainerDetail$environment": "<p>The environment variables to pass to a container.</p>",
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"Integer": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ComputeEnvironmentOrder$order": "<p>The order of the compute environment.</p>",
|
||||
"ComputeResource$minvCpus": "<p>The minimum number of EC2 vCPUs that an environment should maintain. </p>",
|
||||
"ComputeResource$maxvCpus": "<p>The maximum number of EC2 vCPUs that an environment can reach. </p>",
|
||||
"ComputeResource$desiredvCpus": "<p>The desired number of EC2 vCPUS in the compute environment. </p>",
|
||||
"ComputeResource$bidPercentage": "<p>The minimum percentage that a Spot Instance price must be when compared with the On-Demand price for that instance type before instances are launched. For example, if your bid percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance.</p>",
|
||||
"ComputeResourceUpdate$minvCpus": "<p>The minimum number of EC2 vCPUs that an environment should maintain.</p>",
|
||||
"ComputeResourceUpdate$maxvCpus": "<p>The maximum number of EC2 vCPUs that an environment can reach.</p>",
|
||||
"ComputeResourceUpdate$desiredvCpus": "<p>The desired number of EC2 vCPUS in the compute environment.</p>",
|
||||
"ContainerDetail$vcpus": "<p>The number of VCPUs allocated for the job. </p>",
|
||||
"ContainerDetail$memory": "<p>The number of MiB of memory reserved for the job.</p>",
|
||||
"ContainerDetail$exitCode": "<p>The exit code to return upon completion.</p>",
|
||||
"ContainerOverrides$vcpus": "<p>The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.</p>",
|
||||
"ContainerOverrides$memory": "<p>The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.</p>",
|
||||
"ContainerProperties$vcpus": "<p>The number of vCPUs reserved for the container. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Each vCPU is equivalent to 1,024 CPU shares.</p>",
|
||||
"ContainerProperties$memory": "<p>The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>",
|
||||
"CreateJobQueueRequest$priority": "<p>The priority of the job queue. Job queues with a higher priority (or a lower integer value for the <code>priority</code> parameter) are evaluated first when associated with same compute environment. Priority is determined in ascending order, for example, a job queue with a priority value of <code>1</code> is given scheduling preference over a job queue with a priority value of <code>10</code>.</p>",
|
||||
"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>",
|
||||
"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>",
|
||||
"Ulimit$hardLimit": "<p>The hard limit for the <code>ulimit</code> type.</p>",
|
||||
"Ulimit$softLimit": "<p>The soft limit for the <code>ulimit</code> type.</p>",
|
||||
"UpdateJobQueueRequest$priority": "<p>The priority of the job queue. Job queues with a higher priority (or a lower integer value for the <code>priority</code> parameter) are evaluated first when associated with same compute environment. Priority is determined in ascending order, for example, a job queue with a priority value of <code>1</code> is given scheduling preference over a job queue with a priority value of <code>10</code>.</p>"
|
||||
}
|
||||
},
|
||||
"JQState": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateJobQueueRequest$state": "<p>The state of the job queue. If the job queue state is <code>ENABLED</code>, it is able to accept jobs.</p>",
|
||||
"JobQueueDetail$state": "<p>Describes the ability of the queue to accept new jobs.</p>",
|
||||
"UpdateJobQueueRequest$state": "<p>Describes the queue's ability to accept new jobs.</p>"
|
||||
}
|
||||
},
|
||||
"JQStatus": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"JobQueueDetail$status": "<p>The status of the job queue (for example, <code>CREATING</code> or <code>VALID</code>).</p>"
|
||||
}
|
||||
},
|
||||
"JobDefinition": {
|
||||
"base": "<p>An object representing an AWS Batch job definition.</p>",
|
||||
"refs": {
|
||||
"JobDefinitionList$member": null
|
||||
}
|
||||
},
|
||||
"JobDefinitionList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeJobDefinitionsResponse$jobDefinitions": "<p>The list of job definitions. </p>"
|
||||
}
|
||||
},
|
||||
"JobDefinitionType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"RegisterJobDefinitionRequest$type": "<p>The type of job definition.</p>"
|
||||
}
|
||||
},
|
||||
"JobDependency": {
|
||||
"base": "<p>An object representing an AWS Batch job dependency.</p>",
|
||||
"refs": {
|
||||
"JobDependencyList$member": null
|
||||
}
|
||||
},
|
||||
"JobDependencyList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"JobDetail$dependsOn": "<p>A list of job names or IDs on which this job depends.</p>",
|
||||
"SubmitJobRequest$dependsOn": "<p>A list of job names or IDs on which this job depends. A job can depend upon a maximum of 100 jobs. </p>"
|
||||
}
|
||||
},
|
||||
"JobDetail": {
|
||||
"base": "<p>An object representing an AWS Batch job.</p>",
|
||||
"refs": {
|
||||
"JobDetailList$member": null
|
||||
}
|
||||
},
|
||||
"JobDetailList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeJobsResponse$jobs": "<p>The list of jobs. </p>"
|
||||
}
|
||||
},
|
||||
"JobQueueDetail": {
|
||||
"base": "<p>An object representing the details of an AWS Batch job queue.</p>",
|
||||
"refs": {
|
||||
"JobQueueDetailList$member": null
|
||||
}
|
||||
},
|
||||
"JobQueueDetailList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeJobQueuesResponse$jobQueues": "<p>The list of job queues. </p>"
|
||||
}
|
||||
},
|
||||
"JobStatus": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"JobDetail$status": "<p>The current status for the job.</p>",
|
||||
"ListJobsRequest$jobStatus": "<p>The job status with which to filter jobs in the specified queue.</p>"
|
||||
}
|
||||
},
|
||||
"JobSummary": {
|
||||
"base": "<p>An object representing summary details of a job.</p>",
|
||||
"refs": {
|
||||
"JobSummaryList$member": null
|
||||
}
|
||||
},
|
||||
"JobSummaryList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListJobsResponse$jobSummaryList": "<p>A list of job summaries that match the request.</p>"
|
||||
}
|
||||
},
|
||||
"KeyValuePair": {
|
||||
"base": "<p>A key-value pair object.</p>",
|
||||
"refs": {
|
||||
"EnvironmentVariables$member": null
|
||||
}
|
||||
},
|
||||
"ListJobsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListJobsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Long": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"MountPoint": {
|
||||
"base": "<p>Details on a volume mount point that is used in a job's container properties.</p>",
|
||||
"refs": {
|
||||
"MountPoints$member": null
|
||||
}
|
||||
},
|
||||
"MountPoints": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ContainerDetail$mountPoints": "<p>The mount points for data volumes in your container.</p>",
|
||||
"ContainerProperties$mountPoints": "<p>The mount points for data volumes in your container. This parameter maps to <code>Volumes</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--volume</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
|
||||
}
|
||||
},
|
||||
"ParametersMap": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"JobDefinition$parameters": "<p>Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a <code>SubmitJob</code> request override any corresponding parameter defaults from the job definition.</p>",
|
||||
"JobDetail$parameters": "<p>Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition. </p>",
|
||||
"RegisterJobDefinitionRequest$parameters": "<p>Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a <code>SubmitJob</code> request override any corresponding parameter defaults from the job definition.</p>",
|
||||
"SubmitJobRequest$parameters": "<p>Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a <code>SubmitJob</code> request override any corresponding parameter defaults from the job definition.</p>"
|
||||
}
|
||||
},
|
||||
"RegisterJobDefinitionRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"RegisterJobDefinitionResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ServerException": {
|
||||
"base": "<p>These errors are usually caused by a server issue.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"String": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"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>",
|
||||
"ClientException$message": null,
|
||||
"ComputeEnvironmentDetail$computeEnvironmentName": "<p>The name of the compute environment. </p>",
|
||||
"ComputeEnvironmentDetail$computeEnvironmentArn": "<p>The Amazon Resource Name (ARN) of the compute environment. </p>",
|
||||
"ComputeEnvironmentDetail$ecsClusterArn": "<p>The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment. </p>",
|
||||
"ComputeEnvironmentDetail$statusReason": "<p>A short, human-readable string to provide additional details about the current status of the compute environment.</p>",
|
||||
"ComputeEnvironmentDetail$serviceRole": "<p>The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf.</p>",
|
||||
"ComputeEnvironmentOrder$computeEnvironment": "<p>The Amazon Resource Name (ARN) of the compute environment.</p>",
|
||||
"ComputeResource$ec2KeyPair": "<p>The EC2 key pair that is used for instances launched in the compute environment.</p>",
|
||||
"ComputeResource$instanceRole": "<p>The Amazon ECS instance role applied to Amazon EC2 instances in a compute environment.</p>",
|
||||
"ComputeResource$spotIamFleetRole": "<p>The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a <code>SPOT</code> compute environment.</p>",
|
||||
"ContainerDetail$image": "<p>The image used to start the container.</p>",
|
||||
"ContainerDetail$jobRoleArn": "<p>The Amazon Resource Name (ARN) associated with the job upon execution. </p>",
|
||||
"ContainerDetail$user": "<p>The user name to use inside the container.</p>",
|
||||
"ContainerDetail$reason": "<p>A short (255 max characters) human-readable string to provide additional details about a running or stopped container.</p>",
|
||||
"ContainerDetail$containerInstanceArn": "<p>The Amazon Resource Name (ARN) of the container instance on which the container is running.</p>",
|
||||
"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>",
|
||||
"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>",
|
||||
"CreateComputeEnvironmentResponse$computeEnvironmentName": "<p>The name of the compute environment.</p>",
|
||||
"CreateComputeEnvironmentResponse$computeEnvironmentArn": "<p>The Amazon Resource Name (ARN) of the compute environment. </p>",
|
||||
"CreateJobQueueRequest$jobQueueName": "<p>The name of the job queue.</p>",
|
||||
"CreateJobQueueResponse$jobQueueName": "<p>The name of the job queue.</p>",
|
||||
"CreateJobQueueResponse$jobQueueArn": "<p>The Amazon Resource Name (ARN) of the job queue.</p>",
|
||||
"DeleteComputeEnvironmentRequest$computeEnvironment": "<p>The name or Amazon Resource Name (ARN) of the compute environment to delete. </p>",
|
||||
"DeleteJobQueueRequest$jobQueue": "<p>The short name or full Amazon Resource Name (ARN) of the queue to delete. </p>",
|
||||
"DeregisterJobDefinitionRequest$jobDefinition": "<p>The name and revision (<code>name:revision</code>) or full Amazon Resource Name (ARN) of the job definition to deregister. </p>",
|
||||
"DescribeComputeEnvironmentsRequest$nextToken": "<p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeComputeEnvironments</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>",
|
||||
"DescribeComputeEnvironmentsResponse$nextToken": "<p>The <code>nextToken</code> value to include in a future <code>DescribeComputeEnvironments</code> request. When the results of a <code>DescribeJobDefinitions</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>",
|
||||
"DescribeJobDefinitionsRequest$jobDefinitionName": "<p>The name of the job definition to describe.</p>",
|
||||
"DescribeJobDefinitionsRequest$status": "<p>The status with which to filter job definitions.</p>",
|
||||
"DescribeJobDefinitionsRequest$nextToken": "<p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeJobDefinitions</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>",
|
||||
"DescribeJobDefinitionsResponse$nextToken": "<p>The <code>nextToken</code> value to include in a future <code>DescribeJobDefinitions</code> request. When the results of a <code>DescribeJobDefinitions</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>",
|
||||
"DescribeJobQueuesRequest$nextToken": "<p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeJobQueues</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>",
|
||||
"DescribeJobQueuesResponse$nextToken": "<p>The <code>nextToken</code> value to include in a future <code>DescribeJobQueues</code> request. When the results of a <code>DescribeJobQueues</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>",
|
||||
"Host$sourcePath": "<p>The path on the host container instance that is presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If the <code>host</code> parameter contains a <code>sourcePath</code> file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the <code>sourcePath</code> value does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.</p>",
|
||||
"JobDefinition$jobDefinitionName": "<p>The name of the job definition. </p>",
|
||||
"JobDefinition$jobDefinitionArn": "<p>The Amazon Resource Name (ARN) for the job definition. </p>",
|
||||
"JobDefinition$status": "<p>The status of the job definition.</p>",
|
||||
"JobDefinition$type": "<p>The type of job definition.</p>",
|
||||
"JobDependency$jobId": "<p>The job ID of the AWS Batch job associated with this dependency.</p>",
|
||||
"JobDetail$jobName": "<p>The name of the job.</p>",
|
||||
"JobDetail$jobId": "<p>The ID for the job.</p>",
|
||||
"JobDetail$jobQueue": "<p>The Amazon Resource Name (ARN) of the job queue with which the job is associated.</p>",
|
||||
"JobDetail$statusReason": "<p>A short, human-readable string to provide additional details about the current status of the job. </p>",
|
||||
"JobDetail$jobDefinition": "<p>The job definition that is used by this job.</p>",
|
||||
"JobQueueDetail$jobQueueName": "<p>The name of the job queue.</p>",
|
||||
"JobQueueDetail$jobQueueArn": "<p>The Amazon Resource Name (ARN) of the job queue.</p>",
|
||||
"JobQueueDetail$statusReason": "<p>A short, human-readable string to provide additional details about the current status of the job queue.</p>",
|
||||
"JobSummary$jobId": "<p>The ID of the job.</p>",
|
||||
"JobSummary$jobName": "<p>The name of the job.</p>",
|
||||
"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$nextToken": "<p>The <code>nextToken</code> value returned from a previous paginated <code>ListJobs</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is <code>null</code> when there are no more results to return.</p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>",
|
||||
"ListJobsResponse$nextToken": "<p>The <code>nextToken</code> value to include in a future <code>ListJobs</code> request. When the results of a <code>ListJobs</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>",
|
||||
"MountPoint$containerPath": "<p>The path on the container at which to mount the host volume.</p>",
|
||||
"MountPoint$sourceVolume": "<p>The name of the volume to mount.</p>",
|
||||
"ParametersMap$key": null,
|
||||
"ParametersMap$value": null,
|
||||
"RegisterJobDefinitionRequest$jobDefinitionName": "<p>The name of the job definition to register. </p>",
|
||||
"RegisterJobDefinitionResponse$jobDefinitionName": "<p>The name of the job definition. </p>",
|
||||
"RegisterJobDefinitionResponse$jobDefinitionArn": "<p>The Amazon Resource Name (ARN) of the job definition. </p>",
|
||||
"ServerException$message": null,
|
||||
"StringList$member": null,
|
||||
"SubmitJobRequest$jobName": "<p>The name of the job.</p>",
|
||||
"SubmitJobRequest$jobQueue": "<p>The job queue into which the job will be submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue. </p>",
|
||||
"SubmitJobRequest$jobDefinition": "<p>The job definition used by this job. This value can be either a <code>name:revision</code> or the Amazon Resource Name (ARN) for the job definition.</p>",
|
||||
"SubmitJobResponse$jobName": "<p>The name of the job. </p>",
|
||||
"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>",
|
||||
"Ulimit$name": "<p>The <code>type</code> of the <code>ulimit</code>.</p>",
|
||||
"UpdateComputeEnvironmentRequest$computeEnvironment": "<p>The name or full Amazon Resource Name (ARN) of the compute environment to update.</p>",
|
||||
"UpdateComputeEnvironmentRequest$serviceRole": "<p>The name or full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to ECS, Auto Scaling, and EC2 on your behalf.</p>",
|
||||
"UpdateComputeEnvironmentResponse$computeEnvironmentName": "<p>The name of compute environment.</p>",
|
||||
"UpdateComputeEnvironmentResponse$computeEnvironmentArn": "<p>The Amazon Resource Name (ARN) of the compute environment. </p>",
|
||||
"UpdateJobQueueRequest$jobQueue": "<p>The name or the Amazon Resource Name (ARN) of the job queue.</p>",
|
||||
"UpdateJobQueueResponse$jobQueueName": "<p>The name of the job queue.</p>",
|
||||
"UpdateJobQueueResponse$jobQueueArn": "<p>The Amazon Resource Name (ARN) of the job queue.</p>",
|
||||
"Volume$name": "<p>The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the <code>sourceVolume</code> parameter of container definition <code>mountPoints</code>.</p>"
|
||||
}
|
||||
},
|
||||
"StringList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ComputeResource$instanceTypes": "<p>The instances types that may launched.</p>",
|
||||
"ComputeResource$subnets": "<p>The VPC subnets into which the compute resources are launched. </p>",
|
||||
"ComputeResource$securityGroupIds": "<p>The EC2 security group that is associated with instances launched in the compute environment. </p>",
|
||||
"ContainerDetail$command": "<p>The command that is passed to the container. </p>",
|
||||
"ContainerOverrides$command": "<p>The command to send to the container that overrides the default command from the Docker image or the job definition.</p>",
|
||||
"ContainerProperties$command": "<p>The command that is passed to the container. This parameter maps to <code>Cmd</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>COMMAND</code> parameter to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. For more information, see <a href=\"https://docs.docker.com/engine/reference/builder/#cmd\">https://docs.docker.com/engine/reference/builder/#cmd</a>.</p>",
|
||||
"DescribeComputeEnvironmentsRequest$computeEnvironments": "<p>A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries. </p>",
|
||||
"DescribeJobDefinitionsRequest$jobDefinitions": "<p>A space-separated list of up to 100 job definition names or full Amazon Resource Name (ARN) entries.</p>",
|
||||
"DescribeJobQueuesRequest$jobQueues": "<p>A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.</p>",
|
||||
"DescribeJobsRequest$jobs": "<p>A space-separated list of up to 100 job IDs.</p>"
|
||||
}
|
||||
},
|
||||
"SubmitJobRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"SubmitJobResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"TagsMap": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ComputeResource$tags": "<p>Key-value pair tags to be applied to resources that are launched in the compute environment. </p>"
|
||||
}
|
||||
},
|
||||
"TerminateJobRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"TerminateJobResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Ulimit": {
|
||||
"base": "<p>The <code>ulimit</code> settings to pass to the container.</p>",
|
||||
"refs": {
|
||||
"Ulimits$member": null
|
||||
}
|
||||
},
|
||||
"Ulimits": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ContainerDetail$ulimits": "<p>A list of <code>ulimit</code> values to set in the container.</p>",
|
||||
"ContainerProperties$ulimits": "<p>A list of <code>ulimits</code> to set in the container. This parameter maps to <code>Ulimits</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--ulimit</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p>"
|
||||
}
|
||||
},
|
||||
"UpdateComputeEnvironmentRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateComputeEnvironmentResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateJobQueueRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateJobQueueResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Volume": {
|
||||
"base": "<p>A data volume used in a job's container properties.</p>",
|
||||
"refs": {
|
||||
"Volumes$member": null
|
||||
}
|
||||
},
|
||||
"Volumes": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ContainerDetail$volumes": "<p>A list of volumes associated with the job.</p>",
|
||||
"ContainerProperties$volumes": "<p>A list of data volumes used in a job.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+589
@@ -0,0 +1,589 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
"CancelJob": [
|
||||
{
|
||||
"input": {
|
||||
"jobId": "1d828f65-7a4d-42e8-996d-3b900ed59dc4",
|
||||
"reason": "Cancelling job."
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example cancels a job with the specified job ID.",
|
||||
"id": "to-cancel-a-job-1481152314733",
|
||||
"title": "To cancel a job"
|
||||
}
|
||||
],
|
||||
"CreateComputeEnvironment": [
|
||||
{
|
||||
"input": {
|
||||
"type": "MANAGED",
|
||||
"computeEnvironmentName": "C4OnDemand",
|
||||
"computeResources": {
|
||||
"type": "EC2",
|
||||
"desiredvCpus": 48,
|
||||
"ec2KeyPair": "id_rsa",
|
||||
"instanceRole": "ecsInstanceRole",
|
||||
"instanceTypes": [
|
||||
"c4.large",
|
||||
"c4.xlarge",
|
||||
"c4.2xlarge",
|
||||
"c4.4xlarge",
|
||||
"c4.8xlarge"
|
||||
],
|
||||
"maxvCpus": 128,
|
||||
"minvCpus": 0,
|
||||
"securityGroupIds": [
|
||||
"sg-cf5093b2"
|
||||
],
|
||||
"subnets": [
|
||||
"subnet-220c0e0a",
|
||||
"subnet-1a95556d",
|
||||
"subnet-978f6dce"
|
||||
],
|
||||
"tags": {
|
||||
"Name": "Batch Instance - C4OnDemand"
|
||||
}
|
||||
},
|
||||
"serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole",
|
||||
"state": "ENABLED"
|
||||
},
|
||||
"output": {
|
||||
"computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand",
|
||||
"computeEnvironmentName": "C4OnDemand"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example creates a managed compute environment with specific C4 instance types that are launched on demand. The compute environment is called C4OnDemand.",
|
||||
"id": "to-create-a-managed-ec2-compute-environment-1481152600017",
|
||||
"title": "To create a managed EC2 compute environment"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"type": "MANAGED",
|
||||
"computeEnvironmentName": "M4Spot",
|
||||
"computeResources": {
|
||||
"type": "SPOT",
|
||||
"bidPercentage": 20,
|
||||
"desiredvCpus": 4,
|
||||
"ec2KeyPair": "id_rsa",
|
||||
"instanceRole": "ecsInstanceRole",
|
||||
"instanceTypes": [
|
||||
"m4"
|
||||
],
|
||||
"maxvCpus": 128,
|
||||
"minvCpus": 0,
|
||||
"securityGroupIds": [
|
||||
"sg-cf5093b2"
|
||||
],
|
||||
"spotIamFleetRole": "arn:aws:iam::012345678910:role/aws-ec2-spot-fleet-role",
|
||||
"subnets": [
|
||||
"subnet-220c0e0a",
|
||||
"subnet-1a95556d",
|
||||
"subnet-978f6dce"
|
||||
],
|
||||
"tags": {
|
||||
"Name": "Batch Instance - M4Spot"
|
||||
}
|
||||
},
|
||||
"serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole",
|
||||
"state": "ENABLED"
|
||||
},
|
||||
"output": {
|
||||
"computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/M4Spot",
|
||||
"computeEnvironmentName": "M4Spot"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example creates a managed compute environment with the M4 instance type that is launched when the Spot bid price is at or below 20% of the On-Demand price for the instance type. The compute environment is called M4Spot.",
|
||||
"id": "to-create-a-managed-ec2-spot-compute-environment-1481152844190",
|
||||
"title": "To create a managed EC2 Spot compute environment"
|
||||
}
|
||||
],
|
||||
"CreateJobQueue": [
|
||||
{
|
||||
"input": {
|
||||
"computeEnvironmentOrder": [
|
||||
{
|
||||
"computeEnvironment": "M4Spot",
|
||||
"order": 1
|
||||
}
|
||||
],
|
||||
"jobQueueName": "LowPriority",
|
||||
"priority": 10,
|
||||
"state": "ENABLED"
|
||||
},
|
||||
"output": {
|
||||
"jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/LowPriority",
|
||||
"jobQueueName": "LowPriority"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example creates a job queue called LowPriority that uses the M4Spot compute environment.",
|
||||
"id": "to-create-a-job-queue-with-a-single-compute-environment-1481152967946",
|
||||
"title": "To create a job queue with a single compute environment"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"computeEnvironmentOrder": [
|
||||
{
|
||||
"computeEnvironment": "C4OnDemand",
|
||||
"order": 1
|
||||
},
|
||||
{
|
||||
"computeEnvironment": "M4Spot",
|
||||
"order": 2
|
||||
}
|
||||
],
|
||||
"jobQueueName": "HighPriority",
|
||||
"priority": 1,
|
||||
"state": "ENABLED"
|
||||
},
|
||||
"output": {
|
||||
"jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
|
||||
"jobQueueName": "HighPriority"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example creates a job queue called HighPriority that uses the C4OnDemand compute environment with an order of 1 and the M4Spot compute environment with an order of 2.",
|
||||
"id": "to-create-a-job-queue-with-multiple-compute-environments-1481153027051",
|
||||
"title": "To create a job queue with multiple compute environments"
|
||||
}
|
||||
],
|
||||
"DeleteComputeEnvironment": [
|
||||
{
|
||||
"input": {
|
||||
"computeEnvironment": "P2OnDemand"
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deletes the P2OnDemand compute environment.",
|
||||
"id": "to-delete-a-compute-environment-1481153105644",
|
||||
"title": "To delete a compute environment"
|
||||
}
|
||||
],
|
||||
"DeleteJobQueue": [
|
||||
{
|
||||
"input": {
|
||||
"jobQueue": "GPGPU"
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deletes the GPGPU job queue.",
|
||||
"id": "to-delete-a-job-queue-1481153508134",
|
||||
"title": "To delete a job queue"
|
||||
}
|
||||
],
|
||||
"DeregisterJobDefinition": [
|
||||
{
|
||||
"input": {
|
||||
"jobDefinition": "sleep10"
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deregisters a job definition called sleep10.",
|
||||
"id": "to-deregister-a-job-definition-1481153579565",
|
||||
"title": "To deregister a job definition"
|
||||
}
|
||||
],
|
||||
"DescribeComputeEnvironments": [
|
||||
{
|
||||
"input": {
|
||||
"computeEnvironments": [
|
||||
"P2OnDemand"
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"computeEnvironments": [
|
||||
{
|
||||
"type": "MANAGED",
|
||||
"computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand",
|
||||
"computeEnvironmentName": "P2OnDemand",
|
||||
"computeResources": {
|
||||
"type": "EC2",
|
||||
"desiredvCpus": 48,
|
||||
"ec2KeyPair": "id_rsa",
|
||||
"instanceRole": "ecsInstanceRole",
|
||||
"instanceTypes": [
|
||||
"p2"
|
||||
],
|
||||
"maxvCpus": 128,
|
||||
"minvCpus": 0,
|
||||
"securityGroupIds": [
|
||||
"sg-cf5093b2"
|
||||
],
|
||||
"subnets": [
|
||||
"subnet-220c0e0a",
|
||||
"subnet-1a95556d",
|
||||
"subnet-978f6dce"
|
||||
],
|
||||
"tags": {
|
||||
"Name": "Batch Instance - P2OnDemand"
|
||||
}
|
||||
},
|
||||
"ecsClusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/P2OnDemand_Batch_2c06f29d-d1fe-3a49-879d-42394c86effc",
|
||||
"serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole",
|
||||
"state": "ENABLED",
|
||||
"status": "VALID",
|
||||
"statusReason": "ComputeEnvironment Healthy"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the P2OnDemand compute environment.",
|
||||
"id": "to-describe-a-compute-environment-1481153713334",
|
||||
"title": "To describe a compute environment"
|
||||
}
|
||||
],
|
||||
"DescribeJobDefinitions": [
|
||||
{
|
||||
"input": {
|
||||
"status": "ACTIVE"
|
||||
},
|
||||
"output": {
|
||||
"jobDefinitions": [
|
||||
{
|
||||
"type": "container",
|
||||
"containerProperties": {
|
||||
"command": [
|
||||
"sleep",
|
||||
"60"
|
||||
],
|
||||
"environment": [
|
||||
|
||||
],
|
||||
"image": "busybox",
|
||||
"memory": 128,
|
||||
"mountPoints": [
|
||||
|
||||
],
|
||||
"ulimits": [
|
||||
|
||||
],
|
||||
"vcpus": 1,
|
||||
"volumes": [
|
||||
|
||||
]
|
||||
},
|
||||
"jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep60:1",
|
||||
"jobDefinitionName": "sleep60",
|
||||
"revision": 1,
|
||||
"status": "ACTIVE"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes all of your active job definitions.",
|
||||
"id": "to-describe-active-job-definitions-1481153895831",
|
||||
"title": "To describe active job definitions"
|
||||
}
|
||||
],
|
||||
"DescribeJobQueues": [
|
||||
{
|
||||
"input": {
|
||||
"jobQueues": [
|
||||
"HighPriority"
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"jobQueues": [
|
||||
{
|
||||
"computeEnvironmentOrder": [
|
||||
{
|
||||
"computeEnvironment": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand",
|
||||
"order": 1
|
||||
}
|
||||
],
|
||||
"jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
|
||||
"jobQueueName": "HighPriority",
|
||||
"priority": 1,
|
||||
"state": "ENABLED",
|
||||
"status": "VALID",
|
||||
"statusReason": "JobQueue Healthy"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the HighPriority job queue.",
|
||||
"id": "to-describe-a-job-queue-1481153995804",
|
||||
"title": "To describe a job queue"
|
||||
}
|
||||
],
|
||||
"DescribeJobs": [
|
||||
{
|
||||
"input": {
|
||||
"jobs": [
|
||||
"24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9"
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"jobs": [
|
||||
{
|
||||
"container": {
|
||||
"command": [
|
||||
"sleep",
|
||||
"60"
|
||||
],
|
||||
"containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/5406d7cd-58bd-4b8f-9936-48d7c6b1526c",
|
||||
"environment": [
|
||||
|
||||
],
|
||||
"exitCode": 0,
|
||||
"image": "busybox",
|
||||
"memory": 128,
|
||||
"mountPoints": [
|
||||
|
||||
],
|
||||
"ulimits": [
|
||||
|
||||
],
|
||||
"vcpus": 1,
|
||||
"volumes": [
|
||||
|
||||
]
|
||||
},
|
||||
"createdAt": 1480460782010,
|
||||
"dependsOn": [
|
||||
|
||||
],
|
||||
"jobDefinition": "sleep60",
|
||||
"jobId": "24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9",
|
||||
"jobName": "example",
|
||||
"jobQueue": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
|
||||
"parameters": {
|
||||
},
|
||||
"startedAt": 1480460816500,
|
||||
"status": "SUCCEEDED",
|
||||
"stoppedAt": 1480460880699
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes a job with the specified job ID.",
|
||||
"id": "to-describe-a-specific-job-1481154090490",
|
||||
"title": "To describe a specific job"
|
||||
}
|
||||
],
|
||||
"ListJobs": [
|
||||
{
|
||||
"input": {
|
||||
"jobQueue": "HighPriority"
|
||||
},
|
||||
"output": {
|
||||
"jobSummaryList": [
|
||||
{
|
||||
"jobId": "e66ff5fd-a1ff-4640-b1a2-0b0a142f49bb",
|
||||
"jobName": "example"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example lists the running jobs in the HighPriority job queue.",
|
||||
"id": "to-list-running-jobs-1481154202164",
|
||||
"title": "To list running jobs"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"jobQueue": "HighPriority",
|
||||
"jobStatus": "SUBMITTED"
|
||||
},
|
||||
"output": {
|
||||
"jobSummaryList": [
|
||||
{
|
||||
"jobId": "68f0c163-fbd4-44e6-9fd1-25b14a434786",
|
||||
"jobName": "example"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example lists jobs in the HighPriority job queue that are in the SUBMITTED job status.",
|
||||
"id": "to-list-submitted-jobs-1481154251623",
|
||||
"title": "To list submitted jobs"
|
||||
}
|
||||
],
|
||||
"RegisterJobDefinition": [
|
||||
{
|
||||
"input": {
|
||||
"type": "container",
|
||||
"containerProperties": {
|
||||
"command": [
|
||||
"sleep",
|
||||
"10"
|
||||
],
|
||||
"image": "busybox",
|
||||
"memory": 128,
|
||||
"vcpus": 1
|
||||
},
|
||||
"jobDefinitionName": "sleep10"
|
||||
},
|
||||
"output": {
|
||||
"jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep10:1",
|
||||
"jobDefinitionName": "sleep10",
|
||||
"revision": 1
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example registers a job definition for a simple container job.",
|
||||
"id": "to-register-a-job-definition-1481154325325",
|
||||
"title": "To register a job definition"
|
||||
}
|
||||
],
|
||||
"SubmitJob": [
|
||||
{
|
||||
"input": {
|
||||
"jobDefinition": "sleep60",
|
||||
"jobName": "example",
|
||||
"jobQueue": "HighPriority"
|
||||
},
|
||||
"output": {
|
||||
"jobId": "876da822-4198-45f2-a252-6cea32512ea8",
|
||||
"jobName": "example"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example submits a simple container job called example to the HighPriority job queue.",
|
||||
"id": "to-submit-a-job-to-a-queue-1481154481673",
|
||||
"title": "To submit a job to a queue"
|
||||
}
|
||||
],
|
||||
"TerminateJob": [
|
||||
{
|
||||
"input": {
|
||||
"jobId": "61e743ed-35e4-48da-b2de-5c8333821c84",
|
||||
"reason": "Terminating job."
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example terminates a job with the specified job ID.",
|
||||
"id": "to-terminate-a-job-1481154558276",
|
||||
"title": "To terminate a job"
|
||||
}
|
||||
],
|
||||
"UpdateComputeEnvironment": [
|
||||
{
|
||||
"input": {
|
||||
"computeEnvironment": "P2OnDemand",
|
||||
"state": "DISABLED"
|
||||
},
|
||||
"output": {
|
||||
"computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand",
|
||||
"computeEnvironmentName": "P2OnDemand"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example disables the P2OnDemand compute environment so it can be deleted.",
|
||||
"id": "to-update-a-compute-environment-1481154702731",
|
||||
"title": "To update a compute environment"
|
||||
}
|
||||
],
|
||||
"UpdateJobQueue": [
|
||||
{
|
||||
"input": {
|
||||
"jobQueue": "GPGPU",
|
||||
"state": "DISABLED"
|
||||
},
|
||||
"output": {
|
||||
"jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/GPGPU",
|
||||
"jobQueueName": "GPGPU"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example disables a job queue so that it can be deleted.",
|
||||
"id": "to-update-a-job-queue-1481154806981",
|
||||
"title": "To update a job queue"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
Generated
Vendored
Executable
+697
@@ -0,0 +1,697 @@
|
||||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"apiVersion":"2016-10-20",
|
||||
"endpointPrefix":"budgets",
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceAbbreviation":"AWSBudgets",
|
||||
"serviceFullName":"AWS Budgets",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"AWSBudgetServiceGateway",
|
||||
"uid":"budgets-2016-10-20"
|
||||
},
|
||||
"operations":{
|
||||
"CreateBudget":{
|
||||
"name":"CreateBudget",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateBudgetRequest"},
|
||||
"output":{"shape":"CreateBudgetResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"InternalErrorException"},
|
||||
{"shape":"CreationLimitExceededException"},
|
||||
{"shape":"DuplicateRecordException"}
|
||||
]
|
||||
},
|
||||
"CreateNotification":{
|
||||
"name":"CreateNotification",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateNotificationRequest"},
|
||||
"output":{"shape":"CreateNotificationResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalErrorException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"CreationLimitExceededException"},
|
||||
{"shape":"DuplicateRecordException"}
|
||||
]
|
||||
},
|
||||
"CreateSubscriber":{
|
||||
"name":"CreateSubscriber",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateSubscriberRequest"},
|
||||
"output":{"shape":"CreateSubscriberResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalErrorException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"CreationLimitExceededException"},
|
||||
{"shape":"DuplicateRecordException"},
|
||||
{"shape":"NotFoundException"}
|
||||
]
|
||||
},
|
||||
"DeleteBudget":{
|
||||
"name":"DeleteBudget",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteBudgetRequest"},
|
||||
"output":{"shape":"DeleteBudgetResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalErrorException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"NotFoundException"}
|
||||
]
|
||||
},
|
||||
"DeleteNotification":{
|
||||
"name":"DeleteNotification",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteNotificationRequest"},
|
||||
"output":{"shape":"DeleteNotificationResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"InternalErrorException"},
|
||||
{"shape":"NotFoundException"}
|
||||
]
|
||||
},
|
||||
"DeleteSubscriber":{
|
||||
"name":"DeleteSubscriber",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteSubscriberRequest"},
|
||||
"output":{"shape":"DeleteSubscriberResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalErrorException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"NotFoundException"}
|
||||
]
|
||||
},
|
||||
"DescribeBudget":{
|
||||
"name":"DescribeBudget",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeBudgetRequest"},
|
||||
"output":{"shape":"DescribeBudgetResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalErrorException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"NotFoundException"}
|
||||
]
|
||||
},
|
||||
"DescribeBudgets":{
|
||||
"name":"DescribeBudgets",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeBudgetsRequest"},
|
||||
"output":{"shape":"DescribeBudgetsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalErrorException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ExpiredNextTokenException"}
|
||||
]
|
||||
},
|
||||
"DescribeNotificationsForBudget":{
|
||||
"name":"DescribeNotificationsForBudget",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeNotificationsForBudgetRequest"},
|
||||
"output":{"shape":"DescribeNotificationsForBudgetResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalErrorException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ExpiredNextTokenException"}
|
||||
]
|
||||
},
|
||||
"DescribeSubscribersForNotification":{
|
||||
"name":"DescribeSubscribersForNotification",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeSubscribersForNotificationRequest"},
|
||||
"output":{"shape":"DescribeSubscribersForNotificationResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalErrorException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ExpiredNextTokenException"}
|
||||
]
|
||||
},
|
||||
"UpdateBudget":{
|
||||
"name":"UpdateBudget",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateBudgetRequest"},
|
||||
"output":{"shape":"UpdateBudgetResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalErrorException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"NotFoundException"}
|
||||
]
|
||||
},
|
||||
"UpdateNotification":{
|
||||
"name":"UpdateNotification",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateNotificationRequest"},
|
||||
"output":{"shape":"UpdateNotificationResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalErrorException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"NotFoundException"}
|
||||
]
|
||||
},
|
||||
"UpdateSubscriber":{
|
||||
"name":"UpdateSubscriber",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateSubscriberRequest"},
|
||||
"output":{"shape":"UpdateSubscriberResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalErrorException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"NotFoundException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AccountId":{
|
||||
"type":"string",
|
||||
"max":12,
|
||||
"min":12
|
||||
},
|
||||
"Budget":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"BudgetName",
|
||||
"BudgetLimit",
|
||||
"CostTypes",
|
||||
"TimeUnit",
|
||||
"TimePeriod",
|
||||
"BudgetType"
|
||||
],
|
||||
"members":{
|
||||
"BudgetName":{"shape":"BudgetName"},
|
||||
"BudgetLimit":{"shape":"Spend"},
|
||||
"CostFilters":{"shape":"CostFilters"},
|
||||
"CostTypes":{"shape":"CostTypes"},
|
||||
"TimeUnit":{"shape":"TimeUnit"},
|
||||
"TimePeriod":{"shape":"TimePeriod"},
|
||||
"CalculatedSpend":{"shape":"CalculatedSpend"},
|
||||
"BudgetType":{"shape":"BudgetType"}
|
||||
}
|
||||
},
|
||||
"BudgetName":{
|
||||
"type":"string",
|
||||
"max":100,
|
||||
"pattern":"[^:]+"
|
||||
},
|
||||
"BudgetType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"USAGE",
|
||||
"COST"
|
||||
]
|
||||
},
|
||||
"Budgets":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Budget"}
|
||||
},
|
||||
"CalculatedSpend":{
|
||||
"type":"structure",
|
||||
"required":["ActualSpend"],
|
||||
"members":{
|
||||
"ActualSpend":{"shape":"Spend"},
|
||||
"ForecastedSpend":{"shape":"Spend"}
|
||||
}
|
||||
},
|
||||
"ComparisonOperator":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"GREATER_THAN",
|
||||
"LESS_THAN",
|
||||
"EQUAL_TO"
|
||||
]
|
||||
},
|
||||
"CostFilters":{
|
||||
"type":"map",
|
||||
"key":{"shape":"GenericString"},
|
||||
"value":{"shape":"DimensionValues"}
|
||||
},
|
||||
"CostTypes":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"IncludeTax",
|
||||
"IncludeSubscription",
|
||||
"UseBlended"
|
||||
],
|
||||
"members":{
|
||||
"IncludeTax":{"shape":"GenericBoolean"},
|
||||
"IncludeSubscription":{"shape":"GenericBoolean"},
|
||||
"UseBlended":{"shape":"GenericBoolean"}
|
||||
}
|
||||
},
|
||||
"CreateBudgetRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AccountId",
|
||||
"Budget"
|
||||
],
|
||||
"members":{
|
||||
"AccountId":{"shape":"AccountId"},
|
||||
"Budget":{"shape":"Budget"},
|
||||
"NotificationsWithSubscribers":{"shape":"NotificationWithSubscribersList"}
|
||||
}
|
||||
},
|
||||
"CreateBudgetResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"CreateNotificationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AccountId",
|
||||
"BudgetName",
|
||||
"Notification",
|
||||
"Subscribers"
|
||||
],
|
||||
"members":{
|
||||
"AccountId":{"shape":"AccountId"},
|
||||
"BudgetName":{"shape":"BudgetName"},
|
||||
"Notification":{"shape":"Notification"},
|
||||
"Subscribers":{"shape":"Subscribers"}
|
||||
}
|
||||
},
|
||||
"CreateNotificationResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"CreateSubscriberRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AccountId",
|
||||
"BudgetName",
|
||||
"Notification",
|
||||
"Subscriber"
|
||||
],
|
||||
"members":{
|
||||
"AccountId":{"shape":"AccountId"},
|
||||
"BudgetName":{"shape":"BudgetName"},
|
||||
"Notification":{"shape":"Notification"},
|
||||
"Subscriber":{"shape":"Subscriber"}
|
||||
}
|
||||
},
|
||||
"CreateSubscriberResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"CreationLimitExceededException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"errorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"DeleteBudgetRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AccountId",
|
||||
"BudgetName"
|
||||
],
|
||||
"members":{
|
||||
"AccountId":{"shape":"AccountId"},
|
||||
"BudgetName":{"shape":"BudgetName"}
|
||||
}
|
||||
},
|
||||
"DeleteBudgetResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteNotificationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AccountId",
|
||||
"BudgetName",
|
||||
"Notification"
|
||||
],
|
||||
"members":{
|
||||
"AccountId":{"shape":"AccountId"},
|
||||
"BudgetName":{"shape":"BudgetName"},
|
||||
"Notification":{"shape":"Notification"}
|
||||
}
|
||||
},
|
||||
"DeleteNotificationResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteSubscriberRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AccountId",
|
||||
"BudgetName",
|
||||
"Notification",
|
||||
"Subscriber"
|
||||
],
|
||||
"members":{
|
||||
"AccountId":{"shape":"AccountId"},
|
||||
"BudgetName":{"shape":"BudgetName"},
|
||||
"Notification":{"shape":"Notification"},
|
||||
"Subscriber":{"shape":"Subscriber"}
|
||||
}
|
||||
},
|
||||
"DeleteSubscriberResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DescribeBudgetRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AccountId",
|
||||
"BudgetName"
|
||||
],
|
||||
"members":{
|
||||
"AccountId":{"shape":"AccountId"},
|
||||
"BudgetName":{"shape":"BudgetName"}
|
||||
}
|
||||
},
|
||||
"DescribeBudgetResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Budget":{"shape":"Budget"}
|
||||
}
|
||||
},
|
||||
"DescribeBudgetsRequest":{
|
||||
"type":"structure",
|
||||
"required":["AccountId"],
|
||||
"members":{
|
||||
"AccountId":{"shape":"AccountId"},
|
||||
"MaxResults":{"shape":"MaxResults"},
|
||||
"NextToken":{"shape":"GenericString"}
|
||||
}
|
||||
},
|
||||
"DescribeBudgetsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Budgets":{"shape":"Budgets"},
|
||||
"NextToken":{"shape":"GenericString"}
|
||||
}
|
||||
},
|
||||
"DescribeNotificationsForBudgetRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AccountId",
|
||||
"BudgetName"
|
||||
],
|
||||
"members":{
|
||||
"AccountId":{"shape":"AccountId"},
|
||||
"BudgetName":{"shape":"BudgetName"},
|
||||
"MaxResults":{"shape":"MaxResults"},
|
||||
"NextToken":{"shape":"GenericString"}
|
||||
}
|
||||
},
|
||||
"DescribeNotificationsForBudgetResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Notifications":{"shape":"Notifications"},
|
||||
"NextToken":{"shape":"GenericString"}
|
||||
}
|
||||
},
|
||||
"DescribeSubscribersForNotificationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AccountId",
|
||||
"BudgetName",
|
||||
"Notification"
|
||||
],
|
||||
"members":{
|
||||
"AccountId":{"shape":"AccountId"},
|
||||
"BudgetName":{"shape":"BudgetName"},
|
||||
"Notification":{"shape":"Notification"},
|
||||
"MaxResults":{"shape":"MaxResults"},
|
||||
"NextToken":{"shape":"GenericString"}
|
||||
}
|
||||
},
|
||||
"DescribeSubscribersForNotificationResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Subscribers":{"shape":"Subscribers"},
|
||||
"NextToken":{"shape":"GenericString"}
|
||||
}
|
||||
},
|
||||
"DimensionValues":{
|
||||
"type":"list",
|
||||
"member":{"shape":"GenericString"}
|
||||
},
|
||||
"DuplicateRecordException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"errorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ExpiredNextTokenException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"errorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"GenericBoolean":{"type":"boolean"},
|
||||
"GenericString":{"type":"string"},
|
||||
"GenericTimestamp":{"type":"timestamp"},
|
||||
"InternalErrorException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"errorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidNextTokenException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"errorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidParameterException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"errorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"MaxResults":{
|
||||
"type":"integer",
|
||||
"box":true,
|
||||
"max":100,
|
||||
"min":1
|
||||
},
|
||||
"NotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"errorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"Notification":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"NotificationType",
|
||||
"ComparisonOperator",
|
||||
"Threshold"
|
||||
],
|
||||
"members":{
|
||||
"NotificationType":{"shape":"NotificationType"},
|
||||
"ComparisonOperator":{"shape":"ComparisonOperator"},
|
||||
"Threshold":{"shape":"NotificationThreshold"}
|
||||
}
|
||||
},
|
||||
"NotificationThreshold":{
|
||||
"type":"double",
|
||||
"max":300,
|
||||
"min":0.1
|
||||
},
|
||||
"NotificationType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ACTUAL",
|
||||
"FORECASTED"
|
||||
]
|
||||
},
|
||||
"NotificationWithSubscribers":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Notification",
|
||||
"Subscribers"
|
||||
],
|
||||
"members":{
|
||||
"Notification":{"shape":"Notification"},
|
||||
"Subscribers":{"shape":"Subscribers"}
|
||||
}
|
||||
},
|
||||
"NotificationWithSubscribersList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"NotificationWithSubscribers"},
|
||||
"max":5
|
||||
},
|
||||
"Notifications":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Notification"}
|
||||
},
|
||||
"NumericValue":{
|
||||
"type":"string",
|
||||
"pattern":"[0-9]*(\\.)?[0-9]+"
|
||||
},
|
||||
"Spend":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Amount",
|
||||
"Unit"
|
||||
],
|
||||
"members":{
|
||||
"Amount":{"shape":"NumericValue"},
|
||||
"Unit":{"shape":"GenericString"}
|
||||
}
|
||||
},
|
||||
"Subscriber":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"SubscriptionType",
|
||||
"Address"
|
||||
],
|
||||
"members":{
|
||||
"SubscriptionType":{"shape":"SubscriptionType"},
|
||||
"Address":{"shape":"GenericString"}
|
||||
}
|
||||
},
|
||||
"Subscribers":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Subscriber"},
|
||||
"max":11,
|
||||
"min":1
|
||||
},
|
||||
"SubscriptionType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"SNS",
|
||||
"EMAIL"
|
||||
]
|
||||
},
|
||||
"TimePeriod":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Start",
|
||||
"End"
|
||||
],
|
||||
"members":{
|
||||
"Start":{"shape":"GenericTimestamp"},
|
||||
"End":{"shape":"GenericTimestamp"}
|
||||
}
|
||||
},
|
||||
"TimeUnit":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"MONTHLY",
|
||||
"QUARTERLY",
|
||||
"ANNUALLY"
|
||||
]
|
||||
},
|
||||
"UpdateBudgetRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AccountId",
|
||||
"NewBudget"
|
||||
],
|
||||
"members":{
|
||||
"AccountId":{"shape":"AccountId"},
|
||||
"NewBudget":{"shape":"Budget"}
|
||||
}
|
||||
},
|
||||
"UpdateBudgetResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"UpdateNotificationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AccountId",
|
||||
"BudgetName",
|
||||
"OldNotification",
|
||||
"NewNotification"
|
||||
],
|
||||
"members":{
|
||||
"AccountId":{"shape":"AccountId"},
|
||||
"BudgetName":{"shape":"BudgetName"},
|
||||
"OldNotification":{"shape":"Notification"},
|
||||
"NewNotification":{"shape":"Notification"}
|
||||
}
|
||||
},
|
||||
"UpdateNotificationResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"UpdateSubscriberRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AccountId",
|
||||
"BudgetName",
|
||||
"Notification",
|
||||
"OldSubscriber",
|
||||
"NewSubscriber"
|
||||
],
|
||||
"members":{
|
||||
"AccountId":{"shape":"AccountId"},
|
||||
"BudgetName":{"shape":"BudgetName"},
|
||||
"Notification":{"shape":"Notification"},
|
||||
"OldSubscriber":{"shape":"Subscriber"},
|
||||
"NewSubscriber":{"shape":"Subscriber"}
|
||||
}
|
||||
},
|
||||
"UpdateSubscriberResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"errorMessage":{"type":"string"}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
Executable
+416
@@ -0,0 +1,416 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "All public APIs for AWS Budgets",
|
||||
"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"
|
||||
},
|
||||
"shapes": {
|
||||
"AccountId": {
|
||||
"base": "Account Id of the customer. It should be a 12 digit number.",
|
||||
"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
|
||||
}
|
||||
},
|
||||
"Budget": {
|
||||
"base": "AWS Budget model",
|
||||
"refs": {
|
||||
"Budgets$member": null,
|
||||
"CreateBudgetRequest$Budget": null,
|
||||
"DescribeBudgetResponse$Budget": null,
|
||||
"UpdateBudgetRequest$NewBudget": null
|
||||
}
|
||||
},
|
||||
"BudgetName": {
|
||||
"base": "A string represents the budget name. No \":\" character is allowed.",
|
||||
"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
|
||||
}
|
||||
},
|
||||
"BudgetType": {
|
||||
"base": "The type of a budget. Can be COST or USAGE.",
|
||||
"refs": {
|
||||
"Budget$BudgetType": null
|
||||
}
|
||||
},
|
||||
"Budgets": {
|
||||
"base": "A list of budgets",
|
||||
"refs": {
|
||||
"DescribeBudgetsResponse$Budgets": null
|
||||
}
|
||||
},
|
||||
"CalculatedSpend": {
|
||||
"base": "A structure holds the actual and forecasted spend for a budget.",
|
||||
"refs": {
|
||||
"Budget$CalculatedSpend": null
|
||||
}
|
||||
},
|
||||
"ComparisonOperator": {
|
||||
"base": "The comparison operator of a notification. Currently we support less than, equal to and greater than.",
|
||||
"refs": {
|
||||
"Notification$ComparisonOperator": null
|
||||
}
|
||||
},
|
||||
"CostFilters": {
|
||||
"base": "A map represents the cost filters applied to the budget.",
|
||||
"refs": {
|
||||
"Budget$CostFilters": null
|
||||
}
|
||||
},
|
||||
"CostTypes": {
|
||||
"base": "This includes the options for getting the cost of a budget.",
|
||||
"refs": {
|
||||
"Budget$CostTypes": null
|
||||
}
|
||||
},
|
||||
"CreateBudgetRequest": {
|
||||
"base": "Request of CreateBudget",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateBudgetResponse": {
|
||||
"base": "Response of CreateBudget",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateNotificationRequest": {
|
||||
"base": "Request of CreateNotification",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateNotificationResponse": {
|
||||
"base": "Response of CreateNotification",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateSubscriberRequest": {
|
||||
"base": "Request of CreateSubscriber",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateSubscriberResponse": {
|
||||
"base": "Response of CreateSubscriber",
|
||||
"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.",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteBudgetRequest": {
|
||||
"base": "Request of DeleteBudget",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteBudgetResponse": {
|
||||
"base": "Response of DeleteBudget",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteNotificationRequest": {
|
||||
"base": "Request of DeleteNotification",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteNotificationResponse": {
|
||||
"base": "Response of DeleteNotification",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteSubscriberRequest": {
|
||||
"base": "Request of DeleteSubscriber",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteSubscriberResponse": {
|
||||
"base": "Response of DeleteSubscriber",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeBudgetRequest": {
|
||||
"base": "Request of DescribeBudget",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeBudgetResponse": {
|
||||
"base": "Response of DescribeBudget",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeBudgetsRequest": {
|
||||
"base": "Request of DescribeBudgets",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeBudgetsResponse": {
|
||||
"base": "Response of DescribeBudgets",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeNotificationsForBudgetRequest": {
|
||||
"base": "Request of DescribeNotificationsForBudget",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeNotificationsForBudgetResponse": {
|
||||
"base": "Response of GetNotificationsForBudget",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeSubscribersForNotificationRequest": {
|
||||
"base": "Request of DescribeSubscribersForNotification",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeSubscribersForNotificationResponse": {
|
||||
"base": "Response of DescribeSubscribersForNotification",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DimensionValues": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CostFilters$value": null
|
||||
}
|
||||
},
|
||||
"DuplicateRecordException": {
|
||||
"base": "The exception is thrown when customer tries to create a record (e.g. budget) that already exists.",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ExpiredNextTokenException": {
|
||||
"base": "This exception is thrown if the paging token is expired - past its TTL",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GenericBoolean": {
|
||||
"base": "A generic boolean value.",
|
||||
"refs": {
|
||||
"CostTypes$IncludeTax": null,
|
||||
"CostTypes$IncludeSubscription": null,
|
||||
"CostTypes$UseBlended": null
|
||||
}
|
||||
},
|
||||
"GenericString": {
|
||||
"base": "A generic String.",
|
||||
"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,
|
||||
"Spend$Unit": null,
|
||||
"Subscriber$Address": null
|
||||
}
|
||||
},
|
||||
"GenericTimestamp": {
|
||||
"base": "A generic timestamp. In Java it is transformed to a Date object.",
|
||||
"refs": {
|
||||
"TimePeriod$Start": null,
|
||||
"TimePeriod$End": null
|
||||
}
|
||||
},
|
||||
"InternalErrorException": {
|
||||
"base": "This exception is thrown on an unknown internal failure.",
|
||||
"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",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidParameterException": {
|
||||
"base": "This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
"base": "An integer to represent how many entries should a pagianted response contains. Maxium is set to 100.",
|
||||
"refs": {
|
||||
"DescribeBudgetsRequest$MaxResults": null,
|
||||
"DescribeNotificationsForBudgetRequest$MaxResults": null,
|
||||
"DescribeSubscribersForNotificationRequest$MaxResults": null
|
||||
}
|
||||
},
|
||||
"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.",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Notification": {
|
||||
"base": "Notification model. Each budget may contain multiple notifications with different settings.",
|
||||
"refs": {
|
||||
"CreateNotificationRequest$Notification": null,
|
||||
"CreateSubscriberRequest$Notification": null,
|
||||
"DeleteNotificationRequest$Notification": null,
|
||||
"DeleteSubscriberRequest$Notification": null,
|
||||
"DescribeSubscribersForNotificationRequest$Notification": null,
|
||||
"NotificationWithSubscribers$Notification": null,
|
||||
"Notifications$member": null,
|
||||
"UpdateNotificationRequest$OldNotification": null,
|
||||
"UpdateNotificationRequest$NewNotification": null,
|
||||
"UpdateSubscriberRequest$Notification": null
|
||||
}
|
||||
},
|
||||
"NotificationThreshold": {
|
||||
"base": "The threshold of the a notification. It should be a number between 0 and 100.",
|
||||
"refs": {
|
||||
"Notification$Threshold": null
|
||||
}
|
||||
},
|
||||
"NotificationType": {
|
||||
"base": "The type of a notification. It should be ACTUAL or FORECASTED.",
|
||||
"refs": {
|
||||
"Notification$NotificationType": null
|
||||
}
|
||||
},
|
||||
"NotificationWithSubscribers": {
|
||||
"base": "A structure to relate notification and a list of subscribers who belong to the notification.",
|
||||
"refs": {
|
||||
"NotificationWithSubscribersList$member": null
|
||||
}
|
||||
},
|
||||
"NotificationWithSubscribersList": {
|
||||
"base": "A list of Notifications, each with a list of subscribers.",
|
||||
"refs": {
|
||||
"CreateBudgetRequest$NotificationsWithSubscribers": null
|
||||
}
|
||||
},
|
||||
"Notifications": {
|
||||
"base": "A list of notifications.",
|
||||
"refs": {
|
||||
"DescribeNotificationsForBudgetResponse$Notifications": null
|
||||
}
|
||||
},
|
||||
"NumericValue": {
|
||||
"base": "A string to represent NumericValue.",
|
||||
"refs": {
|
||||
"Spend$Amount": null
|
||||
}
|
||||
},
|
||||
"Spend": {
|
||||
"base": "A structure represent either a cost spend or usage spend. Contains an amount and a unit.",
|
||||
"refs": {
|
||||
"Budget$BudgetLimit": null,
|
||||
"CalculatedSpend$ActualSpend": null,
|
||||
"CalculatedSpend$ForecastedSpend": null
|
||||
}
|
||||
},
|
||||
"Subscriber": {
|
||||
"base": "Subscriber model. Each notification may contain multiple subscribers with different addresses.",
|
||||
"refs": {
|
||||
"CreateSubscriberRequest$Subscriber": null,
|
||||
"DeleteSubscriberRequest$Subscriber": null,
|
||||
"Subscribers$member": null,
|
||||
"UpdateSubscriberRequest$OldSubscriber": null,
|
||||
"UpdateSubscriberRequest$NewSubscriber": null
|
||||
}
|
||||
},
|
||||
"Subscribers": {
|
||||
"base": "A list of subscribers.",
|
||||
"refs": {
|
||||
"CreateNotificationRequest$Subscribers": null,
|
||||
"DescribeSubscribersForNotificationResponse$Subscribers": null,
|
||||
"NotificationWithSubscribers$Subscribers": null
|
||||
}
|
||||
},
|
||||
"SubscriptionType": {
|
||||
"base": "The subscription type of the subscriber. It can be SMS or EMAIL.",
|
||||
"refs": {
|
||||
"Subscriber$SubscriptionType": null
|
||||
}
|
||||
},
|
||||
"TimePeriod": {
|
||||
"base": "A time period indicated the start date and end date of a budget.",
|
||||
"refs": {
|
||||
"Budget$TimePeriod": null
|
||||
}
|
||||
},
|
||||
"TimeUnit": {
|
||||
"base": "The time unit of the budget. e.g. weekly, monthly, etc.",
|
||||
"refs": {
|
||||
"Budget$TimeUnit": null
|
||||
}
|
||||
},
|
||||
"UpdateBudgetRequest": {
|
||||
"base": "Request of UpdateBudget",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateBudgetResponse": {
|
||||
"base": "Response of UpdateBudget",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateNotificationRequest": {
|
||||
"base": "Request of UpdateNotification",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateNotificationResponse": {
|
||||
"base": "Response of UpdateNotification",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateSubscriberRequest": {
|
||||
"base": "Request of UpdateSubscriber",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateSubscriberResponse": {
|
||||
"base": "Response of UpdateSubscriber",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"errorMessage": {
|
||||
"base": "The error message the exception carries.",
|
||||
"refs": {
|
||||
"CreationLimitExceededException$Message": null,
|
||||
"DuplicateRecordException$Message": null,
|
||||
"ExpiredNextTokenException$Message": null,
|
||||
"InternalErrorException$Message": null,
|
||||
"InvalidNextTokenException$Message": null,
|
||||
"InvalidParameterException$Message": null,
|
||||
"NotFoundException$Message": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
Executable
+5
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"pagination": {
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+3033
File diff suppressed because it is too large
Load Diff
Generated
Vendored
+1654
File diff suppressed because it is too large
Load Diff
Generated
Vendored
+5
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+84
@@ -0,0 +1,84 @@
|
||||
{
|
||||
"pagination": {
|
||||
"ListAppliedSchemaArns": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListAttachedIndices": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListDevelopmentSchemaArns": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListDirectories": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListFacetAttributes": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListFacetNames": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListIndex": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListObjectAttributes": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListObjectChildren": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListObjectParentPaths": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListObjectParents": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListObjectPolicies": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListPolicyAttachments": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListPublishedSchemaArns": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListTagsForResource": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"LookupPolicy": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+1428
File diff suppressed because it is too large
Load Diff
Generated
Vendored
+1166
File diff suppressed because it is too large
Load Diff
Generated
Vendored
+158
@@ -0,0 +1,158 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
"CancelUpdateStack": [
|
||||
{
|
||||
"input": {
|
||||
"StackName": "MyStack"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example cancels an update of the specified stack.",
|
||||
"id": "to-cancel-a-stack-update-that-is-in-progress-1472747085196",
|
||||
"title": "To cancel a stack update in progress"
|
||||
}
|
||||
],
|
||||
"UpdateStack": [
|
||||
{
|
||||
"input": {
|
||||
"NotificationARNs": [
|
||||
|
||||
],
|
||||
"Parameters": [
|
||||
{
|
||||
"ParameterKey": "KeyPairName",
|
||||
"ParameterValue": "ExampleKeyPair"
|
||||
},
|
||||
{
|
||||
"ParameterKey": "SubnetIDs",
|
||||
"ParameterValue": "ExampleSubnetID1, ExampleSubnetID2"
|
||||
}
|
||||
],
|
||||
"ResourceTypes": [
|
||||
|
||||
],
|
||||
"StackName": "MyStack",
|
||||
"Tags": [
|
||||
|
||||
],
|
||||
"TemplateURL": "https://s3.amazonaws.com/example/updated.template"
|
||||
},
|
||||
"output": {
|
||||
"StackId": ""
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example updates the template and input parameters for the specified stack.",
|
||||
"id": "to-update-an-aws-cloudformation-stack-1472841931621",
|
||||
"title": "To update an AWS CloudFormation stack"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"NotificationARNs": [
|
||||
|
||||
],
|
||||
"Parameters": [
|
||||
{
|
||||
"ParameterKey": "KeyPairName",
|
||||
"UsePreviousValue": true
|
||||
},
|
||||
{
|
||||
"ParameterKey": "SubnetIDs",
|
||||
"ParameterValue": "SampleSubnetID1, UpdatedSampleSubnetID2"
|
||||
}
|
||||
],
|
||||
"ResourceTypes": [
|
||||
|
||||
],
|
||||
"StackName": "MyStack",
|
||||
"Tags": [
|
||||
|
||||
],
|
||||
"TemplateURL": "https://s3.amazonaws.com/example/updated.template"
|
||||
},
|
||||
"output": {
|
||||
"StackId": ""
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example updates only the the specified parameter value for the specified stack. If you don't specify a parameter value, AWS CloudFormation uses the default value from the template.",
|
||||
"id": "to-update-an-aws-cloudformation-stack-1472841931621",
|
||||
"title": "To update an AWS CloudFormation stack"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"Capabilities": [
|
||||
|
||||
],
|
||||
"NotificationARNs": [
|
||||
"arn:aws:sns:use-east-1:123456789012:mytopic1",
|
||||
"arn:aws:sns:us-east-1:123456789012:mytopic2"
|
||||
],
|
||||
"Parameters": [
|
||||
|
||||
],
|
||||
"ResourceTypes": [
|
||||
|
||||
],
|
||||
"StackName": "MyStack",
|
||||
"Tags": [
|
||||
|
||||
],
|
||||
"TemplateURL": "https://s3.amazonaws.com/example/updated.template",
|
||||
"UsePreviousTemplate": true
|
||||
},
|
||||
"output": {
|
||||
"StackId": ""
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example adds two stack notification topics to the specified stack.",
|
||||
"id": "to-update-an-aws-cloudformation-stack-1472841931621",
|
||||
"title": "To update an AWS CloudFormation stack"
|
||||
}
|
||||
],
|
||||
"ValidateTemplate": [
|
||||
{
|
||||
"input": {
|
||||
"TemplateBody": "MyTemplate.json"
|
||||
},
|
||||
"output": {
|
||||
"Capabilities": [
|
||||
|
||||
],
|
||||
"CapabilitiesReason": "",
|
||||
"Description": "AWS CloudFormation Example Template S3_Bucket: An example template that shows how to create a publicly-accessible S3 bucket. IMPORTANT: This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.",
|
||||
"Parameters": [
|
||||
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example validates the specified template.",
|
||||
"id": "to-validate-an-aws-cloudformation-template-1472839072307",
|
||||
"title": "To validate an AWS CloudFormation template"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+27
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"pagination": {
|
||||
"DescribeStackEvents": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "StackEvents"
|
||||
},
|
||||
"DescribeStackResources": {
|
||||
"result_key": "StackResources"
|
||||
},
|
||||
"DescribeStacks": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "Stacks"
|
||||
},
|
||||
"ListStackResources": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "StackResourceSummaries"
|
||||
},
|
||||
"ListStacks": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "StackSummaries"
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+157
@@ -0,0 +1,157 @@
|
||||
{
|
||||
"version": 2,
|
||||
"waiters": {
|
||||
"StackExists": {
|
||||
"delay": 5,
|
||||
"operation": "DescribeStacks",
|
||||
"maxAttempts": 20,
|
||||
"acceptors": [
|
||||
{
|
||||
"matcher": "status",
|
||||
"expected": 200,
|
||||
"state": "success"
|
||||
},
|
||||
{
|
||||
"matcher": "error",
|
||||
"expected": "ValidationError",
|
||||
"state": "retry"
|
||||
}
|
||||
]
|
||||
},
|
||||
"StackCreateComplete": {
|
||||
"delay": 30,
|
||||
"operation": "DescribeStacks",
|
||||
"maxAttempts": 120,
|
||||
"description": "Wait until stack status is CREATE_COMPLETE.",
|
||||
"acceptors": [
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "CREATE_COMPLETE",
|
||||
"matcher": "pathAll",
|
||||
"state": "success"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "CREATE_FAILED",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "DELETE_COMPLETE",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "DELETE_FAILED",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "ROLLBACK_FAILED",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "ROLLBACK_COMPLETE",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"expected": "ValidationError",
|
||||
"matcher": "error",
|
||||
"state": "failure"
|
||||
}
|
||||
]
|
||||
},
|
||||
"StackDeleteComplete": {
|
||||
"delay": 30,
|
||||
"operation": "DescribeStacks",
|
||||
"maxAttempts": 120,
|
||||
"description": "Wait until stack status is DELETE_COMPLETE.",
|
||||
"acceptors": [
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "DELETE_COMPLETE",
|
||||
"matcher": "pathAll",
|
||||
"state": "success"
|
||||
},
|
||||
{
|
||||
"expected": "ValidationError",
|
||||
"matcher": "error",
|
||||
"state": "success"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "DELETE_FAILED",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "CREATE_FAILED",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "ROLLBACK_FAILED",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "UPDATE_ROLLBACK_FAILED",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "UPDATE_ROLLBACK_IN_PROGRESS",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
}
|
||||
]
|
||||
},
|
||||
"StackUpdateComplete": {
|
||||
"delay": 30,
|
||||
"maxAttempts": 120,
|
||||
"operation": "DescribeStacks",
|
||||
"description": "Wait until stack status is UPDATE_COMPLETE.",
|
||||
"acceptors": [
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "UPDATE_COMPLETE",
|
||||
"matcher": "pathAll",
|
||||
"state": "success"
|
||||
},
|
||||
{
|
||||
"expected": "UPDATE_FAILED",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure",
|
||||
"argument": "Stacks[].StackStatus"
|
||||
},
|
||||
{
|
||||
"argument": "Stacks[].StackStatus",
|
||||
"expected": "UPDATE_ROLLBACK_FAILED",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"expected": "UPDATE_ROLLBACK_COMPLETE",
|
||||
"matcher": "pathAny",
|
||||
"state": "failure",
|
||||
"argument": "Stacks[].StackStatus"
|
||||
},
|
||||
{
|
||||
"expected": "ValidationError",
|
||||
"matcher": "error",
|
||||
"state": "failure"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
+2651
File diff suppressed because it is too large
Load Diff
+1141
File diff suppressed because it is too large
Load Diff
Generated
Vendored
+32
@@ -0,0 +1,32 @@
|
||||
{
|
||||
"pagination": {
|
||||
"ListCloudFrontOriginAccessIdentities": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "CloudFrontOriginAccessIdentityList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "CloudFrontOriginAccessIdentityList.IsTruncated",
|
||||
"result_key": "CloudFrontOriginAccessIdentityList.Items"
|
||||
},
|
||||
"ListDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "DistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "DistributionList.IsTruncated",
|
||||
"result_key": "DistributionList.Items"
|
||||
},
|
||||
"ListInvalidations": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "InvalidationList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "InvalidationList.IsTruncated",
|
||||
"result_key": "InvalidationList.Items"
|
||||
},
|
||||
"ListStreamingDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "StreamingDistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "StreamingDistributionList.IsTruncated",
|
||||
"result_key": "StreamingDistributionList.Items"
|
||||
}
|
||||
}
|
||||
}
|
||||
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"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
+2721
File diff suppressed because it is too large
Load Diff
+1164
File diff suppressed because it is too large
Load Diff
Generated
Vendored
+32
@@ -0,0 +1,32 @@
|
||||
{
|
||||
"pagination": {
|
||||
"ListCloudFrontOriginAccessIdentities": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "CloudFrontOriginAccessIdentityList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "CloudFrontOriginAccessIdentityList.IsTruncated",
|
||||
"result_key": "CloudFrontOriginAccessIdentityList.Items"
|
||||
},
|
||||
"ListDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "DistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "DistributionList.IsTruncated",
|
||||
"result_key": "DistributionList.Items"
|
||||
},
|
||||
"ListInvalidations": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "InvalidationList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "InvalidationList.IsTruncated",
|
||||
"result_key": "InvalidationList.Items"
|
||||
},
|
||||
"ListStreamingDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "StreamingDistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "StreamingDistributionList.IsTruncated",
|
||||
"result_key": "StreamingDistributionList.Items"
|
||||
}
|
||||
}
|
||||
}
|
||||
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": "Status"
|
||||
}
|
||||
]
|
||||
},
|
||||
"InvalidationCompleted": {
|
||||
"delay": 20,
|
||||
"operation": "GetInvalidation",
|
||||
"maxAttempts": 30,
|
||||
"description": "Wait until an invalidation has completed.",
|
||||
"acceptors": [
|
||||
{
|
||||
"expected": "Completed",
|
||||
"matcher": "path",
|
||||
"state": "success",
|
||||
"argument": "Status"
|
||||
}
|
||||
]
|
||||
},
|
||||
"StreamingDistributionDeployed": {
|
||||
"delay": 60,
|
||||
"operation": "GetStreamingDistribution",
|
||||
"maxAttempts": 25,
|
||||
"description": "Wait until a streaming distribution is deployed.",
|
||||
"acceptors": [
|
||||
{
|
||||
"expected": "Deployed",
|
||||
"matcher": "path",
|
||||
"state": "success",
|
||||
"argument": "Status"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
+2150
File diff suppressed because it is too large
Load Diff
+1173
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",
|
||||
"output_token": "CloudFrontOriginAccessIdentityList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "CloudFrontOriginAccessIdentityList.IsTruncated",
|
||||
"result_key": "CloudFrontOriginAccessIdentityList.Items"
|
||||
},
|
||||
"ListDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "DistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "DistributionList.IsTruncated",
|
||||
"result_key": "DistributionList.Items"
|
||||
},
|
||||
"ListInvalidations": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "InvalidationList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "InvalidationList.IsTruncated",
|
||||
"result_key": "InvalidationList.Items"
|
||||
},
|
||||
"ListStreamingDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "StreamingDistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "StreamingDistributionList.IsTruncated",
|
||||
"result_key": "StreamingDistributionList.Items"
|
||||
}
|
||||
}
|
||||
}
|
||||
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": "Status"
|
||||
}
|
||||
]
|
||||
},
|
||||
"InvalidationCompleted": {
|
||||
"delay": 20,
|
||||
"operation": "GetInvalidation",
|
||||
"maxAttempts": 30,
|
||||
"description": "Wait until an invalidation has completed.",
|
||||
"acceptors": [
|
||||
{
|
||||
"expected": "Completed",
|
||||
"matcher": "path",
|
||||
"state": "success",
|
||||
"argument": "Status"
|
||||
}
|
||||
]
|
||||
},
|
||||
"StreamingDistributionDeployed": {
|
||||
"delay": 60,
|
||||
"operation": "GetStreamingDistribution",
|
||||
"maxAttempts": 25,
|
||||
"description": "Wait until a streaming distribution is deployed.",
|
||||
"acceptors": [
|
||||
{
|
||||
"expected": "Deployed",
|
||||
"matcher": "path",
|
||||
"state": "success",
|
||||
"argument": "Status"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
+2216
File diff suppressed because it is too large
Load Diff
+1219
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",
|
||||
"output_token": "CloudFrontOriginAccessIdentityList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "CloudFrontOriginAccessIdentityList.IsTruncated",
|
||||
"result_key": "CloudFrontOriginAccessIdentityList.Items"
|
||||
},
|
||||
"ListDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "DistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "DistributionList.IsTruncated",
|
||||
"result_key": "DistributionList.Items"
|
||||
},
|
||||
"ListInvalidations": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "InvalidationList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "InvalidationList.IsTruncated",
|
||||
"result_key": "InvalidationList.Items"
|
||||
},
|
||||
"ListStreamingDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "StreamingDistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "StreamingDistributionList.IsTruncated",
|
||||
"result_key": "StreamingDistributionList.Items"
|
||||
}
|
||||
}
|
||||
}
|
||||
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": "Status"
|
||||
}
|
||||
]
|
||||
},
|
||||
"InvalidationCompleted": {
|
||||
"delay": 20,
|
||||
"operation": "GetInvalidation",
|
||||
"maxAttempts": 30,
|
||||
"description": "Wait until an invalidation has completed.",
|
||||
"acceptors": [
|
||||
{
|
||||
"expected": "Completed",
|
||||
"matcher": "path",
|
||||
"state": "success",
|
||||
"argument": "Status"
|
||||
}
|
||||
]
|
||||
},
|
||||
"StreamingDistributionDeployed": {
|
||||
"delay": 60,
|
||||
"operation": "GetStreamingDistribution",
|
||||
"maxAttempts": 25,
|
||||
"description": "Wait until a streaming distribution is deployed.",
|
||||
"acceptors": [
|
||||
{
|
||||
"expected": "Deployed",
|
||||
"matcher": "path",
|
||||
"state": "success",
|
||||
"argument": "Status"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
+2219
File diff suppressed because it is too large
Load Diff
+1220
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",
|
||||
"output_token": "CloudFrontOriginAccessIdentityList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "CloudFrontOriginAccessIdentityList.IsTruncated",
|
||||
"result_key": "CloudFrontOriginAccessIdentityList.Items"
|
||||
},
|
||||
"ListDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "DistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "DistributionList.IsTruncated",
|
||||
"result_key": "DistributionList.Items"
|
||||
},
|
||||
"ListInvalidations": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "InvalidationList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "InvalidationList.IsTruncated",
|
||||
"result_key": "InvalidationList.Items"
|
||||
},
|
||||
"ListStreamingDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "StreamingDistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "StreamingDistributionList.IsTruncated",
|
||||
"result_key": "StreamingDistributionList.Items"
|
||||
}
|
||||
}
|
||||
}
|
||||
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"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
+2548
File diff suppressed because it is too large
Load Diff
+1355
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",
|
||||
"output_token": "CloudFrontOriginAccessIdentityList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "CloudFrontOriginAccessIdentityList.IsTruncated",
|
||||
"result_key": "CloudFrontOriginAccessIdentityList.Items"
|
||||
},
|
||||
"ListDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "DistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "DistributionList.IsTruncated",
|
||||
"result_key": "DistributionList.Items"
|
||||
},
|
||||
"ListInvalidations": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "InvalidationList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "InvalidationList.IsTruncated",
|
||||
"result_key": "InvalidationList.Items"
|
||||
},
|
||||
"ListStreamingDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "StreamingDistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "StreamingDistributionList.IsTruncated",
|
||||
"result_key": "StreamingDistributionList.Items"
|
||||
}
|
||||
}
|
||||
}
|
||||
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"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
Executable
+2586
File diff suppressed because it is too large
Load Diff
Generated
Vendored
Executable
+1381
File diff suppressed because it is too large
Load Diff
Generated
Vendored
Executable
+32
@@ -0,0 +1,32 @@
|
||||
{
|
||||
"pagination": {
|
||||
"ListCloudFrontOriginAccessIdentities": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "CloudFrontOriginAccessIdentityList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "CloudFrontOriginAccessIdentityList.IsTruncated",
|
||||
"result_key": "CloudFrontOriginAccessIdentityList.Items"
|
||||
},
|
||||
"ListDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "DistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "DistributionList.IsTruncated",
|
||||
"result_key": "DistributionList.Items"
|
||||
},
|
||||
"ListInvalidations": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "InvalidationList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "InvalidationList.IsTruncated",
|
||||
"result_key": "InvalidationList.Items"
|
||||
},
|
||||
"ListStreamingDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "StreamingDistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "StreamingDistributionList.IsTruncated",
|
||||
"result_key": "StreamingDistributionList.Items"
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
Executable
+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"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
Executable
+2596
File diff suppressed because it is too large
Load Diff
Generated
Vendored
Executable
+1388
File diff suppressed because it is too large
Load Diff
Generated
Vendored
Executable
+5
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
Generated
Vendored
Executable
+32
@@ -0,0 +1,32 @@
|
||||
{
|
||||
"pagination": {
|
||||
"ListCloudFrontOriginAccessIdentities": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "CloudFrontOriginAccessIdentityList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "CloudFrontOriginAccessIdentityList.IsTruncated",
|
||||
"result_key": "CloudFrontOriginAccessIdentityList.Items"
|
||||
},
|
||||
"ListDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "DistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "DistributionList.IsTruncated",
|
||||
"result_key": "DistributionList.Items"
|
||||
},
|
||||
"ListInvalidations": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "InvalidationList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "InvalidationList.IsTruncated",
|
||||
"result_key": "InvalidationList.Items"
|
||||
},
|
||||
"ListStreamingDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "StreamingDistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "StreamingDistributionList.IsTruncated",
|
||||
"result_key": "StreamingDistributionList.Items"
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
Executable
+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"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
+2599
File diff suppressed because it is too large
Load Diff
+1390
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",
|
||||
"output_token": "CloudFrontOriginAccessIdentityList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "CloudFrontOriginAccessIdentityList.IsTruncated",
|
||||
"result_key": "CloudFrontOriginAccessIdentityList.Items"
|
||||
},
|
||||
"ListDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "DistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "DistributionList.IsTruncated",
|
||||
"result_key": "DistributionList.Items"
|
||||
},
|
||||
"ListInvalidations": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "InvalidationList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "InvalidationList.IsTruncated",
|
||||
"result_key": "InvalidationList.Items"
|
||||
},
|
||||
"ListStreamingDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "StreamingDistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "StreamingDistributionList.IsTruncated",
|
||||
"result_key": "StreamingDistributionList.Items"
|
||||
}
|
||||
}
|
||||
}
|
||||
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"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
+2665
File diff suppressed because it is too large
Load Diff
+1435
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",
|
||||
"output_token": "CloudFrontOriginAccessIdentityList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "CloudFrontOriginAccessIdentityList.IsTruncated",
|
||||
"result_key": "CloudFrontOriginAccessIdentityList.Items"
|
||||
},
|
||||
"ListDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "DistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "DistributionList.IsTruncated",
|
||||
"result_key": "DistributionList.Items"
|
||||
},
|
||||
"ListInvalidations": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "InvalidationList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "InvalidationList.IsTruncated",
|
||||
"result_key": "InvalidationList.Items"
|
||||
},
|
||||
"ListStreamingDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "StreamingDistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "StreamingDistributionList.IsTruncated",
|
||||
"result_key": "StreamingDistributionList.Items"
|
||||
}
|
||||
}
|
||||
}
|
||||
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"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
+878
@@ -0,0 +1,878 @@
|
||||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"apiVersion":"2014-05-30",
|
||||
"endpointPrefix":"cloudhsm",
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceAbbreviation":"CloudHSM",
|
||||
"serviceFullName":"Amazon CloudHSM",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"CloudHsmFrontendService",
|
||||
"uid":"cloudhsm-2014-05-30"
|
||||
},
|
||||
"operations":{
|
||||
"AddTagsToResource":{
|
||||
"name":"AddTagsToResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"AddTagsToResourceRequest"},
|
||||
"output":{"shape":"AddTagsToResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"},
|
||||
{"shape":"CloudHsmInternalException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"CreateHapg":{
|
||||
"name":"CreateHapg",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateHapgRequest"},
|
||||
"output":{"shape":"CreateHapgResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"},
|
||||
{"shape":"CloudHsmInternalException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"CreateHsm":{
|
||||
"name":"CreateHsm",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateHsmRequest"},
|
||||
"output":{"shape":"CreateHsmResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"},
|
||||
{"shape":"CloudHsmInternalException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"CreateLunaClient":{
|
||||
"name":"CreateLunaClient",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateLunaClientRequest"},
|
||||
"output":{"shape":"CreateLunaClientResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"},
|
||||
{"shape":"CloudHsmInternalException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"DeleteHapg":{
|
||||
"name":"DeleteHapg",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteHapgRequest"},
|
||||
"output":{"shape":"DeleteHapgResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"},
|
||||
{"shape":"CloudHsmInternalException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"DeleteHsm":{
|
||||
"name":"DeleteHsm",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteHsmRequest"},
|
||||
"output":{"shape":"DeleteHsmResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"},
|
||||
{"shape":"CloudHsmInternalException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"DeleteLunaClient":{
|
||||
"name":"DeleteLunaClient",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteLunaClientRequest"},
|
||||
"output":{"shape":"DeleteLunaClientResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"},
|
||||
{"shape":"CloudHsmInternalException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"DescribeHapg":{
|
||||
"name":"DescribeHapg",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeHapgRequest"},
|
||||
"output":{"shape":"DescribeHapgResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"},
|
||||
{"shape":"CloudHsmInternalException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"DescribeHsm":{
|
||||
"name":"DescribeHsm",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeHsmRequest"},
|
||||
"output":{"shape":"DescribeHsmResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"},
|
||||
{"shape":"CloudHsmInternalException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"DescribeLunaClient":{
|
||||
"name":"DescribeLunaClient",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeLunaClientRequest"},
|
||||
"output":{"shape":"DescribeLunaClientResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"},
|
||||
{"shape":"CloudHsmInternalException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"GetConfig":{
|
||||
"name":"GetConfig",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetConfigRequest"},
|
||||
"output":{"shape":"GetConfigResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"},
|
||||
{"shape":"CloudHsmInternalException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"ListAvailableZones":{
|
||||
"name":"ListAvailableZones",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListAvailableZonesRequest"},
|
||||
"output":{"shape":"ListAvailableZonesResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"},
|
||||
{"shape":"CloudHsmInternalException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"ListHapgs":{
|
||||
"name":"ListHapgs",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListHapgsRequest"},
|
||||
"output":{"shape":"ListHapgsResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"},
|
||||
{"shape":"CloudHsmInternalException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"ListHsms":{
|
||||
"name":"ListHsms",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListHsmsRequest"},
|
||||
"output":{"shape":"ListHsmsResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"},
|
||||
{"shape":"CloudHsmInternalException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"ListLunaClients":{
|
||||
"name":"ListLunaClients",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListLunaClientsRequest"},
|
||||
"output":{"shape":"ListLunaClientsResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"},
|
||||
{"shape":"CloudHsmInternalException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"ListTagsForResource":{
|
||||
"name":"ListTagsForResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListTagsForResourceRequest"},
|
||||
"output":{"shape":"ListTagsForResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"},
|
||||
{"shape":"CloudHsmInternalException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"ModifyHapg":{
|
||||
"name":"ModifyHapg",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ModifyHapgRequest"},
|
||||
"output":{"shape":"ModifyHapgResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"},
|
||||
{"shape":"CloudHsmInternalException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"ModifyHsm":{
|
||||
"name":"ModifyHsm",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ModifyHsmRequest"},
|
||||
"output":{"shape":"ModifyHsmResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"},
|
||||
{"shape":"CloudHsmInternalException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"ModifyLunaClient":{
|
||||
"name":"ModifyLunaClient",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ModifyLunaClientRequest"},
|
||||
"output":{"shape":"ModifyLunaClientResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"}
|
||||
]
|
||||
},
|
||||
"RemoveTagsFromResource":{
|
||||
"name":"RemoveTagsFromResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"RemoveTagsFromResourceRequest"},
|
||||
"output":{"shape":"RemoveTagsFromResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"CloudHsmServiceException"},
|
||||
{"shape":"CloudHsmInternalException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AZ":{
|
||||
"type":"string",
|
||||
"pattern":"[a-zA-Z0-9\\-]*"
|
||||
},
|
||||
"AZList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AZ"}
|
||||
},
|
||||
"AddTagsToResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResourceArn",
|
||||
"TagList"
|
||||
],
|
||||
"members":{
|
||||
"ResourceArn":{"shape":"String"},
|
||||
"TagList":{"shape":"TagList"}
|
||||
}
|
||||
},
|
||||
"AddTagsToResourceResponse":{
|
||||
"type":"structure",
|
||||
"required":["Status"],
|
||||
"members":{
|
||||
"Status":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"Boolean":{"type":"boolean"},
|
||||
"Certificate":{
|
||||
"type":"string",
|
||||
"max":2400,
|
||||
"min":600,
|
||||
"pattern":"[\\w :+=./\\n-]*"
|
||||
},
|
||||
"CertificateFingerprint":{
|
||||
"type":"string",
|
||||
"pattern":"([0-9a-fA-F][0-9a-fA-F]:){15}[0-9a-fA-F][0-9a-fA-F]"
|
||||
},
|
||||
"ClientArn":{
|
||||
"type":"string",
|
||||
"pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:client-[0-9a-f]{8}"
|
||||
},
|
||||
"ClientLabel":{
|
||||
"type":"string",
|
||||
"pattern":"[a-zA-Z0-9_.-]{2,64}"
|
||||
},
|
||||
"ClientList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ClientArn"}
|
||||
},
|
||||
"ClientToken":{
|
||||
"type":"string",
|
||||
"pattern":"[a-zA-Z0-9]{1,64}"
|
||||
},
|
||||
"ClientVersion":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"5.1",
|
||||
"5.3"
|
||||
]
|
||||
},
|
||||
"CloudHsmInternalException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true,
|
||||
"fault":true
|
||||
},
|
||||
"CloudHsmObjectState":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"READY",
|
||||
"UPDATING",
|
||||
"DEGRADED"
|
||||
]
|
||||
},
|
||||
"CloudHsmServiceException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"String"},
|
||||
"retryable":{"shape":"Boolean"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"CreateHapgRequest":{
|
||||
"type":"structure",
|
||||
"required":["Label"],
|
||||
"members":{
|
||||
"Label":{"shape":"Label"}
|
||||
}
|
||||
},
|
||||
"CreateHapgResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"HapgArn":{"shape":"HapgArn"}
|
||||
}
|
||||
},
|
||||
"CreateHsmRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"SubnetId",
|
||||
"SshKey",
|
||||
"IamRoleArn",
|
||||
"SubscriptionType"
|
||||
],
|
||||
"members":{
|
||||
"SubnetId":{
|
||||
"shape":"SubnetId",
|
||||
"locationName":"SubnetId"
|
||||
},
|
||||
"SshKey":{
|
||||
"shape":"SshKey",
|
||||
"locationName":"SshKey"
|
||||
},
|
||||
"EniIp":{
|
||||
"shape":"IpAddress",
|
||||
"locationName":"EniIp"
|
||||
},
|
||||
"IamRoleArn":{
|
||||
"shape":"IamRoleArn",
|
||||
"locationName":"IamRoleArn"
|
||||
},
|
||||
"ExternalId":{
|
||||
"shape":"ExternalId",
|
||||
"locationName":"ExternalId"
|
||||
},
|
||||
"SubscriptionType":{
|
||||
"shape":"SubscriptionType",
|
||||
"locationName":"SubscriptionType"
|
||||
},
|
||||
"ClientToken":{
|
||||
"shape":"ClientToken",
|
||||
"locationName":"ClientToken"
|
||||
},
|
||||
"SyslogIp":{
|
||||
"shape":"IpAddress",
|
||||
"locationName":"SyslogIp"
|
||||
}
|
||||
},
|
||||
"locationName":"CreateHsmRequest"
|
||||
},
|
||||
"CreateHsmResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"HsmArn":{"shape":"HsmArn"}
|
||||
}
|
||||
},
|
||||
"CreateLunaClientRequest":{
|
||||
"type":"structure",
|
||||
"required":["Certificate"],
|
||||
"members":{
|
||||
"Label":{"shape":"ClientLabel"},
|
||||
"Certificate":{"shape":"Certificate"}
|
||||
}
|
||||
},
|
||||
"CreateLunaClientResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ClientArn":{"shape":"ClientArn"}
|
||||
}
|
||||
},
|
||||
"DeleteHapgRequest":{
|
||||
"type":"structure",
|
||||
"required":["HapgArn"],
|
||||
"members":{
|
||||
"HapgArn":{"shape":"HapgArn"}
|
||||
}
|
||||
},
|
||||
"DeleteHapgResponse":{
|
||||
"type":"structure",
|
||||
"required":["Status"],
|
||||
"members":{
|
||||
"Status":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DeleteHsmRequest":{
|
||||
"type":"structure",
|
||||
"required":["HsmArn"],
|
||||
"members":{
|
||||
"HsmArn":{
|
||||
"shape":"HsmArn",
|
||||
"locationName":"HsmArn"
|
||||
}
|
||||
},
|
||||
"locationName":"DeleteHsmRequest"
|
||||
},
|
||||
"DeleteHsmResponse":{
|
||||
"type":"structure",
|
||||
"required":["Status"],
|
||||
"members":{
|
||||
"Status":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DeleteLunaClientRequest":{
|
||||
"type":"structure",
|
||||
"required":["ClientArn"],
|
||||
"members":{
|
||||
"ClientArn":{"shape":"ClientArn"}
|
||||
}
|
||||
},
|
||||
"DeleteLunaClientResponse":{
|
||||
"type":"structure",
|
||||
"required":["Status"],
|
||||
"members":{
|
||||
"Status":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DescribeHapgRequest":{
|
||||
"type":"structure",
|
||||
"required":["HapgArn"],
|
||||
"members":{
|
||||
"HapgArn":{"shape":"HapgArn"}
|
||||
}
|
||||
},
|
||||
"DescribeHapgResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"HapgArn":{"shape":"HapgArn"},
|
||||
"HapgSerial":{"shape":"String"},
|
||||
"HsmsLastActionFailed":{"shape":"HsmList"},
|
||||
"HsmsPendingDeletion":{"shape":"HsmList"},
|
||||
"HsmsPendingRegistration":{"shape":"HsmList"},
|
||||
"Label":{"shape":"Label"},
|
||||
"LastModifiedTimestamp":{"shape":"Timestamp"},
|
||||
"PartitionSerialList":{"shape":"PartitionSerialList"},
|
||||
"State":{"shape":"CloudHsmObjectState"}
|
||||
}
|
||||
},
|
||||
"DescribeHsmRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"HsmArn":{"shape":"HsmArn"},
|
||||
"HsmSerialNumber":{"shape":"HsmSerialNumber"}
|
||||
}
|
||||
},
|
||||
"DescribeHsmResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"HsmArn":{"shape":"HsmArn"},
|
||||
"Status":{"shape":"HsmStatus"},
|
||||
"StatusDetails":{"shape":"String"},
|
||||
"AvailabilityZone":{"shape":"AZ"},
|
||||
"EniId":{"shape":"EniId"},
|
||||
"EniIp":{"shape":"IpAddress"},
|
||||
"SubscriptionType":{"shape":"SubscriptionType"},
|
||||
"SubscriptionStartDate":{"shape":"Timestamp"},
|
||||
"SubscriptionEndDate":{"shape":"Timestamp"},
|
||||
"VpcId":{"shape":"VpcId"},
|
||||
"SubnetId":{"shape":"SubnetId"},
|
||||
"IamRoleArn":{"shape":"IamRoleArn"},
|
||||
"SerialNumber":{"shape":"HsmSerialNumber"},
|
||||
"VendorName":{"shape":"String"},
|
||||
"HsmType":{"shape":"String"},
|
||||
"SoftwareVersion":{"shape":"String"},
|
||||
"SshPublicKey":{"shape":"SshKey"},
|
||||
"SshKeyLastUpdated":{"shape":"Timestamp"},
|
||||
"ServerCertUri":{"shape":"String"},
|
||||
"ServerCertLastUpdated":{"shape":"Timestamp"},
|
||||
"Partitions":{"shape":"PartitionList"}
|
||||
}
|
||||
},
|
||||
"DescribeLunaClientRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ClientArn":{"shape":"ClientArn"},
|
||||
"CertificateFingerprint":{"shape":"CertificateFingerprint"}
|
||||
}
|
||||
},
|
||||
"DescribeLunaClientResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ClientArn":{"shape":"ClientArn"},
|
||||
"Certificate":{"shape":"Certificate"},
|
||||
"CertificateFingerprint":{"shape":"CertificateFingerprint"},
|
||||
"LastModifiedTimestamp":{"shape":"Timestamp"},
|
||||
"Label":{"shape":"Label"}
|
||||
}
|
||||
},
|
||||
"EniId":{
|
||||
"type":"string",
|
||||
"pattern":"eni-[0-9a-f]{8}"
|
||||
},
|
||||
"ExternalId":{
|
||||
"type":"string",
|
||||
"pattern":"[\\w :+=./-]*"
|
||||
},
|
||||
"GetConfigRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ClientArn",
|
||||
"ClientVersion",
|
||||
"HapgList"
|
||||
],
|
||||
"members":{
|
||||
"ClientArn":{"shape":"ClientArn"},
|
||||
"ClientVersion":{"shape":"ClientVersion"},
|
||||
"HapgList":{"shape":"HapgList"}
|
||||
}
|
||||
},
|
||||
"GetConfigResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ConfigType":{"shape":"String"},
|
||||
"ConfigFile":{"shape":"String"},
|
||||
"ConfigCred":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"HapgArn":{
|
||||
"type":"string",
|
||||
"pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hapg-[0-9a-f]{8}"
|
||||
},
|
||||
"HapgList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"HapgArn"}
|
||||
},
|
||||
"HsmArn":{
|
||||
"type":"string",
|
||||
"pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hsm-[0-9a-f]{8}"
|
||||
},
|
||||
"HsmList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"HsmArn"}
|
||||
},
|
||||
"HsmSerialNumber":{
|
||||
"type":"string",
|
||||
"pattern":"\\d{1,16}"
|
||||
},
|
||||
"HsmStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"PENDING",
|
||||
"RUNNING",
|
||||
"UPDATING",
|
||||
"SUSPENDED",
|
||||
"TERMINATING",
|
||||
"TERMINATED",
|
||||
"DEGRADED"
|
||||
]
|
||||
},
|
||||
"IamRoleArn":{
|
||||
"type":"string",
|
||||
"pattern":"arn:aws(-iso)?:iam::[0-9]{12}:role/[a-zA-Z0-9_\\+=,\\.\\-@]{1,64}"
|
||||
},
|
||||
"InvalidRequestException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"IpAddress":{
|
||||
"type":"string",
|
||||
"pattern":"\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}"
|
||||
},
|
||||
"Label":{
|
||||
"type":"string",
|
||||
"pattern":"[a-zA-Z0-9_.-]{1,64}"
|
||||
},
|
||||
"ListAvailableZonesRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"ListAvailableZonesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AZList":{"shape":"AZList"}
|
||||
}
|
||||
},
|
||||
"ListHapgsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListHapgsResponse":{
|
||||
"type":"structure",
|
||||
"required":["HapgList"],
|
||||
"members":{
|
||||
"HapgList":{"shape":"HapgList"},
|
||||
"NextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListHsmsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListHsmsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"HsmList":{"shape":"HsmList"},
|
||||
"NextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListLunaClientsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListLunaClientsResponse":{
|
||||
"type":"structure",
|
||||
"required":["ClientList"],
|
||||
"members":{
|
||||
"ClientList":{"shape":"ClientList"},
|
||||
"NextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":["ResourceArn"],
|
||||
"members":{
|
||||
"ResourceArn":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceResponse":{
|
||||
"type":"structure",
|
||||
"required":["TagList"],
|
||||
"members":{
|
||||
"TagList":{"shape":"TagList"}
|
||||
}
|
||||
},
|
||||
"ModifyHapgRequest":{
|
||||
"type":"structure",
|
||||
"required":["HapgArn"],
|
||||
"members":{
|
||||
"HapgArn":{"shape":"HapgArn"},
|
||||
"Label":{"shape":"Label"},
|
||||
"PartitionSerialList":{"shape":"PartitionSerialList"}
|
||||
}
|
||||
},
|
||||
"ModifyHapgResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"HapgArn":{"shape":"HapgArn"}
|
||||
}
|
||||
},
|
||||
"ModifyHsmRequest":{
|
||||
"type":"structure",
|
||||
"required":["HsmArn"],
|
||||
"members":{
|
||||
"HsmArn":{
|
||||
"shape":"HsmArn",
|
||||
"locationName":"HsmArn"
|
||||
},
|
||||
"SubnetId":{
|
||||
"shape":"SubnetId",
|
||||
"locationName":"SubnetId"
|
||||
},
|
||||
"EniIp":{
|
||||
"shape":"IpAddress",
|
||||
"locationName":"EniIp"
|
||||
},
|
||||
"IamRoleArn":{
|
||||
"shape":"IamRoleArn",
|
||||
"locationName":"IamRoleArn"
|
||||
},
|
||||
"ExternalId":{
|
||||
"shape":"ExternalId",
|
||||
"locationName":"ExternalId"
|
||||
},
|
||||
"SyslogIp":{
|
||||
"shape":"IpAddress",
|
||||
"locationName":"SyslogIp"
|
||||
}
|
||||
},
|
||||
"locationName":"ModifyHsmRequest"
|
||||
},
|
||||
"ModifyHsmResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"HsmArn":{"shape":"HsmArn"}
|
||||
}
|
||||
},
|
||||
"ModifyLunaClientRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ClientArn",
|
||||
"Certificate"
|
||||
],
|
||||
"members":{
|
||||
"ClientArn":{"shape":"ClientArn"},
|
||||
"Certificate":{"shape":"Certificate"}
|
||||
}
|
||||
},
|
||||
"ModifyLunaClientResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ClientArn":{"shape":"ClientArn"}
|
||||
}
|
||||
},
|
||||
"PaginationToken":{
|
||||
"type":"string",
|
||||
"pattern":"[a-zA-Z0-9+/]*"
|
||||
},
|
||||
"PartitionArn":{
|
||||
"type":"string",
|
||||
"pattern":"arn:aws(-iso)?:cloudhsm:[a-zA-Z0-9\\-]*:[0-9]{12}:hsm-[0-9a-f]{8}/partition-[0-9]{6,12}"
|
||||
},
|
||||
"PartitionList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"PartitionArn"}
|
||||
},
|
||||
"PartitionSerial":{
|
||||
"type":"string",
|
||||
"pattern":"\\d{6,12}"
|
||||
},
|
||||
"PartitionSerialList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"PartitionSerial"}
|
||||
},
|
||||
"RemoveTagsFromResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResourceArn",
|
||||
"TagKeyList"
|
||||
],
|
||||
"members":{
|
||||
"ResourceArn":{"shape":"String"},
|
||||
"TagKeyList":{"shape":"TagKeyList"}
|
||||
}
|
||||
},
|
||||
"RemoveTagsFromResourceResponse":{
|
||||
"type":"structure",
|
||||
"required":["Status"],
|
||||
"members":{
|
||||
"Status":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"SshKey":{
|
||||
"type":"string",
|
||||
"pattern":"[a-zA-Z0-9+/= ._:\\\\@-]*"
|
||||
},
|
||||
"String":{
|
||||
"type":"string",
|
||||
"pattern":"[\\w :+=./\\\\-]*"
|
||||
},
|
||||
"SubnetId":{
|
||||
"type":"string",
|
||||
"pattern":"subnet-[0-9a-f]{8}"
|
||||
},
|
||||
"SubscriptionType":{
|
||||
"type":"string",
|
||||
"enum":["PRODUCTION"]
|
||||
},
|
||||
"Tag":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Key",
|
||||
"Value"
|
||||
],
|
||||
"members":{
|
||||
"Key":{"shape":"TagKey"},
|
||||
"Value":{"shape":"TagValue"}
|
||||
}
|
||||
},
|
||||
"TagKey":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":1
|
||||
},
|
||||
"TagKeyList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"TagKey"}
|
||||
},
|
||||
"TagList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Tag"}
|
||||
},
|
||||
"TagValue":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":0
|
||||
},
|
||||
"Timestamp":{
|
||||
"type":"string",
|
||||
"pattern":"\\d*"
|
||||
},
|
||||
"VpcId":{
|
||||
"type":"string",
|
||||
"pattern":"vpc-[0-9a-f]{8}"
|
||||
}
|
||||
}
|
||||
}
|
||||
+543
@@ -0,0 +1,543 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<fullname>AWS CloudHSM Service</fullname>",
|
||||
"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>"
|
||||
},
|
||||
"shapes": {
|
||||
"AZ": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AZList$member": null,
|
||||
"DescribeHsmResponse$AvailabilityZone": "<p>The Availability Zone that the HSM is in.</p>"
|
||||
}
|
||||
},
|
||||
"AZList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListAvailableZonesResponse$AZList": "<p>The list of Availability Zones that have available AWS CloudHSM capacity.</p>"
|
||||
}
|
||||
},
|
||||
"AddTagsToResourceRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"AddTagsToResourceResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Boolean": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CloudHsmServiceException$retryable": "<p>Indicates if the action can be retried.</p>"
|
||||
}
|
||||
},
|
||||
"Certificate": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateLunaClientRequest$Certificate": "<p>The contents of a Base64-Encoded X.509 v3 certificate to be installed on the HSMs used by this client.</p>",
|
||||
"DescribeLunaClientResponse$Certificate": "<p>The certificate installed on the HSMs used by this client.</p>",
|
||||
"ModifyLunaClientRequest$Certificate": "<p>The new certificate for the client.</p>"
|
||||
}
|
||||
},
|
||||
"CertificateFingerprint": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeLunaClientRequest$CertificateFingerprint": "<p>The certificate fingerprint.</p>",
|
||||
"DescribeLunaClientResponse$CertificateFingerprint": "<p>The certificate fingerprint.</p>"
|
||||
}
|
||||
},
|
||||
"ClientArn": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ClientList$member": null,
|
||||
"CreateLunaClientResponse$ClientArn": "<p>The ARN of the client.</p>",
|
||||
"DeleteLunaClientRequest$ClientArn": "<p>The ARN of the client to delete.</p>",
|
||||
"DescribeLunaClientRequest$ClientArn": "<p>The ARN of the client.</p>",
|
||||
"DescribeLunaClientResponse$ClientArn": "<p>The ARN of the client.</p>",
|
||||
"GetConfigRequest$ClientArn": "<p>The ARN of the client.</p>",
|
||||
"ModifyLunaClientRequest$ClientArn": "<p>The ARN of the client.</p>",
|
||||
"ModifyLunaClientResponse$ClientArn": "<p>The ARN of the client.</p>"
|
||||
}
|
||||
},
|
||||
"ClientLabel": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateLunaClientRequest$Label": "<p>The label for the client.</p>"
|
||||
}
|
||||
},
|
||||
"ClientList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListLunaClientsResponse$ClientList": "<p>The list of clients.</p>"
|
||||
}
|
||||
},
|
||||
"ClientToken": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateHsmRequest$ClientToken": "<p>A user-defined token to ensure idempotence. Subsequent calls to this operation with the same token will be ignored.</p>"
|
||||
}
|
||||
},
|
||||
"ClientVersion": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetConfigRequest$ClientVersion": "<p>The client version.</p>"
|
||||
}
|
||||
},
|
||||
"CloudHsmInternalException": {
|
||||
"base": "<p>Indicates that an internal error occurred.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CloudHsmObjectState": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeHapgResponse$State": "<p>The state of the high-availability partition group.</p>"
|
||||
}
|
||||
},
|
||||
"CloudHsmServiceException": {
|
||||
"base": "<p>Indicates that an exception occurred in the AWS CloudHSM service.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateHapgRequest": {
|
||||
"base": "<p>Contains the inputs for the <a>CreateHapgRequest</a> action.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateHapgResponse": {
|
||||
"base": "<p>Contains the output of the <a>CreateHAPartitionGroup</a> action.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateHsmRequest": {
|
||||
"base": "<p>Contains the inputs for the <a>CreateHsm</a> operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateHsmResponse": {
|
||||
"base": "<p>Contains the output of the <a>CreateHsm</a> operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateLunaClientRequest": {
|
||||
"base": "<p>Contains the inputs for the <a>CreateLunaClient</a> action.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateLunaClientResponse": {
|
||||
"base": "<p>Contains the output of the <a>CreateLunaClient</a> action.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteHapgRequest": {
|
||||
"base": "<p>Contains the inputs for the <a>DeleteHapg</a> action.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteHapgResponse": {
|
||||
"base": "<p>Contains the output of the <a>DeleteHapg</a> action.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteHsmRequest": {
|
||||
"base": "<p>Contains the inputs for the <a>DeleteHsm</a> operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteHsmResponse": {
|
||||
"base": "<p>Contains the output of the <a>DeleteHsm</a> operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteLunaClientRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteLunaClientResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeHapgRequest": {
|
||||
"base": "<p>Contains the inputs for the <a>DescribeHapg</a> action.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeHapgResponse": {
|
||||
"base": "<p>Contains the output of the <a>DescribeHapg</a> action.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeHsmRequest": {
|
||||
"base": "<p>Contains the inputs for the <a>DescribeHsm</a> operation. </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeHsmResponse": {
|
||||
"base": "<p>Contains the output of the <a>DescribeHsm</a> operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeLunaClientRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeLunaClientResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"EniId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeHsmResponse$EniId": "<p>The identifier of the elastic network interface (ENI) attached to the HSM.</p>"
|
||||
}
|
||||
},
|
||||
"ExternalId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateHsmRequest$ExternalId": "<p>The external ID from <b>IamRoleArn</b>, if present.</p>",
|
||||
"ModifyHsmRequest$ExternalId": "<p>The new external ID.</p>"
|
||||
}
|
||||
},
|
||||
"GetConfigRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetConfigResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"HapgArn": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateHapgResponse$HapgArn": "<p>The ARN of the high-availability partition group.</p>",
|
||||
"DeleteHapgRequest$HapgArn": "<p>The ARN of the high-availability partition group to delete.</p>",
|
||||
"DescribeHapgRequest$HapgArn": "<p>The ARN of the high-availability partition group to describe.</p>",
|
||||
"DescribeHapgResponse$HapgArn": "<p>The ARN of the high-availability partition group.</p>",
|
||||
"HapgList$member": null,
|
||||
"ModifyHapgRequest$HapgArn": "<p>The ARN of the high-availability partition group to modify.</p>",
|
||||
"ModifyHapgResponse$HapgArn": "<p>The ARN of the high-availability partition group.</p>"
|
||||
}
|
||||
},
|
||||
"HapgList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetConfigRequest$HapgList": "<p>A list of ARNs that identify the high-availability partition groups that are associated with the client.</p>",
|
||||
"ListHapgsResponse$HapgList": "<p>The list of high-availability partition groups.</p>"
|
||||
}
|
||||
},
|
||||
"HsmArn": {
|
||||
"base": "<p>An ARN that identifies an HSM.</p>",
|
||||
"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>",
|
||||
"DescribeHsmResponse$HsmArn": "<p>The ARN of the HSM.</p>",
|
||||
"HsmList$member": null,
|
||||
"ModifyHsmRequest$HsmArn": "<p>The ARN of the HSM to modify.</p>",
|
||||
"ModifyHsmResponse$HsmArn": "<p>The ARN of the HSM.</p>"
|
||||
}
|
||||
},
|
||||
"HsmList": {
|
||||
"base": "<p>Contains a list of ARNs that identify the HSMs.</p>",
|
||||
"refs": {
|
||||
"DescribeHapgResponse$HsmsLastActionFailed": null,
|
||||
"DescribeHapgResponse$HsmsPendingDeletion": null,
|
||||
"DescribeHapgResponse$HsmsPendingRegistration": null,
|
||||
"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>",
|
||||
"DescribeHsmResponse$SerialNumber": "<p>The serial number of the HSM.</p>"
|
||||
}
|
||||
},
|
||||
"HsmStatus": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeHsmResponse$Status": "<p>The status of the HSM.</p>"
|
||||
}
|
||||
},
|
||||
"IamRoleArn": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateHsmRequest$IamRoleArn": "<p>The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on your behalf.</p>",
|
||||
"DescribeHsmResponse$IamRoleArn": "<p>The ARN of the IAM role assigned to the HSM.</p>",
|
||||
"ModifyHsmRequest$IamRoleArn": "<p>The new IAM role ARN.</p>"
|
||||
}
|
||||
},
|
||||
"InvalidRequestException": {
|
||||
"base": "<p>Indicates that one or more of the request parameters are not valid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"IpAddress": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateHsmRequest$EniIp": "<p>The IP address to assign to the HSM's ENI.</p> <p>If an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the subnet.</p>",
|
||||
"CreateHsmRequest$SyslogIp": "<p>The IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.</p>",
|
||||
"DescribeHsmResponse$EniIp": "<p>The IP address assigned to the HSM's ENI.</p>",
|
||||
"ModifyHsmRequest$EniIp": "<p>The new IP address for the elastic network interface (ENI) attached to the HSM.</p> <p>If the HSM is moved to a different subnet, and an IP address is not specified, an IP address will be randomly chosen from the CIDR range of the new subnet.</p>",
|
||||
"ModifyHsmRequest$SyslogIp": "<p>The new IP address for the syslog monitoring server. The AWS CloudHSM service only supports one syslog monitoring server.</p>"
|
||||
}
|
||||
},
|
||||
"Label": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateHapgRequest$Label": "<p>The label of the new high-availability partition group.</p>",
|
||||
"DescribeHapgResponse$Label": "<p>The label for the high-availability partition group.</p>",
|
||||
"DescribeLunaClientResponse$Label": "<p>The label of the client.</p>",
|
||||
"ModifyHapgRequest$Label": "<p>The new label for the high-availability partition group.</p>"
|
||||
}
|
||||
},
|
||||
"ListAvailableZonesRequest": {
|
||||
"base": "<p>Contains the inputs for the <a>ListAvailableZones</a> action.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListAvailableZonesResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListHapgsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListHapgsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListHsmsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListHsmsResponse": {
|
||||
"base": "<p>Contains the output of the <a>ListHsms</a> operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListLunaClientsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListLunaClientsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ModifyHapgRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ModifyHapgResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ModifyHsmRequest": {
|
||||
"base": "<p>Contains the inputs for the <a>ModifyHsm</a> operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ModifyHsmResponse": {
|
||||
"base": "<p>Contains the output of the <a>ModifyHsm</a> operation.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ModifyLunaClientRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ModifyLunaClientResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"PartitionArn": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PartitionList$member": null
|
||||
}
|
||||
},
|
||||
"PartitionList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeHsmResponse$Partitions": "<p>The list of partitions on the HSM.</p>"
|
||||
}
|
||||
},
|
||||
"PartitionSerial": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PartitionSerialList$member": null
|
||||
}
|
||||
},
|
||||
"PartitionSerialList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeHapgResponse$PartitionSerialList": "<p>The list of partition serial numbers that belong to the high-availability partition group.</p>",
|
||||
"ModifyHapgRequest$PartitionSerialList": "<p>The list of partition serial numbers to make members of the high-availability partition group.</p>"
|
||||
}
|
||||
},
|
||||
"RemoveTagsFromResourceRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"RemoveTagsFromResourceResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"SshKey": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateHsmRequest$SshKey": "<p>The SSH public key to install on the HSM.</p>",
|
||||
"DescribeHsmResponse$SshPublicKey": "<p>The public SSH key.</p>"
|
||||
}
|
||||
},
|
||||
"String": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AddTagsToResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.</p>",
|
||||
"AddTagsToResourceResponse$Status": "<p>The status of the operation.</p>",
|
||||
"CloudHsmServiceException$message": "<p>Additional information about the error.</p>",
|
||||
"DeleteHapgResponse$Status": "<p>The status of the action.</p>",
|
||||
"DeleteHsmResponse$Status": "<p>The status of the operation.</p>",
|
||||
"DeleteLunaClientResponse$Status": "<p>The status of the action.</p>",
|
||||
"DescribeHapgResponse$HapgSerial": "<p>The serial number of the high-availability partition group.</p>",
|
||||
"DescribeHsmResponse$StatusDetails": "<p>Contains additional information about the status of the HSM.</p>",
|
||||
"DescribeHsmResponse$VendorName": "<p>The name of the HSM vendor.</p>",
|
||||
"DescribeHsmResponse$HsmType": "<p>The HSM model type.</p>",
|
||||
"DescribeHsmResponse$SoftwareVersion": "<p>The HSM software version.</p>",
|
||||
"DescribeHsmResponse$ServerCertUri": "<p>The URI of the certificate server.</p>",
|
||||
"GetConfigResponse$ConfigType": "<p>The type of credentials.</p>",
|
||||
"GetConfigResponse$ConfigFile": "<p>The chrystoki.conf configuration file.</p>",
|
||||
"GetConfigResponse$ConfigCred": "<p>The certificate file containing the server.pem files of the HSMs.</p>",
|
||||
"ListTagsForResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the AWS CloudHSM resource.</p>",
|
||||
"RemoveTagsFromResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the AWS CloudHSM resource.</p>",
|
||||
"RemoveTagsFromResourceResponse$Status": "<p>The status of the operation.</p>"
|
||||
}
|
||||
},
|
||||
"SubnetId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateHsmRequest$SubnetId": "<p>The identifier of the subnet in your VPC in which to place the HSM.</p>",
|
||||
"DescribeHsmResponse$SubnetId": "<p>The identifier of the subnet that the HSM is in.</p>",
|
||||
"ModifyHsmRequest$SubnetId": "<p>The new identifier of the subnet that the HSM is in. The new subnet must be in the same Availability Zone as the current subnet.</p>"
|
||||
}
|
||||
},
|
||||
"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>",
|
||||
"refs": {
|
||||
"CreateHsmRequest$SubscriptionType": null,
|
||||
"DescribeHsmResponse$SubscriptionType": null
|
||||
}
|
||||
},
|
||||
"Tag": {
|
||||
"base": "<p>A key-value pair that identifies or specifies metadata about an AWS CloudHSM resource.</p>",
|
||||
"refs": {
|
||||
"TagList$member": null
|
||||
}
|
||||
},
|
||||
"TagKey": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Tag$Key": "<p>The key of the tag.</p>",
|
||||
"TagKeyList$member": null
|
||||
}
|
||||
},
|
||||
"TagKeyList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"RemoveTagsFromResourceRequest$TagKeyList": "<p>The tag key or keys to remove.</p> <p>Specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use <a>AddTagsToResource</a>.</p>"
|
||||
}
|
||||
},
|
||||
"TagList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AddTagsToResourceRequest$TagList": "<p>One or more tags.</p>",
|
||||
"ListTagsForResourceResponse$TagList": "<p>One or more tags.</p>"
|
||||
}
|
||||
},
|
||||
"TagValue": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Tag$Value": "<p>The value of the tag.</p>"
|
||||
}
|
||||
},
|
||||
"Timestamp": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeHapgResponse$LastModifiedTimestamp": "<p>The date and time the high-availability partition group was last modified.</p>",
|
||||
"DescribeHsmResponse$SubscriptionStartDate": "<p>The subscription start date.</p>",
|
||||
"DescribeHsmResponse$SubscriptionEndDate": "<p>The subscription end date.</p>",
|
||||
"DescribeHsmResponse$SshKeyLastUpdated": "<p>The date and time that the SSH key was last updated.</p>",
|
||||
"DescribeHsmResponse$ServerCertLastUpdated": "<p>The date and time that the server certificate was last updated.</p>",
|
||||
"DescribeLunaClientResponse$LastModifiedTimestamp": "<p>The date and time the client was last modified.</p>"
|
||||
}
|
||||
},
|
||||
"VpcId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeHsmResponse$VpcId": "<p>The identifier of the VPC that the HSM is in.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
+2002
File diff suppressed because it is too large
Load Diff
+865
@@ -0,0 +1,865 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"operations": {
|
||||
"BuildSuggesters": "<p>Indexes the search suggestions. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html#configuring-suggesters\">Configuring Suggesters</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"CreateDomain": "<p>Creates a new search domain. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/creating-domains.html\" target=\"_blank\">Creating a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"DefineAnalysisScheme": "<p>Configures an analysis scheme that can be applied to a <code>text</code> or <code>text-array</code> field to define language-specific text processing options. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html\" target=\"_blank\">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"DefineExpression": "<p>Configures an <code><a>Expression</a></code> for the search domain. Used to create new expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html\" target=\"_blank\">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"DefineIndexField": "<p>Configures an <code><a>IndexField</a></code> for the search domain. Used to create new fields and modify existing ones. You must specify the name of the domain you are configuring and an index field configuration. The index field configuration specifies a unique name, the index field type, and the options you want to configure for the field. The options you can specify depend on the <code><a>IndexFieldType</a></code>. If the field exists, the new configuration replaces the old one. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html\" target=\"_blank\">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>. </p>",
|
||||
"DefineSuggester": "<p>Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html\" target=\"_blank\">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"DeleteAnalysisScheme": "<p>Deletes an analysis scheme. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html\" target=\"_blank\">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>. </p>",
|
||||
"DeleteDomain": "<p>Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/deleting-domains.html\" target=\"_blank\">Deleting a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. </p>",
|
||||
"DeleteExpression": "<p>Removes an <code><a>Expression</a></code> from the search domain. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html\" target=\"_blank\">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"DeleteIndexField": "<p>Removes an <code><a>IndexField</a></code> from the search domain. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html\" target=\"_blank\">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"DeleteSuggester": "<p>Deletes a suggester. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html\" target=\"_blank\">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"DescribeAnalysisSchemes": "<p>Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific text processing options for a <code>text</code> field. Can be limited to specific analysis schemes by name. By default, shows all analysis schemes and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html\" target=\"_blank\">Configuring Analysis Schemes</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"DescribeAvailabilityOptions": "<p>Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html\" target=\"_blank\">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"DescribeDomains": "<p>Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a <code>matchall</code> request to your domain's search endpoint: <code>q=matchall&amp;q.parser=structured&amp;size=0</code>. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html\" target=\"_blank\">Getting Information about a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"DescribeExpressions": "<p>Gets the expressions configured for the search domain. Can be limited to specific expressions by name. By default, shows all expressions and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html\" target=\"_blank\">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"DescribeIndexFields": "<p>Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. By default, shows all fields and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-domain-info.html\" target=\"_blank\">Getting Domain Information</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"DescribeScalingParameters": "<p>Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html\" target=\"_blank\">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"DescribeServiceAccessPolicies": "<p>Gets information about the access policies that control access to the domain's document and search endpoints. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html\" target=\"_blank\">Configuring Access for a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"DescribeSuggesters": "<p>Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/getting-suggestions.html\" target=\"_blank\">Getting Search Suggestions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"IndexDocuments": "<p>Tells the search domain to start indexing its documents using the latest indexing options. This operation must be invoked to activate options whose <a>OptionStatus</a> is <code>RequiresIndexDocuments</code>.</p>",
|
||||
"ListDomainNames": "<p>Lists all search domains owned by an account.</p>",
|
||||
"UpdateAvailabilityOptions": "<p>Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html\" target=\"_blank\">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"UpdateScalingParameters": "<p>Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-scaling-options.html\" target=\"_blank\">Configuring Scaling Options</a> in the <i>Amazon CloudSearch Developer Guide</i>. </p>",
|
||||
"UpdateServiceAccessPolicies": "<p>Configures the access rules that control access to the domain's document and search endpoints. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html\" target=\"_blank\"> Configuring Access for an Amazon CloudSearch Domain</a>.</p>"
|
||||
},
|
||||
"service": "<fullname>Amazon CloudSearch Configuration Service</fullname> <p>You use the Amazon CloudSearch configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.</p> <p>The endpoint for configuration service requests is region-specific: cloudsearch.<i>region</i>.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#cloudsearch_region\" target=\"_blank\">Regions and Endpoints</a>.</p>",
|
||||
"shapes": {
|
||||
"APIVersion": {
|
||||
"base": "<p>The Amazon CloudSearch API version for a domain: 2011-02-01 or 2013-01-01.</p>",
|
||||
"refs": {
|
||||
"DomainNameMap$value": null
|
||||
}
|
||||
},
|
||||
"ARN": {
|
||||
"base": "<p>The Amazon Resource Name (ARN) of the search domain. See <a href=\"http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html\" target=\"_blank\">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access Management</i> for more information.</p>",
|
||||
"refs": {
|
||||
"DomainStatus$ARN": null
|
||||
}
|
||||
},
|
||||
"AccessPoliciesStatus": {
|
||||
"base": "<p>The configured access rules for the domain's document and search endpoints, and the current status of those rules.</p>",
|
||||
"refs": {
|
||||
"DescribeServiceAccessPoliciesResponse$AccessPolicies": "<p>The access rules configured for the domain specified in the request.</p>",
|
||||
"UpdateServiceAccessPoliciesResponse$AccessPolicies": "<p>The access rules configured for the domain.</p>"
|
||||
}
|
||||
},
|
||||
"AlgorithmicStemming": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AnalysisOptions$AlgorithmicStemming": "<p>The level of algorithmic stemming to perform: <code>none</code>, <code>minimal</code>, <code>light</code>, or <code>full</code>. The available levels vary depending on the language. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings\" target=\"_blank\">Language Specific Text Processing Settings</a> in the <i>Amazon CloudSearch Developer Guide</i> </p>"
|
||||
}
|
||||
},
|
||||
"AnalysisOptions": {
|
||||
"base": "<p>Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.</p>",
|
||||
"refs": {
|
||||
"AnalysisScheme$AnalysisOptions": null
|
||||
}
|
||||
},
|
||||
"AnalysisScheme": {
|
||||
"base": "<p>Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: <code>Synonyms</code>, <code>Stopwords</code>, <code>StemmingDictionary</code>, <code>JapaneseTokenizationDictionary</code> and <code>AlgorithmicStemming</code>.</p>",
|
||||
"refs": {
|
||||
"AnalysisSchemeStatus$Options": null,
|
||||
"DefineAnalysisSchemeRequest$AnalysisScheme": null
|
||||
}
|
||||
},
|
||||
"AnalysisSchemeLanguage": {
|
||||
"base": "<p>An <a href=\"http://tools.ietf.org/html/rfc4646\" target=\"_blank\">IETF RFC 4646</a> language code or <code>mul</code> for multiple languages.</p>",
|
||||
"refs": {
|
||||
"AnalysisScheme$AnalysisSchemeLanguage": null
|
||||
}
|
||||
},
|
||||
"AnalysisSchemeStatus": {
|
||||
"base": "<p>The status and configuration of an <code>AnalysisScheme</code>.</p>",
|
||||
"refs": {
|
||||
"AnalysisSchemeStatusList$member": null,
|
||||
"DefineAnalysisSchemeResponse$AnalysisScheme": null,
|
||||
"DeleteAnalysisSchemeResponse$AnalysisScheme": "<p>The status of the analysis scheme being deleted.</p>"
|
||||
}
|
||||
},
|
||||
"AnalysisSchemeStatusList": {
|
||||
"base": "<p>A list of the analysis schemes configured for a domain.</p>",
|
||||
"refs": {
|
||||
"DescribeAnalysisSchemesResponse$AnalysisSchemes": "<p>The analysis scheme descriptions.</p>"
|
||||
}
|
||||
},
|
||||
"AvailabilityOptionsStatus": {
|
||||
"base": "<p>The status and configuration of the domain's availability options.</p>",
|
||||
"refs": {
|
||||
"DescribeAvailabilityOptionsResponse$AvailabilityOptions": "<p>The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain. </p>",
|
||||
"UpdateAvailabilityOptionsResponse$AvailabilityOptions": "<p>The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain. </p>"
|
||||
}
|
||||
},
|
||||
"BaseException": {
|
||||
"base": "<p>An error occurred while processing the request.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Boolean": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DateArrayOptions$FacetEnabled": "<p>Whether facet information can be returned for the field.</p>",
|
||||
"DateArrayOptions$SearchEnabled": "<p>Whether the contents of the field are searchable.</p>",
|
||||
"DateArrayOptions$ReturnEnabled": "<p>Whether the contents of the field can be returned in the search results.</p>",
|
||||
"DateOptions$FacetEnabled": "<p>Whether facet information can be returned for the field.</p>",
|
||||
"DateOptions$SearchEnabled": "<p>Whether the contents of the field are searchable.</p>",
|
||||
"DateOptions$ReturnEnabled": "<p>Whether the contents of the field can be returned in the search results.</p>",
|
||||
"DateOptions$SortEnabled": "<p>Whether the field can be used to sort the search results.</p>",
|
||||
"DescribeAnalysisSchemesRequest$Deployed": "<p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>",
|
||||
"DescribeAvailabilityOptionsRequest$Deployed": "<p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>",
|
||||
"DescribeExpressionsRequest$Deployed": "<p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>",
|
||||
"DescribeIndexFieldsRequest$Deployed": "<p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>",
|
||||
"DescribeServiceAccessPoliciesRequest$Deployed": "<p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>",
|
||||
"DescribeSuggestersRequest$Deployed": "<p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>",
|
||||
"DomainStatus$Created": "<p>True if the search domain is created. It can take several minutes to initialize a domain when <a>CreateDomain</a> is called. Newly created search domains are returned from <a>DescribeDomains</a> with a false value for Created until domain creation is complete.</p>",
|
||||
"DomainStatus$Deleted": "<p>True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when <a>DeleteDomain</a> is called. Newly deleted search domains are returned from <a>DescribeDomains</a> with a true value for IsDeleted for several minutes until resource cleanup is complete.</p>",
|
||||
"DomainStatus$RequiresIndexDocuments": "<p>True if <a>IndexDocuments</a> needs to be called to activate the current domain configuration.</p>",
|
||||
"DomainStatus$Processing": "<p>True if processing is being done to activate the current domain configuration.</p>",
|
||||
"DoubleArrayOptions$FacetEnabled": "<p>Whether facet information can be returned for the field.</p>",
|
||||
"DoubleArrayOptions$SearchEnabled": "<p>Whether the contents of the field are searchable.</p>",
|
||||
"DoubleArrayOptions$ReturnEnabled": "<p>Whether the contents of the field can be returned in the search results.</p>",
|
||||
"DoubleOptions$FacetEnabled": "<p>Whether facet information can be returned for the field.</p>",
|
||||
"DoubleOptions$SearchEnabled": "<p>Whether the contents of the field are searchable.</p>",
|
||||
"DoubleOptions$ReturnEnabled": "<p>Whether the contents of the field can be returned in the search results.</p>",
|
||||
"DoubleOptions$SortEnabled": "<p>Whether the field can be used to sort the search results.</p>",
|
||||
"IntArrayOptions$FacetEnabled": "<p>Whether facet information can be returned for the field.</p>",
|
||||
"IntArrayOptions$SearchEnabled": "<p>Whether the contents of the field are searchable.</p>",
|
||||
"IntArrayOptions$ReturnEnabled": "<p>Whether the contents of the field can be returned in the search results.</p>",
|
||||
"IntOptions$FacetEnabled": "<p>Whether facet information can be returned for the field.</p>",
|
||||
"IntOptions$SearchEnabled": "<p>Whether the contents of the field are searchable.</p>",
|
||||
"IntOptions$ReturnEnabled": "<p>Whether the contents of the field can be returned in the search results.</p>",
|
||||
"IntOptions$SortEnabled": "<p>Whether the field can be used to sort the search results.</p>",
|
||||
"LatLonOptions$FacetEnabled": "<p>Whether facet information can be returned for the field.</p>",
|
||||
"LatLonOptions$SearchEnabled": "<p>Whether the contents of the field are searchable.</p>",
|
||||
"LatLonOptions$ReturnEnabled": "<p>Whether the contents of the field can be returned in the search results.</p>",
|
||||
"LatLonOptions$SortEnabled": "<p>Whether the field can be used to sort the search results.</p>",
|
||||
"LiteralArrayOptions$FacetEnabled": "<p>Whether facet information can be returned for the field.</p>",
|
||||
"LiteralArrayOptions$SearchEnabled": "<p>Whether the contents of the field are searchable.</p>",
|
||||
"LiteralArrayOptions$ReturnEnabled": "<p>Whether the contents of the field can be returned in the search results.</p>",
|
||||
"LiteralOptions$FacetEnabled": "<p>Whether facet information can be returned for the field.</p>",
|
||||
"LiteralOptions$SearchEnabled": "<p>Whether the contents of the field are searchable.</p>",
|
||||
"LiteralOptions$ReturnEnabled": "<p>Whether the contents of the field can be returned in the search results.</p>",
|
||||
"LiteralOptions$SortEnabled": "<p>Whether the field can be used to sort the search results.</p>",
|
||||
"OptionStatus$PendingDeletion": "<p>Indicates that the option will be deleted once processing is complete.</p>",
|
||||
"TextArrayOptions$ReturnEnabled": "<p>Whether the contents of the field can be returned in the search results.</p>",
|
||||
"TextArrayOptions$HighlightEnabled": "<p>Whether highlights can be returned for the field.</p>",
|
||||
"TextOptions$ReturnEnabled": "<p>Whether the contents of the field can be returned in the search results.</p>",
|
||||
"TextOptions$SortEnabled": "<p>Whether the field can be used to sort the search results.</p>",
|
||||
"TextOptions$HighlightEnabled": "<p>Whether highlights can be returned for the field.</p>",
|
||||
"UpdateAvailabilityOptionsRequest$MultiAZ": "<p>You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to <code>false</code>. </p>"
|
||||
}
|
||||
},
|
||||
"BuildSuggestersRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>BuildSuggester</a></code> operation. Specifies the name of the domain you want to update.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"BuildSuggestersResponse": {
|
||||
"base": "<p>The result of a <code>BuildSuggester</code> request. Contains a list of the fields used for suggestions.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateDomainRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>CreateDomain</a></code> operation. Specifies a name for the new search domain.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateDomainResponse": {
|
||||
"base": "<p>The result of a <code>CreateDomainRequest</code>. Contains the status of a newly created domain.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DateArrayOptions": {
|
||||
"base": "<p>Options for a field that contains an array of dates. Present if <code>IndexFieldType</code> specifies the field is of type <code>date-array</code>. All options are enabled by default.</p>",
|
||||
"refs": {
|
||||
"IndexField$DateArrayOptions": null
|
||||
}
|
||||
},
|
||||
"DateOptions": {
|
||||
"base": "<p>Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if <code>IndexFieldType</code> specifies the field is of type <code>date</code>. All options are enabled by default.</p>",
|
||||
"refs": {
|
||||
"IndexField$DateOptions": null
|
||||
}
|
||||
},
|
||||
"DefineAnalysisSchemeRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>DefineAnalysisScheme</a></code> operation. Specifies the name of the domain you want to update and the analysis scheme configuration.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DefineAnalysisSchemeResponse": {
|
||||
"base": "<p>The result of a <code><a>DefineAnalysisScheme</a></code> request. Contains the status of the newly-configured analysis scheme.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DefineExpressionRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>DefineExpression</a></code> operation. Specifies the name of the domain you want to update and the expression you want to configure.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DefineExpressionResponse": {
|
||||
"base": "<p>The result of a <code>DefineExpression</code> request. Contains the status of the newly-configured expression.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DefineIndexFieldRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>DefineIndexField</a></code> operation. Specifies the name of the domain you want to update and the index field configuration.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DefineIndexFieldResponse": {
|
||||
"base": "<p>The result of a <code><a>DefineIndexField</a></code> request. Contains the status of the newly-configured index field.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DefineSuggesterRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>DefineSuggester</a></code> operation. Specifies the name of the domain you want to update and the suggester configuration.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DefineSuggesterResponse": {
|
||||
"base": "<p>The result of a <code>DefineSuggester</code> request. Contains the status of the newly-configured suggester.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteAnalysisSchemeRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>DeleteAnalysisScheme</a></code> operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete. </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteAnalysisSchemeResponse": {
|
||||
"base": "<p>The result of a <code>DeleteAnalysisScheme</code> request. Contains the status of the deleted analysis scheme.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteDomainRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>DeleteDomain</a></code> operation. Specifies the name of the domain you want to delete.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteDomainResponse": {
|
||||
"base": "<p>The result of a <code>DeleteDomain</code> request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteExpressionRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>DeleteExpression</a></code> operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteExpressionResponse": {
|
||||
"base": "<p>The result of a <code><a>DeleteExpression</a></code> request. Specifies the expression being deleted.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteIndexFieldRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>DeleteIndexField</a></code> operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteIndexFieldResponse": {
|
||||
"base": "<p>The result of a <code><a>DeleteIndexField</a></code> request.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteSuggesterRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>DeleteSuggester</a></code> operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteSuggesterResponse": {
|
||||
"base": "<p>The result of a <code>DeleteSuggester</code> request. Contains the status of the deleted suggester.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeAnalysisSchemesRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>DescribeAnalysisSchemes</a></code> operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>. </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeAnalysisSchemesResponse": {
|
||||
"base": "<p>The result of a <code>DescribeAnalysisSchemes</code> request. Contains the analysis schemes configured for the domain specified in the request.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeAvailabilityOptionsRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>DescribeAvailabilityOptions</a></code> operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to <code>true</code>.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeAvailabilityOptionsResponse": {
|
||||
"base": "<p>The result of a <code>DescribeAvailabilityOptions</code> request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request. </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeDomainsRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>DescribeDomains</a></code> operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeDomainsResponse": {
|
||||
"base": "<p>The result of a <code>DescribeDomains</code> request. Contains the status of the domains specified in the request or all domains owned by the account.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeExpressionsRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>DescribeDomains</a></code> operation. Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeExpressionsResponse": {
|
||||
"base": "<p>The result of a <code>DescribeExpressions</code> request. Contains the expressions configured for the domain specified in the request.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeIndexFieldsRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>DescribeIndexFields</a></code> operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeIndexFieldsResponse": {
|
||||
"base": "<p>The result of a <code>DescribeIndexFields</code> request. Contains the index fields configured for the domain specified in the request.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeScalingParametersRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>DescribeScalingParameters</a></code> operation. Specifies the name of the domain you want to describe. </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeScalingParametersResponse": {
|
||||
"base": "<p>The result of a <code>DescribeScalingParameters</code> request. Contains the scaling parameters configured for the domain specified in the request.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeServiceAccessPoliciesRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>DescribeServiceAccessPolicies</a></code> operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeServiceAccessPoliciesResponse": {
|
||||
"base": "<p>The result of a <code>DescribeServiceAccessPolicies</code> request.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeSuggestersRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>DescribeSuggester</a></code> operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeSuggestersResponse": {
|
||||
"base": "<p>The result of a <code>DescribeSuggesters</code> request.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DisabledOperationException": {
|
||||
"base": "<p>The request was rejected because it attempted an operation which is not enabled.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DocumentSuggesterOptions": {
|
||||
"base": "<p>Options for a search suggester.</p>",
|
||||
"refs": {
|
||||
"Suggester$DocumentSuggesterOptions": null
|
||||
}
|
||||
},
|
||||
"DomainId": {
|
||||
"base": "<p>An internally generated unique identifier for a domain.</p>",
|
||||
"refs": {
|
||||
"DomainStatus$DomainId": null
|
||||
}
|
||||
},
|
||||
"DomainName": {
|
||||
"base": "<p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>",
|
||||
"refs": {
|
||||
"BuildSuggestersRequest$DomainName": null,
|
||||
"CreateDomainRequest$DomainName": "<p>A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.</p>",
|
||||
"DefineAnalysisSchemeRequest$DomainName": null,
|
||||
"DefineExpressionRequest$DomainName": null,
|
||||
"DefineIndexFieldRequest$DomainName": null,
|
||||
"DefineSuggesterRequest$DomainName": null,
|
||||
"DeleteAnalysisSchemeRequest$DomainName": null,
|
||||
"DeleteDomainRequest$DomainName": "<p>The name of the domain you want to permanently delete.</p>",
|
||||
"DeleteExpressionRequest$DomainName": null,
|
||||
"DeleteIndexFieldRequest$DomainName": null,
|
||||
"DeleteSuggesterRequest$DomainName": null,
|
||||
"DescribeAnalysisSchemesRequest$DomainName": "<p>The name of the domain you want to describe.</p>",
|
||||
"DescribeAvailabilityOptionsRequest$DomainName": "<p>The name of the domain you want to describe.</p>",
|
||||
"DescribeExpressionsRequest$DomainName": "<p>The name of the domain you want to describe.</p>",
|
||||
"DescribeIndexFieldsRequest$DomainName": "<p>The name of the domain you want to describe.</p>",
|
||||
"DescribeScalingParametersRequest$DomainName": null,
|
||||
"DescribeServiceAccessPoliciesRequest$DomainName": "<p>The name of the domain you want to describe.</p>",
|
||||
"DescribeSuggestersRequest$DomainName": "<p>The name of the domain you want to describe.</p>",
|
||||
"DomainNameList$member": null,
|
||||
"DomainNameMap$key": null,
|
||||
"DomainStatus$DomainName": null,
|
||||
"IndexDocumentsRequest$DomainName": null,
|
||||
"UpdateAvailabilityOptionsRequest$DomainName": null,
|
||||
"UpdateScalingParametersRequest$DomainName": null,
|
||||
"UpdateServiceAccessPoliciesRequest$DomainName": null
|
||||
}
|
||||
},
|
||||
"DomainNameList": {
|
||||
"base": "<p>A list of domain names.</p>",
|
||||
"refs": {
|
||||
"DescribeDomainsRequest$DomainNames": "<p>The names of the domains you want to include in the response.</p>"
|
||||
}
|
||||
},
|
||||
"DomainNameMap": {
|
||||
"base": "<p>A collection of domain names.</p>",
|
||||
"refs": {
|
||||
"ListDomainNamesResponse$DomainNames": "<p>The names of the search domains owned by an account.</p>"
|
||||
}
|
||||
},
|
||||
"DomainStatus": {
|
||||
"base": "<p>The current status of the search domain.</p>",
|
||||
"refs": {
|
||||
"CreateDomainResponse$DomainStatus": null,
|
||||
"DeleteDomainResponse$DomainStatus": null,
|
||||
"DomainStatusList$member": null
|
||||
}
|
||||
},
|
||||
"DomainStatusList": {
|
||||
"base": "<p>A list that contains the status of each requested domain.</p>",
|
||||
"refs": {
|
||||
"DescribeDomainsResponse$DomainStatusList": null
|
||||
}
|
||||
},
|
||||
"Double": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DoubleArrayOptions$DefaultValue": "A value to use for the field if the field isn't specified for a document.",
|
||||
"DoubleOptions$DefaultValue": "<p>A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.</p>"
|
||||
}
|
||||
},
|
||||
"DoubleArrayOptions": {
|
||||
"base": "<p>Options for a field that contains an array of double-precision 64-bit floating point values. Present if <code>IndexFieldType</code> specifies the field is of type <code>double-array</code>. All options are enabled by default.</p>",
|
||||
"refs": {
|
||||
"IndexField$DoubleArrayOptions": null
|
||||
}
|
||||
},
|
||||
"DoubleOptions": {
|
||||
"base": "<p>Options for a double-precision 64-bit floating point field. Present if <code>IndexFieldType</code> specifies the field is of type <code>double</code>. All options are enabled by default.</p>",
|
||||
"refs": {
|
||||
"IndexField$DoubleOptions": null
|
||||
}
|
||||
},
|
||||
"DynamicFieldName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DeleteIndexFieldRequest$IndexFieldName": "<p>The name of the index field your want to remove from the domain's indexing options.</p>",
|
||||
"DynamicFieldNameList$member": null,
|
||||
"IndexField$IndexFieldName": "<p>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options. </p> <p>Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported. </p> <p>The name <code>score</code> is reserved and cannot be used as a field name. To reference a document's ID, you can use the name <code>_id</code>. </p>"
|
||||
}
|
||||
},
|
||||
"DynamicFieldNameList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeIndexFieldsRequest$FieldNames": "<p>A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.</p>"
|
||||
}
|
||||
},
|
||||
"ErrorCode": {
|
||||
"base": "<p>A machine-parsable string error or warning code.</p>",
|
||||
"refs": {
|
||||
"BaseException$Code": null
|
||||
}
|
||||
},
|
||||
"ErrorMessage": {
|
||||
"base": "<p>A human-readable string error or warning message.</p>",
|
||||
"refs": {
|
||||
"BaseException$Message": null
|
||||
}
|
||||
},
|
||||
"Expression": {
|
||||
"base": "<p>A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results. </p>",
|
||||
"refs": {
|
||||
"DefineExpressionRequest$Expression": null,
|
||||
"ExpressionStatus$Options": "<p>The expression that is evaluated for sorting while processing a search request.</p>"
|
||||
}
|
||||
},
|
||||
"ExpressionStatus": {
|
||||
"base": "<p>The value of an <code>Expression</code> and its current status.</p>",
|
||||
"refs": {
|
||||
"DefineExpressionResponse$Expression": null,
|
||||
"DeleteExpressionResponse$Expression": "<p>The status of the expression being deleted.</p>",
|
||||
"ExpressionStatusList$member": null
|
||||
}
|
||||
},
|
||||
"ExpressionStatusList": {
|
||||
"base": "<p>Contains the status of multiple expressions.</p>",
|
||||
"refs": {
|
||||
"DescribeExpressionsResponse$Expressions": "<p>The expressions configured for the domain.</p>"
|
||||
}
|
||||
},
|
||||
"ExpressionValue": {
|
||||
"base": "<p>The expression to evaluate for sorting while processing a search request. The <code>Expression</code> syntax is based on JavaScript expressions. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html\" target=\"_blank\">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"refs": {
|
||||
"Expression$ExpressionValue": null
|
||||
}
|
||||
},
|
||||
"FieldName": {
|
||||
"base": "<p>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options. </p> <p>Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported. </p> <p>The name <code>score</code> is reserved and cannot be used as a field name. To reference a document's ID, you can use the name <code>_id</code>. </p>",
|
||||
"refs": {
|
||||
"DateOptions$SourceField": null,
|
||||
"DocumentSuggesterOptions$SourceField": "<p>The name of the index field you want to use for suggestions. </p>",
|
||||
"DoubleOptions$SourceField": "<p>The name of the source field to map to the field. </p>",
|
||||
"FieldNameList$member": null,
|
||||
"IntOptions$SourceField": "<p>The name of the source field to map to the field. </p>",
|
||||
"LatLonOptions$SourceField": null,
|
||||
"LiteralOptions$SourceField": null,
|
||||
"TextOptions$SourceField": null
|
||||
}
|
||||
},
|
||||
"FieldNameCommaList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DateArrayOptions$SourceFields": "<p>A list of source fields to map to the field. </p>",
|
||||
"DoubleArrayOptions$SourceFields": "<p>A list of source fields to map to the field. </p>",
|
||||
"IntArrayOptions$SourceFields": "<p>A list of source fields to map to the field. </p>",
|
||||
"LiteralArrayOptions$SourceFields": "<p>A list of source fields to map to the field. </p>",
|
||||
"TextArrayOptions$SourceFields": "<p>A list of source fields to map to the field. </p>"
|
||||
}
|
||||
},
|
||||
"FieldNameList": {
|
||||
"base": "<p>A list of field names.</p>",
|
||||
"refs": {
|
||||
"BuildSuggestersResponse$FieldNames": null,
|
||||
"IndexDocumentsResponse$FieldNames": "<p>The names of the fields that are currently being indexed.</p>"
|
||||
}
|
||||
},
|
||||
"FieldValue": {
|
||||
"base": "<p>The value of a field attribute.</p>",
|
||||
"refs": {
|
||||
"DateArrayOptions$DefaultValue": "A value to use for the field if the field isn't specified for a document.",
|
||||
"DateOptions$DefaultValue": "A value to use for the field if the field isn't specified for a document.",
|
||||
"LatLonOptions$DefaultValue": "A value to use for the field if the field isn't specified for a document.",
|
||||
"LiteralArrayOptions$DefaultValue": "A value to use for the field if the field isn't specified for a document.",
|
||||
"LiteralOptions$DefaultValue": "A value to use for the field if the field isn't specified for a document.",
|
||||
"TextArrayOptions$DefaultValue": "A value to use for the field if the field isn't specified for a document.",
|
||||
"TextOptions$DefaultValue": "A value to use for the field if the field isn't specified for a document."
|
||||
}
|
||||
},
|
||||
"IndexDocumentsRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>IndexDocuments</a></code> operation. Specifies the name of the domain you want to re-index.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"IndexDocumentsResponse": {
|
||||
"base": "<p>The result of an <code>IndexDocuments</code> request. Contains the status of the indexing operation, including the fields being indexed.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"IndexField": {
|
||||
"base": "<p>Configuration information for a field in the index, including its name, type, and options. The supported options depend on the <code><a>IndexFieldType</a></code>.</p>",
|
||||
"refs": {
|
||||
"DefineIndexFieldRequest$IndexField": "<p>The index field and field options you want to configure. </p>",
|
||||
"IndexFieldStatus$Options": null
|
||||
}
|
||||
},
|
||||
"IndexFieldStatus": {
|
||||
"base": "<p>The value of an <code>IndexField</code> and its current status.</p>",
|
||||
"refs": {
|
||||
"DefineIndexFieldResponse$IndexField": null,
|
||||
"DeleteIndexFieldResponse$IndexField": "<p>The status of the index field being deleted.</p>",
|
||||
"IndexFieldStatusList$member": null
|
||||
}
|
||||
},
|
||||
"IndexFieldStatusList": {
|
||||
"base": "<p>Contains the status of multiple index fields.</p>",
|
||||
"refs": {
|
||||
"DescribeIndexFieldsResponse$IndexFields": "<p>The index fields configured for the domain.</p>"
|
||||
}
|
||||
},
|
||||
"IndexFieldType": {
|
||||
"base": "<p>The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html\" target=\"_blank\">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"refs": {
|
||||
"IndexField$IndexFieldType": null
|
||||
}
|
||||
},
|
||||
"InstanceCount": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DomainStatus$SearchInstanceCount": "<p>The number of search instances that are available to process search requests.</p>"
|
||||
}
|
||||
},
|
||||
"IntArrayOptions": {
|
||||
"base": "<p>Options for a field that contains an array of 64-bit signed integers. Present if <code>IndexFieldType</code> specifies the field is of type <code>int-array</code>. All options are enabled by default.</p>",
|
||||
"refs": {
|
||||
"IndexField$IntArrayOptions": null
|
||||
}
|
||||
},
|
||||
"IntOptions": {
|
||||
"base": "<p>Options for a 64-bit signed integer field. Present if <code>IndexFieldType</code> specifies the field is of type <code>int</code>. All options are enabled by default.</p>",
|
||||
"refs": {
|
||||
"IndexField$IntOptions": null
|
||||
}
|
||||
},
|
||||
"InternalException": {
|
||||
"base": "<p>An internal error occurred while processing the request. If this problem persists, report an issue from the <a href=\"http://status.aws.amazon.com/\" target=\"_blank\">Service Health Dashboard</a>.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidTypeException": {
|
||||
"base": "<p>The request was rejected because it specified an invalid type definition.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"LatLonOptions": {
|
||||
"base": "<p>Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if <code>IndexFieldType</code> specifies the field is of type <code>latlon</code>. All options are enabled by default.</p>",
|
||||
"refs": {
|
||||
"IndexField$LatLonOptions": null
|
||||
}
|
||||
},
|
||||
"LimitExceededException": {
|
||||
"base": "<p>The request was rejected because a resource limit has already been met.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Limits": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DomainStatus$Limits": null
|
||||
}
|
||||
},
|
||||
"ListDomainNamesResponse": {
|
||||
"base": "<p>The result of a <code>ListDomainNames</code> request. Contains a list of the domains owned by an account.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"LiteralArrayOptions": {
|
||||
"base": "<p>Options for a field that contains an array of literal strings. Present if <code>IndexFieldType</code> specifies the field is of type <code>literal-array</code>. All options are enabled by default.</p>",
|
||||
"refs": {
|
||||
"IndexField$LiteralArrayOptions": null
|
||||
}
|
||||
},
|
||||
"LiteralOptions": {
|
||||
"base": "<p>Options for literal field. Present if <code>IndexFieldType</code> specifies the field is of type <code>literal</code>. All options are enabled by default.</p>",
|
||||
"refs": {
|
||||
"IndexField$LiteralOptions": null
|
||||
}
|
||||
},
|
||||
"Long": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"IntArrayOptions$DefaultValue": "A value to use for the field if the field isn't specified for a document.",
|
||||
"IntOptions$DefaultValue": "A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document."
|
||||
}
|
||||
},
|
||||
"MaximumPartitionCount": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Limits$MaximumPartitionCount": null
|
||||
}
|
||||
},
|
||||
"MaximumReplicationCount": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Limits$MaximumReplicationCount": null
|
||||
}
|
||||
},
|
||||
"MultiAZ": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AvailabilityOptionsStatus$Options": "<p>The availability options configured for the domain.</p>"
|
||||
}
|
||||
},
|
||||
"OptionState": {
|
||||
"base": "<p>The state of processing a change to an option. One of:</p> <ul> <li>RequiresIndexDocuments: The option's latest value will not be deployed until <a>IndexDocuments</a> has been called and indexing is complete.</li> <li>Processing: The option's latest value is in the process of being activated.</li> <li>Active: The option's latest value is fully deployed. </li> <li>FailedToValidate: The option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.</li> </ul>",
|
||||
"refs": {
|
||||
"OptionStatus$State": "<p>The state of processing a change to an option. Possible values:</p> <ul> <li> <code>RequiresIndexDocuments</code>: the option's latest value will not be deployed until <a>IndexDocuments</a> has been called and indexing is complete.</li> <li> <code>Processing</code>: the option's latest value is in the process of being activated. </li> <li> <code>Active</code>: the option's latest value is completely deployed.</li> <li> <code>FailedToValidate</code>: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.</li> </ul>"
|
||||
}
|
||||
},
|
||||
"OptionStatus": {
|
||||
"base": "<p>The status of domain configuration option.</p>",
|
||||
"refs": {
|
||||
"AccessPoliciesStatus$Status": null,
|
||||
"AnalysisSchemeStatus$Status": null,
|
||||
"AvailabilityOptionsStatus$Status": null,
|
||||
"ExpressionStatus$Status": null,
|
||||
"IndexFieldStatus$Status": null,
|
||||
"ScalingParametersStatus$Status": null,
|
||||
"SuggesterStatus$Status": null
|
||||
}
|
||||
},
|
||||
"PartitionCount": {
|
||||
"base": "<p>The number of partitions used to hold the domain's index.</p>",
|
||||
"refs": {
|
||||
"DomainStatus$SearchPartitionCount": "<p>The number of partitions across which the search index is spread.</p>"
|
||||
}
|
||||
},
|
||||
"PartitionInstanceType": {
|
||||
"base": "<p>The instance type (such as <code>search.m1.small</code>) on which an index partition is hosted.</p>",
|
||||
"refs": {
|
||||
"ScalingParameters$DesiredInstanceType": "<p>The instance type that you want to preconfigure for your domain. For example, <code>search.m1.small</code>.</p>"
|
||||
}
|
||||
},
|
||||
"PolicyDocument": {
|
||||
"base": "<p>Access rules for a domain's document or search service endpoints. For more information, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html\" target=\"_blank\">Configuring Access for a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. The maximum size of a policy document is 100 KB.</p>",
|
||||
"refs": {
|
||||
"AccessPoliciesStatus$Options": null,
|
||||
"UpdateServiceAccessPoliciesRequest$AccessPolicies": "<p>The access rules you want to configure. These rules replace any existing rules. </p>"
|
||||
}
|
||||
},
|
||||
"ResourceNotFoundException": {
|
||||
"base": "<p>The request was rejected because it attempted to reference a resource that does not exist.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ScalingParameters": {
|
||||
"base": "<p>The desired instance type and desired number of replicas of each index partition.</p>",
|
||||
"refs": {
|
||||
"ScalingParametersStatus$Options": null,
|
||||
"UpdateScalingParametersRequest$ScalingParameters": null
|
||||
}
|
||||
},
|
||||
"ScalingParametersStatus": {
|
||||
"base": "<p>The status and configuration of a search domain's scaling parameters. </p>",
|
||||
"refs": {
|
||||
"DescribeScalingParametersResponse$ScalingParameters": null,
|
||||
"UpdateScalingParametersResponse$ScalingParameters": null
|
||||
}
|
||||
},
|
||||
"SearchInstanceType": {
|
||||
"base": "<p>The instance type (such as <code>search.m1.small</code>) that is being used to process search requests.</p>",
|
||||
"refs": {
|
||||
"DomainStatus$SearchInstanceType": "<p>The instance type that is being used to process search requests.</p>"
|
||||
}
|
||||
},
|
||||
"ServiceEndpoint": {
|
||||
"base": "<p>The endpoint to which service requests can be submitted.</p>",
|
||||
"refs": {
|
||||
"DomainStatus$DocService": "<p>The service endpoint for updating documents in a search domain.</p>",
|
||||
"DomainStatus$SearchService": "<p>The service endpoint for requesting search results from a search domain.</p>"
|
||||
}
|
||||
},
|
||||
"ServiceUrl": {
|
||||
"base": "<p>The endpoint to which service requests can be submitted. For example, <code>search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code> or <code>doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code>.</p>",
|
||||
"refs": {
|
||||
"ServiceEndpoint$Endpoint": null
|
||||
}
|
||||
},
|
||||
"StandardName": {
|
||||
"base": "<p>Names must begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore).</p>",
|
||||
"refs": {
|
||||
"AnalysisScheme$AnalysisSchemeName": null,
|
||||
"DeleteAnalysisSchemeRequest$AnalysisSchemeName": "<p>The name of the analysis scheme you want to delete.</p>",
|
||||
"DeleteExpressionRequest$ExpressionName": "<p>The name of the <code><a>Expression</a></code> to delete.</p>",
|
||||
"DeleteSuggesterRequest$SuggesterName": "<p>Specifies the name of the suggester you want to delete.</p>",
|
||||
"Expression$ExpressionName": null,
|
||||
"StandardNameList$member": null,
|
||||
"Suggester$SuggesterName": null
|
||||
}
|
||||
},
|
||||
"StandardNameList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeAnalysisSchemesRequest$AnalysisSchemeNames": "<p>The analysis schemes you want to describe.</p>",
|
||||
"DescribeExpressionsRequest$ExpressionNames": "<p>Limits the <code><a>DescribeExpressions</a></code> response to the specified expressions. If not specified, all expressions are shown.</p>",
|
||||
"DescribeSuggestersRequest$SuggesterNames": "<p>The suggesters you want to describe.</p>"
|
||||
}
|
||||
},
|
||||
"String": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AnalysisOptions$Synonyms": "<p>A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see <a href=\"http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms\">Synonyms</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>",
|
||||
"AnalysisOptions$Stopwords": "<p>A JSON array of terms to ignore during indexing and searching. For example, <code>[\"a\", \"an\", \"the\", \"of\"]</code>. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. </p>",
|
||||
"AnalysisOptions$StemmingDictionary": "<p>A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, <code>{\"term1\": \"stem1\", \"term2\": \"stem2\", \"term3\": \"stem3\"}</code>. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.</p>",
|
||||
"AnalysisOptions$JapaneseTokenizationDictionary": "<p>A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.</p>",
|
||||
"DocumentSuggesterOptions$SortExpression": "<p>An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed for suggestions, so sort expressions cannot reference the <code>_score</code> value. To sort suggestions using a numeric field or existing expression, simply specify the name of the field or expression. If no expression is configured for the suggester, the suggestions are sorted with the closest matches listed first.</p>"
|
||||
}
|
||||
},
|
||||
"Suggester": {
|
||||
"base": "<p>Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: <code>FuzzyMatching</code>, <code>SortExpression</code>. </p>",
|
||||
"refs": {
|
||||
"DefineSuggesterRequest$Suggester": null,
|
||||
"SuggesterStatus$Options": null
|
||||
}
|
||||
},
|
||||
"SuggesterFuzzyMatching": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DocumentSuggesterOptions$FuzzyMatching": "<p>The level of fuzziness allowed when suggesting matches for a string: <code>none</code>, <code>low</code>, or <code>high</code>. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none. </p>"
|
||||
}
|
||||
},
|
||||
"SuggesterStatus": {
|
||||
"base": "<p>The value of a <code>Suggester</code> and its current status.</p>",
|
||||
"refs": {
|
||||
"DefineSuggesterResponse$Suggester": null,
|
||||
"DeleteSuggesterResponse$Suggester": "<p>The status of the suggester being deleted.</p>",
|
||||
"SuggesterStatusList$member": null
|
||||
}
|
||||
},
|
||||
"SuggesterStatusList": {
|
||||
"base": "<p>Contains the status of multiple suggesters.</p>",
|
||||
"refs": {
|
||||
"DescribeSuggestersResponse$Suggesters": "<p>The suggesters configured for the domain specified in the request.</p>"
|
||||
}
|
||||
},
|
||||
"TextArrayOptions": {
|
||||
"base": "<p>Options for a field that contains an array of text strings. Present if <code>IndexFieldType</code> specifies the field is of type <code>text-array</code>. A <code>text-array</code> field is always searchable. All options are enabled by default.</p>",
|
||||
"refs": {
|
||||
"IndexField$TextArrayOptions": null
|
||||
}
|
||||
},
|
||||
"TextOptions": {
|
||||
"base": "<p>Options for text field. Present if <code>IndexFieldType</code> specifies the field is of type <code>text</code>. A <code>text</code> field is always searchable. All options are enabled by default.</p>",
|
||||
"refs": {
|
||||
"IndexField$TextOptions": null
|
||||
}
|
||||
},
|
||||
"UIntValue": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"OptionStatus$UpdateVersion": "<p>A unique integer that indicates when this option was last updated.</p>",
|
||||
"ScalingParameters$DesiredReplicationCount": "<p>The number of replicas you want to preconfigure for each index partition.</p>",
|
||||
"ScalingParameters$DesiredPartitionCount": "<p>The number of partitions you want to preconfigure for your domain. Only valid when you select <code>m2.2xlarge</code> as the desired instance type.</p>"
|
||||
}
|
||||
},
|
||||
"UpdateAvailabilityOptionsRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>UpdateAvailabilityOptions</a></code> operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateAvailabilityOptionsResponse": {
|
||||
"base": "<p>The result of a <code>UpdateAvailabilityOptions</code> request. Contains the status of the domain's availability options. </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateScalingParametersRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>UpdateScalingParameters</a></code> operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateScalingParametersResponse": {
|
||||
"base": "<p>The result of a <code>UpdateScalingParameters</code> request. Contains the status of the newly-configured scaling parameters.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateServiceAccessPoliciesRequest": {
|
||||
"base": "<p>Container for the parameters to the <code><a>UpdateServiceAccessPolicies</a></code> operation. Specifies the name of the domain you want to update and the access rules you want to configure.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateServiceAccessPoliciesResponse": {
|
||||
"base": "<p>The result of an <code>UpdateServiceAccessPolicies</code> request. Contains the new access policies.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateTimestamp": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"OptionStatus$CreationDate": "<p>A timestamp for when this option was created.</p>",
|
||||
"OptionStatus$UpdateDate": "<p>A timestamp for when this option was last updated.</p>"
|
||||
}
|
||||
},
|
||||
"Word": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"TextArrayOptions$AnalysisScheme": "<p>The name of an analysis scheme for a <code>text-array</code> field.</p>",
|
||||
"TextOptions$AnalysisScheme": "<p>The name of an analysis scheme for a <code>text</code> field.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+20
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"pagination": {
|
||||
"DescribeAnalysisSchemes": {
|
||||
"result_key": "AnalysisSchemes"
|
||||
},
|
||||
"DescribeDomains": {
|
||||
"result_key": "DomainStatusList"
|
||||
},
|
||||
"DescribeExpressions": {
|
||||
"result_key": "Expressions"
|
||||
},
|
||||
"DescribeIndexFields": {
|
||||
"result_key": "IndexFields"
|
||||
},
|
||||
"DescribeSuggesters": {
|
||||
"result_key": "Suggesters"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Generated
Vendored
+374
@@ -0,0 +1,374 @@
|
||||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"apiVersion":"2013-01-01",
|
||||
"endpointPrefix":"cloudsearchdomain",
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"rest-json",
|
||||
"serviceFullName":"Amazon CloudSearch Domain",
|
||||
"signatureVersion":"v4",
|
||||
"signingName":"cloudsearch",
|
||||
"uid":"cloudsearchdomain-2013-01-01"
|
||||
},
|
||||
"operations":{
|
||||
"Search":{
|
||||
"name":"Search",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/2013-01-01/search?format=sdk&pretty=true"
|
||||
},
|
||||
"input":{"shape":"SearchRequest"},
|
||||
"output":{"shape":"SearchResponse"},
|
||||
"errors":[
|
||||
{"shape":"SearchException"}
|
||||
]
|
||||
},
|
||||
"Suggest":{
|
||||
"name":"Suggest",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/2013-01-01/suggest?format=sdk&pretty=true"
|
||||
},
|
||||
"input":{"shape":"SuggestRequest"},
|
||||
"output":{"shape":"SuggestResponse"},
|
||||
"errors":[
|
||||
{"shape":"SearchException"}
|
||||
]
|
||||
},
|
||||
"UploadDocuments":{
|
||||
"name":"UploadDocuments",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/2013-01-01/documents/batch?format=sdk"
|
||||
},
|
||||
"input":{"shape":"UploadDocumentsRequest"},
|
||||
"output":{"shape":"UploadDocumentsResponse"},
|
||||
"errors":[
|
||||
{"shape":"DocumentServiceException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"Adds":{"type":"long"},
|
||||
"Blob":{
|
||||
"type":"blob",
|
||||
"streaming":true
|
||||
},
|
||||
"Bucket":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"value":{"shape":"String"},
|
||||
"count":{"shape":"Long"}
|
||||
}
|
||||
},
|
||||
"BucketInfo":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"buckets":{"shape":"BucketList"}
|
||||
}
|
||||
},
|
||||
"BucketList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Bucket"}
|
||||
},
|
||||
"ContentType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"application/json",
|
||||
"application/xml"
|
||||
]
|
||||
},
|
||||
"Cursor":{"type":"string"},
|
||||
"Deletes":{"type":"long"},
|
||||
"DocumentServiceException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"status":{"shape":"String"},
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"DocumentServiceWarning":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DocumentServiceWarnings":{
|
||||
"type":"list",
|
||||
"member":{"shape":"DocumentServiceWarning"}
|
||||
},
|
||||
"Double":{"type":"double"},
|
||||
"Expr":{"type":"string"},
|
||||
"Exprs":{
|
||||
"type":"map",
|
||||
"key":{"shape":"String"},
|
||||
"value":{"shape":"String"}
|
||||
},
|
||||
"Facet":{"type":"string"},
|
||||
"Facets":{
|
||||
"type":"map",
|
||||
"key":{"shape":"String"},
|
||||
"value":{"shape":"BucketInfo"}
|
||||
},
|
||||
"FieldStats":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"min":{"shape":"String"},
|
||||
"max":{"shape":"String"},
|
||||
"count":{"shape":"Long"},
|
||||
"missing":{"shape":"Long"},
|
||||
"sum":{"shape":"Double"},
|
||||
"sumOfSquares":{"shape":"Double"},
|
||||
"mean":{"shape":"String"},
|
||||
"stddev":{"shape":"Double"}
|
||||
}
|
||||
},
|
||||
"FieldValue":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"Fields":{
|
||||
"type":"map",
|
||||
"key":{"shape":"String"},
|
||||
"value":{"shape":"FieldValue"}
|
||||
},
|
||||
"FilterQuery":{"type":"string"},
|
||||
"Highlight":{"type":"string"},
|
||||
"Highlights":{
|
||||
"type":"map",
|
||||
"key":{"shape":"String"},
|
||||
"value":{"shape":"String"}
|
||||
},
|
||||
"Hit":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"id":{"shape":"String"},
|
||||
"fields":{"shape":"Fields"},
|
||||
"exprs":{"shape":"Exprs"},
|
||||
"highlights":{"shape":"Highlights"}
|
||||
}
|
||||
},
|
||||
"HitList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Hit"}
|
||||
},
|
||||
"Hits":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"found":{"shape":"Long"},
|
||||
"start":{"shape":"Long"},
|
||||
"cursor":{"shape":"String"},
|
||||
"hit":{"shape":"HitList"}
|
||||
}
|
||||
},
|
||||
"Long":{"type":"long"},
|
||||
"Partial":{"type":"boolean"},
|
||||
"Query":{"type":"string"},
|
||||
"QueryOptions":{"type":"string"},
|
||||
"QueryParser":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"simple",
|
||||
"structured",
|
||||
"lucene",
|
||||
"dismax"
|
||||
]
|
||||
},
|
||||
"Return":{"type":"string"},
|
||||
"SearchException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"SearchRequest":{
|
||||
"type":"structure",
|
||||
"required":["query"],
|
||||
"members":{
|
||||
"cursor":{
|
||||
"shape":"Cursor",
|
||||
"location":"querystring",
|
||||
"locationName":"cursor"
|
||||
},
|
||||
"expr":{
|
||||
"shape":"Expr",
|
||||
"location":"querystring",
|
||||
"locationName":"expr"
|
||||
},
|
||||
"facet":{
|
||||
"shape":"Facet",
|
||||
"location":"querystring",
|
||||
"locationName":"facet"
|
||||
},
|
||||
"filterQuery":{
|
||||
"shape":"FilterQuery",
|
||||
"location":"querystring",
|
||||
"locationName":"fq"
|
||||
},
|
||||
"highlight":{
|
||||
"shape":"Highlight",
|
||||
"location":"querystring",
|
||||
"locationName":"highlight"
|
||||
},
|
||||
"partial":{
|
||||
"shape":"Partial",
|
||||
"location":"querystring",
|
||||
"locationName":"partial"
|
||||
},
|
||||
"query":{
|
||||
"shape":"Query",
|
||||
"location":"querystring",
|
||||
"locationName":"q"
|
||||
},
|
||||
"queryOptions":{
|
||||
"shape":"QueryOptions",
|
||||
"location":"querystring",
|
||||
"locationName":"q.options"
|
||||
},
|
||||
"queryParser":{
|
||||
"shape":"QueryParser",
|
||||
"location":"querystring",
|
||||
"locationName":"q.parser"
|
||||
},
|
||||
"return":{
|
||||
"shape":"Return",
|
||||
"location":"querystring",
|
||||
"locationName":"return"
|
||||
},
|
||||
"size":{
|
||||
"shape":"Size",
|
||||
"location":"querystring",
|
||||
"locationName":"size"
|
||||
},
|
||||
"sort":{
|
||||
"shape":"Sort",
|
||||
"location":"querystring",
|
||||
"locationName":"sort"
|
||||
},
|
||||
"start":{
|
||||
"shape":"Start",
|
||||
"location":"querystring",
|
||||
"locationName":"start"
|
||||
},
|
||||
"stats":{
|
||||
"shape":"Stat",
|
||||
"location":"querystring",
|
||||
"locationName":"stats"
|
||||
}
|
||||
}
|
||||
},
|
||||
"SearchResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"status":{"shape":"SearchStatus"},
|
||||
"hits":{"shape":"Hits"},
|
||||
"facets":{"shape":"Facets"},
|
||||
"stats":{"shape":"Stats"}
|
||||
}
|
||||
},
|
||||
"SearchStatus":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"timems":{"shape":"Long"},
|
||||
"rid":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"Size":{"type":"long"},
|
||||
"Sort":{"type":"string"},
|
||||
"Start":{"type":"long"},
|
||||
"Stat":{"type":"string"},
|
||||
"Stats":{
|
||||
"type":"map",
|
||||
"key":{"shape":"String"},
|
||||
"value":{"shape":"FieldStats"}
|
||||
},
|
||||
"String":{"type":"string"},
|
||||
"SuggestModel":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"query":{"shape":"String"},
|
||||
"found":{"shape":"Long"},
|
||||
"suggestions":{"shape":"Suggestions"}
|
||||
}
|
||||
},
|
||||
"SuggestRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"query",
|
||||
"suggester"
|
||||
],
|
||||
"members":{
|
||||
"query":{
|
||||
"shape":"Query",
|
||||
"location":"querystring",
|
||||
"locationName":"q"
|
||||
},
|
||||
"suggester":{
|
||||
"shape":"Suggester",
|
||||
"location":"querystring",
|
||||
"locationName":"suggester"
|
||||
},
|
||||
"size":{
|
||||
"shape":"SuggestionsSize",
|
||||
"location":"querystring",
|
||||
"locationName":"size"
|
||||
}
|
||||
}
|
||||
},
|
||||
"SuggestResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"status":{"shape":"SuggestStatus"},
|
||||
"suggest":{"shape":"SuggestModel"}
|
||||
}
|
||||
},
|
||||
"SuggestStatus":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"timems":{"shape":"Long"},
|
||||
"rid":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"Suggester":{"type":"string"},
|
||||
"SuggestionMatch":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"suggestion":{"shape":"String"},
|
||||
"score":{"shape":"Long"},
|
||||
"id":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"Suggestions":{
|
||||
"type":"list",
|
||||
"member":{"shape":"SuggestionMatch"}
|
||||
},
|
||||
"SuggestionsSize":{"type":"long"},
|
||||
"UploadDocumentsRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"documents",
|
||||
"contentType"
|
||||
],
|
||||
"members":{
|
||||
"documents":{"shape":"Blob"},
|
||||
"contentType":{
|
||||
"shape":"ContentType",
|
||||
"location":"header",
|
||||
"locationName":"Content-Type"
|
||||
}
|
||||
},
|
||||
"payload":"documents"
|
||||
},
|
||||
"UploadDocumentsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"status":{"shape":"String"},
|
||||
"adds":{"shape":"Adds"},
|
||||
"deletes":{"shape":"Deletes"},
|
||||
"warnings":{"shape":"DocumentServiceWarnings"}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+343
File diff suppressed because one or more lines are too long
Generated
Vendored
+5
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
+907
@@ -0,0 +1,907 @@
|
||||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"apiVersion":"2013-11-01",
|
||||
"endpointPrefix":"cloudtrail",
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceAbbreviation":"CloudTrail",
|
||||
"serviceFullName":"AWS CloudTrail",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"com.amazonaws.cloudtrail.v20131101.CloudTrail_20131101",
|
||||
"uid":"cloudtrail-2013-11-01"
|
||||
},
|
||||
"operations":{
|
||||
"AddTags":{
|
||||
"name":"AddTags",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"AddTagsRequest"},
|
||||
"output":{"shape":"AddTagsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"CloudTrailARNInvalidException"},
|
||||
{"shape":"ResourceTypeNotSupportedException"},
|
||||
{"shape":"TagsLimitExceededException"},
|
||||
{"shape":"InvalidTrailNameException"},
|
||||
{"shape":"InvalidTagParameterException"},
|
||||
{"shape":"UnsupportedOperationException"},
|
||||
{"shape":"OperationNotPermittedException"}
|
||||
],
|
||||
"idempotent":true
|
||||
},
|
||||
"CreateTrail":{
|
||||
"name":"CreateTrail",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateTrailRequest"},
|
||||
"output":{"shape":"CreateTrailResponse"},
|
||||
"errors":[
|
||||
{"shape":"MaximumNumberOfTrailsExceededException"},
|
||||
{"shape":"TrailAlreadyExistsException"},
|
||||
{"shape":"S3BucketDoesNotExistException"},
|
||||
{"shape":"InsufficientS3BucketPolicyException"},
|
||||
{"shape":"InsufficientSnsTopicPolicyException"},
|
||||
{"shape":"InsufficientEncryptionPolicyException"},
|
||||
{"shape":"InvalidS3BucketNameException"},
|
||||
{"shape":"InvalidS3PrefixException"},
|
||||
{"shape":"InvalidSnsTopicNameException"},
|
||||
{"shape":"InvalidKmsKeyIdException"},
|
||||
{"shape":"InvalidTrailNameException"},
|
||||
{"shape":"TrailNotProvidedException"},
|
||||
{"shape":"InvalidParameterCombinationException"},
|
||||
{"shape":"KmsKeyNotFoundException"},
|
||||
{"shape":"KmsKeyDisabledException"},
|
||||
{"shape":"KmsException"},
|
||||
{"shape":"InvalidCloudWatchLogsLogGroupArnException"},
|
||||
{"shape":"InvalidCloudWatchLogsRoleArnException"},
|
||||
{"shape":"CloudWatchLogsDeliveryUnavailableException"},
|
||||
{"shape":"UnsupportedOperationException"},
|
||||
{"shape":"OperationNotPermittedException"}
|
||||
],
|
||||
"idempotent":true
|
||||
},
|
||||
"DeleteTrail":{
|
||||
"name":"DeleteTrail",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteTrailRequest"},
|
||||
"output":{"shape":"DeleteTrailResponse"},
|
||||
"errors":[
|
||||
{"shape":"TrailNotFoundException"},
|
||||
{"shape":"InvalidTrailNameException"},
|
||||
{"shape":"InvalidHomeRegionException"}
|
||||
],
|
||||
"idempotent":true
|
||||
},
|
||||
"DescribeTrails":{
|
||||
"name":"DescribeTrails",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeTrailsRequest"},
|
||||
"output":{"shape":"DescribeTrailsResponse"},
|
||||
"errors":[
|
||||
{"shape":"UnsupportedOperationException"},
|
||||
{"shape":"OperationNotPermittedException"}
|
||||
],
|
||||
"idempotent":true
|
||||
},
|
||||
"GetEventSelectors":{
|
||||
"name":"GetEventSelectors",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetEventSelectorsRequest"},
|
||||
"output":{"shape":"GetEventSelectorsResponse"},
|
||||
"errors":[
|
||||
{"shape":"TrailNotFoundException"},
|
||||
{"shape":"InvalidTrailNameException"},
|
||||
{"shape":"UnsupportedOperationException"},
|
||||
{"shape":"OperationNotPermittedException"}
|
||||
],
|
||||
"idempotent":true
|
||||
},
|
||||
"GetTrailStatus":{
|
||||
"name":"GetTrailStatus",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetTrailStatusRequest"},
|
||||
"output":{"shape":"GetTrailStatusResponse"},
|
||||
"errors":[
|
||||
{"shape":"TrailNotFoundException"},
|
||||
{"shape":"InvalidTrailNameException"}
|
||||
],
|
||||
"idempotent":true
|
||||
},
|
||||
"ListPublicKeys":{
|
||||
"name":"ListPublicKeys",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListPublicKeysRequest"},
|
||||
"output":{"shape":"ListPublicKeysResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidTimeRangeException"},
|
||||
{"shape":"UnsupportedOperationException"},
|
||||
{"shape":"OperationNotPermittedException"},
|
||||
{"shape":"InvalidTokenException"}
|
||||
],
|
||||
"idempotent":true
|
||||
},
|
||||
"ListTags":{
|
||||
"name":"ListTags",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListTagsRequest"},
|
||||
"output":{"shape":"ListTagsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"CloudTrailARNInvalidException"},
|
||||
{"shape":"ResourceTypeNotSupportedException"},
|
||||
{"shape":"InvalidTrailNameException"},
|
||||
{"shape":"UnsupportedOperationException"},
|
||||
{"shape":"OperationNotPermittedException"},
|
||||
{"shape":"InvalidTokenException"}
|
||||
],
|
||||
"idempotent":true
|
||||
},
|
||||
"LookupEvents":{
|
||||
"name":"LookupEvents",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"LookupEventsRequest"},
|
||||
"output":{"shape":"LookupEventsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidLookupAttributesException"},
|
||||
{"shape":"InvalidTimeRangeException"},
|
||||
{"shape":"InvalidMaxResultsException"},
|
||||
{"shape":"InvalidNextTokenException"}
|
||||
],
|
||||
"idempotent":true
|
||||
},
|
||||
"PutEventSelectors":{
|
||||
"name":"PutEventSelectors",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"PutEventSelectorsRequest"},
|
||||
"output":{"shape":"PutEventSelectorsResponse"},
|
||||
"errors":[
|
||||
{"shape":"TrailNotFoundException"},
|
||||
{"shape":"InvalidTrailNameException"},
|
||||
{"shape":"InvalidHomeRegionException"},
|
||||
{"shape":"InvalidEventSelectorsException"},
|
||||
{"shape":"UnsupportedOperationException"},
|
||||
{"shape":"OperationNotPermittedException"}
|
||||
],
|
||||
"idempotent":true
|
||||
},
|
||||
"RemoveTags":{
|
||||
"name":"RemoveTags",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"RemoveTagsRequest"},
|
||||
"output":{"shape":"RemoveTagsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"CloudTrailARNInvalidException"},
|
||||
{"shape":"ResourceTypeNotSupportedException"},
|
||||
{"shape":"InvalidTrailNameException"},
|
||||
{"shape":"InvalidTagParameterException"},
|
||||
{"shape":"UnsupportedOperationException"},
|
||||
{"shape":"OperationNotPermittedException"}
|
||||
],
|
||||
"idempotent":true
|
||||
},
|
||||
"StartLogging":{
|
||||
"name":"StartLogging",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StartLoggingRequest"},
|
||||
"output":{"shape":"StartLoggingResponse"},
|
||||
"errors":[
|
||||
{"shape":"TrailNotFoundException"},
|
||||
{"shape":"InvalidTrailNameException"},
|
||||
{"shape":"InvalidHomeRegionException"}
|
||||
],
|
||||
"idempotent":true
|
||||
},
|
||||
"StopLogging":{
|
||||
"name":"StopLogging",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StopLoggingRequest"},
|
||||
"output":{"shape":"StopLoggingResponse"},
|
||||
"errors":[
|
||||
{"shape":"TrailNotFoundException"},
|
||||
{"shape":"InvalidTrailNameException"},
|
||||
{"shape":"InvalidHomeRegionException"}
|
||||
],
|
||||
"idempotent":true
|
||||
},
|
||||
"UpdateTrail":{
|
||||
"name":"UpdateTrail",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateTrailRequest"},
|
||||
"output":{"shape":"UpdateTrailResponse"},
|
||||
"errors":[
|
||||
{"shape":"S3BucketDoesNotExistException"},
|
||||
{"shape":"InsufficientS3BucketPolicyException"},
|
||||
{"shape":"InsufficientSnsTopicPolicyException"},
|
||||
{"shape":"InsufficientEncryptionPolicyException"},
|
||||
{"shape":"TrailNotFoundException"},
|
||||
{"shape":"InvalidS3BucketNameException"},
|
||||
{"shape":"InvalidS3PrefixException"},
|
||||
{"shape":"InvalidSnsTopicNameException"},
|
||||
{"shape":"InvalidKmsKeyIdException"},
|
||||
{"shape":"InvalidTrailNameException"},
|
||||
{"shape":"TrailNotProvidedException"},
|
||||
{"shape":"InvalidParameterCombinationException"},
|
||||
{"shape":"InvalidHomeRegionException"},
|
||||
{"shape":"KmsKeyNotFoundException"},
|
||||
{"shape":"KmsKeyDisabledException"},
|
||||
{"shape":"KmsException"},
|
||||
{"shape":"InvalidCloudWatchLogsLogGroupArnException"},
|
||||
{"shape":"InvalidCloudWatchLogsRoleArnException"},
|
||||
{"shape":"CloudWatchLogsDeliveryUnavailableException"},
|
||||
{"shape":"UnsupportedOperationException"},
|
||||
{"shape":"OperationNotPermittedException"}
|
||||
],
|
||||
"idempotent":true
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AddTagsRequest":{
|
||||
"type":"structure",
|
||||
"required":["ResourceId"],
|
||||
"members":{
|
||||
"ResourceId":{"shape":"String"},
|
||||
"TagsList":{"shape":"TagsList"}
|
||||
}
|
||||
},
|
||||
"AddTagsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"Boolean":{"type":"boolean"},
|
||||
"ByteBuffer":{"type":"blob"},
|
||||
"CloudTrailARNInvalidException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"CloudWatchLogsDeliveryUnavailableException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"CreateTrailRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Name",
|
||||
"S3BucketName"
|
||||
],
|
||||
"members":{
|
||||
"Name":{"shape":"String"},
|
||||
"S3BucketName":{"shape":"String"},
|
||||
"S3KeyPrefix":{"shape":"String"},
|
||||
"SnsTopicName":{"shape":"String"},
|
||||
"IncludeGlobalServiceEvents":{"shape":"Boolean"},
|
||||
"IsMultiRegionTrail":{"shape":"Boolean"},
|
||||
"EnableLogFileValidation":{"shape":"Boolean"},
|
||||
"CloudWatchLogsLogGroupArn":{"shape":"String"},
|
||||
"CloudWatchLogsRoleArn":{"shape":"String"},
|
||||
"KmsKeyId":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"CreateTrailResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Name":{"shape":"String"},
|
||||
"S3BucketName":{"shape":"String"},
|
||||
"S3KeyPrefix":{"shape":"String"},
|
||||
"SnsTopicName":{
|
||||
"shape":"String",
|
||||
"deprecated":true
|
||||
},
|
||||
"SnsTopicARN":{"shape":"String"},
|
||||
"IncludeGlobalServiceEvents":{"shape":"Boolean"},
|
||||
"IsMultiRegionTrail":{"shape":"Boolean"},
|
||||
"TrailARN":{"shape":"String"},
|
||||
"LogFileValidationEnabled":{"shape":"Boolean"},
|
||||
"CloudWatchLogsLogGroupArn":{"shape":"String"},
|
||||
"CloudWatchLogsRoleArn":{"shape":"String"},
|
||||
"KmsKeyId":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DataResource":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Type":{"shape":"String"},
|
||||
"Values":{"shape":"DataResourceValues"}
|
||||
}
|
||||
},
|
||||
"DataResourceValues":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"DataResources":{
|
||||
"type":"list",
|
||||
"member":{"shape":"DataResource"}
|
||||
},
|
||||
"Date":{"type":"timestamp"},
|
||||
"DeleteTrailRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"DeleteTrailResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DescribeTrailsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"trailNameList":{"shape":"TrailNameList"},
|
||||
"includeShadowTrails":{"shape":"Boolean"}
|
||||
}
|
||||
},
|
||||
"DescribeTrailsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"trailList":{"shape":"TrailList"}
|
||||
}
|
||||
},
|
||||
"Event":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"EventId":{"shape":"String"},
|
||||
"EventName":{"shape":"String"},
|
||||
"EventTime":{"shape":"Date"},
|
||||
"EventSource":{"shape":"String"},
|
||||
"Username":{"shape":"String"},
|
||||
"Resources":{"shape":"ResourceList"},
|
||||
"CloudTrailEvent":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"EventSelector":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ReadWriteType":{"shape":"ReadWriteType"},
|
||||
"IncludeManagementEvents":{"shape":"Boolean"},
|
||||
"DataResources":{"shape":"DataResources"}
|
||||
}
|
||||
},
|
||||
"EventSelectors":{
|
||||
"type":"list",
|
||||
"member":{"shape":"EventSelector"}
|
||||
},
|
||||
"EventsList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Event"}
|
||||
},
|
||||
"GetEventSelectorsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TrailName":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"GetEventSelectorsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TrailARN":{"shape":"String"},
|
||||
"EventSelectors":{"shape":"EventSelectors"}
|
||||
}
|
||||
},
|
||||
"GetTrailStatusRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"GetTrailStatusResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"IsLogging":{"shape":"Boolean"},
|
||||
"LatestDeliveryError":{"shape":"String"},
|
||||
"LatestNotificationError":{"shape":"String"},
|
||||
"LatestDeliveryTime":{"shape":"Date"},
|
||||
"LatestNotificationTime":{"shape":"Date"},
|
||||
"StartLoggingTime":{"shape":"Date"},
|
||||
"StopLoggingTime":{"shape":"Date"},
|
||||
"LatestCloudWatchLogsDeliveryError":{"shape":"String"},
|
||||
"LatestCloudWatchLogsDeliveryTime":{"shape":"Date"},
|
||||
"LatestDigestDeliveryTime":{"shape":"Date"},
|
||||
"LatestDigestDeliveryError":{"shape":"String"},
|
||||
"LatestDeliveryAttemptTime":{"shape":"String"},
|
||||
"LatestNotificationAttemptTime":{"shape":"String"},
|
||||
"LatestNotificationAttemptSucceeded":{"shape":"String"},
|
||||
"LatestDeliveryAttemptSucceeded":{"shape":"String"},
|
||||
"TimeLoggingStarted":{"shape":"String"},
|
||||
"TimeLoggingStopped":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"InsufficientEncryptionPolicyException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InsufficientS3BucketPolicyException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InsufficientSnsTopicPolicyException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidCloudWatchLogsLogGroupArnException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidCloudWatchLogsRoleArnException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidEventSelectorsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidHomeRegionException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidKmsKeyIdException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidLookupAttributesException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidMaxResultsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidNextTokenException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidParameterCombinationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidS3BucketNameException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidS3PrefixException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidSnsTopicNameException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidTagParameterException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidTimeRangeException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidTokenException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidTrailNameException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"KmsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"KmsKeyDisabledException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"deprecated":true,
|
||||
"exception":true
|
||||
},
|
||||
"KmsKeyNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ListPublicKeysRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"StartTime":{"shape":"Date"},
|
||||
"EndTime":{"shape":"Date"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ListPublicKeysResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"PublicKeyList":{"shape":"PublicKeyList"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ListTagsRequest":{
|
||||
"type":"structure",
|
||||
"required":["ResourceIdList"],
|
||||
"members":{
|
||||
"ResourceIdList":{"shape":"ResourceIdList"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ListTagsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ResourceTagList":{"shape":"ResourceTagList"},
|
||||
"NextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"LookupAttribute":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AttributeKey",
|
||||
"AttributeValue"
|
||||
],
|
||||
"members":{
|
||||
"AttributeKey":{"shape":"LookupAttributeKey"},
|
||||
"AttributeValue":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"LookupAttributeKey":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"EventId",
|
||||
"EventName",
|
||||
"Username",
|
||||
"ResourceType",
|
||||
"ResourceName",
|
||||
"EventSource"
|
||||
]
|
||||
},
|
||||
"LookupAttributesList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"LookupAttribute"}
|
||||
},
|
||||
"LookupEventsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"LookupAttributes":{"shape":"LookupAttributesList"},
|
||||
"StartTime":{"shape":"Date"},
|
||||
"EndTime":{"shape":"Date"},
|
||||
"MaxResults":{"shape":"MaxResults"},
|
||||
"NextToken":{"shape":"NextToken"}
|
||||
}
|
||||
},
|
||||
"LookupEventsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Events":{"shape":"EventsList"},
|
||||
"NextToken":{"shape":"NextToken"}
|
||||
}
|
||||
},
|
||||
"MaxResults":{
|
||||
"type":"integer",
|
||||
"max":50,
|
||||
"min":1
|
||||
},
|
||||
"MaximumNumberOfTrailsExceededException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"NextToken":{"type":"string"},
|
||||
"OperationNotPermittedException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"PublicKey":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Value":{"shape":"ByteBuffer"},
|
||||
"ValidityStartTime":{"shape":"Date"},
|
||||
"ValidityEndTime":{"shape":"Date"},
|
||||
"Fingerprint":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"PublicKeyList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"PublicKey"}
|
||||
},
|
||||
"PutEventSelectorsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TrailName":{"shape":"String"},
|
||||
"EventSelectors":{"shape":"EventSelectors"}
|
||||
}
|
||||
},
|
||||
"PutEventSelectorsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TrailARN":{"shape":"String"},
|
||||
"EventSelectors":{"shape":"EventSelectors"}
|
||||
}
|
||||
},
|
||||
"ReadWriteType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ReadOnly",
|
||||
"WriteOnly",
|
||||
"All"
|
||||
]
|
||||
},
|
||||
"RemoveTagsRequest":{
|
||||
"type":"structure",
|
||||
"required":["ResourceId"],
|
||||
"members":{
|
||||
"ResourceId":{"shape":"String"},
|
||||
"TagsList":{"shape":"TagsList"}
|
||||
}
|
||||
},
|
||||
"RemoveTagsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"Resource":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ResourceType":{"shape":"String"},
|
||||
"ResourceName":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ResourceIdList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"ResourceList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Resource"}
|
||||
},
|
||||
"ResourceNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ResourceTag":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ResourceId":{"shape":"String"},
|
||||
"TagsList":{"shape":"TagsList"}
|
||||
}
|
||||
},
|
||||
"ResourceTagList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ResourceTag"}
|
||||
},
|
||||
"ResourceTypeNotSupportedException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"S3BucketDoesNotExistException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"StartLoggingRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"StartLoggingResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"StopLoggingRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"StopLoggingResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"String":{"type":"string"},
|
||||
"Tag":{
|
||||
"type":"structure",
|
||||
"required":["Key"],
|
||||
"members":{
|
||||
"Key":{"shape":"String"},
|
||||
"Value":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"TagsLimitExceededException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"TagsList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Tag"}
|
||||
},
|
||||
"Trail":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Name":{"shape":"String"},
|
||||
"S3BucketName":{"shape":"String"},
|
||||
"S3KeyPrefix":{"shape":"String"},
|
||||
"SnsTopicName":{
|
||||
"shape":"String",
|
||||
"deprecated":true
|
||||
},
|
||||
"SnsTopicARN":{"shape":"String"},
|
||||
"IncludeGlobalServiceEvents":{"shape":"Boolean"},
|
||||
"IsMultiRegionTrail":{"shape":"Boolean"},
|
||||
"HomeRegion":{"shape":"String"},
|
||||
"TrailARN":{"shape":"String"},
|
||||
"LogFileValidationEnabled":{"shape":"Boolean"},
|
||||
"CloudWatchLogsLogGroupArn":{"shape":"String"},
|
||||
"CloudWatchLogsRoleArn":{"shape":"String"},
|
||||
"KmsKeyId":{"shape":"String"},
|
||||
"HasCustomEventSelectors":{"shape":"Boolean"}
|
||||
}
|
||||
},
|
||||
"TrailAlreadyExistsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"TrailList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Trail"}
|
||||
},
|
||||
"TrailNameList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"TrailNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"TrailNotProvidedException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"UnsupportedOperationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"UpdateTrailRequest":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{"shape":"String"},
|
||||
"S3BucketName":{"shape":"String"},
|
||||
"S3KeyPrefix":{"shape":"String"},
|
||||
"SnsTopicName":{"shape":"String"},
|
||||
"IncludeGlobalServiceEvents":{"shape":"Boolean"},
|
||||
"IsMultiRegionTrail":{"shape":"Boolean"},
|
||||
"EnableLogFileValidation":{"shape":"Boolean"},
|
||||
"CloudWatchLogsLogGroupArn":{"shape":"String"},
|
||||
"CloudWatchLogsRoleArn":{"shape":"String"},
|
||||
"KmsKeyId":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"UpdateTrailResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Name":{"shape":"String"},
|
||||
"S3BucketName":{"shape":"String"},
|
||||
"S3KeyPrefix":{"shape":"String"},
|
||||
"SnsTopicName":{
|
||||
"shape":"String",
|
||||
"deprecated":true
|
||||
},
|
||||
"SnsTopicARN":{"shape":"String"},
|
||||
"IncludeGlobalServiceEvents":{"shape":"Boolean"},
|
||||
"IsMultiRegionTrail":{"shape":"Boolean"},
|
||||
"TrailARN":{"shape":"String"},
|
||||
"LogFileValidationEnabled":{"shape":"Boolean"},
|
||||
"CloudWatchLogsLogGroupArn":{"shape":"String"},
|
||||
"CloudWatchLogsRoleArn":{"shape":"String"},
|
||||
"KmsKeyId":{"shape":"String"}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+622
@@ -0,0 +1,622 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<fullname>AWS CloudTrail</fullname> <p>This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.</p> <p>CloudTrail is a web service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the AWS API call, the source IP address, the request parameters, and the response elements returned by the service.</p> <note> <p>As an alternative to the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWSCloudTrail. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For information about the AWS SDKs, including how to download and install them, see the <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services page</a>.</p> </note> <p>See the <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-user-guide.html\">AWS CloudTrail User Guide</a> for information about the data that is included with each AWS API call listed in the log files.</p>",
|
||||
"operations": {
|
||||
"AddTags": "<p>Adds one or more tags to a trail, up to a limit of 50. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all regions only from the region in which the trail was created (that is, from its home region).</p>",
|
||||
"CreateTrail": "<p>Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.</p>",
|
||||
"DeleteTrail": "<p>Deletes a trail. This operation must be called from the region in which the trail was created. <code>DeleteTrail</code> cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.</p>",
|
||||
"DescribeTrails": "<p>Retrieves settings for the trail associated with the current region for your account.</p>",
|
||||
"GetEventSelectors": "<p>Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:</p> <ul> <li> <p>The S3 objects that you are logging for data events.</p> </li> <li> <p>If your event selector includes management events.</p> </li> <li> <p>If your event selector includes read-only events, write-only events, or all. </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html\">Logging Data and Management Events for Trails </a> in the <i>AWS CloudTrail User Guide</i>.</p>",
|
||||
"GetTrailStatus": "<p>Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region.</p>",
|
||||
"ListPublicKeys": "<p>Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.</p> <note> <p>CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.</p> </note>",
|
||||
"ListTags": "<p>Lists the tags for the trail in the current region.</p>",
|
||||
"LookupEvents": "<p>Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports the following attributes:</p> <ul> <li> <p>Event ID</p> </li> <li> <p>Event name</p> </li> <li> <p>Event source</p> </li> <li> <p>Resource name</p> </li> <li> <p>Resource type</p> </li> <li> <p>User name</p> </li> </ul> <p>All attributes are optional. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.</p> <important> <p>The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.</p> </important> <important> <p>Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.</p> </important>",
|
||||
"PutEventSelectors": "<p>Configures an event selector for your trail. Use event selectors to specify whether you want your trail to log management and/or data events. When an event occurs in your account, CloudTrail evaluates the event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. </p> <p>Example</p> <ol> <li> <p>You create an event selector for a trail and specify that you want write-only events.</p> </li> <li> <p>The EC2 <code>GetConsoleOutput</code> and <code>RunInstances</code> API operations occur in your account.</p> </li> <li> <p>CloudTrail evaluates whether the events match your event selectors.</p> </li> <li> <p>The <code>RunInstances</code> is a write-only event and it matches your event selector. The trail logs the event.</p> </li> <li> <p>The <code>GetConsoleOutput</code> is a read-only event but it doesn't match your event selector. The trail doesn't log the event. </p> </li> </ol> <p>The <code>PutEventSelectors</code> operation must be called from the region in which the trail was created; otherwise, an <code>InvalidHomeRegionException</code> is thrown.</p> <p>You can configure up to five event selectors for each trail. For more information, see <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html\">Logging Data and Management Events for Trails </a> in the <i>AWS CloudTrail User Guide</i>.</p>",
|
||||
"RemoveTags": "<p>Removes the specified tags from a trail.</p>",
|
||||
"StartLogging": "<p>Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.</p>",
|
||||
"StopLogging": "<p>Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an <code>InvalidHomeRegionException</code> will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.</p>",
|
||||
"UpdateTrail": "<p>Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. <code>UpdateTrail</code> must be called from the region in which the trail was created; otherwise, an <code>InvalidHomeRegionException</code> is thrown.</p>"
|
||||
},
|
||||
"shapes": {
|
||||
"AddTagsRequest": {
|
||||
"base": "<p>Specifies the tags to add to a trail.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"AddTagsResponse": {
|
||||
"base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Boolean": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateTrailRequest$IncludeGlobalServiceEvents": "<p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>",
|
||||
"CreateTrailRequest$IsMultiRegionTrail": "<p>Specifies whether the trail is created in the current region or in all regions. The default is false.</p>",
|
||||
"CreateTrailRequest$EnableLogFileValidation": "<p>Specifies whether log file integrity validation is enabled. The default is false.</p> <note> <p>When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.</p> </note>",
|
||||
"CreateTrailResponse$IncludeGlobalServiceEvents": "<p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>",
|
||||
"CreateTrailResponse$IsMultiRegionTrail": "<p>Specifies whether the trail exists in one region or in all regions.</p>",
|
||||
"CreateTrailResponse$LogFileValidationEnabled": "<p>Specifies whether log file integrity validation is enabled.</p>",
|
||||
"DescribeTrailsRequest$includeShadowTrails": "<p>Specifies whether to include shadow trails in the response. A shadow trail is the replication in a region of a trail that was created in a different region. The default is true.</p>",
|
||||
"EventSelector$IncludeManagementEvents": "<p>Specify if you want your event selector to include management events for your trail.</p> <p> For more information, see <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-management-events\">Management Events</a> in the <i>AWS CloudTrail User Guide</i>.</p> <p>By default, the value is <code>true</code>.</p>",
|
||||
"GetTrailStatusResponse$IsLogging": "<p>Whether the CloudTrail is currently logging AWS API calls.</p>",
|
||||
"Trail$IncludeGlobalServiceEvents": "<p>Set to <b>True</b> to include AWS API calls from AWS global services such as IAM. Otherwise, <b>False</b>.</p>",
|
||||
"Trail$IsMultiRegionTrail": "<p>Specifies whether the trail belongs only to one region or exists in all regions.</p>",
|
||||
"Trail$LogFileValidationEnabled": "<p>Specifies whether log file validation is enabled.</p>",
|
||||
"Trail$HasCustomEventSelectors": "<p>Specifies if the trail has custom event selectors.</p>",
|
||||
"UpdateTrailRequest$IncludeGlobalServiceEvents": "<p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>",
|
||||
"UpdateTrailRequest$IsMultiRegionTrail": "<p>Specifies whether the trail applies only to the current region or to all regions. The default is false. If the trail exists only in the current region and this value is set to true, shadow trails (replications of the trail) will be created in the other regions. If the trail exists in all regions and this value is set to false, the trail will remain in the region where it was created, and its shadow trails in other regions will be deleted.</p>",
|
||||
"UpdateTrailRequest$EnableLogFileValidation": "<p>Specifies whether log file validation is enabled. The default is false.</p> <note> <p>When you disable log file integrity validation, the chain of digest files is broken after one hour. CloudTrail will not create digest files for log files that were delivered during a period in which log file integrity validation was disabled. For example, if you enable log file integrity validation at noon on January 1, disable it at noon on January 2, and re-enable it at noon on January 10, digest files will not be created for the log files delivered from noon on January 2 to noon on January 10. The same applies whenever you stop CloudTrail logging or delete a trail.</p> </note>",
|
||||
"UpdateTrailResponse$IncludeGlobalServiceEvents": "<p>Specifies whether the trail is publishing events from global services such as IAM to the log files.</p>",
|
||||
"UpdateTrailResponse$IsMultiRegionTrail": "<p>Specifies whether the trail exists in one region or in all regions.</p>",
|
||||
"UpdateTrailResponse$LogFileValidationEnabled": "<p>Specifies whether log file integrity validation is enabled.</p>"
|
||||
}
|
||||
},
|
||||
"ByteBuffer": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PublicKey$Value": "<p>The DER encoded public key value in PKCS#1 format.</p>"
|
||||
}
|
||||
},
|
||||
"CloudTrailARNInvalidException": {
|
||||
"base": "<p>This exception is thrown when an operation is called with an invalid trail ARN. The format of a trail ARN is:</p> <p> <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code> </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CloudWatchLogsDeliveryUnavailableException": {
|
||||
"base": "<p>Cannot set a CloudWatch Logs delivery for this region.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateTrailRequest": {
|
||||
"base": "<p>Specifies the settings for each trail.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateTrailResponse": {
|
||||
"base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DataResource": {
|
||||
"base": "<p>The Amazon S3 objects that you specify in your event selectors for your trail to log data events. Data events are object-level API operations that access S3 objects, such as <code>GetObject</code>, <code>DeleteObject</code>, and <code>PutObject</code>. You can specify up to 250 S3 buckets and object prefixes for a trail. </p> <p>Example</p> <ol> <li> <p>You create an event selector for a trail and specify an S3 bucket and an empty prefix, such as <code>arn:aws:s3:::bucket-1/</code>.</p> </li> <li> <p>You upload an image file to <code>bucket-1</code>.</p> </li> <li> <p>The <code>PutObject</code> API operation occurs on an object in the S3 bucket that you specified in the event selector. The trail processes and logs the event.</p> </li> <li> <p>You upload another image file to a different S3 bucket named <code>arn:aws:s3:::bucket-2</code>.</p> </li> <li> <p>The event occurs on an object in an S3 bucket that you didn't specify in the event selector. The trail doesn’t log the event.</p> </li> </ol>",
|
||||
"refs": {
|
||||
"DataResources$member": null
|
||||
}
|
||||
},
|
||||
"DataResourceValues": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DataResource$Values": "<p>A list of ARN-like strings for the specified S3 objects.</p> <p>To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as <code>arn:aws:s3:::bucket-1/</code>. The trail logs data events for all objects in this S3 bucket.</p> <p>To log data events for specific objects, specify the S3 bucket and object prefix such as <code>arn:aws:s3:::bucket-1/example-images</code>. The trail logs data events for objects in this S3 bucket that match the prefix.</p>"
|
||||
}
|
||||
},
|
||||
"DataResources": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"EventSelector$DataResources": "<p>CloudTrail supports logging only data events for S3 objects. You can specify up to 250 S3 buckets and object prefixes for a trail.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-data-events\">Data Events</a> in the <i>AWS CloudTrail User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"Date": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Event$EventTime": "<p>The date and time of the event returned.</p>",
|
||||
"GetTrailStatusResponse$LatestDeliveryTime": "<p>Specifies the date and time that CloudTrail last delivered log files to an account's Amazon S3 bucket.</p>",
|
||||
"GetTrailStatusResponse$LatestNotificationTime": "<p>Specifies the date and time of the most recent Amazon SNS notification that CloudTrail has written a new log file to an account's Amazon S3 bucket.</p>",
|
||||
"GetTrailStatusResponse$StartLoggingTime": "<p>Specifies the most recent date and time when CloudTrail started recording API calls for an AWS account.</p>",
|
||||
"GetTrailStatusResponse$StopLoggingTime": "<p>Specifies the most recent date and time when CloudTrail stopped recording API calls for an AWS account.</p>",
|
||||
"GetTrailStatusResponse$LatestCloudWatchLogsDeliveryTime": "<p>Displays the most recent date and time when CloudTrail delivered logs to CloudWatch Logs.</p>",
|
||||
"GetTrailStatusResponse$LatestDigestDeliveryTime": "<p>Specifies the date and time that CloudTrail last delivered a digest file to an account's Amazon S3 bucket.</p>",
|
||||
"ListPublicKeysRequest$StartTime": "<p>Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.</p>",
|
||||
"ListPublicKeysRequest$EndTime": "<p>Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.</p>",
|
||||
"LookupEventsRequest$StartTime": "<p>Specifies that only events that occur after or at the specified time are returned. If the specified start time is after the specified end time, an error is returned.</p>",
|
||||
"LookupEventsRequest$EndTime": "<p>Specifies that only events that occur before or at the specified time are returned. If the specified end time is before the specified start time, an error is returned.</p>",
|
||||
"PublicKey$ValidityStartTime": "<p>The starting time of validity of the public key.</p>",
|
||||
"PublicKey$ValidityEndTime": "<p>The ending time of validity of the public key.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteTrailRequest": {
|
||||
"base": "<p>The request that specifies the name of a trail to delete.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteTrailResponse": {
|
||||
"base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeTrailsRequest": {
|
||||
"base": "<p>Returns information about the trail.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeTrailsResponse": {
|
||||
"base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Event": {
|
||||
"base": "<p>Contains information about an event that was returned by a lookup request. The result includes a representation of a CloudTrail event.</p>",
|
||||
"refs": {
|
||||
"EventsList$member": null
|
||||
}
|
||||
},
|
||||
"EventSelector": {
|
||||
"base": "<p>Use event selectors to specify whether you want your trail to log management and/or data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.</p> <p>You can configure up to five event selectors for a trail.</p>",
|
||||
"refs": {
|
||||
"EventSelectors$member": null
|
||||
}
|
||||
},
|
||||
"EventSelectors": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetEventSelectorsResponse$EventSelectors": "<p>The event selectors that are configured for the trail.</p>",
|
||||
"PutEventSelectorsRequest$EventSelectors": "<p>Specifies the settings for your event selectors. You can configure up to five event selectors for a trail.</p>",
|
||||
"PutEventSelectorsResponse$EventSelectors": "<p>Specifies the event selectors configured for your trail.</p>"
|
||||
}
|
||||
},
|
||||
"EventsList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"LookupEventsResponse$Events": "<p>A list of events returned based on the lookup attributes specified and the CloudTrail event. The events list is sorted by time. The most recent event is listed first.</p>"
|
||||
}
|
||||
},
|
||||
"GetEventSelectorsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetEventSelectorsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetTrailStatusRequest": {
|
||||
"base": "<p>The name of a trail about which you want the current status.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetTrailStatusResponse": {
|
||||
"base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InsufficientEncryptionPolicyException": {
|
||||
"base": "<p>This exception is thrown when the policy on the S3 bucket or KMS key is not sufficient.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InsufficientS3BucketPolicyException": {
|
||||
"base": "<p>This exception is thrown when the policy on the S3 bucket is not sufficient.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InsufficientSnsTopicPolicyException": {
|
||||
"base": "<p>This exception is thrown when the policy on the SNS topic is not sufficient.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidCloudWatchLogsLogGroupArnException": {
|
||||
"base": "<p>This exception is thrown when the provided CloudWatch log group is not valid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidCloudWatchLogsRoleArnException": {
|
||||
"base": "<p>This exception is thrown when the provided role is not valid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidEventSelectorsException": {
|
||||
"base": "<p>This exception is thrown when the <code>PutEventSelectors</code> operation is called with an invalid number of event selectors, data resources, or an invalid value for a parameter:</p> <ul> <li> <p>Specify a valid number of event selectors (1 to 5) for a trail.</p> </li> <li> <p>Specify a valid number of data resources (1 to 250) for an event selector.</p> </li> <li> <p>Specify a valid value for a parameter. For example, specifying the <code>ReadWriteType</code> parameter with a value of <code>read-only</code> is invalid.</p> </li> </ul>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidHomeRegionException": {
|
||||
"base": "<p>This exception is thrown when an operation is called on a trail from a region other than the region in which the trail was created.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidKmsKeyIdException": {
|
||||
"base": "<p>This exception is thrown when the KMS key ARN is invalid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidLookupAttributesException": {
|
||||
"base": "<p>Occurs when an invalid lookup attribute is specified.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidMaxResultsException": {
|
||||
"base": "<p>This exception is thrown if the limit specified is invalid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidNextTokenException": {
|
||||
"base": "<p>Invalid token or token that was previously used in a request with different parameters. This exception is thrown if the token is invalid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidParameterCombinationException": {
|
||||
"base": "<p>This exception is thrown when the combination of parameters provided is not valid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidS3BucketNameException": {
|
||||
"base": "<p>This exception is thrown when the provided S3 bucket name is not valid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidS3PrefixException": {
|
||||
"base": "<p>This exception is thrown when the provided S3 prefix is not valid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidSnsTopicNameException": {
|
||||
"base": "<p>This exception is thrown when the provided SNS topic name is not valid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidTagParameterException": {
|
||||
"base": "<p>This exception is thrown when the key or value specified for the tag does not match the regular expression <code>^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-@]*)$</code>.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidTimeRangeException": {
|
||||
"base": "<p>Occurs if the timestamp values are invalid. Either the start time occurs after the end time or the time range is outside the range of possible values.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidTokenException": {
|
||||
"base": "<p>Reserved for future use.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidTrailNameException": {
|
||||
"base": "<p>This exception is thrown when the provided trail name is not valid. Trail names must meet the following requirements:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p> </li> <li> <p>Start with a letter or number, and end with a letter or number</p> </li> <li> <p>Be between 3 and 128 characters</p> </li> <li> <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</p> </li> <li> <p>Not be in IP address format (for example, 192.168.5.4)</p> </li> </ul>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"KmsException": {
|
||||
"base": "<p>This exception is thrown when there is an issue with the specified KMS key and the trail can’t be updated.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"KmsKeyDisabledException": {
|
||||
"base": "<p>This exception is deprecated.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"KmsKeyNotFoundException": {
|
||||
"base": "<p>This exception is thrown when the KMS key does not exist, or when the S3 bucket and the KMS key are not in the same region.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListPublicKeysRequest": {
|
||||
"base": "<p>Requests the public keys for a specified time range.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListPublicKeysResponse": {
|
||||
"base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListTagsRequest": {
|
||||
"base": "<p>Specifies a list of trail tags to return.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListTagsResponse": {
|
||||
"base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"LookupAttribute": {
|
||||
"base": "<p>Specifies an attribute and value that filter the events returned.</p>",
|
||||
"refs": {
|
||||
"LookupAttributesList$member": null
|
||||
}
|
||||
},
|
||||
"LookupAttributeKey": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"LookupAttribute$AttributeKey": "<p>Specifies an attribute on which to filter the events returned.</p>"
|
||||
}
|
||||
},
|
||||
"LookupAttributesList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"LookupEventsRequest$LookupAttributes": "<p>Contains a list of lookup attributes. Currently the list can contain only one item.</p>"
|
||||
}
|
||||
},
|
||||
"LookupEventsRequest": {
|
||||
"base": "<p>Contains a request for LookupEvents.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"LookupEventsResponse": {
|
||||
"base": "<p>Contains a response to a LookupEvents action.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"LookupEventsRequest$MaxResults": "<p>The number of events to return. Possible values are 1 through 50. The default is 10.</p>"
|
||||
}
|
||||
},
|
||||
"MaximumNumberOfTrailsExceededException": {
|
||||
"base": "<p>This exception is thrown when the maximum number of trails is reached.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"LookupEventsRequest$NextToken": "<p>The token to use to get the next page of results after a previous API call. This token must be passed in with the same parameters that were specified in the the original call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.</p>",
|
||||
"LookupEventsResponse$NextToken": "<p>The token to use to get the next page of results after a previous API call. If the token does not appear, there are no more results to return. The token must be passed in with the same parameters as the previous call. For example, if the original call specified an AttributeKey of 'Username' with a value of 'root', the call with NextToken should include those same parameters.</p>"
|
||||
}
|
||||
},
|
||||
"OperationNotPermittedException": {
|
||||
"base": "<p>This exception is thrown when the requested operation is not permitted.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"PublicKey": {
|
||||
"base": "<p>Contains information about a returned public key.</p>",
|
||||
"refs": {
|
||||
"PublicKeyList$member": null
|
||||
}
|
||||
},
|
||||
"PublicKeyList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListPublicKeysResponse$PublicKeyList": "<p>Contains an array of PublicKey objects.</p> <note> <p>The returned public keys may have validity time ranges that overlap.</p> </note>"
|
||||
}
|
||||
},
|
||||
"PutEventSelectorsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"PutEventSelectorsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ReadWriteType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"EventSelector$ReadWriteType": "<p>Specify if you want your trail to log read-only events, write-only events, or all. For example, the EC2 <code>GetConsoleOutput</code> is a read-only API operation and <code>RunInstances</code> is a write-only API operation.</p> <p> By default, the value is <code>All</code>.</p>"
|
||||
}
|
||||
},
|
||||
"RemoveTagsRequest": {
|
||||
"base": "<p>Specifies the tags to remove from a trail.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"RemoveTagsResponse": {
|
||||
"base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Resource": {
|
||||
"base": "<p>Specifies the type and name of a resource referenced by an event.</p>",
|
||||
"refs": {
|
||||
"ResourceList$member": null
|
||||
}
|
||||
},
|
||||
"ResourceIdList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListTagsRequest$ResourceIdList": "<p>Specifies a list of trail ARNs whose tags will be listed. The list has a limit of 20 ARNs. The format of a trail ARN is:</p> <p> <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code> </p>"
|
||||
}
|
||||
},
|
||||
"ResourceList": {
|
||||
"base": "<p>A list of resources referenced by the event returned.</p>",
|
||||
"refs": {
|
||||
"Event$Resources": "<p>A list of resources referenced by the event returned.</p>"
|
||||
}
|
||||
},
|
||||
"ResourceNotFoundException": {
|
||||
"base": "<p>This exception is thrown when the specified resource is not found.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ResourceTag": {
|
||||
"base": "<p>A resource tag.</p>",
|
||||
"refs": {
|
||||
"ResourceTagList$member": null
|
||||
}
|
||||
},
|
||||
"ResourceTagList": {
|
||||
"base": "<p>A list of resource tags.</p>",
|
||||
"refs": {
|
||||
"ListTagsResponse$ResourceTagList": null
|
||||
}
|
||||
},
|
||||
"ResourceTypeNotSupportedException": {
|
||||
"base": "<p>This exception is thrown when the specified resource type is not supported by CloudTrail.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"S3BucketDoesNotExistException": {
|
||||
"base": "<p>This exception is thrown when the specified S3 bucket does not exist.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"StartLoggingRequest": {
|
||||
"base": "<p>The request to CloudTrail to start logging AWS API calls for an account.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"StartLoggingResponse": {
|
||||
"base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"StopLoggingRequest": {
|
||||
"base": "<p>Passes the request to CloudTrail to stop logging AWS API calls for the specified account.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"StopLoggingResponse": {
|
||||
"base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"String": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AddTagsRequest$ResourceId": "<p>Specifies the ARN of the trail to which one or more tags will be added. The format of a trail ARN is:</p> <p> <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code> </p>",
|
||||
"CreateTrailRequest$Name": "<p>Specifies the name of the trail. The name must meet the following requirements:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p> </li> <li> <p>Start with a letter or number, and end with a letter or number</p> </li> <li> <p>Be between 3 and 128 characters</p> </li> <li> <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</p> </li> <li> <p>Not be in IP address format (for example, 192.168.5.4)</p> </li> </ul>",
|
||||
"CreateTrailRequest$S3BucketName": "<p>Specifies the name of the Amazon S3 bucket designated for publishing log files. See <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html\">Amazon S3 Bucket Naming Requirements</a>.</p>",
|
||||
"CreateTrailRequest$S3KeyPrefix": "<p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html\">Finding Your CloudTrail Log Files</a>. The maximum length is 200 characters.</p>",
|
||||
"CreateTrailRequest$SnsTopicName": "<p>Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.</p>",
|
||||
"CreateTrailRequest$CloudWatchLogsLogGroupArn": "<p>Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.</p>",
|
||||
"CreateTrailRequest$CloudWatchLogsRoleArn": "<p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</p>",
|
||||
"CreateTrailRequest$KmsKeyId": "<p>Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by \"alias/\", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.</p> <p>Examples:</p> <ul> <li> <p>alias/MyAliasName</p> </li> <li> <p>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</p> </li> <li> <p>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</p> </li> <li> <p>12345678-1234-1234-1234-123456789012</p> </li> </ul>",
|
||||
"CreateTrailResponse$Name": "<p>Specifies the name of the trail.</p>",
|
||||
"CreateTrailResponse$S3BucketName": "<p>Specifies the name of the Amazon S3 bucket designated for publishing log files.</p>",
|
||||
"CreateTrailResponse$S3KeyPrefix": "<p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html\">Finding Your CloudTrail Log Files</a>.</p>",
|
||||
"CreateTrailResponse$SnsTopicName": "<p>This field is deprecated. Use SnsTopicARN.</p>",
|
||||
"CreateTrailResponse$SnsTopicARN": "<p>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:</p> <p> <code>arn:aws:sns:us-east-1:123456789012:MyTopic</code> </p>",
|
||||
"CreateTrailResponse$TrailARN": "<p>Specifies the ARN of the trail that was created. The format of a trail ARN is:</p> <p> <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code> </p>",
|
||||
"CreateTrailResponse$CloudWatchLogsLogGroupArn": "<p>Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.</p>",
|
||||
"CreateTrailResponse$CloudWatchLogsRoleArn": "<p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</p>",
|
||||
"CreateTrailResponse$KmsKeyId": "<p>Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:</p> <p> <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p>",
|
||||
"DataResource$Type": "<p>The resource type in which you want to log data events. You can specify only the following value: <code>AWS::S3::Object</code>.</p>",
|
||||
"DataResourceValues$member": null,
|
||||
"DeleteTrailRequest$Name": "<p>Specifies the name or the CloudTrail ARN of the trail to be deleted. The format of a trail ARN is: <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code> </p>",
|
||||
"Event$EventId": "<p>The CloudTrail ID of the event returned.</p>",
|
||||
"Event$EventName": "<p>The name of the event returned.</p>",
|
||||
"Event$EventSource": "<p>The AWS service that the request was made to.</p>",
|
||||
"Event$Username": "<p>A user name or role name of the requester that called the API in the event returned.</p>",
|
||||
"Event$CloudTrailEvent": "<p>A JSON string that contains a representation of the event returned.</p>",
|
||||
"GetEventSelectorsRequest$TrailName": "<p>Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p> </li> <li> <p>Start with a letter or number, and end with a letter or number</p> </li> <li> <p>Be between 3 and 128 characters</p> </li> <li> <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</p> </li> <li> <p>Not be in IP address format (for example, 192.168.5.4)</p> </li> </ul> <p>If you specify a trail ARN, it must be in the format:</p> <p> <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code> </p>",
|
||||
"GetEventSelectorsResponse$TrailARN": "<p>The specified trail ARN that has the event selectors.</p>",
|
||||
"GetTrailStatusRequest$Name": "<p>Specifies the name or the CloudTrail ARN of the trail for which you are requesting status. To get the status of a shadow trail (a replication of the trail in another region), you must specify its ARN. The format of a trail ARN is:</p> <p> <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code> </p>",
|
||||
"GetTrailStatusResponse$LatestDeliveryError": "<p>Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver log files to the designated bucket. For more information see the topic <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html\">Error Responses</a> in the Amazon S3 API Reference. </p> <note> <p>This error occurs only when there is a problem with the destination S3 bucket and will not occur for timeouts. To resolve the issue, create a new bucket and call <code>UpdateTrail</code> to specify the new bucket, or fix the existing objects so that CloudTrail can again write to the bucket.</p> </note>",
|
||||
"GetTrailStatusResponse$LatestNotificationError": "<p>Displays any Amazon SNS error that CloudTrail encountered when attempting to send a notification. For more information about Amazon SNS errors, see the <a href=\"http://docs.aws.amazon.com/sns/latest/dg/welcome.html\">Amazon SNS Developer Guide</a>. </p>",
|
||||
"GetTrailStatusResponse$LatestCloudWatchLogsDeliveryError": "<p>Displays any CloudWatch Logs error that CloudTrail encountered when attempting to deliver logs to CloudWatch Logs.</p>",
|
||||
"GetTrailStatusResponse$LatestDigestDeliveryError": "<p>Displays any Amazon S3 error that CloudTrail encountered when attempting to deliver a digest file to the designated bucket. For more information see the topic <a href=\"http://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html\">Error Responses</a> in the Amazon S3 API Reference. </p> <note> <p>This error occurs only when there is a problem with the destination S3 bucket and will not occur for timeouts. To resolve the issue, create a new bucket and call <code>UpdateTrail</code> to specify the new bucket, or fix the existing objects so that CloudTrail can again write to the bucket.</p> </note>",
|
||||
"GetTrailStatusResponse$LatestDeliveryAttemptTime": "<p>This field is deprecated.</p>",
|
||||
"GetTrailStatusResponse$LatestNotificationAttemptTime": "<p>This field is deprecated.</p>",
|
||||
"GetTrailStatusResponse$LatestNotificationAttemptSucceeded": "<p>This field is deprecated.</p>",
|
||||
"GetTrailStatusResponse$LatestDeliveryAttemptSucceeded": "<p>This field is deprecated.</p>",
|
||||
"GetTrailStatusResponse$TimeLoggingStarted": "<p>This field is deprecated.</p>",
|
||||
"GetTrailStatusResponse$TimeLoggingStopped": "<p>This field is deprecated.</p>",
|
||||
"ListPublicKeysRequest$NextToken": "<p>Reserved for future use.</p>",
|
||||
"ListPublicKeysResponse$NextToken": "<p>Reserved for future use.</p>",
|
||||
"ListTagsRequest$NextToken": "<p>Reserved for future use.</p>",
|
||||
"ListTagsResponse$NextToken": "<p>Reserved for future use.</p>",
|
||||
"LookupAttribute$AttributeValue": "<p>Specifies a value for the specified AttributeKey.</p>",
|
||||
"PublicKey$Fingerprint": "<p>The fingerprint of the public key.</p>",
|
||||
"PutEventSelectorsRequest$TrailName": "<p>Specifies the name of the trail or trail ARN. If you specify a trail name, the string must meet the following requirements:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p> </li> <li> <p>Start with a letter or number, and end with a letter or number</p> </li> <li> <p>Be between 3 and 128 characters</p> </li> <li> <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</p> </li> <li> <p>Not be in IP address format (for example, 192.168.5.4)</p> </li> </ul> <p>If you specify a trail ARN, it must be in the format:</p> <p> <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code> </p>",
|
||||
"PutEventSelectorsResponse$TrailARN": "<p>Specifies the ARN of the trail that was updated with event selectors. The format of a trail ARN is:</p> <p> <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code> </p>",
|
||||
"RemoveTagsRequest$ResourceId": "<p>Specifies the ARN of the trail from which tags should be removed. The format of a trail ARN is:</p> <p> <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code> </p>",
|
||||
"Resource$ResourceType": "<p>The type of a resource referenced by the event returned. When the resource type cannot be determined, null is returned. Some examples of resource types are: <b>Instance</b> for EC2, <b>Trail</b> for CloudTrail, <b>DBInstance</b> for RDS, and <b>AccessKey</b> for IAM. For a list of resource types supported for event lookup, see <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/lookup_supported_resourcetypes.html\">Resource Types Supported for Event Lookup</a>.</p>",
|
||||
"Resource$ResourceName": "<p>The name of the resource referenced by the event returned. These are user-created names whose values will depend on the environment. For example, the resource name might be \"auto-scaling-test-group\" for an Auto Scaling Group or \"i-1234567\" for an EC2 Instance.</p>",
|
||||
"ResourceIdList$member": null,
|
||||
"ResourceTag$ResourceId": "<p>Specifies the ARN of the resource.</p>",
|
||||
"StartLoggingRequest$Name": "<p>Specifies the name or the CloudTrail ARN of the trail for which CloudTrail logs AWS API calls. The format of a trail ARN is:</p> <p> <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code> </p>",
|
||||
"StopLoggingRequest$Name": "<p>Specifies the name or the CloudTrail ARN of the trail for which CloudTrail will stop logging AWS API calls. The format of a trail ARN is:</p> <p> <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code> </p>",
|
||||
"Tag$Key": "<p>The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. The key must be unique for the resource to which it applies.</p>",
|
||||
"Tag$Value": "<p>The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.</p>",
|
||||
"Trail$Name": "<p>Name of the trail set by calling <a>CreateTrail</a>. The maximum length is 128 characters.</p>",
|
||||
"Trail$S3BucketName": "<p>Name of the Amazon S3 bucket into which CloudTrail delivers your trail files. See <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html\">Amazon S3 Bucket Naming Requirements</a>.</p>",
|
||||
"Trail$S3KeyPrefix": "<p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html\">Finding Your CloudTrail Log Files</a>.The maximum length is 200 characters.</p>",
|
||||
"Trail$SnsTopicName": "<p>This field is deprecated. Use SnsTopicARN.</p>",
|
||||
"Trail$SnsTopicARN": "<p>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:</p> <p> <code>arn:aws:sns:us-east-1:123456789012:MyTopic</code> </p>",
|
||||
"Trail$HomeRegion": "<p>The region in which the trail was created.</p>",
|
||||
"Trail$TrailARN": "<p>Specifies the ARN of the trail. The format of a trail ARN is:</p> <p> <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code> </p>",
|
||||
"Trail$CloudWatchLogsLogGroupArn": "<p>Specifies an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered.</p>",
|
||||
"Trail$CloudWatchLogsRoleArn": "<p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</p>",
|
||||
"Trail$KmsKeyId": "<p>Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:</p> <p> <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p>",
|
||||
"TrailNameList$member": null,
|
||||
"UpdateTrailRequest$Name": "<p>Specifies the name of the trail or trail ARN. If <code>Name</code> is a trail name, the string must meet the following requirements:</p> <ul> <li> <p>Contain only ASCII letters (a-z, A-Z), numbers (0-9), periods (.), underscores (_), or dashes (-)</p> </li> <li> <p>Start with a letter or number, and end with a letter or number</p> </li> <li> <p>Be between 3 and 128 characters</p> </li> <li> <p>Have no adjacent periods, underscores or dashes. Names like <code>my-_namespace</code> and <code>my--namespace</code> are invalid.</p> </li> <li> <p>Not be in IP address format (for example, 192.168.5.4)</p> </li> </ul> <p>If <code>Name</code> is a trail ARN, it must be in the format:</p> <p> <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code> </p>",
|
||||
"UpdateTrailRequest$S3BucketName": "<p>Specifies the name of the Amazon S3 bucket designated for publishing log files. See <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/create_trail_naming_policy.html\">Amazon S3 Bucket Naming Requirements</a>.</p>",
|
||||
"UpdateTrailRequest$S3KeyPrefix": "<p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html\">Finding Your CloudTrail Log Files</a>. The maximum length is 200 characters.</p>",
|
||||
"UpdateTrailRequest$SnsTopicName": "<p>Specifies the name of the Amazon SNS topic defined for notification of log file delivery. The maximum length is 256 characters.</p>",
|
||||
"UpdateTrailRequest$CloudWatchLogsLogGroupArn": "<p>Specifies a log group name using an Amazon Resource Name (ARN), a unique identifier that represents the log group to which CloudTrail logs will be delivered. Not required unless you specify CloudWatchLogsRoleArn.</p>",
|
||||
"UpdateTrailRequest$CloudWatchLogsRoleArn": "<p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</p>",
|
||||
"UpdateTrailRequest$KmsKeyId": "<p>Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by \"alias/\", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.</p> <p>Examples:</p> <ul> <li> <p>alias/MyAliasName</p> </li> <li> <p>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</p> </li> <li> <p>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</p> </li> <li> <p>12345678-1234-1234-1234-123456789012</p> </li> </ul>",
|
||||
"UpdateTrailResponse$Name": "<p>Specifies the name of the trail.</p>",
|
||||
"UpdateTrailResponse$S3BucketName": "<p>Specifies the name of the Amazon S3 bucket designated for publishing log files.</p>",
|
||||
"UpdateTrailResponse$S3KeyPrefix": "<p>Specifies the Amazon S3 key prefix that comes after the name of the bucket you have designated for log file delivery. For more information, see <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-find-log-files.html\">Finding Your CloudTrail Log Files</a>.</p>",
|
||||
"UpdateTrailResponse$SnsTopicName": "<p>This field is deprecated. Use SnsTopicARN.</p>",
|
||||
"UpdateTrailResponse$SnsTopicARN": "<p>Specifies the ARN of the Amazon SNS topic that CloudTrail uses to send notifications when log files are delivered. The format of a topic ARN is:</p> <p> <code>arn:aws:sns:us-east-1:123456789012:MyTopic</code> </p>",
|
||||
"UpdateTrailResponse$TrailARN": "<p>Specifies the ARN of the trail that was updated. The format of a trail ARN is:</p> <p> <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code> </p>",
|
||||
"UpdateTrailResponse$CloudWatchLogsLogGroupArn": "<p>Specifies the Amazon Resource Name (ARN) of the log group to which CloudTrail logs will be delivered.</p>",
|
||||
"UpdateTrailResponse$CloudWatchLogsRoleArn": "<p>Specifies the role for the CloudWatch Logs endpoint to assume to write to a user's log group.</p>",
|
||||
"UpdateTrailResponse$KmsKeyId": "<p>Specifies the KMS key ID that encrypts the logs delivered by CloudTrail. The value is a fully specified ARN to a KMS key in the format:</p> <p> <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p>"
|
||||
}
|
||||
},
|
||||
"Tag": {
|
||||
"base": "<p>A custom key-value pair associated with a resource such as a CloudTrail trail.</p>",
|
||||
"refs": {
|
||||
"TagsList$member": null
|
||||
}
|
||||
},
|
||||
"TagsLimitExceededException": {
|
||||
"base": "<p>The number of tags per trail has exceeded the permitted amount. Currently, the limit is 50.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"TagsList": {
|
||||
"base": "<p>A list of tags.</p>",
|
||||
"refs": {
|
||||
"AddTagsRequest$TagsList": "<p>Contains a list of CloudTrail tags, up to a limit of 50</p>",
|
||||
"RemoveTagsRequest$TagsList": "<p>Specifies a list of tags to be removed.</p>",
|
||||
"ResourceTag$TagsList": null
|
||||
}
|
||||
},
|
||||
"Trail": {
|
||||
"base": "<p>The settings for a trail.</p>",
|
||||
"refs": {
|
||||
"TrailList$member": null
|
||||
}
|
||||
},
|
||||
"TrailAlreadyExistsException": {
|
||||
"base": "<p>This exception is thrown when the specified trail already exists.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"TrailList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeTrailsResponse$trailList": "<p>The list of trail objects.</p>"
|
||||
}
|
||||
},
|
||||
"TrailNameList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeTrailsRequest$trailNameList": "<p>Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:</p> <p> <code>arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail</code> </p> <p>If an empty list is specified, information for the trail in the current region is returned.</p> <ul> <li> <p>If an empty list is specified and <code>IncludeShadowTrails</code> is false, then information for all trails in the current region is returned.</p> </li> <li> <p>If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current region and any associated shadow trails in other regions is returned.</p> </li> </ul> <note> <p>If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current region. To return information about a trail in another region, you must specify its trail ARN.</p> </note>"
|
||||
}
|
||||
},
|
||||
"TrailNotFoundException": {
|
||||
"base": "<p>This exception is thrown when the trail with the given name is not found.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"TrailNotProvidedException": {
|
||||
"base": "<p>This exception is deprecated.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UnsupportedOperationException": {
|
||||
"base": "<p>This exception is thrown when the requested operation is not supported.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateTrailRequest": {
|
||||
"base": "<p>Specifies settings to update for the trail.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateTrailResponse": {
|
||||
"base": "<p>Returns the objects or data listed below if successful. Otherwise, returns an error.</p>",
|
||||
"refs": {
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+5
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+13
@@ -0,0 +1,13 @@
|
||||
{
|
||||
"pagination": {
|
||||
"DescribeTrails": {
|
||||
"result_key": "trailList"
|
||||
},
|
||||
"LookupEvents": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "Events"
|
||||
}
|
||||
}
|
||||
}
|
||||
+702
@@ -0,0 +1,702 @@
|
||||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"apiVersion":"2016-10-06",
|
||||
"endpointPrefix":"codebuild",
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceFullName":"AWS CodeBuild",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"CodeBuild_20161006",
|
||||
"uid":"codebuild-2016-10-06"
|
||||
},
|
||||
"operations":{
|
||||
"BatchGetBuilds":{
|
||||
"name":"BatchGetBuilds",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"BatchGetBuildsInput"},
|
||||
"output":{"shape":"BatchGetBuildsOutput"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"}
|
||||
]
|
||||
},
|
||||
"BatchGetProjects":{
|
||||
"name":"BatchGetProjects",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"BatchGetProjectsInput"},
|
||||
"output":{"shape":"BatchGetProjectsOutput"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"}
|
||||
]
|
||||
},
|
||||
"CreateProject":{
|
||||
"name":"CreateProject",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateProjectInput"},
|
||||
"output":{"shape":"CreateProjectOutput"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"ResourceAlreadyExistsException"},
|
||||
{"shape":"AccountLimitExceededException"}
|
||||
]
|
||||
},
|
||||
"DeleteProject":{
|
||||
"name":"DeleteProject",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteProjectInput"},
|
||||
"output":{"shape":"DeleteProjectOutput"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"}
|
||||
]
|
||||
},
|
||||
"ListBuilds":{
|
||||
"name":"ListBuilds",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListBuildsInput"},
|
||||
"output":{"shape":"ListBuildsOutput"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"}
|
||||
]
|
||||
},
|
||||
"ListBuildsForProject":{
|
||||
"name":"ListBuildsForProject",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListBuildsForProjectInput"},
|
||||
"output":{"shape":"ListBuildsForProjectOutput"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"ListCuratedEnvironmentImages":{
|
||||
"name":"ListCuratedEnvironmentImages",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListCuratedEnvironmentImagesInput"},
|
||||
"output":{"shape":"ListCuratedEnvironmentImagesOutput"}
|
||||
},
|
||||
"ListProjects":{
|
||||
"name":"ListProjects",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListProjectsInput"},
|
||||
"output":{"shape":"ListProjectsOutput"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"}
|
||||
]
|
||||
},
|
||||
"StartBuild":{
|
||||
"name":"StartBuild",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StartBuildInput"},
|
||||
"output":{"shape":"StartBuildOutput"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"AccountLimitExceededException"}
|
||||
]
|
||||
},
|
||||
"StopBuild":{
|
||||
"name":"StopBuild",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StopBuildInput"},
|
||||
"output":{"shape":"StopBuildOutput"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"UpdateProject":{
|
||||
"name":"UpdateProject",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateProjectInput"},
|
||||
"output":{"shape":"UpdateProjectOutput"},
|
||||
"errors":[
|
||||
{"shape":"InvalidInputException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AccountLimitExceededException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ArtifactNamespace":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"NONE",
|
||||
"BUILD_ID"
|
||||
]
|
||||
},
|
||||
"ArtifactPackaging":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"NONE",
|
||||
"ZIP"
|
||||
]
|
||||
},
|
||||
"ArtifactsType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"CODEPIPELINE",
|
||||
"S3",
|
||||
"NO_ARTIFACTS"
|
||||
]
|
||||
},
|
||||
"BatchGetBuildsInput":{
|
||||
"type":"structure",
|
||||
"required":["ids"],
|
||||
"members":{
|
||||
"ids":{"shape":"BuildIds"}
|
||||
}
|
||||
},
|
||||
"BatchGetBuildsOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"builds":{"shape":"Builds"},
|
||||
"buildsNotFound":{"shape":"BuildIds"}
|
||||
}
|
||||
},
|
||||
"BatchGetProjectsInput":{
|
||||
"type":"structure",
|
||||
"required":["names"],
|
||||
"members":{
|
||||
"names":{"shape":"ProjectNames"}
|
||||
}
|
||||
},
|
||||
"BatchGetProjectsOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"projects":{"shape":"Projects"},
|
||||
"projectsNotFound":{"shape":"ProjectNames"}
|
||||
}
|
||||
},
|
||||
"Boolean":{"type":"boolean"},
|
||||
"Build":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"id":{"shape":"NonEmptyString"},
|
||||
"arn":{"shape":"NonEmptyString"},
|
||||
"startTime":{"shape":"Timestamp"},
|
||||
"endTime":{"shape":"Timestamp"},
|
||||
"currentPhase":{"shape":"String"},
|
||||
"buildStatus":{"shape":"StatusType"},
|
||||
"sourceVersion":{"shape":"NonEmptyString"},
|
||||
"projectName":{"shape":"NonEmptyString"},
|
||||
"phases":{"shape":"BuildPhases"},
|
||||
"source":{"shape":"ProjectSource"},
|
||||
"artifacts":{"shape":"BuildArtifacts"},
|
||||
"environment":{"shape":"ProjectEnvironment"},
|
||||
"logs":{"shape":"LogsLocation"},
|
||||
"timeoutInMinutes":{"shape":"WrapperInt"},
|
||||
"buildComplete":{"shape":"Boolean"},
|
||||
"initiator":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"BuildArtifacts":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"location":{"shape":"String"},
|
||||
"sha256sum":{"shape":"String"},
|
||||
"md5sum":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"BuildIds":{
|
||||
"type":"list",
|
||||
"member":{"shape":"NonEmptyString"},
|
||||
"max":100,
|
||||
"min":1
|
||||
},
|
||||
"BuildPhase":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"phaseType":{"shape":"BuildPhaseType"},
|
||||
"phaseStatus":{"shape":"StatusType"},
|
||||
"startTime":{"shape":"Timestamp"},
|
||||
"endTime":{"shape":"Timestamp"},
|
||||
"durationInSeconds":{"shape":"WrapperLong"},
|
||||
"contexts":{"shape":"PhaseContexts"}
|
||||
}
|
||||
},
|
||||
"BuildPhaseType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"SUBMITTED",
|
||||
"PROVISIONING",
|
||||
"DOWNLOAD_SOURCE",
|
||||
"INSTALL",
|
||||
"PRE_BUILD",
|
||||
"BUILD",
|
||||
"POST_BUILD",
|
||||
"UPLOAD_ARTIFACTS",
|
||||
"FINALIZING",
|
||||
"COMPLETED"
|
||||
]
|
||||
},
|
||||
"BuildPhases":{
|
||||
"type":"list",
|
||||
"member":{"shape":"BuildPhase"}
|
||||
},
|
||||
"Builds":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Build"}
|
||||
},
|
||||
"ComputeType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"BUILD_GENERAL1_SMALL",
|
||||
"BUILD_GENERAL1_MEDIUM",
|
||||
"BUILD_GENERAL1_LARGE"
|
||||
]
|
||||
},
|
||||
"CreateProjectInput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"name",
|
||||
"source",
|
||||
"artifacts",
|
||||
"environment"
|
||||
],
|
||||
"members":{
|
||||
"name":{"shape":"ProjectName"},
|
||||
"description":{"shape":"ProjectDescription"},
|
||||
"source":{"shape":"ProjectSource"},
|
||||
"artifacts":{"shape":"ProjectArtifacts"},
|
||||
"environment":{"shape":"ProjectEnvironment"},
|
||||
"serviceRole":{"shape":"NonEmptyString"},
|
||||
"timeoutInMinutes":{"shape":"TimeOut"},
|
||||
"encryptionKey":{"shape":"NonEmptyString"},
|
||||
"tags":{"shape":"TagList"}
|
||||
}
|
||||
},
|
||||
"CreateProjectOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"project":{"shape":"Project"}
|
||||
}
|
||||
},
|
||||
"DeleteProjectInput":{
|
||||
"type":"structure",
|
||||
"required":["name"],
|
||||
"members":{
|
||||
"name":{"shape":"NonEmptyString"}
|
||||
}
|
||||
},
|
||||
"DeleteProjectOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"EnvironmentImage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"name":{"shape":"String"},
|
||||
"description":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"EnvironmentImages":{
|
||||
"type":"list",
|
||||
"member":{"shape":"EnvironmentImage"}
|
||||
},
|
||||
"EnvironmentLanguage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"language":{"shape":"LanguageType"},
|
||||
"images":{"shape":"EnvironmentImages"}
|
||||
}
|
||||
},
|
||||
"EnvironmentLanguages":{
|
||||
"type":"list",
|
||||
"member":{"shape":"EnvironmentLanguage"}
|
||||
},
|
||||
"EnvironmentPlatform":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"platform":{"shape":"PlatformType"},
|
||||
"languages":{"shape":"EnvironmentLanguages"}
|
||||
}
|
||||
},
|
||||
"EnvironmentPlatforms":{
|
||||
"type":"list",
|
||||
"member":{"shape":"EnvironmentPlatform"}
|
||||
},
|
||||
"EnvironmentType":{
|
||||
"type":"string",
|
||||
"enum":["LINUX_CONTAINER"]
|
||||
},
|
||||
"EnvironmentVariable":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"name",
|
||||
"value"
|
||||
],
|
||||
"members":{
|
||||
"name":{"shape":"NonEmptyString"},
|
||||
"value":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"EnvironmentVariables":{
|
||||
"type":"list",
|
||||
"member":{"shape":"EnvironmentVariable"}
|
||||
},
|
||||
"InvalidInputException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"KeyInput":{
|
||||
"type":"string",
|
||||
"max":127,
|
||||
"min":1,
|
||||
"pattern":"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=@+\\\\-]*)$"
|
||||
},
|
||||
"LanguageType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"JAVA",
|
||||
"PYTHON",
|
||||
"NODE_JS",
|
||||
"RUBY",
|
||||
"GOLANG",
|
||||
"DOCKER",
|
||||
"ANDROID",
|
||||
"BASE"
|
||||
]
|
||||
},
|
||||
"ListBuildsForProjectInput":{
|
||||
"type":"structure",
|
||||
"required":["projectName"],
|
||||
"members":{
|
||||
"projectName":{"shape":"NonEmptyString"},
|
||||
"sortOrder":{"shape":"SortOrderType"},
|
||||
"nextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ListBuildsForProjectOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ids":{"shape":"BuildIds"},
|
||||
"nextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ListBuildsInput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"sortOrder":{"shape":"SortOrderType"},
|
||||
"nextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ListBuildsOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ids":{"shape":"BuildIds"},
|
||||
"nextToken":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ListCuratedEnvironmentImagesInput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"ListCuratedEnvironmentImagesOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"platforms":{"shape":"EnvironmentPlatforms"}
|
||||
}
|
||||
},
|
||||
"ListProjectsInput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"sortBy":{"shape":"ProjectSortByType"},
|
||||
"sortOrder":{"shape":"SortOrderType"},
|
||||
"nextToken":{"shape":"NonEmptyString"}
|
||||
}
|
||||
},
|
||||
"ListProjectsOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"nextToken":{"shape":"String"},
|
||||
"projects":{"shape":"ProjectNames"}
|
||||
}
|
||||
},
|
||||
"LogsLocation":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"groupName":{"shape":"String"},
|
||||
"streamName":{"shape":"String"},
|
||||
"deepLink":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"NonEmptyString":{
|
||||
"type":"string",
|
||||
"min":1
|
||||
},
|
||||
"PhaseContext":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"statusCode":{"shape":"String"},
|
||||
"message":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"PhaseContexts":{
|
||||
"type":"list",
|
||||
"member":{"shape":"PhaseContext"}
|
||||
},
|
||||
"PlatformType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"DEBIAN",
|
||||
"AMAZON_LINUX",
|
||||
"UBUNTU"
|
||||
]
|
||||
},
|
||||
"Project":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"name":{"shape":"ProjectName"},
|
||||
"arn":{"shape":"String"},
|
||||
"description":{"shape":"ProjectDescription"},
|
||||
"source":{"shape":"ProjectSource"},
|
||||
"artifacts":{"shape":"ProjectArtifacts"},
|
||||
"environment":{"shape":"ProjectEnvironment"},
|
||||
"serviceRole":{"shape":"NonEmptyString"},
|
||||
"timeoutInMinutes":{"shape":"TimeOut"},
|
||||
"encryptionKey":{"shape":"NonEmptyString"},
|
||||
"tags":{"shape":"TagList"},
|
||||
"created":{"shape":"Timestamp"},
|
||||
"lastModified":{"shape":"Timestamp"}
|
||||
}
|
||||
},
|
||||
"ProjectArtifacts":{
|
||||
"type":"structure",
|
||||
"required":["type"],
|
||||
"members":{
|
||||
"type":{"shape":"ArtifactsType"},
|
||||
"location":{"shape":"String"},
|
||||
"path":{"shape":"String"},
|
||||
"namespaceType":{"shape":"ArtifactNamespace"},
|
||||
"name":{"shape":"String"},
|
||||
"packaging":{"shape":"ArtifactPackaging"}
|
||||
}
|
||||
},
|
||||
"ProjectDescription":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":0
|
||||
},
|
||||
"ProjectEnvironment":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"type",
|
||||
"image",
|
||||
"computeType"
|
||||
],
|
||||
"members":{
|
||||
"type":{"shape":"EnvironmentType"},
|
||||
"image":{"shape":"NonEmptyString"},
|
||||
"computeType":{"shape":"ComputeType"},
|
||||
"environmentVariables":{"shape":"EnvironmentVariables"}
|
||||
}
|
||||
},
|
||||
"ProjectName":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":2,
|
||||
"pattern":"[A-Za-z0-9][A-Za-z0-9\\-_]{1,254}"
|
||||
},
|
||||
"ProjectNames":{
|
||||
"type":"list",
|
||||
"member":{"shape":"NonEmptyString"},
|
||||
"max":100,
|
||||
"min":1
|
||||
},
|
||||
"ProjectSortByType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"NAME",
|
||||
"CREATED_TIME",
|
||||
"LAST_MODIFIED_TIME"
|
||||
]
|
||||
},
|
||||
"ProjectSource":{
|
||||
"type":"structure",
|
||||
"required":["type"],
|
||||
"members":{
|
||||
"type":{"shape":"SourceType"},
|
||||
"location":{"shape":"String"},
|
||||
"buildspec":{"shape":"String"},
|
||||
"auth":{"shape":"SourceAuth"}
|
||||
}
|
||||
},
|
||||
"Projects":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Project"}
|
||||
},
|
||||
"ResourceAlreadyExistsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ResourceNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"SortOrderType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ASCENDING",
|
||||
"DESCENDING"
|
||||
]
|
||||
},
|
||||
"SourceAuth":{
|
||||
"type":"structure",
|
||||
"required":["type"],
|
||||
"members":{
|
||||
"type":{"shape":"SourceAuthType"},
|
||||
"resource":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"SourceAuthType":{
|
||||
"type":"string",
|
||||
"enum":["OAUTH"]
|
||||
},
|
||||
"SourceType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"CODECOMMIT",
|
||||
"CODEPIPELINE",
|
||||
"GITHUB",
|
||||
"S3"
|
||||
]
|
||||
},
|
||||
"StartBuildInput":{
|
||||
"type":"structure",
|
||||
"required":["projectName"],
|
||||
"members":{
|
||||
"projectName":{"shape":"NonEmptyString"},
|
||||
"sourceVersion":{"shape":"String"},
|
||||
"artifactsOverride":{"shape":"ProjectArtifacts"},
|
||||
"environmentVariablesOverride":{"shape":"EnvironmentVariables"},
|
||||
"buildspecOverride":{"shape":"String"},
|
||||
"timeoutInMinutesOverride":{"shape":"TimeOut"}
|
||||
}
|
||||
},
|
||||
"StartBuildOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"build":{"shape":"Build"}
|
||||
}
|
||||
},
|
||||
"StatusType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"SUCCEEDED",
|
||||
"FAILED",
|
||||
"FAULT",
|
||||
"TIMED_OUT",
|
||||
"IN_PROGRESS",
|
||||
"STOPPED"
|
||||
]
|
||||
},
|
||||
"StopBuildInput":{
|
||||
"type":"structure",
|
||||
"required":["id"],
|
||||
"members":{
|
||||
"id":{"shape":"NonEmptyString"}
|
||||
}
|
||||
},
|
||||
"StopBuildOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"build":{"shape":"Build"}
|
||||
}
|
||||
},
|
||||
"String":{"type":"string"},
|
||||
"Tag":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"key":{"shape":"KeyInput"},
|
||||
"value":{"shape":"ValueInput"}
|
||||
}
|
||||
},
|
||||
"TagList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Tag"},
|
||||
"max":50,
|
||||
"min":0
|
||||
},
|
||||
"TimeOut":{
|
||||
"type":"integer",
|
||||
"max":480,
|
||||
"min":1
|
||||
},
|
||||
"Timestamp":{"type":"timestamp"},
|
||||
"UpdateProjectInput":{
|
||||
"type":"structure",
|
||||
"required":["name"],
|
||||
"members":{
|
||||
"name":{"shape":"NonEmptyString"},
|
||||
"description":{"shape":"ProjectDescription"},
|
||||
"source":{"shape":"ProjectSource"},
|
||||
"artifacts":{"shape":"ProjectArtifacts"},
|
||||
"environment":{"shape":"ProjectEnvironment"},
|
||||
"serviceRole":{"shape":"NonEmptyString"},
|
||||
"timeoutInMinutes":{"shape":"TimeOut"},
|
||||
"encryptionKey":{"shape":"NonEmptyString"},
|
||||
"tags":{"shape":"TagList"}
|
||||
}
|
||||
},
|
||||
"UpdateProjectOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"project":{"shape":"Project"}
|
||||
}
|
||||
},
|
||||
"ValueInput":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":1,
|
||||
"pattern":"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=@+\\\\-]*)$"
|
||||
},
|
||||
"WrapperInt":{"type":"integer"},
|
||||
"WrapperLong":{"type":"long"}
|
||||
}
|
||||
}
|
||||
+529
@@ -0,0 +1,529 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<fullname>AWS CodeBuild</fullname> <p>AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. AWS CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apach Maven, Gradle, and more. You can also fully customize build environments in AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests, and you pay only for the build time you consume. For more information about AWS CodeBuild, see the <i>AWS CodeBuild User Guide</i>.</p> <p>AWS CodeBuild supports these operations:</p> <ul> <li> <p> <code>BatchGetProjects</code>: Gets information about one or more build projects. A <i>build project</i> defines how AWS CodeBuild will run a build. This includes information such as where to get the source code to build, the build environment to use, the build commands to run, and where to store the build output. A <i>build environment</i> represents a combination of operating system, programming language runtime, and tools that AWS CodeBuild will use to run a build. Also, you can add tags to build projects to help manage your resources and costs.</p> </li> <li> <p> <code>CreateProject</code>: Creates a build project.</p> </li> <li> <p> <code>DeleteProject</code>: Deletes a build project.</p> </li> <li> <p> <code>ListProjects</code>: Gets a list of build project names, with each build project name representing a single build project.</p> </li> <li> <p> <code>UpdateProject</code>: Changes the settings of an existing build project.</p> </li> <li> <p> <code>BatchGetBuilds</code>: Gets information about one or more builds.</p> </li> <li> <p> <code>ListBuilds</code>: Gets a list of build IDs, with each build ID representing a single build.</p> </li> <li> <p> <code>ListBuildsForProject</code>: Gets a list of build IDs for the specified build project, with each build ID representing a single build.</p> </li> <li> <p> <code>StartBuild</code>: Starts running a build.</p> </li> <li> <p> <code>StopBuild</code>: Attempts to stop running a build.</p> </li> <li> <p> <code>ListCuratedEnvironmentImages</code>: Gets information about Docker images that are managed by AWS CodeBuild.</p> </li> </ul>",
|
||||
"operations": {
|
||||
"BatchGetBuilds": "<p>Gets information about builds.</p>",
|
||||
"BatchGetProjects": "<p>Gets information about build projects.</p>",
|
||||
"CreateProject": "<p>Creates a build project.</p>",
|
||||
"DeleteProject": "<p>Deletes a build 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>"
|
||||
},
|
||||
"shapes": {
|
||||
"AccountLimitExceededException": {
|
||||
"base": "<p>An AWS service limit was exceeded for the calling AWS account.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ArtifactNamespace": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ProjectArtifacts$namespaceType": "<p>Along with <code>path</code> and <code>name</code>, the pattern that AWS CodeBuild will use to determine the name and location to 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>, then valid values include:</p> <ul> <li> <p> <code>BUILD_ID</code>: Include the build ID in the location of the build output artifact.</p> </li> <li> <p> <code>NONE</code>: Do not include the build ID. This is the default if <code>namespaceType</code> is not specified.</p> </li> </ul> </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>"
|
||||
}
|
||||
},
|
||||
"ArtifactPackaging": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ProjectArtifacts$packaging": "<p>The type of build output artifact to create, 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 artifacts 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>, valid values include:</p> <ul> <li> <p> <code>NONE</code>: AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if <code>packaging</code> is not specified.</p> </li> <li> <p> <code>ZIP</code>: AWS CodeBuild will create in the output bucket a ZIP file containing the build output.</p> </li> </ul> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"ArtifactsType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ProjectArtifacts$type": "<p>The type of build output artifact. Valid values include:</p> <ul> <li> <p> <code>CODEPIPELINE</code>: The build project will have build output generated through AWS CodePipeline.</p> </li> <li> <p> <code>NO_ARTIFACTS</code>: The build project will not produce any build output.</p> </li> <li> <p> <code>S3</code>: The build project will store build output in Amazon Simple Storage Service (Amazon S3).</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"BatchGetBuildsInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"BatchGetBuildsOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"BatchGetProjectsInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"BatchGetProjectsOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Boolean": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Build$buildComplete": "<p>Whether the build has finished. True if completed; otherwise, false.</p>"
|
||||
}
|
||||
},
|
||||
"Build": {
|
||||
"base": "<p>Information about a build.</p>",
|
||||
"refs": {
|
||||
"Builds$member": null,
|
||||
"StartBuildOutput$build": "<p>Information about the build to be run.</p>",
|
||||
"StopBuildOutput$build": "<p>Information about the build.</p>"
|
||||
}
|
||||
},
|
||||
"BuildArtifacts": {
|
||||
"base": "<p>Information about build output artifacts.</p>",
|
||||
"refs": {
|
||||
"Build$artifacts": "<p>Information about the output artifacts for the build.</p>"
|
||||
}
|
||||
},
|
||||
"BuildIds": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchGetBuildsInput$ids": "<p>The IDs of the builds.</p>",
|
||||
"BatchGetBuildsOutput$buildsNotFound": "<p>The IDs of builds for which information could not be found.</p>",
|
||||
"ListBuildsForProjectOutput$ids": "<p>A list of build IDs for the specified build project, with each build ID representing a single build.</p>",
|
||||
"ListBuildsOutput$ids": "<p>A list of build IDs, with each build ID representing a single build.</p>"
|
||||
}
|
||||
},
|
||||
"BuildPhase": {
|
||||
"base": "<p>Information about a stage for a build.</p>",
|
||||
"refs": {
|
||||
"BuildPhases$member": null
|
||||
}
|
||||
},
|
||||
"BuildPhaseType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BuildPhase$phaseType": "<p>The name of the build phase. Valid values include:</p> <ul> <li> <p> <code>BUILD</code>: Core build activities typically occur in this build phase.</p> </li> <li> <p> <code>COMPLETED</code>: The build has been completed.</p> </li> <li> <p> <code>DOWNLOAD_SOURCE</code>: Source code is being downloaded in this build phase.</p> </li> <li> <p> <code>FINALIZING</code>: The build process is completing in this build phase.</p> </li> <li> <p> <code>INSTALL</code>: Installation activities typically occur in this build phase.</p> </li> <li> <p> <code>POST_BUILD</code>: Post-build activities typically occur in this build phase.</p> </li> <li> <p> <code>PRE_BUILD</code>: Pre-build activities typically occur in this build phase.</p> </li> <li> <p> <code>PROVISIONING</code>: The build environment is being set up.</p> </li> <li> <p> <code>SUBMITTED</code>: The build has been submitted.</p> </li> <li> <p> <code>UPLOAD_ARTIFACTS</code>: Build output artifacts are being uploaded to the output location.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"BuildPhases": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Build$phases": "<p>Information about all previous build phases that are completed and information about any current build phase that is not yet complete.</p>"
|
||||
}
|
||||
},
|
||||
"Builds": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchGetBuildsOutput$builds": "<p>Information about the requested builds.</p>"
|
||||
}
|
||||
},
|
||||
"ComputeType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ProjectEnvironment$computeType": "<p>Information about the compute resources the build project will use. Available values include:</p> <ul> <li> <p> <code>BUILD_GENERAL1_SMALL</code>: Use up to 3 GB memory and 2 vCPUs for builds.</p> </li> <li> <p> <code>BUILD_GENERAL1_MEDIUM</code>: Use up to 7 GB memory and 4 vCPUs for builds.</p> </li> <li> <p> <code>BUILD_GENERAL1_LARGE</code>: Use up to 15 GB memory and 8 vCPUs for builds.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"CreateProjectInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateProjectOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteProjectInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteProjectOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"EnvironmentImage": {
|
||||
"base": "<p>Information about a Docker image that is managed by AWS CodeBuild.</p>",
|
||||
"refs": {
|
||||
"EnvironmentImages$member": null
|
||||
}
|
||||
},
|
||||
"EnvironmentImages": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"EnvironmentLanguage$images": "<p>The list of Docker images that are related by the specified programming language.</p>"
|
||||
}
|
||||
},
|
||||
"EnvironmentLanguage": {
|
||||
"base": "<p>A set of Docker images that are related by programming language and are managed by AWS CodeBuild.</p>",
|
||||
"refs": {
|
||||
"EnvironmentLanguages$member": null
|
||||
}
|
||||
},
|
||||
"EnvironmentLanguages": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"EnvironmentPlatform$languages": "<p>The list of programming languages that are available for the specified platform.</p>"
|
||||
}
|
||||
},
|
||||
"EnvironmentPlatform": {
|
||||
"base": "<p>A set of Docker images that are related by platform and are managed by AWS CodeBuild.</p>",
|
||||
"refs": {
|
||||
"EnvironmentPlatforms$member": null
|
||||
}
|
||||
},
|
||||
"EnvironmentPlatforms": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListCuratedEnvironmentImagesOutput$platforms": "<p>Information about supported platforms for Docker images that are managed by AWS CodeBuild.</p>"
|
||||
}
|
||||
},
|
||||
"EnvironmentType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ProjectEnvironment$type": "<p>The type of build environment to use for related builds.</p>"
|
||||
}
|
||||
},
|
||||
"EnvironmentVariable": {
|
||||
"base": "<p>Information about an environment variable for a build project or a build.</p>",
|
||||
"refs": {
|
||||
"EnvironmentVariables$member": null
|
||||
}
|
||||
},
|
||||
"EnvironmentVariables": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ProjectEnvironment$environmentVariables": "<p>A set of environment variables to make available to builds for this build project.</p>",
|
||||
"StartBuildInput$environmentVariablesOverride": "<p>A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.</p>"
|
||||
}
|
||||
},
|
||||
"InvalidInputException": {
|
||||
"base": "<p>The input value that was provided is not valid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"KeyInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Tag$key": "<p>The tag's key.</p>"
|
||||
}
|
||||
},
|
||||
"LanguageType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"EnvironmentLanguage$language": "<p>The programming language for the Docker images.</p>"
|
||||
}
|
||||
},
|
||||
"ListBuildsForProjectInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListBuildsForProjectOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListBuildsInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListBuildsOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListCuratedEnvironmentImagesInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListCuratedEnvironmentImagesOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListProjectsInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListProjectsOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"LogsLocation": {
|
||||
"base": "<p>Information about build logs in Amazon CloudWatch Logs.</p>",
|
||||
"refs": {
|
||||
"Build$logs": "<p>Information about the build's logs in Amazon CloudWatch Logs.</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>",
|
||||
"BuildIds$member": null,
|
||||
"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>",
|
||||
"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>",
|
||||
"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>",
|
||||
"StopBuildInput$id": "<p>The ID of the build.</p>",
|
||||
"UpdateProjectInput$name": "<p>The name of the build project.</p> <note> <p>You cannot change a build project's name.</p> </note>",
|
||||
"UpdateProjectInput$serviceRole": "<p>The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.</p>",
|
||||
"UpdateProjectInput$encryptionKey": "<p>The replacement AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.</p> <p>You can specify either the CMK's Amazon Resource Name (ARN) or, if available, the CMK's alias (using the format <code>alias/<i>alias-name</i> </code>).</p>"
|
||||
}
|
||||
},
|
||||
"PhaseContext": {
|
||||
"base": "<p>Additional information about a build phase that has an error. You can use this information to help troubleshoot a failed build.</p>",
|
||||
"refs": {
|
||||
"PhaseContexts$member": null
|
||||
}
|
||||
},
|
||||
"PhaseContexts": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BuildPhase$contexts": "<p>Additional information about a build phase, especially to help troubleshoot a failed build.</p>"
|
||||
}
|
||||
},
|
||||
"PlatformType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"EnvironmentPlatform$platform": "<p>The platform's name.</p>"
|
||||
}
|
||||
},
|
||||
"Project": {
|
||||
"base": "<p>Information about a build project.</p>",
|
||||
"refs": {
|
||||
"CreateProjectOutput$project": "<p>Information about the build project that was created.</p>",
|
||||
"Projects$member": null,
|
||||
"UpdateProjectOutput$project": "<p>Information about the build project that was changed.</p>"
|
||||
}
|
||||
},
|
||||
"ProjectArtifacts": {
|
||||
"base": "<p>Information about the build output artifacts for the build project.</p>",
|
||||
"refs": {
|
||||
"CreateProjectInput$artifacts": "<p>Information about the build output artifacts for the build project.</p>",
|
||||
"Project$artifacts": "<p>Information about the build output artifacts for the build project.</p>",
|
||||
"StartBuildInput$artifactsOverride": "<p>Build output artifact settings that override, for this build only, the latest ones already defined in the build project.</p>",
|
||||
"UpdateProjectInput$artifacts": "<p>Information to be changed about the build output artifacts for the build project.</p>"
|
||||
}
|
||||
},
|
||||
"ProjectDescription": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateProjectInput$description": "<p>A description that makes the build project easy to identify.</p>",
|
||||
"Project$description": "<p>A description that makes the build project easy to identify.</p>",
|
||||
"UpdateProjectInput$description": "<p>A new or replacement description of the build project.</p>"
|
||||
}
|
||||
},
|
||||
"ProjectEnvironment": {
|
||||
"base": "<p>Information about the build environment of the build project.</p>",
|
||||
"refs": {
|
||||
"Build$environment": "<p>Information about the build environment for this build.</p>",
|
||||
"CreateProjectInput$environment": "<p>Information about the build environment for the build project.</p>",
|
||||
"Project$environment": "<p>Information about the build environment for this build project.</p>",
|
||||
"UpdateProjectInput$environment": "<p>Information to be changed about the build environment for the build project.</p>"
|
||||
}
|
||||
},
|
||||
"ProjectName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateProjectInput$name": "<p>The name of the build project.</p>",
|
||||
"Project$name": "<p>The name of the build project.</p>"
|
||||
}
|
||||
},
|
||||
"ProjectNames": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchGetProjectsInput$names": "<p>The names of the build projects.</p>",
|
||||
"BatchGetProjectsOutput$projectsNotFound": "<p>The names of build projects for which information could not be found.</p>",
|
||||
"ListProjectsOutput$projects": "<p>The list of build project names, with each build project name representing a single build project.</p>"
|
||||
}
|
||||
},
|
||||
"ProjectSortByType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListProjectsInput$sortBy": "<p>The criterion to be used to list build project names. Valid values include:</p> <ul> <li> <p> <code>CREATED_TIME</code>: List the build project names based on when each build project was created.</p> </li> <li> <p> <code>LAST_MODIFIED_TIME</code>: List the build project names based on when information about each build project was last changed.</p> </li> <li> <p> <code>NAME</code>: List the build project names based on each build project's name.</p> </li> </ul> <p>Use <code>sortOrder</code> to specify in what order to list the build project names based on the preceding criteria.</p>"
|
||||
}
|
||||
},
|
||||
"ProjectSource": {
|
||||
"base": "<p>Information about the build input source code for the build project.</p>",
|
||||
"refs": {
|
||||
"Build$source": "<p>Information about the source code to be built.</p>",
|
||||
"CreateProjectInput$source": "<p>Information about the build input source code for the build project.</p>",
|
||||
"Project$source": "<p>Information about the build input source code for this build project.</p>",
|
||||
"UpdateProjectInput$source": "<p>Information to be changed about the build input source code for the build project.</p>"
|
||||
}
|
||||
},
|
||||
"Projects": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchGetProjectsOutput$projects": "<p>Information about the requested build projects.</p>"
|
||||
}
|
||||
},
|
||||
"ResourceAlreadyExistsException": {
|
||||
"base": "<p>The specified AWS resource cannot be created, because an AWS resource with the same settings already exists.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ResourceNotFoundException": {
|
||||
"base": "<p>The specified AWS resource cannot be found.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"SortOrderType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListBuildsForProjectInput$sortOrder": "<p>The order to list build IDs. Valid values include:</p> <ul> <li> <p> <code>ASCENDING</code>: List the build IDs in ascending order by build ID.</p> </li> <li> <p> <code>DESCENDING</code>: List the build IDs in descending order by build ID.</p> </li> </ul>",
|
||||
"ListBuildsInput$sortOrder": "<p>The order to list build IDs. Valid values include:</p> <ul> <li> <p> <code>ASCENDING</code>: List the build IDs in ascending order by build ID.</p> </li> <li> <p> <code>DESCENDING</code>: List the build IDs in descending order by build ID.</p> </li> </ul>",
|
||||
"ListProjectsInput$sortOrder": "<p>The order in which to list build projects. Valid values include:</p> <ul> <li> <p> <code>ASCENDING</code>: List the build project names in ascending order.</p> </li> <li> <p> <code>DESCENDING</code>: List the build project names in descending order.</p> </li> </ul> <p>Use <code>sortBy</code> to specify the criterion to be used to list build project names.</p>"
|
||||
}
|
||||
},
|
||||
"SourceAuth": {
|
||||
"base": "<p>Information about the authorization settings for AWS CodeBuild to access the source code to be built.</p> <p>This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly (unless the build project's source <code>type</code> value is <code>GITHUB</code>).</p>",
|
||||
"refs": {
|
||||
"ProjectSource$auth": "<p>Information about the authorization settings for AWS CodeBuild to access the source code to be built.</p> <p>This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly (unless the build project's source <code>type</code> value is <code>GITHUB</code>).</p>"
|
||||
}
|
||||
},
|
||||
"SourceAuthType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"SourceAuth$type": "<p>The authorization type to use. The only valid value is <code>OAUTH</code>, which represents the OAuth authorization type.</p>"
|
||||
}
|
||||
},
|
||||
"SourceType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ProjectSource$type": "<p>The type of repository that contains the source code to be built. Valid values include:</p> <ul> <li> <p> <code>CODECOMMIT</code>: The source code is in an AWS CodeCommit repository.</p> </li> <li> <p> <code>CODEPIPELINE</code>: The source code settings are specified in the source action of a pipeline in AWS CodePipeline.</p> </li> <li> <p> <code>GITHUB</code>: The source code is in a GitHub repository.</p> </li> <li> <p> <code>S3</code>: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"StartBuildInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"StartBuildOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"StatusType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Build$buildStatus": "<p>The current status of the build. Valid values include:</p> <ul> <li> <p> <code>FAILED</code>: The build failed.</p> </li> <li> <p> <code>FAULT</code>: The build faulted.</p> </li> <li> <p> <code>IN_PROGRESS</code>: The build is still in progress.</p> </li> <li> <p> <code>STOPPED</code>: The build stopped.</p> </li> <li> <p> <code>SUCCEEDED</code>: The build succeeded.</p> </li> <li> <p> <code>TIMED_OUT</code>: The build timed out.</p> </li> </ul>",
|
||||
"BuildPhase$phaseStatus": "<p>The current status of the build phase. Valid values include:</p> <ul> <li> <p> <code>FAILED</code>: The build phase failed.</p> </li> <li> <p> <code>FAULT</code>: The build phase faulted.</p> </li> <li> <p> <code>IN_PROGRESS</code>: The build phase is still in progress.</p> </li> <li> <p> <code>STOPPED</code>: The build phase stopped.</p> </li> <li> <p> <code>SUCCEEDED</code>: The build phase succeeded.</p> </li> <li> <p> <code>TIMED_OUT</code>: The build phase timed out.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"StopBuildInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"StopBuildOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"String": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Build$currentPhase": "<p>The current build phase.</p>",
|
||||
"Build$initiator": "<p>The entity that started the build. Valid values include:</p> <ul> <li> <p>If AWS CodePipeline started the build, the pipeline's name (for example, <code>codepipeline/my-demo-pipeline</code>).</p> </li> <li> <p>If an AWS Identity and Access Management (IAM) user started the build, the user's name (for example <code>MyUserName</code>).</p> </li> <li> <p>If the Jenkins plugin for AWS CodeBuild started the build, the string <code>CodeBuild-Jenkins-Plugin</code>.</p> </li> </ul>",
|
||||
"BuildArtifacts$location": "<p>Information about the location of the build artifacts.</p>",
|
||||
"BuildArtifacts$sha256sum": "<p>The SHA-256 hash of the build artifact.</p> <p>You can use this hash along with a checksum tool to confirm both file integrity and authenticity.</p> <note> <p>This value is available only if the build project's <code>packaging</code> value is set to <code>ZIP</code>.</p> </note>",
|
||||
"BuildArtifacts$md5sum": "<p>The MD5 hash of the build artifact.</p> <p>You can use this hash along with a checksum tool to confirm both file integrity and authenticity.</p> <note> <p>This value is available only if the build project's <code>packaging</code> value is set to <code>ZIP</code>.</p> </note>",
|
||||
"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>",
|
||||
"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>",
|
||||
"ListBuildsOutput$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>",
|
||||
"ListProjectsOutput$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>",
|
||||
"LogsLocation$groupName": "<p>The name of the Amazon CloudWatch Logs group for the build logs.</p>",
|
||||
"LogsLocation$streamName": "<p>The name of the Amazon CloudWatch Logs stream for the build logs.</p>",
|
||||
"LogsLocation$deepLink": "<p>The URL to an individual build log in Amazon CloudWatch Logs.</p>",
|
||||
"PhaseContext$statusCode": "<p>The status code for the context of the build phase.</p>",
|
||||
"PhaseContext$message": "<p>An explanation of the build phase's context. This explanation might include a command ID and an exit code.</p>",
|
||||
"Project$arn": "<p>The Amazon Resource Name (ARN) of the build project.</p>",
|
||||
"ProjectArtifacts$location": "<p>Information about the build output artifact location, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, then this value will be ignored if specified, because no build output will be produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket.</p> </li> </ul>",
|
||||
"ProjectArtifacts$path": "<p>Along with <code>namespaceType</code> and <code>name</code>, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, then this value will be ignored if specified, because no build output will be produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the path to the output artifact. If <code>path</code> is not specified, then <code>path</code> will not be used.</p> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact would be stored in the output bucket at <code>MyArtifacts/MyArtifact.zip</code>.</p>",
|
||||
"ProjectArtifacts$name": "<p>Along with <code>path</code> and <code>namespaceType</code>, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:</p> <ul> <li> <p>If <code>type</code> is set to <code>CODEPIPELINE</code>, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.</p> </li> <li> <p>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, then this value will be ignored if specified, because no build output will be produced.</p> </li> <li> <p>If <code>type</code> is set to <code>S3</code>, this is the name of the output artifact object.</p> </li> </ul> <p>For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact would be stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>.</p>",
|
||||
"ProjectSource$location": "<p>Information about the location of the source code to be built. Valid values include:</p> <ul> <li> <p>For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, <code>location</code> should not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.</p> </li> <li> <p>For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, <code>https://git-codecommit.<i>region-ID</i>.amazonaws.com/v1/repos/<i>repo-name</i> </code>).</p> </li> <li> <p>For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example, <code> <i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>object-name</i>.zip</code>)</p> </li> <li> <p>For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your GitHub account. To do this, use the AWS CodeBuild console to begin creating a build project, and follow the on-screen instructions to complete the connection. (After you have connected to your GitHub account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</p> </li> </ul>",
|
||||
"ProjectSource$buildspec": "<p>The build spec declaration to use for the builds in this build project.</p> <p>If this value is not specified, a build spec must be included along with the source code to be built.</p>",
|
||||
"SourceAuth$resource": "<p>The resource value that applies to the specified authorization type.</p>",
|
||||
"StartBuildInput$sourceVersion": "<p>A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of:</p> <ul> <li> <p>For AWS CodeCommit or GitHub: the commit ID to use.</p> </li> <li> <p>For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.</p> </li> </ul>",
|
||||
"StartBuildInput$buildspecOverride": "<p>A build spec declaration that overrides, for this build only, the latest one already defined in the build project.</p>"
|
||||
}
|
||||
},
|
||||
"Tag": {
|
||||
"base": "<p>A tag, consisting of a key and a value.</p> <p>This tag is available for use by AWS services that support tags in AWS CodeBuild.</p>",
|
||||
"refs": {
|
||||
"TagList$member": null
|
||||
}
|
||||
},
|
||||
"TagList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateProjectInput$tags": "<p>A set of tags for this build project.</p> <p>These tags are available for use by AWS services that support AWS CodeBuild build project tags.</p>",
|
||||
"Project$tags": "<p>The tags for this build project.</p> <p>These tags are available for use by AWS services that support AWS CodeBuild build project tags.</p>",
|
||||
"UpdateProjectInput$tags": "<p>The replacement set of tags for this build project.</p> <p>These tags are available for use by AWS services that support AWS CodeBuild build project tags.</p>"
|
||||
}
|
||||
},
|
||||
"TimeOut": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateProjectInput$timeoutInMinutes": "<p>How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any build that has not been marked as completed. The default is 60 minutes.</p>",
|
||||
"Project$timeoutInMinutes": "<p>How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.</p>",
|
||||
"StartBuildInput$timeoutInMinutesOverride": "<p>The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.</p>",
|
||||
"UpdateProjectInput$timeoutInMinutes": "<p>The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed.</p>"
|
||||
}
|
||||
},
|
||||
"Timestamp": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Build$startTime": "<p>When the build process started, expressed in Unix time format.</p>",
|
||||
"Build$endTime": "<p>When the build process ended, expressed in Unix time format.</p>",
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"UpdateProjectInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateProjectOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ValueInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Tag$value": "<p>The tag's value.</p>"
|
||||
}
|
||||
},
|
||||
"WrapperInt": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Build$timeoutInMinutes": "<p>How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed.</p>"
|
||||
}
|
||||
},
|
||||
"WrapperLong": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BuildPhase$durationInSeconds": "<p>How long, in seconds, between the starting and ending times of the build's phase.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+5
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user