mirror of
https://github.com/aptly-dev/aptly.git
synced 2026-05-31 04:30:44 +00:00
Update Go AWS SDK to the latest version
This commit is contained in:
Andrey Smirnov
committed by
Andrey Smirnov
Andrey Smirnov
parent
d08be990ef
commit
94a72b23ff
Generated
Vendored
+2
-2
@@ -17,7 +17,7 @@
|
||||
"ListProgressUpdateStreams": "<p>Lists progress update streams associated with the user account making this call.</p>",
|
||||
"NotifyApplicationState": "<p>Sets the migration state of an application. For a given application identified by the value passed to <code>ApplicationId</code>, its status is set or updated by passing one of three values to <code>Status</code>: <code>NOT_STARTED | IN_PROGRESS | COMPLETED</code>.</p>",
|
||||
"NotifyMigrationTaskState": "<p>Notifies Migration Hub of the current status, progress, or other detail regarding a migration task. This API has the following traits:</p> <ul> <li> <p>Migration tools will call the <code>NotifyMigrationTaskState</code> API to share the latest progress and status.</p> </li> <li> <p> <code>MigrationTaskName</code> is used for addressing updates to the correct target.</p> </li> <li> <p> <code>ProgressUpdateStream</code> is used for access control and to provide a namespace for each migration tool.</p> </li> </ul>",
|
||||
"PutResourceAttributes": "<p>Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service (ADS)'s repository. This association occurs asynchronously after <code>PutResourceAttributes</code> returns.</p> <important> <ul> <li> <p>Keep in mind that subsequent calls to PutResourceAttributes will override previously stored attributes. For example, if it is first called with a MAC address, but later, it is desired to <i>add</i> an IP address, it will then be required to call it with <i>both</i> the IP and MAC addresses to prevent overiding the MAC address.</p> </li> <li> <p>Note the instructions regarding the special use case of the <code>ResourceAttributeList</code> parameter when specifying any \"VM\" related value.</p> </li> </ul> </important> <note> <p>Because this is an asynchronous call, it will always return 200, whether an association occurs or not. To confirm if an association was found based on the provided details, call <code>ListDiscoveredResources</code>.</p> </note>"
|
||||
"PutResourceAttributes": "<p>Provides identifying details of the resource being migrated so that it can be associated in the Application Discovery Service (ADS)'s repository. This association occurs asynchronously after <code>PutResourceAttributes</code> returns.</p> <important> <ul> <li> <p>Keep in mind that subsequent calls to PutResourceAttributes will override previously stored attributes. For example, if it is first called with a MAC address, but later, it is desired to <i>add</i> an IP address, it will then be required to call it with <i>both</i> the IP and MAC addresses to prevent overiding the MAC address.</p> </li> <li> <p>Note the instructions regarding the special use case of the <a href=\"https://docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#migrationhub-PutResourceAttributes-request-ResourceAttributeList\"> <code>ResourceAttributeList</code> </a> parameter when specifying any \"VM\" related value. </p> </li> </ul> </important> <note> <p>Because this is an asynchronous call, it will always return 200, whether an association occurs or not. To confirm if an association was found based on the provided details, call <code>ListDiscoveredResources</code>.</p> </note>"
|
||||
},
|
||||
"shapes": {
|
||||
"AccessDeniedException": {
|
||||
@@ -414,7 +414,7 @@
|
||||
"ResourceAttributeList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PutResourceAttributesRequest$ResourceAttributeList": "<p>Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service (ADS)'s repository.</p> <note> <p>In the <code>ResourceAttribute</code> object array, the <code>Type</code> field is reserved for the following values: <code>IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER</code>, and the identifying value can be a string up to 256 characters.</p> </note> <important> <p>If any \"VM\" related value is used for a <code>ResourceAttribute</code> object, it is required that <code>VM_MANAGER_ID</code>, as a minimum, is always used. If it is not used, the server will not be associated in the Application Discovery Service (ADS)'s repository using any of the other \"VM\" related values, and you will experience data loss. See the Example section below for a use case of specifying \"VM\" related values.</p> </important>"
|
||||
"PutResourceAttributesRequest$ResourceAttributeList": "<p>Information about the resource that is being migrated. This data will be used to map the task to a resource in the Application Discovery Service (ADS)'s repository.</p> <note> <p>Takes the object array of <code>ResourceAttribute</code> where the <code>Type</code> field is reserved for the following values: <code>IPV4_ADDRESS | IPV6_ADDRESS | MAC_ADDRESS | FQDN | VM_MANAGER_ID | VM_MANAGED_OBJECT_REFERENCE | VM_NAME | VM_PATH | BIOS_ID | MOTHERBOARD_SERIAL_NUMBER</code> where the identifying value can be a string up to 256 characters.</p> </note> <important> <ul> <li> <p>If any \"VM\" related value is set for a <code>ResourceAttribute</code> object, it is required that <code>VM_MANAGER_ID</code>, as a minimum, is always set. If <code>VM_MANAGER_ID</code> is not set, then all \"VM\" fields will be discarded and \"VM\" fields will not be used for matching the migration task to a server in Application Discovery Service (ADS)'s repository. See the <a href=\"https://docs.aws.amazon.com/migrationhub/latest/ug/API_PutResourceAttributes.html#API_PutResourceAttributes_Examples\">Example</a> section below for a use case of specifying \"VM\" related values.</p> </li> <li> <p> If a server you are trying to match has multiple IP or MAC addresses, you should provide as many as you know in separate type/value pairs passed to the <code>ResourceAttributeList</code> parameter to maximize the chances of matching.</p> </li> </ul> </important>"
|
||||
}
|
||||
},
|
||||
"ResourceAttributeType": {
|
||||
|
||||
+196
-10
@@ -24,6 +24,7 @@
|
||||
"errors":[
|
||||
{"shape":"InvalidArgsException"},
|
||||
{"shape":"InvalidPolicyException"},
|
||||
{"shape":"InvalidTagException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"idempotent":true
|
||||
@@ -46,6 +47,22 @@
|
||||
],
|
||||
"idempotent":true
|
||||
},
|
||||
"CreatePermission":{
|
||||
"name":"CreatePermission",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreatePermissionRequest"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"PermissionAlreadyExistsException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidStateException"},
|
||||
{"shape":"RequestFailedException"}
|
||||
]
|
||||
},
|
||||
"DeleteCertificateAuthority":{
|
||||
"name":"DeleteCertificateAuthority",
|
||||
"http":{
|
||||
@@ -60,6 +77,20 @@
|
||||
{"shape":"InvalidStateException"}
|
||||
]
|
||||
},
|
||||
"DeletePermission":{
|
||||
"name":"DeletePermission",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeletePermissionRequest"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"InvalidStateException"},
|
||||
{"shape":"RequestFailedException"}
|
||||
]
|
||||
},
|
||||
"DescribeCertificateAuthority":{
|
||||
"name":"DescribeCertificateAuthority",
|
||||
"http":{
|
||||
@@ -83,6 +114,7 @@
|
||||
"output":{"shape":"DescribeCertificateAuthorityAuditReportResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"InvalidArgsException"}
|
||||
]
|
||||
},
|
||||
@@ -128,7 +160,8 @@
|
||||
{"shape":"RequestInProgressException"},
|
||||
{"shape":"RequestFailedException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidArnException"}
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"InvalidStateException"}
|
||||
]
|
||||
},
|
||||
"ImportCertificateAuthorityCertificate":{
|
||||
@@ -144,6 +177,8 @@
|
||||
{"shape":"RequestFailedException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"InvalidStateException"},
|
||||
{"shape":"MalformedCertificateException"},
|
||||
{"shape":"CertificateMismatchException"}
|
||||
]
|
||||
@@ -178,6 +213,22 @@
|
||||
{"shape":"InvalidNextTokenException"}
|
||||
]
|
||||
},
|
||||
"ListPermissions":{
|
||||
"name":"ListPermissions",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListPermissionsRequest"},
|
||||
"output":{"shape":"ListPermissionsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"InvalidStateException"},
|
||||
{"shape":"RequestFailedException"}
|
||||
]
|
||||
},
|
||||
"ListTags":{
|
||||
"name":"ListTags",
|
||||
"http":{
|
||||
@@ -188,6 +239,20 @@
|
||||
"output":{"shape":"ListTagsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"InvalidStateException"}
|
||||
]
|
||||
},
|
||||
"RestoreCertificateAuthority":{
|
||||
"name":"RestoreCertificateAuthority",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"RestoreCertificateAuthorityRequest"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidStateException"},
|
||||
{"shape":"InvalidArnException"}
|
||||
]
|
||||
},
|
||||
@@ -201,7 +266,9 @@
|
||||
"errors":[
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"InvalidStateException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"RequestAlreadyProcessedException"},
|
||||
{"shape":"RequestInProgressException"},
|
||||
@@ -218,6 +285,7 @@
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"InvalidStateException"},
|
||||
{"shape":"InvalidTagException"},
|
||||
{"shape":"TooManyTagsException"}
|
||||
]
|
||||
@@ -232,6 +300,7 @@
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"InvalidStateException"},
|
||||
{"shape":"InvalidTagException"}
|
||||
]
|
||||
},
|
||||
@@ -272,11 +341,31 @@
|
||||
"GenerationQualifier":{"shape":"String3"}
|
||||
}
|
||||
},
|
||||
"AccountId":{
|
||||
"type":"string",
|
||||
"max":12,
|
||||
"min":12,
|
||||
"pattern":"[0-9]+"
|
||||
},
|
||||
"ActionList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ActionType"},
|
||||
"max":3,
|
||||
"min":1
|
||||
},
|
||||
"ActionType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"IssueCertificate",
|
||||
"GetCertificate",
|
||||
"ListPermissions"
|
||||
]
|
||||
},
|
||||
"Arn":{
|
||||
"type":"string",
|
||||
"max":200,
|
||||
"min":5,
|
||||
"pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=/,.@-]+)*"
|
||||
"pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]*:[\\w+=,.@-]+(/[\\w+=/,.@-]+)*"
|
||||
},
|
||||
"AuditReportId":{
|
||||
"type":"string",
|
||||
@@ -317,7 +406,8 @@
|
||||
"NotAfter":{"shape":"TStamp"},
|
||||
"FailureReason":{"shape":"FailureReason"},
|
||||
"CertificateAuthorityConfiguration":{"shape":"CertificateAuthorityConfiguration"},
|
||||
"RevocationConfiguration":{"shape":"RevocationConfiguration"}
|
||||
"RevocationConfiguration":{"shape":"RevocationConfiguration"},
|
||||
"RestorableUntil":{"shape":"TStamp"}
|
||||
}
|
||||
},
|
||||
"CertificateAuthorityConfiguration":{
|
||||
@@ -339,6 +429,7 @@
|
||||
"CREATING",
|
||||
"PENDING_CERTIFICATE",
|
||||
"ACTIVE",
|
||||
"DELETED",
|
||||
"DISABLED",
|
||||
"EXPIRED",
|
||||
"FAILED"
|
||||
@@ -346,7 +437,10 @@
|
||||
},
|
||||
"CertificateAuthorityType":{
|
||||
"type":"string",
|
||||
"enum":["SUBORDINATE"]
|
||||
"enum":[
|
||||
"ROOT",
|
||||
"SUBORDINATE"
|
||||
]
|
||||
},
|
||||
"CertificateBody":{"type":"string"},
|
||||
"CertificateBodyBlob":{
|
||||
@@ -408,7 +502,8 @@
|
||||
"CertificateAuthorityConfiguration":{"shape":"CertificateAuthorityConfiguration"},
|
||||
"RevocationConfiguration":{"shape":"RevocationConfiguration"},
|
||||
"CertificateAuthorityType":{"shape":"CertificateAuthorityType"},
|
||||
"IdempotencyToken":{"shape":"IdempotencyToken"}
|
||||
"IdempotencyToken":{"shape":"IdempotencyToken"},
|
||||
"Tags":{"shape":"TagList"}
|
||||
}
|
||||
},
|
||||
"CreateCertificateAuthorityResponse":{
|
||||
@@ -417,6 +512,20 @@
|
||||
"CertificateAuthorityArn":{"shape":"Arn"}
|
||||
}
|
||||
},
|
||||
"CreatePermissionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"CertificateAuthorityArn",
|
||||
"Principal",
|
||||
"Actions"
|
||||
],
|
||||
"members":{
|
||||
"CertificateAuthorityArn":{"shape":"Arn"},
|
||||
"Principal":{"shape":"Principal"},
|
||||
"SourceAccount":{"shape":"AccountId"},
|
||||
"Actions":{"shape":"ActionList"}
|
||||
}
|
||||
},
|
||||
"CrlConfiguration":{
|
||||
"type":"structure",
|
||||
"required":["Enabled"],
|
||||
@@ -443,7 +552,20 @@
|
||||
"type":"structure",
|
||||
"required":["CertificateAuthorityArn"],
|
||||
"members":{
|
||||
"CertificateAuthorityArn":{"shape":"Arn"}
|
||||
"CertificateAuthorityArn":{"shape":"Arn"},
|
||||
"PermanentDeletionTimeInDays":{"shape":"PermanentDeletionTimeInDays"}
|
||||
}
|
||||
},
|
||||
"DeletePermissionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"CertificateAuthorityArn",
|
||||
"Principal"
|
||||
],
|
||||
"members":{
|
||||
"CertificateAuthorityArn":{"shape":"Arn"},
|
||||
"Principal":{"shape":"Principal"},
|
||||
"SourceAccount":{"shape":"AccountId"}
|
||||
}
|
||||
},
|
||||
"DescribeCertificateAuthorityAuditReportRequest":{
|
||||
@@ -548,8 +670,7 @@
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"CertificateAuthorityArn",
|
||||
"Certificate",
|
||||
"CertificateChain"
|
||||
"Certificate"
|
||||
],
|
||||
"members":{
|
||||
"CertificateAuthorityArn":{"shape":"Arn"},
|
||||
@@ -590,6 +711,13 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidRequestException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidStateException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -616,6 +744,7 @@
|
||||
"CertificateAuthorityArn":{"shape":"Arn"},
|
||||
"Csr":{"shape":"CsrBlob"},
|
||||
"SigningAlgorithm":{"shape":"SigningAlgorithm"},
|
||||
"TemplateArn":{"shape":"Arn"},
|
||||
"Validity":{"shape":"Validity"},
|
||||
"IdempotencyToken":{"shape":"IdempotencyToken"}
|
||||
}
|
||||
@@ -656,6 +785,22 @@
|
||||
"NextToken":{"shape":"NextToken"}
|
||||
}
|
||||
},
|
||||
"ListPermissionsRequest":{
|
||||
"type":"structure",
|
||||
"required":["CertificateAuthorityArn"],
|
||||
"members":{
|
||||
"CertificateAuthorityArn":{"shape":"Arn"},
|
||||
"NextToken":{"shape":"NextToken"},
|
||||
"MaxResults":{"shape":"MaxResults"}
|
||||
}
|
||||
},
|
||||
"ListPermissionsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Permissions":{"shape":"PermissionList"},
|
||||
"NextToken":{"shape":"NextToken"}
|
||||
}
|
||||
},
|
||||
"ListTagsRequest":{
|
||||
"type":"structure",
|
||||
"required":["CertificateAuthorityArn"],
|
||||
@@ -696,10 +841,44 @@
|
||||
"max":500,
|
||||
"min":1
|
||||
},
|
||||
"PermanentDeletionTimeInDays":{
|
||||
"type":"integer",
|
||||
"max":30,
|
||||
"min":7
|
||||
},
|
||||
"Permission":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CertificateAuthorityArn":{"shape":"Arn"},
|
||||
"CreatedAt":{"shape":"TStamp"},
|
||||
"Principal":{"shape":"String"},
|
||||
"SourceAccount":{"shape":"String"},
|
||||
"Actions":{"shape":"ActionList"},
|
||||
"Policy":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"PermissionAlreadyExistsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"PermissionList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Permission"},
|
||||
"min":0
|
||||
},
|
||||
"PositiveLong":{
|
||||
"type":"long",
|
||||
"min":1
|
||||
},
|
||||
"Principal":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":0,
|
||||
"pattern":"^[^*]+$"
|
||||
},
|
||||
"RequestAlreadyProcessedException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -728,6 +907,13 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"RestoreCertificateAuthorityRequest":{
|
||||
"type":"structure",
|
||||
"required":["CertificateAuthorityArn"],
|
||||
"members":{
|
||||
"CertificateAuthorityArn":{"shape":"Arn"}
|
||||
}
|
||||
},
|
||||
"RevocationConfiguration":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -836,7 +1022,7 @@
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":1,
|
||||
"pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*"
|
||||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
|
||||
},
|
||||
"TagList":{
|
||||
"type":"list",
|
||||
@@ -848,7 +1034,7 @@
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":0,
|
||||
"pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*"
|
||||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
|
||||
},
|
||||
"TooManyTagsException":{
|
||||
"type":"structure",
|
||||
|
||||
+162
-61
@@ -1,65 +1,95 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<p>You can use the ACM PCA API to create a private certificate authority (CA). You must first call the <a>CreateCertificateAuthority</a> function. If successful, the function returns an Amazon Resource Name (ARN) for your private CA. Use this ARN as input to the <a>GetCertificateAuthorityCsr</a> function to retrieve the certificate signing request (CSR) for your private CA certificate. Sign the CSR using the root or an intermediate CA in your on-premises PKI hierarchy, and call the <a>ImportCertificateAuthorityCertificate</a> to import your signed private CA certificate into ACM PCA. </p> <p>Use your private CA to issue and revoke certificates. These are private certificates that identify and secure client computers, servers, applications, services, devices, and users over SSLS/TLS connections within your organization. Call the <a>IssueCertificate</a> function to issue a certificate. Call the <a>RevokeCertificate</a> function to revoke a certificate. </p> <note> <p>Certificates issued by your private CA can be trusted only within your organization, not publicly.</p> </note> <p>Your private CA can optionally create a certificate revocation list (CRL) to track the certificates you revoke. To create a CRL, you must specify a <a>RevocationConfiguration</a> object when you call the <a>CreateCertificateAuthority</a> function. ACM PCA writes the CRL to an S3 bucket that you specify. You must specify a bucket policy that grants ACM PCA write permission. </p> <p>You can also call the <a>CreateCertificateAuthorityAuditReport</a> to create an optional audit report that lists every time the CA private key is used. The private key is used for signing when the <b>IssueCertificate</b> or <b>RevokeCertificate</b> function is called. </p>",
|
||||
"service": "<p>This is the <i>ACM Private CA API Reference</i>. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing private certificate authorities (CA) for your organization.</p> <p>The documentation for each action shows the Query API request parameters and the XML response. Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see <a href=\"https://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p> <note> <p>Each ACM Private CA API action has a throttling limit which determines the number of times the action can be called per second. For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaLimits.html#PcaLimits-api\">API Rate Limits in ACM Private CA</a> in the ACM Private CA user guide.</p> </note>",
|
||||
"operations": {
|
||||
"CreateCertificateAuthority": "<p>Creates a private subordinate certificate authority (CA). You must specify the CA configuration, the revocation configuration, the CA type, and an optional idempotency token. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses to sign, and X.500 subject information. The CRL (certificate revocation list) configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this function returns the Amazon Resource Name (ARN) of the CA.</p>",
|
||||
"CreateCertificateAuthorityAuditReport": "<p>Creates an audit report that lists every time that the your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The <a>IssueCertificate</a> and <a>RevokeCertificate</a> functions use the private key. You can generate a new report every 30 minutes.</p>",
|
||||
"DeleteCertificateAuthority": "<p>Deletes the private certificate authority (CA) that you created or started to create by calling the <a>CreateCertificateAuthority</a> function. This action requires that you enter an ARN (Amazon Resource Name) for the private CA that you want to delete. You can find the ARN by calling the <a>ListCertificateAuthorities</a> function. You can delete the CA if you are waiting for it to be created (the <b>Status</b> field of the <a>CertificateAuthority</a> is <code>CREATING</code>) or if the CA has been created but you haven't yet imported the signed certificate (the <b>Status</b> is <code>PENDING_CERTIFICATE</code>) into ACM PCA. If you've already imported the certificate, you cannot delete the CA unless it has been disabled for more than 30 days. To disable a CA, call the <a>UpdateCertificateAuthority</a> function and set the <b>CertificateAuthorityStatus</b> argument to <code>DISABLED</code>. </p>",
|
||||
"DescribeCertificateAuthority": "<p>Lists information about your private certificate authority (CA). You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following: </p> <ul> <li> <p> <b>CREATING:</b> ACM PCA is creating your private certificate authority.</p> </li> <li> <p> <b>PENDING_CERTIFICATE:</b> The certificate is pending. You must use your on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA. </p> </li> <li> <p> <b>ACTIVE:</b> Your private CA is active.</p> </li> <li> <p> <b>DISABLED:</b> Your private CA has been disabled.</p> </li> <li> <p> <b>EXPIRED:</b> Your private CA certificate has expired.</p> </li> <li> <p> <b>FAILED:</b> Your private CA has failed. Your CA can fail for problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA. </p> </li> </ul>",
|
||||
"DescribeCertificateAuthorityAuditReport": "<p>Lists information about a specific audit report created by calling the <a>CreateCertificateAuthorityAuditReport</a> function. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the <a>IssueCertificate</a> function or the <a>RevokeCertificate</a> function. </p>",
|
||||
"GetCertificate": "<p>Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the <a>IssueCertificate</a> function. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the <b>GetCertificate</b> function. You can retrieve the certificate if it is in the <b>ISSUED</b> state. You can call the <a>CreateCertificateAuthorityAuditReport</a> function to create a report that contains information about all of the certificates issued and revoked by your private CA. </p>",
|
||||
"CreateCertificateAuthority": "<p>Creates a root or subordinate private certificate authority (CA). You must specify the CA configuration, the certificate revocation list (CRL) configuration, the CA type, and an optional idempotency token to avoid accidental creation of multiple CAs. The CA configuration specifies the name of the algorithm and key size to be used to create the CA private key, the type of signing algorithm that the CA uses, and X.500 subject information. The CRL configuration specifies the CRL expiration period in days (the validity period of the CRL), the Amazon S3 bucket that will contain the CRL, and a CNAME alias for the S3 bucket that is included in certificates issued by the CA. If successful, this action returns the Amazon Resource Name (ARN) of the CA.</p>",
|
||||
"CreateCertificateAuthorityAuditReport": "<p>Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The <a>IssueCertificate</a> and <a>RevokeCertificate</a> actions use the private key.</p>",
|
||||
"CreatePermission": "<p>Assigns permissions from a private CA to a designated AWS service. Services are specified by their service principals and can be given permission to create and retrieve certificates on a private CA. Services can also be given permission to list the active permissions that the private CA has granted. For ACM to automatically renew your private CA's certificates, you must assign all possible permissions from the CA to the ACM service principal.</p> <p>At this time, you can only assign permissions to ACM (<code>acm.amazonaws.com</code>). Permissions can be revoked with the <a>DeletePermission</a> action and listed with the <a>ListPermissions</a> action.</p>",
|
||||
"DeleteCertificateAuthority": "<p>Deletes a private certificate authority (CA). You must provide the Amazon Resource Name (ARN) of the private CA that you want to delete. You can find the ARN by calling the <a>ListCertificateAuthorities</a> action. </p> <note> <p>Deleting a CA will invalidate other CAs and certificates below it in your CA hierarchy.</p> </note> <p>Before you can delete a CA that you have created and activated, you must disable it. To do this, call the <a>UpdateCertificateAuthority</a> action and set the <b>CertificateAuthorityStatus</b> parameter to <code>DISABLED</code>. </p> <p>Additionally, you can delete a CA if you are waiting for it to be created (that is, the status of the CA is <code>CREATING</code>). You can also delete it if the CA has been created but you haven't yet imported the signed certificate into ACM Private CA (that is, the status of the CA is <code>PENDING_CERTIFICATE</code>). </p> <p>When you successfully call <a>DeleteCertificateAuthority</a>, the CA's status changes to <code>DELETED</code>. However, the CA won't be permanently deleted until the restoration period has passed. By default, if you do not set the <code>PermanentDeletionTimeInDays</code> parameter, the CA remains restorable for 30 days. You can set the parameter from 7 to 30 days. The <a>DescribeCertificateAuthority</a> action returns the time remaining in the restoration window of a private CA in the <code>DELETED</code> state. To restore an eligible CA, call the <a>RestoreCertificateAuthority</a> action.</p>",
|
||||
"DeletePermission": "<p>Revokes permissions that a private CA assigned to a designated AWS service. Permissions can be created with the <a>CreatePermission</a> action and listed with the <a>ListPermissions</a> action. </p>",
|
||||
"DescribeCertificateAuthority": "<p>Lists information about your private certificate authority (CA). You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following: </p> <ul> <li> <p> <code>CREATING</code> - ACM Private CA is creating your private certificate authority.</p> </li> <li> <p> <code>PENDING_CERTIFICATE</code> - The certificate is pending. You must use your ACM Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA. </p> </li> <li> <p> <code>ACTIVE</code> - Your private CA is active.</p> </li> <li> <p> <code>DISABLED</code> - Your private CA has been disabled.</p> </li> <li> <p> <code>EXPIRED</code> - Your private CA certificate has expired.</p> </li> <li> <p> <code>FAILED</code> - Your private CA has failed. Your CA can fail because of problems such a network outage or backend AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA. </p> </li> <li> <p> <code>DELETED</code> - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.</p> </li> </ul>",
|
||||
"DescribeCertificateAuthorityAuditReport": "<p>Lists information about a specific audit report created by calling the <a>CreateCertificateAuthorityAuditReport</a> action. Audit information is created every time the certificate authority (CA) private key is used. The private key is used when you call the <a>IssueCertificate</a> action or the <a>RevokeCertificate</a> action. </p>",
|
||||
"GetCertificate": "<p>Retrieves a certificate from your private CA. The ARN of the certificate is returned when you call the <a>IssueCertificate</a> action. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the <b>GetCertificate</b> action. You can retrieve the certificate if it is in the <b>ISSUED</b> state. You can call the <a>CreateCertificateAuthorityAuditReport</a> action to create a report that contains information about all of the certificates issued and revoked by your private CA. </p>",
|
||||
"GetCertificateAuthorityCertificate": "<p>Retrieves the certificate and certificate chain for your private certificate authority (CA). Both the certificate and the chain are base64 PEM-encoded. The chain does not include the CA certificate. Each certificate in the chain signs the one before it. </p>",
|
||||
"GetCertificateAuthorityCsr": "<p>Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the <a>CreateCertificateAuthority</a> function. Take the CSR to your on-premises X.509 infrastructure and sign it by using your root or a subordinate CA. Then import the signed certificate back into ACM PCA by calling the <a>ImportCertificateAuthorityCertificate</a> function. The CSR is returned as a base64 PEM-encoded string. </p>",
|
||||
"ImportCertificateAuthorityCertificate": "<p>Imports your signed private CA certificate into ACM PCA. Before you can call this function, you must create the private certificate authority by calling the <a>CreateCertificateAuthority</a> function. You must then generate a certificate signing request (CSR) by calling the <a>GetCertificateAuthorityCsr</a> function. Take the CSR to your on-premises CA and use the root certificate or a subordinate certificate to sign it. Create a certificate chain and copy the signed certificate and the certificate chain to your working directory. </p> <note> <p>Your certificate chain must not include the private CA certificate that you are importing.</p> </note> <note> <p>Your on-premises CA certificate must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built. </p> </note> <note> <p>The chain must be PEM-encoded.</p> </note>",
|
||||
"IssueCertificate": "<p>Uses your private certificate authority (CA) to issue a client certificate. This function returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the <a>GetCertificate</a> function and specifying the ARN. </p> <note> <p>You cannot use the ACM <b>ListCertificateAuthorities</b> function to retrieve the ARNs of the certificates that you issue by using ACM PCA.</p> </note>",
|
||||
"ListCertificateAuthorities": "<p>Lists the private certificate authorities that you created by using the <a>CreateCertificateAuthority</a> function.</p>",
|
||||
"ListTags": "<p>Lists the tags, if any, that are associated with your private CA. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the <a>TagCertificateAuthority</a> function to add one or more tags to your CA. Call the <a>UntagCertificateAuthority</a> function to remove tags. </p>",
|
||||
"RevokeCertificate": "<p>Revokes a certificate that you issued by calling the <a>IssueCertificate</a> function. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. ACM PCA writes the CRL to an S3 bucket that you specify. For more information about revocation, see the <a>CrlConfiguration</a> structure. ACM PCA also writes revocation information to the audit report. For more information, see <a>CreateCertificateAuthorityAuditReport</a>. </p>",
|
||||
"TagCertificateAuthority": "<p>Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the <a>UntagCertificateAuthority</a> function. Call the <a>ListTags</a> function to see what tags are associated with your CA. </p>",
|
||||
"UntagCertificateAuthority": "<p>Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the <a>TagCertificateAuthority</a>. Call the <a>ListTags</a> function to see what tags are associated with your CA. </p>",
|
||||
"UpdateCertificateAuthority": "<p>Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the <b> <code>ACTIVE</code> </b> or <b> <code>DISABLED</code> </b> state before you can update it. You can disable a private CA that is in the <b> <code>ACTIVE</code> </b> state or make a CA that is in the <b> <code>DISABLED</code> </b> state active again.</p>"
|
||||
"GetCertificateAuthorityCsr": "<p>Retrieves the certificate signing request (CSR) for your private certificate authority (CA). The CSR is created when you call the <a>CreateCertificateAuthority</a> action. Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA. Then import the signed certificate back into ACM Private CA by calling the <a>ImportCertificateAuthorityCertificate</a> action. The CSR is returned as a base64 PEM-encoded string. </p>",
|
||||
"ImportCertificateAuthorityCertificate": "<p>Imports a signed private CA certificate into ACM Private CA. This action is used when you are using a chain of trust whose root is located outside ACM Private CA. Before you can call this action, the following preparations must in place:</p> <ol> <li> <p>In ACM Private CA, call the <a>CreateCertificateAuthority</a> action to create the private CA that that you plan to back with the imported certificate.</p> </li> <li> <p>Call the <a>GetCertificateAuthorityCsr</a> action to generate a certificate signing request (CSR).</p> </li> <li> <p>Sign the CSR using a root or intermediate CA hosted either by an on-premises PKI hierarchy or a commercial CA..</p> </li> <li> <p>Create a certificate chain and copy the signed certificate and the certificate chain to your working directory.</p> </li> </ol> <p>The following requirements apply when you import a CA certificate.</p> <ul> <li> <p>You cannot import a non-self-signed certificate for use as a root CA.</p> </li> <li> <p>You cannot import a self-signed certificate for use as a subordinate CA.</p> </li> <li> <p>Your certificate chain must not include the private CA certificate that you are importing.</p> </li> <li> <p>Your ACM Private CA-hosted or on-premises CA certificate must be the last certificate in your chain. The subordinate certificate, if any, that your root CA signed must be next to last. The subordinate certificate signed by the preceding subordinate CA must come next, and so on until your chain is built. </p> </li> <li> <p>The chain must be PEM-encoded.</p> </li> </ul>",
|
||||
"IssueCertificate": "<p>Uses your private certificate authority (CA) to issue a client certificate. This action returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the <a>GetCertificate</a> action and specifying the ARN. </p> <note> <p>You cannot use the ACM <b>ListCertificateAuthorities</b> action to retrieve the ARNs of the certificates that you issue by using ACM Private CA.</p> </note>",
|
||||
"ListCertificateAuthorities": "<p>Lists the private certificate authorities that you created by using the <a>CreateCertificateAuthority</a> action.</p>",
|
||||
"ListPermissions": "<p>Lists all the permissions, if any, that have been assigned by a private CA. Permissions can be granted with the <a>CreatePermission</a> action and revoked with the <a>DeletePermission</a> action.</p>",
|
||||
"ListTags": "<p>Lists the tags, if any, that are associated with your private CA. Tags are labels that you can use to identify and organize your CAs. Each tag consists of a key and an optional value. Call the <a>TagCertificateAuthority</a> action to add one or more tags to your CA. Call the <a>UntagCertificateAuthority</a> action to remove tags. </p>",
|
||||
"RestoreCertificateAuthority": "<p>Restores a certificate authority (CA) that is in the <code>DELETED</code> state. You can restore a CA during the period that you defined in the <b>PermanentDeletionTimeInDays</b> parameter of the <a>DeleteCertificateAuthority</a> action. Currently, you can specify 7 to 30 days. If you did not specify a <b>PermanentDeletionTimeInDays</b> value, by default you can restore the CA at any time in a 30 day period. You can check the time remaining in the restoration period of a private CA in the <code>DELETED</code> state by calling the <a>DescribeCertificateAuthority</a> or <a>ListCertificateAuthorities</a> actions. The status of a restored CA is set to its pre-deletion status when the <b>RestoreCertificateAuthority</b> action returns. To change its status to <code>ACTIVE</code>, call the <a>UpdateCertificateAuthority</a> action. If the private CA was in the <code>PENDING_CERTIFICATE</code> state at deletion, you must use the <a>ImportCertificateAuthorityCertificate</a> action to import a certificate authority into the private CA before it can be activated. You cannot restore a CA after the restoration period has ended.</p>",
|
||||
"RevokeCertificate": "<p>Revokes a certificate that was issued inside ACM Private CA. If you enable a certificate revocation list (CRL) when you create or update your private CA, information about the revoked certificates will be included in the CRL. ACM Private CA writes the CRL to an S3 bucket that you specify. For more information about revocation, see the <a>CrlConfiguration</a> structure. ACM Private CA also writes revocation information to the audit report. For more information, see <a>CreateCertificateAuthorityAuditReport</a>. </p> <note> <p>You cannot revoke a root CA self-signed certificate.</p> </note>",
|
||||
"TagCertificateAuthority": "<p>Adds one or more tags to your private CA. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a key and an optional value. You specify the private CA on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. You can apply a tag to just one private CA if you want to identify a specific characteristic of that CA, or you can apply the same tag to multiple private CAs if you want to filter for a common relationship among those CAs. To remove one or more tags, use the <a>UntagCertificateAuthority</a> action. Call the <a>ListTags</a> action to see what tags are associated with your CA. </p>",
|
||||
"UntagCertificateAuthority": "<p>Remove one or more tags from your private CA. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this action, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. To add tags to a private CA, use the <a>TagCertificateAuthority</a>. Call the <a>ListTags</a> action to see what tags are associated with your CA. </p>",
|
||||
"UpdateCertificateAuthority": "<p>Updates the status or configuration of a private certificate authority (CA). Your private CA must be in the <code>ACTIVE</code> or <code>DISABLED</code> state before you can update it. You can disable a private CA that is in the <code>ACTIVE</code> state or make a CA that is in the <code>DISABLED</code> state active again.</p>"
|
||||
},
|
||||
"shapes": {
|
||||
"ASN1Subject": {
|
||||
"base": "<p>Contains information about the certificate subject. The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The <b>Subject</b> field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The <b>Subject</b> must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each for each entity, but your private CA can issue more than one certificate with the same DN to the same entity. </p>",
|
||||
"base": "<p>Contains information about the certificate subject. The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The <b>Subject</b> field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The <b>Subject</b> must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each entity, but your private CA can issue more than one certificate with the same DN to the same entity. </p>",
|
||||
"refs": {
|
||||
"CertificateAuthorityConfiguration$Subject": "<p>Structure that contains X.500 distinguished name information for your private CA.</p>"
|
||||
}
|
||||
},
|
||||
"AccountId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreatePermissionRequest$SourceAccount": "<p>The ID of the calling account.</p>",
|
||||
"DeletePermissionRequest$SourceAccount": "<p>The AWS account that calls this action.</p>"
|
||||
}
|
||||
},
|
||||
"ActionList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreatePermissionRequest$Actions": "<p>The actions that the specified AWS service principal can use. These include <code>IssueCertificate</code>, <code>GetCertificate</code>, and <code>ListPermissions</code>.</p>",
|
||||
"Permission$Actions": "<p>The private CA actions that can be performed by the designated AWS service.</p>"
|
||||
}
|
||||
},
|
||||
"ActionType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ActionList$member": null
|
||||
}
|
||||
},
|
||||
"Arn": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CertificateAuthority$Arn": "<p>Amazon Resource Name (ARN) for your private certificate authority (CA). The format is <code> <i>12345678-1234-1234-1234-123456789012</i> </code>.</p>",
|
||||
"CreateCertificateAuthorityAuditReportRequest$CertificateAuthorityArn": "<p>Amazon Resource Name (ARN) of the CA to be audited. This is of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>.</p>",
|
||||
"CreateCertificateAuthorityResponse$CertificateAuthorityArn": "<p>If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This is of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
|
||||
"DeleteCertificateAuthorityRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
|
||||
"DescribeCertificateAuthorityAuditReportRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) of the private CA. This must be of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
|
||||
"DescribeCertificateAuthorityRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
|
||||
"GetCertificateAuthorityCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) of your private CA. This is of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
|
||||
"GetCertificateAuthorityCsrRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called the <a>CreateCertificateAuthority</a> function. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
|
||||
"GetCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
|
||||
"GetCertificateRequest$CertificateArn": "<p>The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>/certificate/<i>286535153982981100925020015808220737245</i> </code> </p>",
|
||||
"ImportCertificateAuthorityCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
|
||||
"IssueCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
|
||||
"IssueCertificateResponse$CertificateArn": "<p>The Amazon Resource Name (ARN) of the issued certificate and the certificate serial number. This is of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>/certificate/<i>286535153982981100925020015808220737245</i> </code> </p>",
|
||||
"ListTagsRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called the <a>CreateCertificateAuthority</a> function. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
|
||||
"RevokeCertificateRequest$CertificateAuthorityArn": "<p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
|
||||
"TagCertificateAuthorityRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
|
||||
"UntagCertificateAuthorityRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
|
||||
"UpdateCertificateAuthorityRequest$CertificateAuthorityArn": "<p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:</p> <p> <code>arn:aws:acm:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
|
||||
"CreateCertificateAuthorityAuditReportRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) of the CA to be audited. This is of the form:</p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>.</p>",
|
||||
"CreateCertificateAuthorityResponse$CertificateAuthorityArn": "<p>If successful, the Amazon Resource Name (ARN) of the certificate authority (CA). This is of the form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
|
||||
"CreatePermissionRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) of the CA that grants the permissions. You can find the ARN by calling the <a>ListCertificateAuthorities</a> action. This must have the following form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
|
||||
"DeleteCertificateAuthorityRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must have the following form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
|
||||
"DeletePermissionRequest$CertificateAuthorityArn": "<p>The Amazon Resource Number (ARN) of the private CA that issued the permissions. You can find the CA's ARN by calling the <a>ListCertificateAuthorities</a> action. This must have the following form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
|
||||
"DescribeCertificateAuthorityAuditReportRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) of the private CA. This must be of the form:</p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
|
||||
"DescribeCertificateAuthorityRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
|
||||
"GetCertificateAuthorityCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) of your private CA. This is of the form:</p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
|
||||
"GetCertificateAuthorityCsrRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called the <a>CreateCertificateAuthority</a> action. This must be of the form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
|
||||
"GetCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code>. </p>",
|
||||
"GetCertificateRequest$CertificateArn": "<p>The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>/certificate/<i>286535153982981100925020015808220737245</i> </code> </p>",
|
||||
"ImportCertificateAuthorityCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
|
||||
"IssueCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form:</p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
|
||||
"IssueCertificateRequest$TemplateArn": "<p>Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the <code>EndEntityCertificate/V1</code> template.</p> <p>The following service-owned <code>TemplateArn</code> values are supported by ACM Private CA: </p> <ul> <li> <p>arn:aws:acm-pca:::template/EndEntityCertificate/V1</p> </li> <li> <p>arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen0/V1</p> </li> <li> <p>arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen1/V1</p> </li> <li> <p>arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen2/V1</p> </li> <li> <p>arn:aws:acm-pca:::template/SubordinateCACertificate_PathLen3/V1</p> </li> <li> <p>arn:aws:acm-pca:::template/RootCACertificate/V1</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/UsingTemplates.html\">Using Templates</a>.</p>",
|
||||
"IssueCertificateResponse$CertificateArn": "<p>The Amazon Resource Name (ARN) of the issued certificate and the certificate serial number. This is of the form:</p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i>/certificate/<i>286535153982981100925020015808220737245</i> </code> </p>",
|
||||
"ListPermissionsRequest$CertificateAuthorityArn": "<p>The Amazon Resource Number (ARN) of the private CA to inspect. You can find the ARN by calling the <a>ListCertificateAuthorities</a> action. This must be of the form: <code>arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012</code> You can get a private CA's ARN by running the <a>ListCertificateAuthorities</a> action.</p>",
|
||||
"ListTagsRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called the <a>CreateCertificateAuthority</a> action. This must be of the form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
|
||||
"Permission$CertificateAuthorityArn": "<p>The Amazon Resource Number (ARN) of the private CA from which the permission was issued.</p>",
|
||||
"RestoreCertificateAuthorityRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called the <a>CreateCertificateAuthority</a> action. This must be of the form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
|
||||
"RevokeCertificateRequest$CertificateAuthorityArn": "<p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:</p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
|
||||
"TagCertificateAuthorityRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
|
||||
"UntagCertificateAuthorityRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) that was returned when you called <a>CreateCertificateAuthority</a>. This must be of the form: </p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>",
|
||||
"UpdateCertificateAuthorityRequest$CertificateAuthorityArn": "<p>Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:</p> <p> <code>arn:aws:acm-pca:<i>region</i>:<i>account</i>:certificate-authority/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
|
||||
}
|
||||
},
|
||||
"AuditReportId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateCertificateAuthorityAuditReportResponse$AuditReportId": "<p>An alphanumeric string that contains a report identifier.</p>",
|
||||
"DescribeCertificateAuthorityAuditReportRequest$AuditReportId": "<p>The report ID returned by calling the <a>CreateCertificateAuthorityAuditReport</a> function.</p>"
|
||||
"DescribeCertificateAuthorityAuditReportRequest$AuditReportId": "<p>The report ID returned by calling the <a>CreateCertificateAuthorityAuditReport</a> action.</p>"
|
||||
}
|
||||
},
|
||||
"AuditReportResponseFormat": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateCertificateAuthorityAuditReportRequest$AuditReportResponseFormat": "<p>Format in which to create the report. This can be either <b>JSON</b> or <b>CSV</b>.</p>"
|
||||
"CreateCertificateAuthorityAuditReportRequest$AuditReportResponseFormat": "<p>The format in which to create the report. This can be either <b>JSON</b> or <b>CSV</b>.</p>"
|
||||
}
|
||||
},
|
||||
"AuditReportStatus": {
|
||||
@@ -71,7 +101,7 @@
|
||||
"Boolean": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CrlConfiguration$Enabled": "<p>Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the <a>CreateCertificateAuthority</a> function or for an existing CA when you call the <a>UpdateCertificateAuthority</a> function. </p>"
|
||||
"CrlConfiguration$Enabled": "<p>Boolean value that specifies whether certificate revocation lists (CRLs) are enabled. You can use this value to enable certificate revocation for a new CA when you call the <a>CreateCertificateAuthority</a> action or for an existing CA when you call the <a>UpdateCertificateAuthority</a> action. </p>"
|
||||
}
|
||||
},
|
||||
"CertificateAuthorities": {
|
||||
@@ -81,14 +111,14 @@
|
||||
}
|
||||
},
|
||||
"CertificateAuthority": {
|
||||
"base": "<p>Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate <b>Subject</b> field owns or controls the public key contained in the <b>Subject Public Key Info</b> field. Call the <a>CreateCertificateAuthority</a> function to create your private CA. You must then call the <a>GetCertificateAuthorityCertificate</a> function to retrieve a private CA certificate signing request (CSR). Take the CSR to your on-premises CA and sign it with the root CA certificate or a subordinate certificate. Call the <a>ImportCertificateAuthorityCertificate</a> function to import the signed certificate into AWS Certificate Manager (ACM). </p>",
|
||||
"base": "<p>Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate <b>Subject</b> field owns or controls the public key contained in the <b>Subject Public Key Info</b> field. Call the <a>CreateCertificateAuthority</a> action to create your private CA. You must then call the <a>GetCertificateAuthorityCertificate</a> action to retrieve a private CA certificate signing request (CSR). Sign the CSR with your ACM Private CA-hosted or on-premises root or subordinate CA certificate. Call the <a>ImportCertificateAuthorityCertificate</a> action to import the signed certificate into AWS Certificate Manager (ACM). </p>",
|
||||
"refs": {
|
||||
"CertificateAuthorities$member": null,
|
||||
"DescribeCertificateAuthorityResponse$CertificateAuthority": "<p>A <a>CertificateAuthority</a> structure that contains information about your private CA.</p>"
|
||||
}
|
||||
},
|
||||
"CertificateAuthorityConfiguration": {
|
||||
"base": "<p>Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate, the signature algorithm it uses used when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the <a>CreateCertificateAuthority</a> function. </p>",
|
||||
"base": "<p>Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate. It also includes the signature algorithm that it uses when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the <a>CreateCertificateAuthority</a> action. </p>",
|
||||
"refs": {
|
||||
"CertificateAuthority$CertificateAuthorityConfiguration": "<p>Your private CA configuration.</p>",
|
||||
"CreateCertificateAuthorityRequest$CertificateAuthorityConfiguration": "<p>Name and bit size of the private key algorithm, the name of the signing algorithm, and X.500 certificate subject information.</p>"
|
||||
@@ -105,7 +135,7 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CertificateAuthority$Type": "<p>Type of your private CA.</p>",
|
||||
"CreateCertificateAuthorityRequest$CertificateAuthorityType": "<p>The type of the certificate authority. Currently, this must be <b>SUBORDINATE</b>.</p>"
|
||||
"CreateCertificateAuthorityRequest$CertificateAuthorityType": "<p>The type of the certificate authority.</p>"
|
||||
}
|
||||
},
|
||||
"CertificateBody": {
|
||||
@@ -118,20 +148,20 @@
|
||||
"CertificateBodyBlob": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ImportCertificateAuthorityCertificateRequest$Certificate": "<p>The PEM-encoded certificate for your private CA. This must be signed by using your on-premises CA.</p>"
|
||||
"ImportCertificateAuthorityCertificateRequest$Certificate": "<p>The PEM-encoded certificate for a private CA. This may be a self-signed certificate in the case of a root CA, or it may be signed by another CA that you control.</p>"
|
||||
}
|
||||
},
|
||||
"CertificateChain": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetCertificateAuthorityCertificateResponse$CertificateChain": "<p>Base64-encoded certificate chain that includes any intermediate certificates and chains up to root on-premises certificate that you used to sign your private CA certificate. The chain does not include your private CA certificate. </p>",
|
||||
"GetCertificateAuthorityCertificateResponse$CertificateChain": "<p>Base64-encoded certificate chain that includes any intermediate certificates and chains up to root on-premises certificate that you used to sign your private CA certificate. The chain does not include your private CA certificate. If this is a root CA, the value will be null.</p>",
|
||||
"GetCertificateResponse$CertificateChain": "<p>The base64 PEM-encoded certificate chain that chains up to the on-premises root CA certificate that you used to sign your private CA certificate. </p>"
|
||||
}
|
||||
},
|
||||
"CertificateChainBlob": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ImportCertificateAuthorityCertificateRequest$CertificateChain": "<p>A PEM-encoded file that contains all of your certificates, other than the certificate you're importing, chaining up to your root CA. Your on-premises root certificate is the last in the chain, and each certificate in the chain signs the one preceding. </p>"
|
||||
"ImportCertificateAuthorityCertificateRequest$CertificateChain": "<p>A PEM-encoded file that contains all of your certificates, other than the certificate you're importing, chaining up to your root CA. Your ACM Private CA-hosted or on-premises root certificate is the last in the chain, and each certificate in the chain signs the one preceding. </p> <p>This parameter must be supplied when you import a subordinate CA. When you import a root CA, there is no chain.</p>"
|
||||
}
|
||||
},
|
||||
"CertificateMismatchException": {
|
||||
@@ -147,7 +177,7 @@
|
||||
"CountryCodeString": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ASN1Subject$Country": "<p>Two digit code that specifies the country in which the certificate subject located.</p>"
|
||||
"ASN1Subject$Country": "<p>Two-digit code that specifies the country in which the certificate subject located.</p>"
|
||||
}
|
||||
},
|
||||
"CreateCertificateAuthorityAuditReportRequest": {
|
||||
@@ -170,8 +200,13 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreatePermissionRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CrlConfiguration": {
|
||||
"base": "<p>Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the <b>Enabled</b> parameter to <code>true</code>. Your private CA writes CRLs to an S3 bucket that you specify in the <b>S3BucketName</b> parameter. You can hide the name of your bucket by specifying a value for the <b>CustomCname</b> parameter. Your private CA copies the CNAME or the S3 bucket name to the <b>CRL Distribution Points</b> extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM PCA. </p> <p>Your private CA uses the value in the <b>ExpirationInDays</b> parameter to calculate the <b>nextUpdate</b> field in the CRL. The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked. When a certificate is revoked, it is recorded in the next CRL that is generated and in the next audit report. Only time valid certificates are listed in the CRL. Expired certificates are not included. </p> <p>CRLs contain the following fields:</p> <ul> <li> <p> <b>Version</b>: The current version number defined in RFC 5280 is V2. The integer value is 0x1. </p> </li> <li> <p> <b>Signature Algorithm</b>: The name of the algorithm used to sign the CRL.</p> </li> <li> <p> <b>Issuer</b>: The X.500 distinguished name of your private CA that issued the CRL.</p> </li> <li> <p> <b>Last Update</b>: The issue date and time of this CRL.</p> </li> <li> <p> <b>Next Update</b>: The day and time by which the next CRL will be issued.</p> </li> <li> <p> <b>Revoked Certificates</b>: List of revoked certificates. Each list item contains the following information.</p> <ul> <li> <p> <b>Serial Number</b>: The serial number, in hexadecimal format, of the revoked certificate.</p> </li> <li> <p> <b>Revocation Date</b>: Date and time the certificate was revoked.</p> </li> <li> <p> <b>CRL Entry Extensions</b>: Optional extensions for the CRL entry.</p> <ul> <li> <p> <b>X509v3 CRL Reason Code</b>: Reason the certificate was revoked.</p> </li> </ul> </li> </ul> </li> <li> <p> <b>CRL Extensions</b>: Optional extensions for the CRL.</p> <ul> <li> <p> <b>X509v3 Authority Key Identifier</b>: Identifies the public key associated with the private key used to sign the certificate.</p> </li> <li> <p> <b>X509v3 CRL Number:</b>: Decimal sequence number for the CRL.</p> </li> </ul> </li> <li> <p> <b>Signature Algorithm</b>: Algorithm used by your private CA to sign the CRL.</p> </li> <li> <p> <b>Signature Value</b>: Signature computed over the CRL.</p> </li> </ul> <p>Certificate revocation lists created by ACM PCA are DER-encoded. You can use the following OpenSSL command to list a CRL.</p> <p> <code>openssl crl -inform DER -text -in <i>crl_path</i> -noout</code> </p>",
|
||||
"base": "<p>Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the <b>Enabled</b> parameter to <code>true</code>. Your private CA writes CRLs to an S3 bucket that you specify in the <b>S3BucketName</b> parameter. You can hide the name of your bucket by specifying a value for the <b>CustomCname</b> parameter. Your private CA copies the CNAME or the S3 bucket name to the <b>CRL Distribution Points</b> extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM Private CA. </p> <p>Your private CA uses the value in the <b>ExpirationInDays</b> parameter to calculate the <b>nextUpdate</b> field in the CRL. The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked. When a certificate is revoked, it is recorded in the next CRL that is generated and in the next audit report. Only time valid certificates are listed in the CRL. Expired certificates are not included. </p> <p>CRLs contain the following fields:</p> <ul> <li> <p> <b>Version</b>: The current version number defined in RFC 5280 is V2. The integer value is 0x1. </p> </li> <li> <p> <b>Signature Algorithm</b>: The name of the algorithm used to sign the CRL.</p> </li> <li> <p> <b>Issuer</b>: The X.500 distinguished name of your private CA that issued the CRL.</p> </li> <li> <p> <b>Last Update</b>: The issue date and time of this CRL.</p> </li> <li> <p> <b>Next Update</b>: The day and time by which the next CRL will be issued.</p> </li> <li> <p> <b>Revoked Certificates</b>: List of revoked certificates. Each list item contains the following information.</p> <ul> <li> <p> <b>Serial Number</b>: The serial number, in hexadecimal format, of the revoked certificate.</p> </li> <li> <p> <b>Revocation Date</b>: Date and time the certificate was revoked.</p> </li> <li> <p> <b>CRL Entry Extensions</b>: Optional extensions for the CRL entry.</p> <ul> <li> <p> <b>X509v3 CRL Reason Code</b>: Reason the certificate was revoked.</p> </li> </ul> </li> </ul> </li> <li> <p> <b>CRL Extensions</b>: Optional extensions for the CRL.</p> <ul> <li> <p> <b>X509v3 Authority Key Identifier</b>: Identifies the public key associated with the private key used to sign the certificate.</p> </li> <li> <p> <b>X509v3 CRL Number:</b>: Decimal sequence number for the CRL.</p> </li> </ul> </li> <li> <p> <b>Signature Algorithm</b>: Algorithm used by your private CA to sign the CRL.</p> </li> <li> <p> <b>Signature Value</b>: Signature computed over the CRL.</p> </li> </ul> <p>Certificate revocation lists created by ACM Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.</p> <p> <code>openssl crl -inform DER -text -in <i>crl_path</i> -noout</code> </p>",
|
||||
"refs": {
|
||||
"RevocationConfiguration$CrlConfiguration": "<p>Configuration of the certificate revocation list (CRL), if any, maintained by your private CA.</p>"
|
||||
}
|
||||
@@ -193,6 +228,11 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeletePermissionRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeCertificateAuthorityAuditReportRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -258,8 +298,8 @@
|
||||
"IdempotencyToken": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateCertificateAuthorityRequest$IdempotencyToken": "<p>Alphanumeric string that can be used to distinguish between calls to <b>CreateCertificateAuthority</b>. Idempotency tokens time out after five minutes. Therefore, if you call <b>CreateCertificateAuthority</b> multiple times with the same idempotency token within a five minute period, ACM PCA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, however, ACM PCA recognizes that you are requesting multiple certificates.</p>",
|
||||
"IssueCertificateRequest$IdempotencyToken": "<p>Custom string that can be used to distinguish between calls to the <b>IssueCertificate</b> function. Idempotency tokens time out after one hour. Therefore, if you call <b>IssueCertificate</b> multiple times with the same idempotency token within 5 minutes, ACM PCA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.</p>"
|
||||
"CreateCertificateAuthorityRequest$IdempotencyToken": "<p>Alphanumeric string that can be used to distinguish between calls to <b>CreateCertificateAuthority</b>. Idempotency tokens time out after five minutes. Therefore, if you call <b>CreateCertificateAuthority</b> multiple times with the same idempotency token within a five minute period, ACM Private CA recognizes that you are requesting only one certificate. As a result, ACM Private CA issues only one. If you change the idempotency token for each call, however, ACM Private CA recognizes that you are requesting multiple certificates.</p>",
|
||||
"IssueCertificateRequest$IdempotencyToken": "<p>Custom string that can be used to distinguish between calls to the <b>IssueCertificate</b> action. Idempotency tokens time out after one hour. Therefore, if you call <b>IssueCertificate</b> multiple times with the same idempotency token within 5 minutes, ACM Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.</p>"
|
||||
}
|
||||
},
|
||||
"ImportCertificateAuthorityCertificateRequest": {
|
||||
@@ -289,12 +329,17 @@
|
||||
}
|
||||
},
|
||||
"InvalidPolicyException": {
|
||||
"base": "<p>The S3 bucket policy is not valid. The policy must give ACM PCA rights to read from and write to the bucket and find the bucket location.</p>",
|
||||
"base": "<p>The S3 bucket policy is not valid. The policy must give ACM Private CA rights to read from and write to the bucket and find the bucket location.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidRequestException": {
|
||||
"base": "<p>The request action cannot be performed or is prohibited.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidStateException": {
|
||||
"base": "<p>The private CA is in a state during which a report cannot be generated.</p>",
|
||||
"base": "<p>The private CA is in a state during which a report or certificate cannot be generated.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -316,11 +361,11 @@
|
||||
"KeyAlgorithm": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CertificateAuthorityConfiguration$KeyAlgorithm": "<p>Type of the public key algorithm and size, in bits, of the key pair that your key pair creates when it issues a certificate.</p>"
|
||||
"CertificateAuthorityConfiguration$KeyAlgorithm": "<p>Type of the public key algorithm and size, in bits, of the key pair that your CA creates when it issues a certificate. When you create a subordinate CA, you must use a key algorithm supported by the parent CA.</p>"
|
||||
}
|
||||
},
|
||||
"LimitExceededException": {
|
||||
"base": "<p>An ACM PCA limit has been exceeded. See the exception message returned to determine the limit that was exceeded.</p>",
|
||||
"base": "<p>An ACM Private CA limit has been exceeded. See the exception message returned to determine the limit that was exceeded.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -334,6 +379,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListPermissionsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListPermissionsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListTagsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -358,6 +413,7 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListCertificateAuthoritiesRequest$MaxResults": "<p>Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the <code>NextToken</code> element is sent in the response. Use this <code>NextToken</code> value in a subsequent request to retrieve additional items.</p>",
|
||||
"ListPermissionsRequest$MaxResults": "<p>When paginating results, use this parameter to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the <b>NextToken</b> element is sent in the response. Use this <b>NextToken</b> value in a subsequent request to retrieve additional items.</p>",
|
||||
"ListTagsRequest$MaxResults": "<p>Use this parameter when paginating results to specify the maximum number of items to return in the response. If additional items exist beyond the number you specify, the <b>NextToken</b> element is sent in the response. Use this <b>NextToken</b> value in a subsequent request to retrieve additional items.</p>"
|
||||
}
|
||||
},
|
||||
@@ -366,16 +422,48 @@
|
||||
"refs": {
|
||||
"ListCertificateAuthoritiesRequest$NextToken": "<p>Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the <code>NextToken</code> parameter from the response you just received.</p>",
|
||||
"ListCertificateAuthoritiesResponse$NextToken": "<p>When the list is truncated, this value is present and should be used for the <code>NextToken</code> parameter in a subsequent pagination request.</p>",
|
||||
"ListPermissionsRequest$NextToken": "<p>When paginating results, use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <b>NextToken</b> from the response you just received.</p>",
|
||||
"ListPermissionsResponse$NextToken": "<p>When the list is truncated, this value is present and should be used for the <b>NextToken</b> parameter in a subsequent pagination request. </p>",
|
||||
"ListTagsRequest$NextToken": "<p>Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of <b>NextToken</b> from the response you just received.</p>",
|
||||
"ListTagsResponse$NextToken": "<p>When the list is truncated, this value is present and should be used for the <b>NextToken</b> parameter in a subsequent pagination request. </p>"
|
||||
}
|
||||
},
|
||||
"PermanentDeletionTimeInDays": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DeleteCertificateAuthorityRequest$PermanentDeletionTimeInDays": "<p>The number of days to make a CA restorable after it has been deleted. This can be anywhere from 7 to 30 days, with 30 being the default.</p>"
|
||||
}
|
||||
},
|
||||
"Permission": {
|
||||
"base": "<p>Permissions designate which private CA actions can be performed by an AWS service or entity. In order for ACM to automatically renew private certificates, you must give the ACM service principal all available permissions (<code>IssueCertificate</code>, <code>GetCertificate</code>, and <code>ListPermissions</code>). Permissions can be assigned with the <a>CreatePermission</a> action, removed with the <a>DeletePermission</a> action, and listed with the <a>ListPermissions</a> action.</p>",
|
||||
"refs": {
|
||||
"PermissionList$member": null
|
||||
}
|
||||
},
|
||||
"PermissionAlreadyExistsException": {
|
||||
"base": "<p>The designated permission has already been given to the user.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"PermissionList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListPermissionsResponse$Permissions": "<p>Summary information about each permission assigned by the specified private CA, including the action enabled, the policy provided, and the time of creation.</p>"
|
||||
}
|
||||
},
|
||||
"PositiveLong": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Validity$Value": "<p>Time period.</p>"
|
||||
}
|
||||
},
|
||||
"Principal": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreatePermissionRequest$Principal": "<p>The AWS service or identity that receives the permission. At this time, the only valid principal is <code>acm.amazonaws.com</code>.</p>",
|
||||
"DeletePermissionRequest$Principal": "<p>The AWS service or identity that will have its CA permissions revoked. At this time, the only valid service principal is <code>acm.amazonaws.com</code> </p>"
|
||||
}
|
||||
},
|
||||
"RequestAlreadyProcessedException": {
|
||||
"base": "<p>Your request has already been completed.</p>",
|
||||
"refs": {
|
||||
@@ -396,11 +484,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"RestoreCertificateAuthorityRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"RevocationConfiguration": {
|
||||
"base": "<p>Certificate revocation information used by the <a>CreateCertificateAuthority</a> and <a>UpdateCertificateAuthority</a> functions. Your private certificate authority (CA) can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates revoked by your CA. For more information, see <a>RevokeCertificate</a>.</p>",
|
||||
"base": "<p>Certificate revocation information used by the <a>CreateCertificateAuthority</a> and <a>UpdateCertificateAuthority</a> actions. Your private certificate authority (CA) can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates revoked by your CA. For more information, see <a>RevokeCertificate</a>.</p>",
|
||||
"refs": {
|
||||
"CertificateAuthority$RevocationConfiguration": "<p>Information about the certificate revocation list (CRL) created and maintained by your private CA. </p>",
|
||||
"CreateCertificateAuthorityRequest$RevocationConfiguration": "<p>Contains a Boolean value that you can use to enable a certification revocation list (CRL) for the CA, the name of the S3 bucket to which ACM PCA will write the CRL, and an optional CNAME alias that you can use to hide the name of your bucket in the <b>CRL Distribution Points</b> extension of your CA certificate. For more information, see the <a>CrlConfiguration</a> structure. </p>",
|
||||
"CreateCertificateAuthorityRequest$RevocationConfiguration": "<p>Contains a Boolean value that you can use to enable a certification revocation list (CRL) for the CA, the name of the S3 bucket to which ACM Private CA will write the CRL, and an optional CNAME alias that you can use to hide the name of your bucket in the <b>CRL Distribution Points</b> extension of your CA certificate. For more information, see the <a>CrlConfiguration</a> structure. </p>",
|
||||
"UpdateCertificateAuthorityRequest$RevocationConfiguration": "<p>Revocation information for your private CA.</p>"
|
||||
}
|
||||
},
|
||||
@@ -428,7 +521,7 @@
|
||||
"CertificateAuthority$Serial": "<p>Serial number of your private CA.</p>",
|
||||
"CertificateMismatchException$message": null,
|
||||
"ConcurrentModificationException$message": null,
|
||||
"CreateCertificateAuthorityAuditReportRequest$S3BucketName": "<p>Name of the S3 bucket that will contain the audit report.</p>",
|
||||
"CreateCertificateAuthorityAuditReportRequest$S3BucketName": "<p>The name of the S3 bucket that will contain the audit report.</p>",
|
||||
"CreateCertificateAuthorityAuditReportResponse$S3Key": "<p>The <b>key</b> that uniquely identifies the report file in your S3 bucket.</p>",
|
||||
"DescribeCertificateAuthorityAuditReportResponse$S3BucketName": "<p>Name of the S3 bucket that contains the report.</p>",
|
||||
"DescribeCertificateAuthorityAuditReportResponse$S3Key": "<p>S3 <b>key</b> that uniquely identifies the report file in your S3 bucket.</p>",
|
||||
@@ -436,11 +529,16 @@
|
||||
"InvalidArnException$message": null,
|
||||
"InvalidNextTokenException$message": null,
|
||||
"InvalidPolicyException$message": null,
|
||||
"InvalidRequestException$message": null,
|
||||
"InvalidStateException$message": null,
|
||||
"InvalidTagException$message": null,
|
||||
"LimitExceededException$message": null,
|
||||
"MalformedCSRException$message": null,
|
||||
"MalformedCertificateException$message": null,
|
||||
"Permission$Principal": "<p>The AWS service or entity that holds the permission. At this time, the only valid principal is <code>acm.amazonaws.com</code>.</p>",
|
||||
"Permission$SourceAccount": "<p>The ID of the account that assigned the permission.</p>",
|
||||
"Permission$Policy": "<p>The name of the policy that is associated with the permission.</p>",
|
||||
"PermissionAlreadyExistsException$message": null,
|
||||
"RequestAlreadyProcessedException$message": null,
|
||||
"RequestFailedException$message": null,
|
||||
"RequestInProgressException$message": null,
|
||||
@@ -454,7 +552,7 @@
|
||||
"ASN1Subject$State": "<p>State in which the subject of the certificate is located.</p>",
|
||||
"ASN1Subject$Locality": "<p>The locality (such as a city or town) in which the certificate subject is located.</p>",
|
||||
"ASN1Subject$Pseudonym": "<p>Typically a shortened version of a longer <b>GivenName</b>. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.</p>",
|
||||
"RevokeCertificateRequest$CertificateSerial": "<p>Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling <a>GetCertificate</a> with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The <b>GetCertificate</b> function retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number. </p> <p> <code>openssl x509 -in <i>file_path</i> -text -noout</code> </p> <p>You can also copy the serial number from the console or use the <a href=\"http://docs.aws.amazon.comacm/latest/APIReferenceAPI_DescribeCertificate.html\">DescribeCertificate</a> function in the <i>AWS Certificate Manager API Reference</i>. </p>"
|
||||
"RevokeCertificateRequest$CertificateSerial": "<p>Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling <a>GetCertificate</a> with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The <b>GetCertificate</b> action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number. </p> <p> <code>openssl x509 -in <i>file_path</i> -text -noout</code> </p> <p>You can also copy the serial number from the console or use the <a href=\"https://docs.aws.amazon.com/acm/latest/APIReference/API_DescribeCertificate.html\">DescribeCertificate</a> action in the <i>AWS Certificate Manager API Reference</i>. </p>"
|
||||
}
|
||||
},
|
||||
"String16": {
|
||||
@@ -478,13 +576,13 @@
|
||||
"String3To255": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CrlConfiguration$S3BucketName": "<p>Name of the S3 bucket that contains the CRL. If you do not provide a value for the <b>CustomCname</b> argument, the name of your S3 bucket is placed into the <b>CRL Distribution Points</b> extension of the issued certificate. You can change the name of your bucket by calling the <a>UpdateCertificateAuthority</a> function. You must specify a bucket policy that allows ACM PCA to write the CRL to your bucket.</p>"
|
||||
"CrlConfiguration$S3BucketName": "<p>Name of the S3 bucket that contains the CRL. If you do not provide a value for the <b>CustomCname</b> argument, the name of your S3 bucket is placed into the <b>CRL Distribution Points</b> extension of the issued certificate. You can change the name of your bucket by calling the <a>UpdateCertificateAuthority</a> action. You must specify a bucket policy that allows ACM Private CA to write the CRL to your bucket.</p>"
|
||||
}
|
||||
},
|
||||
"String40": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ASN1Subject$Surname": "<p>Family name. In the US and the UK for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.</p>"
|
||||
"ASN1Subject$Surname": "<p>Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.</p>"
|
||||
}
|
||||
},
|
||||
"String5": {
|
||||
@@ -500,7 +598,7 @@
|
||||
"ASN1Subject$OrganizationalUnit": "<p>A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.</p>",
|
||||
"ASN1Subject$CommonName": "<p>Fully qualified domain name (FQDN) associated with the certificate subject.</p>",
|
||||
"ASN1Subject$SerialNumber": "<p>The certificate serial number.</p>",
|
||||
"ASN1Subject$Title": "<p>A title such as Mr. or Ms. which is pre-pended to the name to refer formally to the certificate subject.</p>"
|
||||
"ASN1Subject$Title": "<p>A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.</p>"
|
||||
}
|
||||
},
|
||||
"TStamp": {
|
||||
@@ -510,11 +608,13 @@
|
||||
"CertificateAuthority$LastStateChangeAt": "<p>Date and time at which your private CA was last updated.</p>",
|
||||
"CertificateAuthority$NotBefore": "<p>Date and time before which your private CA certificate is not valid.</p>",
|
||||
"CertificateAuthority$NotAfter": "<p>Date and time after which your private CA certificate is not valid.</p>",
|
||||
"DescribeCertificateAuthorityAuditReportResponse$CreatedAt": "<p>The date and time at which the report was created.</p>"
|
||||
"CertificateAuthority$RestorableUntil": "<p>The period during which a deleted CA can be restored. For more information, see the <code>PermanentDeletionTimeInDays</code> parameter of the <a>DeleteCertificateAuthorityRequest</a> action. </p>",
|
||||
"DescribeCertificateAuthorityAuditReportResponse$CreatedAt": "<p>The date and time at which the report was created.</p>",
|
||||
"Permission$CreatedAt": "<p>The time at which the permission was created.</p>"
|
||||
}
|
||||
},
|
||||
"Tag": {
|
||||
"base": "<p>Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the <a>TagCertificateAuthority</a> function. To remove a tag, call the <a>UntagCertificateAuthority</a> function. </p>",
|
||||
"base": "<p>Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the <a>TagCertificateAuthority</a> action. To remove a tag, call the <a>UntagCertificateAuthority</a> action. </p>",
|
||||
"refs": {
|
||||
"TagList$member": null
|
||||
}
|
||||
@@ -533,6 +633,7 @@
|
||||
"TagList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateCertificateAuthorityRequest$Tags": "<p>Key-value pairs that will be attached to the new private CA. You can associate up to 50 tags with a private CA. For information using tags with </p> <p>IAM to manage permissions, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html\">Controlling Access Using IAM Tags</a>.</p>",
|
||||
"ListTagsResponse$Tags": "<p>The tags associated with your private CA.</p>",
|
||||
"TagCertificateAuthorityRequest$Tags": "<p>List of tags to be associated with the CA.</p>",
|
||||
"UntagCertificateAuthorityRequest$Tags": "<p>List of tags to be removed from the CA.</p>"
|
||||
@@ -560,7 +661,7 @@
|
||||
}
|
||||
},
|
||||
"Validity": {
|
||||
"base": "<p>Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years. You can issue a certificate by calling the <a>IssueCertificate</a> function.</p>",
|
||||
"base": "<p>Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years. You can issue a certificate by calling the <a>IssueCertificate</a> action.</p>",
|
||||
"refs": {
|
||||
"IssueCertificateRequest$Validity": "<p>The type of the validity period.</p>"
|
||||
}
|
||||
|
||||
Generated
Vendored
+19
-1
@@ -1,4 +1,22 @@
|
||||
{
|
||||
"pagination": {
|
||||
"ListCertificateAuthorities": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "CertificateAuthorities"
|
||||
},
|
||||
"ListPermissions": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "Permissions"
|
||||
},
|
||||
"ListTags": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "Tags"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+61
@@ -0,0 +1,61 @@
|
||||
{
|
||||
"version": 2,
|
||||
"waiters": {
|
||||
"CertificateAuthorityCSRCreated": {
|
||||
"description": "Wait until a Certificate Authority CSR is created",
|
||||
"operation": "GetCertificateAuthorityCsr",
|
||||
"delay": 3,
|
||||
"maxAttempts": 60,
|
||||
"acceptors": [
|
||||
{
|
||||
"state": "success",
|
||||
"matcher": "status",
|
||||
"expected": 200
|
||||
},
|
||||
{
|
||||
"state": "retry",
|
||||
"matcher": "error",
|
||||
"expected": "RequestInProgressException"
|
||||
}
|
||||
]
|
||||
},
|
||||
"CertificateIssued": {
|
||||
"description": "Wait until a certificate is issued",
|
||||
"operation": "GetCertificate",
|
||||
"delay": 3,
|
||||
"maxAttempts": 60,
|
||||
"acceptors": [
|
||||
{
|
||||
"state": "success",
|
||||
"matcher": "status",
|
||||
"expected": 200
|
||||
},
|
||||
{
|
||||
"state": "retry",
|
||||
"matcher": "error",
|
||||
"expected": "RequestInProgressException"
|
||||
}
|
||||
]
|
||||
},
|
||||
"AuditReportCreated": {
|
||||
"description": "Wait until a Audit Report is created",
|
||||
"operation": "DescribeCertificateAuthorityAuditReport",
|
||||
"delay": 3,
|
||||
"maxAttempts": 60,
|
||||
"acceptors": [
|
||||
{
|
||||
"state": "success",
|
||||
"matcher": "path",
|
||||
"argument": "AuditReportStatus",
|
||||
"expected": "SUCCESS"
|
||||
},
|
||||
{
|
||||
"state": "failure",
|
||||
"matcher": "path",
|
||||
"argument": "AuditReportStatus",
|
||||
"expected": "FAILED"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
+38
-3
@@ -101,7 +101,10 @@
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListCertificatesRequest"},
|
||||
"output":{"shape":"ListCertificatesResponse"}
|
||||
"output":{"shape":"ListCertificatesResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidArgsException"}
|
||||
]
|
||||
},
|
||||
"ListTagsForCertificate":{
|
||||
"name":"ListTagsForCertificate",
|
||||
@@ -129,6 +132,18 @@
|
||||
{"shape":"InvalidTagException"}
|
||||
]
|
||||
},
|
||||
"RenewCertificate":{
|
||||
"name":"RenewCertificate",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"RenewCertificateRequest"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidArnException"}
|
||||
]
|
||||
},
|
||||
"RequestCertificate":{
|
||||
"name":"RequestCertificate",
|
||||
"http":{
|
||||
@@ -424,6 +439,7 @@
|
||||
"ADDITIONAL_VERIFICATION_REQUIRED",
|
||||
"DOMAIN_NOT_ALLOWED",
|
||||
"INVALID_PUBLIC_DOMAIN",
|
||||
"DOMAIN_VALIDATION_DENIED",
|
||||
"CAA_ERROR",
|
||||
"PCA_LIMIT_EXCEEDED",
|
||||
"PCA_INVALID_ARN",
|
||||
@@ -431,6 +447,8 @@
|
||||
"PCA_REQUEST_FAILED",
|
||||
"PCA_RESOURCE_NOT_FOUND",
|
||||
"PCA_INVALID_ARGS",
|
||||
"PCA_INVALID_DURATION",
|
||||
"PCA_ACCESS_DENIED",
|
||||
"OTHER"
|
||||
]
|
||||
},
|
||||
@@ -485,6 +503,13 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"InvalidArgsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidArnException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -639,6 +664,13 @@
|
||||
"Tags":{"shape":"TagList"}
|
||||
}
|
||||
},
|
||||
"RenewCertificateRequest":{
|
||||
"type":"structure",
|
||||
"required":["CertificateArn"],
|
||||
"members":{
|
||||
"CertificateArn":{"shape":"Arn"}
|
||||
}
|
||||
},
|
||||
"RenewalEligibility":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
@@ -659,11 +691,14 @@
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"RenewalStatus",
|
||||
"DomainValidationOptions"
|
||||
"DomainValidationOptions",
|
||||
"UpdatedAt"
|
||||
],
|
||||
"members":{
|
||||
"RenewalStatus":{"shape":"RenewalStatus"},
|
||||
"DomainValidationOptions":{"shape":"DomainValidationList"}
|
||||
"DomainValidationOptions":{"shape":"DomainValidationList"},
|
||||
"RenewalStatusReason":{"shape":"FailureReason"},
|
||||
"UpdatedAt":{"shape":"TStamp"}
|
||||
}
|
||||
},
|
||||
"RequestCertificateRequest":{
|
||||
|
||||
+48
-33
@@ -1,19 +1,20 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<fullname>AWS Certificate Manager</fullname> <p>Welcome to the AWS Certificate Manager (ACM) API documentation.</p> <p>You can use ACM to manage SSL/TLS certificates for your AWS-based websites and applications. For general information about using ACM, see the <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/\"> <i>AWS Certificate Manager User Guide</i> </a>.</p>",
|
||||
"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=\"https://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/http:/docs.aws.amazon.comacm/latest/userguide/tags.html\">Tagging ACM certificates</a>. </p> <p>To remove one or more tags, use the <a>RemoveTagsFromCertificate</a> action. To view all of the tags that have been applied to the certificate, use the <a>ListTagsForCertificate</a> action. </p>",
|
||||
"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=\"https://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 a certificate and its associated private key. If this action succeeds, the certificate no longer appears in the list that can be displayed by calling the <a>ListCertificates</a> action or be retrieved by calling the <a>GetCertificate</a> action. The certificate will not be available for use by AWS services integrated with ACM. </p> <note> <p>You cannot delete an ACM certificate that is being used by another AWS service. To delete a certificate that is in use, the certificate association must first be removed.</p> </note>",
|
||||
"DescribeCertificate": "<p>Returns detailed metadata about the specified ACM certificate.</p>",
|
||||
"ExportCertificate": "<p>Exports a certificate for use anywhere. You can export the certificate, the certificate chain, and the encrypted private key associated with the public key embedded in the certificate. You must store the private key securely. The private key is a 2048 bit RSA key. You must provide a passphrase for the private key when exporting it. You can use the following OpenSSL command to decrypt it later. Provide the passphrase when prompted. </p> <p> <code>openssl rsa -in encrypted_key.pem -out decrypted_key.pem</code> </p>",
|
||||
"ExportCertificate": "<p>Exports a private certificate issued by a private certificate authority (CA) for use anywhere. You can export the certificate, the certificate chain, and the encrypted private key associated with the public key embedded in the certificate. You must store the private key securely. The private key is a 2048 bit RSA key. You must provide a passphrase for the private key when exporting it. You can use the following OpenSSL command to decrypt it later. Provide the passphrase when prompted. </p> <p> <code>openssl rsa -in encrypted_key.pem -out decrypted_key.pem</code> </p>",
|
||||
"GetCertificate": "<p>Retrieves a certificate specified by an ARN and its certificate chain . The chain is an ordered list of certificates that contains the end entity certificate, intermediate certificates of subordinate CAs, and the root certificate in that order. The certificate and certificate chain are base64 encoded. If you want to decode the certificate to see the individual fields, you can use OpenSSL.</p>",
|
||||
"ImportCertificate": "<p>Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-services.html\">integrated services</a> allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>. </p> <note> <p>ACM does not provide <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-renewal.html\">managed renewal</a> for certificates that you import.</p> </note> <p>Note the following guidelines when importing third party certificates:</p> <ul> <li> <p>You must enter the private key that matches the certificate you are importing.</p> </li> <li> <p>The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.</p> </li> <li> <p>If the certificate you are importing is not self-signed, you must enter its certificate chain.</p> </li> <li> <p>If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.</p> </li> <li> <p>The certificate, private key, and certificate chain must be PEM-encoded.</p> </li> <li> <p>The current time must be between the <code>Not Before</code> and <code>Not After</code> certificate fields.</p> </li> <li> <p>The <code>Issuer</code> field must not be empty.</p> </li> <li> <p>The OCSP authority URL, if present, must not exceed 1000 characters.</p> </li> <li> <p>To import a new certificate, omit the <code>CertificateArn</code> argument. Include this argument only when you want to replace a previously imported certificate.</p> </li> <li> <p>When you import a certificate by using the CLI or one of the SDKs, you must specify the certificate, the certificate chain, and the private key by their file names preceded by <code>file://</code>. For example, you can specify a certificate saved in the <code>C:\\temp</code> folder as <code>file://C:\\temp\\certificate_to_import.pem</code>. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. </p> </li> </ul> <p>This operation returns the <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>",
|
||||
"ImportCertificate": "<p>Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-services.html\">integrated services</a> allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>. </p> <note> <p>ACM does not provide <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html\">managed renewal</a> for certificates that you import.</p> </note> <p>Note the following guidelines when importing third party certificates:</p> <ul> <li> <p>You must enter the private key that matches the certificate you are importing.</p> </li> <li> <p>The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.</p> </li> <li> <p>If the certificate you are importing is not self-signed, you must enter its certificate chain.</p> </li> <li> <p>If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.</p> </li> <li> <p>The certificate, private key, and certificate chain must be PEM-encoded.</p> </li> <li> <p>The current time must be between the <code>Not Before</code> and <code>Not After</code> certificate fields.</p> </li> <li> <p>The <code>Issuer</code> field must not be empty.</p> </li> <li> <p>The OCSP authority URL, if present, must not exceed 1000 characters.</p> </li> <li> <p>To import a new certificate, omit the <code>CertificateArn</code> argument. Include this argument only when you want to replace a previously imported certificate.</p> </li> <li> <p>When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by <code>file://</code>. For example, you can specify a certificate saved in the <code>C:\\temp</code> folder as <code>file://C:\\temp\\certificate_to_import.pem</code>. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. </p> </li> <li> <p>When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using. </p> </li> </ul> <p>This operation returns the <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>",
|
||||
"ListCertificates": "<p>Retrieves a list of certificate ARNs and domain names. You can request that only certificates that match a specific status be listed. You can also filter by specific attributes of the certificate. </p>",
|
||||
"ListTagsForCertificate": "<p>Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the <a>AddTagsToCertificate</a> action. To delete a tag, use the <a>RemoveTagsFromCertificate</a> action. </p>",
|
||||
"RemoveTagsFromCertificate": "<p>Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. </p> <p>To add tags to a certificate, use the <a>AddTagsToCertificate</a> action. To view all of the tags that have been applied to a specific ACM certificate, use the <a>ListTagsForCertificate</a> action. </p>",
|
||||
"RequestCertificate": "<p>Requests an ACM certificate for use with other AWS services. To request an ACM certificate, you must specify the fully qualified domain name (FQDN) for your site in the <code>DomainName</code> parameter. You can also specify additional FQDNs in the <code>SubjectAlternativeNames</code> parameter. </p> <p>Each domain name that you specify must be validated to verify that you own or control the domain. You can use <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/gs-acm-validate-dns.html\">DNS validation</a> or <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/gs-acm-validate-email.html\">email validation</a>. We recommend that you use DNS validation. </p> <p>If you choose email validation, email is sent to the domain owner to request approval to issue the certificate. Email is sent to three registered contact addresses in the WHOIS database and to five common system administration addresses formed from the <code>DomainName</code> you enter or the optional <code>ValidationDomain</code> parameter. For more information, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/gs-acm-validate-email.html\">Validate with Email</a>. </p> <p>After receiving approval from the domain owner, the ACM certificate is issued.</p>",
|
||||
"ResendValidationEmail": "<p>Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking <b>I Approve</b>. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/setup-email.html\">Configure Email for your Domain</a>. </p>",
|
||||
"UpdateCertificateOptions": "<p>Updates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-bestpractices.html#best-practices-transparency\"> Opting Out of Certificate Transparency Logging</a>. </p>"
|
||||
"RenewCertificate": "<p>Renews an eligable ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your ACM PCA certificates with ACM, you must first <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaPermissions.html\">grant the ACM service principal permission to do so</a>. For more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/manual-renewal.html\">Testing Managed Renewal</a> in the ACM User Guide.</p>",
|
||||
"RequestCertificate": "<p>Requests an ACM certificate for use with other AWS services. To request an ACM certificate, you must specify a fully qualified domain name (FQDN) in the <code>DomainName</code> parameter. You can also specify additional FQDNs in the <code>SubjectAlternativeNames</code> parameter. </p> <p>If you are requesting a private certificate, domain validation is not required. If you are requesting a public certificate, each domain name that you specify must be validated to verify that you own or control the domain. You can use <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html\">DNS validation</a> or <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html\">email validation</a>. We recommend that you use DNS validation. ACM issues public certificates after receiving approval from the domain owner. </p>",
|
||||
"ResendValidationEmail": "<p>Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking <b>I Approve</b>. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/setup-email.html\">Configure Email for your Domain</a>. </p>",
|
||||
"UpdateCertificateOptions": "<p>Updates a certificate. Currently, you can use this function to specify whether to opt in to or out of recording your certificate in a certificate transparency log. For more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency\"> Opting Out of Certificate Transparency Logging</a>. </p>"
|
||||
},
|
||||
"shapes": {
|
||||
"AddTagsToCertificateRequest": {
|
||||
@@ -24,19 +25,20 @@
|
||||
"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>",
|
||||
"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=\"https://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=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>",
|
||||
"CertificateDetail$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) of the ACM PCA private certificate authority (CA) that issued the certificate. This has the following format: </p> <p> <code>arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012</code> </p>",
|
||||
"CertificateSummary$CertificateArn": "<p>Amazon Resource Name (ARN) of the certificate. This is of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </p>",
|
||||
"DeleteCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM certificate to be deleted. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
|
||||
"DescribeCertificateRequest$CertificateArn": "<p>The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
|
||||
"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=\"https://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=\"https://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=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
|
||||
"ExportCertificateRequest$CertificateArn": "<p>An Amazon Resource Name (ARN) of the issued certificate. This must be of the form:</p> <p> <code>arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012</code> </p>",
|
||||
"GetCertificateRequest$CertificateArn": "<p>String that contains a certificate ARN in the following format:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
|
||||
"ImportCertificateRequest$CertificateArn": "<p>The <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of an imported certificate to replace. To import a new certificate, omit this field. </p>",
|
||||
"ImportCertificateResponse$CertificateArn": "<p>The <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>",
|
||||
"ListTagsForCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM certificate for which you want to list the tags. This must have the following form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </p>",
|
||||
"RemoveTagsFromCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM Certificate with one or more tags that you want to remove. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </p>",
|
||||
"RequestCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. For more information about private CAs, see the <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm-pca/latest/userguide/PcaWelcome.html\">AWS Certificate Manager Private Certificate Authority (PCA)</a> user guide. The ARN must have the following form: </p> <p> <code>arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012</code> </p>",
|
||||
"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=\"https://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=\"https://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=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>",
|
||||
"ListTagsForCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM certificate for which you want to list the tags. This must have the following form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"https://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=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </p>",
|
||||
"RenewCertificateRequest$CertificateArn": "<p>String that contains the ARN of the ACM certificate to be renewed. 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=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>",
|
||||
"RequestCertificateRequest$CertificateAuthorityArn": "<p>The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaWelcome.html\">AWS Certificate Manager Private Certificate Authority (PCA)</a> user guide. The ARN must have the following form: </p> <p> <code>arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012</code> </p>",
|
||||
"RequestCertificateResponse$CertificateArn": "<p>String that contains the ARN of the issued certificate. This must be of the form:</p> <p> <code>arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p>",
|
||||
"ResendValidationEmailRequest$CertificateArn": "<p>String that contains the ARN of the requested certificate. The certificate ARN is generated and returned by the <a>RequestCertificate</a> action as soon as the request is made. By default, using this parameter causes email to be sent to all top-level domains you specified in the certificate request. The ARN must be of the form: </p> <p> <code>arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p>",
|
||||
"UpdateCertificateOptionsRequest$CertificateArn": "<p>ARN of the requested certificate to update. This must be of the form:</p> <p> <code>arn:aws:acm:us-east-1:<i>account</i>:certificate/<i>12345678-1234-1234-1234-123456789012</i> </code> </p>"
|
||||
@@ -75,10 +77,10 @@
|
||||
}
|
||||
},
|
||||
"CertificateOptions": {
|
||||
"base": "<p>Structure that contains options for your certificate. Currently, you can use this only to specify whether to opt in to or out of certificate transparency logging. Some browsers require that public certificates issued for your domain be recorded in a log. Certificates that are not logged typically generate a browser error. Transparency makes it possible for you to detect SSL/TLS certificates that have been mistakenly or maliciously issued for your domain. For general information, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-concepts.html#concept-transparency\">Certificate Transparency Logging</a>. </p>",
|
||||
"base": "<p>Structure that contains options for your certificate. Currently, you can use this only to specify whether to opt in to or out of certificate transparency logging. Some browsers require that public certificates issued for your domain be recorded in a log. Certificates that are not logged typically generate a browser error. Transparency makes it possible for you to detect SSL/TLS certificates that have been mistakenly or maliciously issued for your domain. For general information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-concepts.html#concept-transparency\">Certificate Transparency Logging</a>. </p>",
|
||||
"refs": {
|
||||
"CertificateDetail$Options": "<p>Value that specifies whether to add the certificate to a transparency log. Certificate transparency makes it possible to detect SSL certificates that have been mistakenly or maliciously issued. A browser might respond to certificate that has not been logged by showing an error message. The logs are cryptographically secure. </p>",
|
||||
"RequestCertificateRequest$Options": "<p>Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-bestpractices.html#best-practices-transparency\">Opting Out of Certificate Transparency Logging</a>.</p>",
|
||||
"RequestCertificateRequest$Options": "<p>Currently, you can use this parameter to specify whether to add the certificate to a certificate transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. For more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency\">Opting Out of Certificate Transparency Logging</a>.</p>",
|
||||
"UpdateCertificateOptionsRequest$Options": "<p>Use to update the options for your certificate. Currently, you can specify whether to add your certificate to a transparency log. Certificate transparency makes it possible to detect SSL/TLS certificates that have been mistakenly or maliciously issued. Certificates that have not been logged typically produce an error message in a browser. </p>"
|
||||
}
|
||||
},
|
||||
@@ -116,7 +118,7 @@
|
||||
"CertificateType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CertificateDetail$Type": "<p>The source of the certificate. For certificates provided by ACM, this value is <code>AMAZON_ISSUED</code>. For certificates that you imported with <a>ImportCertificate</a>, this value is <code>IMPORTED</code>. ACM does not provide <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-renewal.html\">managed renewal</a> for imported certificates. For more information about the differences between certificates that you import and those that ACM provides, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>. </p>"
|
||||
"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=\"https://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=\"https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>. </p>"
|
||||
}
|
||||
},
|
||||
"DeleteCertificateRequest": {
|
||||
@@ -138,7 +140,7 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CertificateDetail$SubjectAlternativeNames": "<p>One or more domain names (subject alternative names) included in the certificate. This list contains the domain names that are bound to the public key that is contained in the certificate. The subject alternative names include the canonical domain name (CN) of the certificate and additional domain names that can be used to connect to the website. </p>",
|
||||
"RequestCertificateRequest$SubjectAlternativeNames": "<p>Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the <code>DomainName</code> field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial limit is 10 domain names. If you need more than 10 names, you must request a limit increase. For more information, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-limits.html\">Limits</a>.</p> <p> The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples: </p> <ul> <li> <p> <code>(63 octets).(63 octets).(63 octets).(61 octets)</code> is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.</p> </li> <li> <p> <code>(64 octets).(63 octets).(63 octets).(61 octets)</code> is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.</p> </li> <li> <p> <code>(63 octets).(63 octets).(63 octets).(62 octets)</code> is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.</p> </li> </ul>"
|
||||
"RequestCertificateRequest$SubjectAlternativeNames": "<p>Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, add the name www.example.net to a certificate for which the <code>DomainName</code> field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM certificate is 100. However, the initial limit is 10 domain names. If you need more than 10 names, you must request a limit increase. For more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html\">Limits</a>.</p> <p> The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples: </p> <ul> <li> <p> <code>(63 octets).(63 octets).(63 octets).(61 octets)</code> is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.</p> </li> <li> <p> <code>(64 octets).(63 octets).(63 octets).(61 octets)</code> is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.</p> </li> <li> <p> <code>(63 octets).(63 octets).(63 octets).(62 octets)</code> is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"DomainNameString": {
|
||||
@@ -151,7 +153,7 @@
|
||||
"DomainValidation$ValidationDomain": "<p>The domain name that ACM used to send domain validation emails.</p>",
|
||||
"DomainValidationOption$DomainName": "<p>A fully qualified domain name (FQDN) in the certificate request.</p>",
|
||||
"DomainValidationOption$ValidationDomain": "<p>The domain name that you want ACM to use to send you validation emails. This domain name is the suffix of the email addresses that you want ACM to use. This must be the same as the <code>DomainName</code> value or a superdomain of the <code>DomainName</code> value. For example, if you request a certificate for <code>testing.example.com</code>, you can specify <code>example.com</code> for this value. In that case, ACM sends domain validation emails to the following five addresses:</p> <ul> <li> <p>admin@example.com</p> </li> <li> <p>administrator@example.com</p> </li> <li> <p>hostmaster@example.com</p> </li> <li> <p>postmaster@example.com</p> </li> <li> <p>webmaster@example.com</p> </li> </ul>",
|
||||
"RequestCertificateRequest$DomainName": "<p> Fully qualified domain name (FQDN), such as www.example.com, of the site that you want to secure with an ACM Certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com. </p> <p> The first domain name you enter cannot exceed 63 octets, including periods. Each subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length. </p>",
|
||||
"RequestCertificateRequest$DomainName": "<p> Fully qualified domain name (FQDN), such as www.example.com, that you want to secure with an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com. </p> <p> The first domain name you enter cannot exceed 63 octets, including periods. Each subsequent Subject Alternative Name (SAN), however, can be up to 253 octets in length. </p>",
|
||||
"ResendValidationEmailRequest$Domain": "<p>The fully qualified domain name (FQDN) of the certificate that needs to be validated.</p>",
|
||||
"ResendValidationEmailRequest$ValidationDomain": "<p>The base validation domain that will act as the suffix of the email addresses that are used to send the emails. This must be the same as the <code>Domain</code> value or a superdomain of the <code>Domain</code> value. For example, if you requested a certificate for <code>site.subdomain.example.com</code> and specify a <b>ValidationDomain</b> of <code>subdomain.example.com</code>, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS and the following five addresses:</p> <ul> <li> <p>admin@subdomain.example.com</p> </li> <li> <p>administrator@subdomain.example.com</p> </li> <li> <p>hostmaster@subdomain.example.com</p> </li> <li> <p>postmaster@subdomain.example.com</p> </li> <li> <p>webmaster@subdomain.example.com</p> </li> </ul>"
|
||||
}
|
||||
@@ -172,7 +174,7 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CertificateDetail$DomainValidationOptions": "<p>Contains information about the initial validation of each domain name that occurs as a result of the <a>RequestCertificate</a> request. This field exists only when the certificate type is <code>AMAZON_ISSUED</code>. </p>",
|
||||
"RenewalSummary$DomainValidationOptions": "<p>Contains information about the validation of each domain name in the certificate, as it pertains to ACM's <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-renewal.html\">managed renewal</a>. This is different from the initial validation that occurs as a result of the <a>RequestCertificate</a> request. This field exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>"
|
||||
"RenewalSummary$DomainValidationOptions": "<p>Contains information about the validation of each domain name in the certificate, as it pertains to ACM's <a href=\"https://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": {
|
||||
@@ -225,7 +227,8 @@
|
||||
"FailureReason": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CertificateDetail$FailureReason": "<p>The reason the certificate request failed. This value exists only when the certificate status is <code>FAILED</code>. For more information, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/troubleshooting.html#troubleshooting-failed\">Certificate Request Failed</a> in the <i>AWS Certificate Manager User Guide</i>. </p>"
|
||||
"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=\"https://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>",
|
||||
"RenewalSummary$RenewalStatusReason": "<p>The reason that a renewal request was unsuccessful.</p>"
|
||||
}
|
||||
},
|
||||
"Filters": {
|
||||
@@ -266,6 +269,11 @@
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
"InvalidArgsException": {
|
||||
"base": "<p>One or more of of request parameters specified is not valid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InvalidArnException": {
|
||||
"base": "<p>The requested Amazon Resource Name (ARN) does not refer to an existing resource.</p>",
|
||||
"refs": {
|
||||
@@ -371,7 +379,7 @@
|
||||
"PrivateKey": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ExportCertificateResponse$PrivateKey": "<p>The PEM-encoded private key associated with the public key in the certificate.</p>"
|
||||
"ExportCertificateResponse$PrivateKey": "<p>The encrypted private key associated with the public key in the certificate. The key is output in PKCS #8 format and is base64 PEM-encoded. </p>"
|
||||
}
|
||||
},
|
||||
"PrivateKeyBlob": {
|
||||
@@ -391,22 +399,27 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"RenewCertificateRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"RenewalEligibility": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CertificateDetail$RenewalEligibility": "<p>Specifies whether the certificate is eligible for renewal.</p>"
|
||||
"CertificateDetail$RenewalEligibility": "<p>Specifies whether the certificate is eligible for renewal. At this time, only exported private certificates can be renewed with the <a>RenewCertificate</a> command.</p>"
|
||||
}
|
||||
},
|
||||
"RenewalStatus": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"RenewalSummary$RenewalStatus": "<p>The status of ACM's <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/acm-renewal.html\">managed renewal</a> of the certificate.</p>"
|
||||
"RenewalSummary$RenewalStatus": "<p>The status of ACM's <a href=\"https://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/http:/docs.aws.amazon.comacm/latest/userguide/acm-renewal.html\">managed renewal</a> for the certificate. This structure exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>",
|
||||
"base": "<p>Contains information about the status of ACM's <a href=\"https://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/http:/docs.aws.amazon.comacm/latest/userguide/acm-renewal.html\">managed renewal</a> for the certificate. This field exists only when the certificate type is <code>AMAZON_ISSUED</code>.</p>"
|
||||
"CertificateDetail$RenewalSummary": "<p>Contains information about the status of ACM's <a href=\"https://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": {
|
||||
@@ -442,7 +455,7 @@
|
||||
"ResourceRecord": {
|
||||
"base": "<p>Contains a DNS record value that you can use to can use to validate ownership or control of a domain. This is used by the <a>DescribeCertificate</a> action. </p>",
|
||||
"refs": {
|
||||
"DomainValidation$ResourceRecord": "<p>Contains the CNAME record that you add to your DNS database for domain validation. For more information, see <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/gs-acm-validate-dns.html\">Use DNS to Validate Domain Ownership</a>.</p>"
|
||||
"DomainValidation$ResourceRecord": "<p>Contains the CNAME record that you add to your DNS database for domain validation. For more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html\">Use DNS to Validate Domain Ownership</a>.</p>"
|
||||
}
|
||||
},
|
||||
"RevocationReason": {
|
||||
@@ -460,6 +473,7 @@
|
||||
"CertificateDetail$SignatureAlgorithm": "<p>The algorithm that was used to sign the certificate.</p>",
|
||||
"ExtendedKeyUsage$OID": "<p>An object identifier (OID) for the extension value. OIDs are strings of numbers separated by periods. The following OIDs are defined in RFC 3280 and RFC 5280. </p> <ul> <li> <p> <code>1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.3 (CODE_SIGNING)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.8 (TIME_STAMPING)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.9 (OCSP_SIGNING)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL)</code> </p> </li> <li> <p> <code>1.3.6.1.5.5.7.3.7 (IPSEC_USER)</code> </p> </li> </ul>",
|
||||
"InUseList$member": null,
|
||||
"InvalidArgsException$message": null,
|
||||
"InvalidArnException$message": null,
|
||||
"InvalidDomainValidationOptionsException$message": null,
|
||||
"InvalidStateException$message": null,
|
||||
@@ -482,7 +496,8 @@
|
||||
"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>"
|
||||
"CertificateDetail$NotAfter": "<p>The time after which the certificate is not valid.</p>",
|
||||
"RenewalSummary$UpdatedAt": "<p>The time at which the renewal summary was last updated.</p>"
|
||||
}
|
||||
},
|
||||
"Tag": {
|
||||
@@ -531,7 +546,7 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DomainValidation$ValidationMethod": "<p>Specifies the domain validation method.</p>",
|
||||
"RequestCertificateRequest$ValidationMethod": "<p>The method you want to use to validate that you own or control domain. You can <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/gs-acm-validate-dns.html\">validate with DNS</a> or <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.comacm/latest/userguide/gs-acm-validate-email.html\">validate with email</a>. We recommend that you use DNS validation. </p>"
|
||||
"RequestCertificateRequest$ValidationMethod": "<p>The method you want to use if you are requesting a public certificate to validate that you own or control domain. You can <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html\">validate with DNS</a> or <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html\">validate with email</a>. We recommend that you use DNS validation. </p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+35
@@ -0,0 +1,35 @@
|
||||
{
|
||||
"version": 2,
|
||||
"waiters": {
|
||||
"CertificateValidated": {
|
||||
"delay": 60,
|
||||
"maxAttempts": 40,
|
||||
"operation": "DescribeCertificate",
|
||||
"acceptors": [
|
||||
{
|
||||
"matcher": "pathAll",
|
||||
"expected": "SUCCESS",
|
||||
"argument": "Certificate.DomainValidationOptions[].ValidationStatus",
|
||||
"state": "success"
|
||||
},
|
||||
{
|
||||
"matcher": "pathAny",
|
||||
"expected": "PENDING_VALIDATION",
|
||||
"argument": "Certificate.DomainValidationOptions[].ValidationStatus",
|
||||
"state": "retry"
|
||||
},
|
||||
{
|
||||
"matcher": "path",
|
||||
"expected": "FAILED",
|
||||
"argument": "Certificate.Status",
|
||||
"state": "failure"
|
||||
},
|
||||
{
|
||||
"matcher": "error",
|
||||
"expected": "ResourceNotFoundException",
|
||||
"state": "failure"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+2175
-41
File diff suppressed because it is too large
Load Diff
Generated
Vendored
+1555
-46
File diff suppressed because it is too large
Load Diff
Generated
Vendored
+45
@@ -1,10 +1,50 @@
|
||||
{
|
||||
"pagination": {
|
||||
"ListBusinessReportSchedules": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListConferenceProviders": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListDeviceEvents": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListGatewayGroups": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListGateways": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListSkills": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListSkillsStoreCategories": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListSkillsStoreSkillsByCategory": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListSmartHomeAppliances": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListTags": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
@@ -25,6 +65,11 @@
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"SearchNetworkProfiles": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"SearchProfiles": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
|
||||
+1972
File diff suppressed because it is too large
Load Diff
+1193
File diff suppressed because it is too large
Load Diff
Generated
Vendored
Generated
Vendored
+60
-20
@@ -1905,7 +1905,8 @@
|
||||
"enabled":{"shape":"Boolean"},
|
||||
"createdDate":{"shape":"Timestamp"},
|
||||
"lastUpdatedDate":{"shape":"Timestamp"},
|
||||
"stageKeys":{"shape":"ListOfString"}
|
||||
"stageKeys":{"shape":"ListOfString"},
|
||||
"tags":{"shape":"MapOfStringToString"}
|
||||
}
|
||||
},
|
||||
"ApiKeyIds":{
|
||||
@@ -1941,7 +1942,8 @@
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"apiId":{"shape":"String"},
|
||||
"stage":{"shape":"String"}
|
||||
"stage":{"shape":"String"},
|
||||
"throttle":{"shape":"MapOfApiStageThrottleSettings"}
|
||||
}
|
||||
},
|
||||
"Authorizer":{
|
||||
@@ -2044,7 +2046,8 @@
|
||||
"description":{"shape":"String"},
|
||||
"pemEncodedCertificate":{"shape":"String"},
|
||||
"createdDate":{"shape":"Timestamp"},
|
||||
"expirationDate":{"shape":"Timestamp"}
|
||||
"expirationDate":{"shape":"Timestamp"},
|
||||
"tags":{"shape":"MapOfStringToString"}
|
||||
}
|
||||
},
|
||||
"ClientCertificates":{
|
||||
@@ -2088,7 +2091,8 @@
|
||||
"generateDistinctId":{"shape":"Boolean"},
|
||||
"value":{"shape":"String"},
|
||||
"stageKeys":{"shape":"ListOfStageKeys"},
|
||||
"customerId":{"shape":"String"}
|
||||
"customerId":{"shape":"String"},
|
||||
"tags":{"shape":"MapOfStringToString"}
|
||||
}
|
||||
},
|
||||
"CreateAuthorizerRequest":{
|
||||
@@ -2147,7 +2151,8 @@
|
||||
"cacheClusterEnabled":{"shape":"NullableBoolean"},
|
||||
"cacheClusterSize":{"shape":"CacheClusterSize"},
|
||||
"variables":{"shape":"MapOfStringToString"},
|
||||
"canarySettings":{"shape":"DeploymentCanarySettings"}
|
||||
"canarySettings":{"shape":"DeploymentCanarySettings"},
|
||||
"tracingEnabled":{"shape":"NullableBoolean"}
|
||||
}
|
||||
},
|
||||
"CreateDocumentationPartRequest":{
|
||||
@@ -2196,7 +2201,9 @@
|
||||
"certificateArn":{"shape":"String"},
|
||||
"regionalCertificateName":{"shape":"String"},
|
||||
"regionalCertificateArn":{"shape":"String"},
|
||||
"endpointConfiguration":{"shape":"EndpointConfiguration"}
|
||||
"endpointConfiguration":{"shape":"EndpointConfiguration"},
|
||||
"tags":{"shape":"MapOfStringToString"},
|
||||
"securityPolicy":{"shape":"SecurityPolicy"}
|
||||
}
|
||||
},
|
||||
"CreateModelRequest":{
|
||||
@@ -2265,7 +2272,8 @@
|
||||
"minimumCompressionSize":{"shape":"NullableInteger"},
|
||||
"apiKeySource":{"shape":"ApiKeySourceType"},
|
||||
"endpointConfiguration":{"shape":"EndpointConfiguration"},
|
||||
"policy":{"shape":"String"}
|
||||
"policy":{"shape":"String"},
|
||||
"tags":{"shape":"MapOfStringToString"}
|
||||
}
|
||||
},
|
||||
"CreateStageRequest":{
|
||||
@@ -2289,6 +2297,7 @@
|
||||
"variables":{"shape":"MapOfStringToString"},
|
||||
"documentationVersion":{"shape":"String"},
|
||||
"canarySettings":{"shape":"CanarySettings"},
|
||||
"tracingEnabled":{"shape":"Boolean"},
|
||||
"tags":{"shape":"MapOfStringToString"}
|
||||
}
|
||||
},
|
||||
@@ -2317,7 +2326,8 @@
|
||||
"description":{"shape":"String"},
|
||||
"apiStages":{"shape":"ListOfApiStage"},
|
||||
"throttle":{"shape":"ThrottleSettings"},
|
||||
"quota":{"shape":"QuotaSettings"}
|
||||
"quota":{"shape":"QuotaSettings"},
|
||||
"tags":{"shape":"MapOfStringToString"}
|
||||
}
|
||||
},
|
||||
"CreateVpcLinkRequest":{
|
||||
@@ -2329,7 +2339,8 @@
|
||||
"members":{
|
||||
"name":{"shape":"String"},
|
||||
"description":{"shape":"String"},
|
||||
"targetArns":{"shape":"ListOfString"}
|
||||
"targetArns":{"shape":"ListOfString"},
|
||||
"tags":{"shape":"MapOfStringToString"}
|
||||
}
|
||||
},
|
||||
"DeleteApiKeyRequest":{
|
||||
@@ -2834,9 +2845,21 @@
|
||||
"regionalCertificateArn":{"shape":"String"},
|
||||
"distributionDomainName":{"shape":"String"},
|
||||
"distributionHostedZoneId":{"shape":"String"},
|
||||
"endpointConfiguration":{"shape":"EndpointConfiguration"}
|
||||
"endpointConfiguration":{"shape":"EndpointConfiguration"},
|
||||
"domainNameStatus":{"shape":"DomainNameStatus"},
|
||||
"domainNameStatusMessage":{"shape":"String"},
|
||||
"securityPolicy":{"shape":"SecurityPolicy"},
|
||||
"tags":{"shape":"MapOfStringToString"}
|
||||
}
|
||||
},
|
||||
"DomainNameStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"AVAILABLE",
|
||||
"UPDATING",
|
||||
"PENDING"
|
||||
]
|
||||
},
|
||||
"DomainNames":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -2858,7 +2881,8 @@
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"REGIONAL",
|
||||
"EDGE"
|
||||
"EDGE",
|
||||
"PRIVATE"
|
||||
]
|
||||
},
|
||||
"ExportResponse":{
|
||||
@@ -2964,7 +2988,8 @@
|
||||
"GenerateClientCertificateRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"description":{"shape":"String"}
|
||||
"description":{"shape":"String"},
|
||||
"tags":{"shape":"MapOfStringToString"}
|
||||
}
|
||||
},
|
||||
"GetAccountRequest":{
|
||||
@@ -4147,10 +4172,10 @@
|
||||
]
|
||||
},
|
||||
"Long":{"type":"long"},
|
||||
"MapOfHeaderValues":{
|
||||
"MapOfApiStageThrottleSettings":{
|
||||
"type":"map",
|
||||
"key":{"shape":"String"},
|
||||
"value":{"shape":"String"}
|
||||
"value":{"shape":"ThrottleSettings"}
|
||||
},
|
||||
"MapOfIntegrationResponse":{
|
||||
"type":"map",
|
||||
@@ -4570,7 +4595,8 @@
|
||||
"minimumCompressionSize":{"shape":"NullableInteger"},
|
||||
"apiKeySource":{"shape":"ApiKeySourceType"},
|
||||
"endpointConfiguration":{"shape":"EndpointConfiguration"},
|
||||
"policy":{"shape":"String"}
|
||||
"policy":{"shape":"String"},
|
||||
"tags":{"shape":"MapOfStringToString"}
|
||||
}
|
||||
},
|
||||
"RestApis":{
|
||||
@@ -4629,6 +4655,13 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"SecurityPolicy":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"TLS_1_0",
|
||||
"TLS_1_2"
|
||||
]
|
||||
},
|
||||
"ServiceUnavailableException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -4658,6 +4691,8 @@
|
||||
"documentationVersion":{"shape":"String"},
|
||||
"accessLogSettings":{"shape":"AccessLogSettings"},
|
||||
"canarySettings":{"shape":"CanarySettings"},
|
||||
"tracingEnabled":{"shape":"Boolean"},
|
||||
"webAclArn":{"shape":"String"},
|
||||
"tags":{"shape":"MapOfStringToString"},
|
||||
"createdDate":{"shape":"Timestamp"},
|
||||
"lastUpdatedDate":{"shape":"Timestamp"}
|
||||
@@ -4725,7 +4760,8 @@
|
||||
"location":"uri",
|
||||
"locationName":"authorizer_id"
|
||||
},
|
||||
"headers":{"shape":"MapOfHeaderValues"},
|
||||
"headers":{"shape":"MapOfStringToString"},
|
||||
"multiValueHeaders":{"shape":"MapOfStringToList"},
|
||||
"pathWithQueryString":{"shape":"String"},
|
||||
"body":{"shape":"String"},
|
||||
"stageVariables":{"shape":"MapOfStringToString"},
|
||||
@@ -4769,7 +4805,8 @@
|
||||
},
|
||||
"pathWithQueryString":{"shape":"String"},
|
||||
"body":{"shape":"String"},
|
||||
"headers":{"shape":"MapOfHeaderValues"},
|
||||
"headers":{"shape":"MapOfStringToString"},
|
||||
"multiValueHeaders":{"shape":"MapOfStringToList"},
|
||||
"clientCertificateId":{"shape":"String"},
|
||||
"stageVariables":{"shape":"MapOfStringToString"}
|
||||
}
|
||||
@@ -4779,7 +4816,8 @@
|
||||
"members":{
|
||||
"status":{"shape":"Integer"},
|
||||
"body":{"shape":"String"},
|
||||
"headers":{"shape":"MapOfHeaderValues"},
|
||||
"headers":{"shape":"MapOfStringToString"},
|
||||
"multiValueHeaders":{"shape":"MapOfStringToList"},
|
||||
"log":{"shape":"String"},
|
||||
"latency":{"shape":"Long"}
|
||||
}
|
||||
@@ -5276,7 +5314,8 @@
|
||||
"apiStages":{"shape":"ListOfApiStage"},
|
||||
"throttle":{"shape":"ThrottleSettings"},
|
||||
"quota":{"shape":"QuotaSettings"},
|
||||
"productCode":{"shape":"String"}
|
||||
"productCode":{"shape":"String"},
|
||||
"tags":{"shape":"MapOfStringToString"}
|
||||
}
|
||||
},
|
||||
"UsagePlanKey":{
|
||||
@@ -5316,7 +5355,8 @@
|
||||
"description":{"shape":"String"},
|
||||
"targetArns":{"shape":"ListOfString"},
|
||||
"status":{"shape":"VpcLinkStatus"},
|
||||
"statusMessage":{"shape":"String"}
|
||||
"statusMessage":{"shape":"String"},
|
||||
"tags":{"shape":"MapOfStringToString"}
|
||||
}
|
||||
},
|
||||
"VpcLinkStatus":{
|
||||
|
||||
+145
-111
File diff suppressed because one or more lines are too long
Generated
Vendored
+96
@@ -0,0 +1,96 @@
|
||||
{
|
||||
"metadata" : {
|
||||
"apiVersion" : "2018-11-29",
|
||||
"endpointPrefix" : "execute-api",
|
||||
"signingName" : "execute-api",
|
||||
"serviceFullName" : "AmazonApiGatewayManagementApi",
|
||||
"serviceId" : "ApiGatewayManagementApi",
|
||||
"protocol" : "rest-json",
|
||||
"jsonVersion" : "1.1",
|
||||
"uid" : "apigatewaymanagementapi-2018-11-29",
|
||||
"signatureVersion" : "v4"
|
||||
},
|
||||
"operations" : {
|
||||
"PostToConnection" : {
|
||||
"name" : "PostToConnection",
|
||||
"http" : {
|
||||
"method" : "POST",
|
||||
"requestUri" : "/@connections/{connectionId}",
|
||||
"responseCode" : 200
|
||||
},
|
||||
"input" : {
|
||||
"shape" : "PostToConnectionRequest"
|
||||
},
|
||||
"errors" : [ {
|
||||
"shape" : "GoneException"
|
||||
}, {
|
||||
"shape" : "LimitExceededException"
|
||||
}, {
|
||||
"shape" : "PayloadTooLargeException"
|
||||
}, {
|
||||
"shape" : "ForbiddenException"
|
||||
} ]
|
||||
}
|
||||
},
|
||||
"shapes" : {
|
||||
"Data" : {
|
||||
"type" : "blob",
|
||||
"max" : 131072
|
||||
},
|
||||
"ForbiddenException" : {
|
||||
"type" : "structure",
|
||||
"members" : { },
|
||||
"exception" : true,
|
||||
"error" : {
|
||||
"httpStatusCode" : 403
|
||||
}
|
||||
},
|
||||
"GoneException" : {
|
||||
"type" : "structure",
|
||||
"members" : { },
|
||||
"exception" : true,
|
||||
"error" : {
|
||||
"httpStatusCode" : 410
|
||||
}
|
||||
},
|
||||
"LimitExceededException" : {
|
||||
"type" : "structure",
|
||||
"members" : { },
|
||||
"exception" : true,
|
||||
"error" : {
|
||||
"httpStatusCode" : 429
|
||||
}
|
||||
},
|
||||
"PayloadTooLargeException" : {
|
||||
"type" : "structure",
|
||||
"members" : {
|
||||
"Message" : {
|
||||
"shape" : "__string",
|
||||
"locationName" : "message"
|
||||
}
|
||||
},
|
||||
"exception" : true,
|
||||
"error" : {
|
||||
"httpStatusCode" : 413
|
||||
}
|
||||
},
|
||||
"PostToConnectionRequest" : {
|
||||
"type" : "structure",
|
||||
"members" : {
|
||||
"Data" : {
|
||||
"shape" : "Data"
|
||||
},
|
||||
"ConnectionId" : {
|
||||
"shape" : "__string",
|
||||
"location" : "uri",
|
||||
"locationName" : "connectionId"
|
||||
}
|
||||
},
|
||||
"required" : [ "ConnectionId", "Data" ],
|
||||
"payload" : "Data"
|
||||
},
|
||||
"__string" : {
|
||||
"type" : "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+35
@@ -0,0 +1,35 @@
|
||||
{
|
||||
"version" : "2.0",
|
||||
"service" : "<p>The Amazon API Gateway Management API allows you to directly manage runtime aspects of your deployed APIs. To use it, you must explicitly set the SDK's endpoint to point to the endpoint of your deployed API. The endpoint will be of the form https://{api-id}.execute-api.{region}.amazonaws.com/{stage}, or will be the endpoint corresponding to your API's custom domain and base path, if applicable.</p>",
|
||||
"operations" : {
|
||||
"PostToConnection" : "<p>Sends the provided data to the specified connection.</p>"
|
||||
},
|
||||
"shapes" : {
|
||||
"Data" : {
|
||||
"base" : "<p>The data to be sent to the client specified by its connection id.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"ForbiddenException" : {
|
||||
"base" : "<p>The caller is not authorized to invoke this operation.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"GoneException" : {
|
||||
"base" : "<p>The connection with the provided id no longer exists.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"LimitExceededException" : {
|
||||
"base" : "<p>The client is sending more than the allowed number of requests per unit of time.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"PayloadTooLargeException" : {
|
||||
"base" : "<p>The data has exceeded the maximum size allowed.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"__string" : {
|
||||
"base" : null,
|
||||
"refs" : {
|
||||
"PayloadTooLargeException$Message" : null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+3
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"pagination" : { }
|
||||
}
|
||||
+5773
File diff suppressed because it is too large
Load Diff
+866
@@ -0,0 +1,866 @@
|
||||
{
|
||||
"version" : "2.0",
|
||||
"service" : "<p>Amazon API Gateway V2</p>",
|
||||
"operations" : {
|
||||
"CreateApi" : "<p>Creates an Api resource.</p>",
|
||||
"CreateApiMapping" : "<p>Creates an API mapping.</p>",
|
||||
"CreateAuthorizer" : "<p>Creates an Authorizer for an API.</p>",
|
||||
"CreateDeployment" : "<p>Creates a Deployment for an API.</p>",
|
||||
"CreateDomainName" : "<p>Creates a domain name.</p>",
|
||||
"CreateIntegration" : "<p>Creates an Integration.</p>",
|
||||
"CreateIntegrationResponse" : "<p>Creates an IntegrationResponses.</p>",
|
||||
"CreateModel" : "<p>Creates a Model for an API.</p>",
|
||||
"CreateRoute" : "<p>Creates a Route for an API.</p>",
|
||||
"CreateRouteResponse" : "<p>Creates a RouteResponse for a Route.</p>",
|
||||
"CreateStage" : "<p>Creates a Stage for an API.</p>",
|
||||
"DeleteApi" : "<p>Deletes an Api resource.</p>",
|
||||
"DeleteApiMapping" : "<p>Deletes an API mapping.</p>",
|
||||
"DeleteAuthorizer" : "<p>Deletes an Authorizer.</p>",
|
||||
"DeleteDeployment" : "<p>Deletes a Deployment.</p>",
|
||||
"DeleteDomainName" : "<p>Deletes a domain name.</p>",
|
||||
"DeleteIntegration" : "<p>Deletes an Integration.</p>",
|
||||
"DeleteIntegrationResponse" : "<p>Deletes an IntegrationResponses.</p>",
|
||||
"DeleteModel" : "<p>Deletes a Model.</p>",
|
||||
"DeleteRoute" : "<p>Deletes a Route.</p>",
|
||||
"DeleteRouteResponse" : "<p>Deletes a RouteResponse.</p>",
|
||||
"DeleteStage" : "<p>Deletes a Stage.</p>",
|
||||
"GetApi" : "<p>Gets an Api resource.</p>",
|
||||
"GetApiMapping" : "<p>The API mapping.</p>",
|
||||
"GetApiMappings" : "<p>The API mappings.</p>",
|
||||
"GetApis" : "<p>Gets a collection of Api resources.</p>",
|
||||
"GetAuthorizer" : "<p>Gets an Authorizer.</p>",
|
||||
"GetAuthorizers" : "<p>Gets the Authorizers for an API.</p>",
|
||||
"GetDeployment" : "<p>Gets a Deployment.</p>",
|
||||
"GetDeployments" : "<p>Gets the Deployments for an API.</p>",
|
||||
"GetDomainName" : "<p>Gets a domain name.</p>",
|
||||
"GetDomainNames" : "<p>Gets the domain names for an AWS account.</p>",
|
||||
"GetIntegration" : "<p>Gets an Integration.</p>",
|
||||
"GetIntegrationResponse" : "<p>Gets an IntegrationResponses.</p>",
|
||||
"GetIntegrationResponses" : "<p>Gets the IntegrationResponses for an Integration.</p>",
|
||||
"GetIntegrations" : "<p>Gets the Integrations for an API.</p>",
|
||||
"GetModel" : "<p>Gets a Model.</p>",
|
||||
"GetModelTemplate" : "<p>Gets a model template.</p>",
|
||||
"GetModels" : "<p>Gets the Models for an API.</p>",
|
||||
"GetRoute" : "<p>Gets a Route.</p>",
|
||||
"GetRouteResponse" : "<p>Gets a RouteResponse.</p>",
|
||||
"GetRouteResponses" : "<p>Gets the RouteResponses for a Route.</p>",
|
||||
"GetRoutes" : "<p>Gets the Routes for an API.</p>",
|
||||
"GetStage" : "<p>Gets a Stage.</p>",
|
||||
"GetStages" : "<p>Gets the Stages for an API.</p>",
|
||||
"GetTags" : "<p>Gets the Tags for a resource.</p>",
|
||||
"UpdateApi" : "<p>Updates an Api resource.</p>",
|
||||
"UpdateApiMapping" : "<p>The API mapping.</p>",
|
||||
"UpdateAuthorizer" : "<p>Updates an Authorizer.</p>",
|
||||
"UpdateDeployment" : "<p>Updates a Deployment.</p>",
|
||||
"UpdateDomainName" : "<p>Updates a domain name.</p>",
|
||||
"UpdateIntegration" : "<p>Updates an Integration.</p>",
|
||||
"UpdateIntegrationResponse" : "<p>Updates an IntegrationResponses.</p>",
|
||||
"UpdateModel" : "<p>Updates a Model.</p>",
|
||||
"UpdateRoute" : "<p>Updates a Route.</p>",
|
||||
"UpdateRouteResponse" : "<p>Updates a RouteResponse.</p>",
|
||||
"UpdateStage" : "<p>Updates a Stage.</p>"
|
||||
},
|
||||
"shapes" : {
|
||||
"AccessLogSettings" : {
|
||||
"base" : "<p>Settings for logging access in a stage.</p>",
|
||||
"refs" : {
|
||||
"CreateStageInput$AccessLogSettings" : "<p>Settings for logging access in this stage.</p>",
|
||||
"Stage$AccessLogSettings" : "<p>Settings for logging access in this stage.</p>",
|
||||
"UpdateStageInput$AccessLogSettings" : "<p>Settings for logging access in this stage.</p>"
|
||||
}
|
||||
},
|
||||
"Api" : {
|
||||
"base" : "<p>Represents an API.</p>",
|
||||
"refs" : {
|
||||
"__listOfApi$member" : null
|
||||
}
|
||||
},
|
||||
"ApiMapping" : {
|
||||
"base" : "<p>Represents an API mapping.</p>",
|
||||
"refs" : {
|
||||
"__listOfApiMapping$member" : null
|
||||
}
|
||||
},
|
||||
"ApiMappings" : {
|
||||
"base" : "<p>Represents a collection of ApiMappings resources.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"Apis" : {
|
||||
"base" : "<p>Represents a collection of APIs.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"Arn" : {
|
||||
"base" : "<p>Represents an Amazon Resource Name (ARN).</p>",
|
||||
"refs" : {
|
||||
"AccessLogSettings$DestinationArn" : "<p>The ARN of the CloudWatch Logs log group to receive access logs.</p>",
|
||||
"Authorizer$AuthorizerCredentialsArn" : "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the\n authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon\n Resource Name (ARN). To use resource-based permissions on the Lambda function,\n specify null.</p>",
|
||||
"CreateAuthorizerInput$AuthorizerCredentialsArn" : "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the\n authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon\n Resource Name (ARN). To use resource-based permissions on the Lambda function,\n specify null.</p>",
|
||||
"CreateIntegrationInput$CredentialsArn" : "<p>Specifies the credentials required for the integration, if any. For AWS\n integrations, three options are available. To specify an IAM Role for API Gateway to\n assume, use the role's Amazon Resource Name (ARN). To require that the caller's\n identity be passed through from the request, specify the string\n arn:aws:iam::*:user/*. To use resource-based permissions on supported\n AWS services, specify null.</p>",
|
||||
"DomainNameConfiguration$CertificateArn" : "<p>An AWS-managed certificate that will be used by the edge-optimized endpoint for\n this domain name. AWS Certificate Manager is the only supported source.</p>",
|
||||
"Integration$CredentialsArn" : "<p>Specifies the credentials required for the integration, if any. For AWS\n integrations, three options are available. To specify an IAM Role for API Gateway to\n assume, use the role's Amazon Resource Name (ARN). To require that the caller's\n identity be passed through from the request, specify the string\n arn:aws:iam::*:user/*. To use resource-based permissions on supported\n AWS services, specify null.</p>",
|
||||
"ProviderArnList$member" : null,
|
||||
"UpdateAuthorizerInput$AuthorizerCredentialsArn" : "<p>Specifies the required credentials as an IAM role for API Gateway to invoke the\n authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon\n Resource Name (ARN). To use resource-based permissions on the Lambda function,\n specify null.</p>",
|
||||
"UpdateIntegrationInput$CredentialsArn" : "<p>Specifies the credentials required for the integration, if any. For AWS\n integrations, three options are available. To specify an IAM Role for API Gateway to\n assume, use the role's Amazon Resource Name (ARN). To require that the caller's\n identity be passed through from the request, specify the string\n arn:aws:iam::*:user/*. To use resource-based permissions on supported\n AWS services, specify null.</p>"
|
||||
}
|
||||
},
|
||||
"AuthorizationScopes" : {
|
||||
"base" : "<p>A list of authorization scopes configured on a route. The scopes are used with a\n COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization\n works by matching the route scopes against the scopes parsed from the access token in\n the incoming request. The method invocation is authorized if any route scope matches\n a claimed scope in the access token. Otherwise, the invocation is not authorized.\n When the route scope is configured, the client must provide an access token instead\n of an identity token for authorization purposes.</p>",
|
||||
"refs" : {
|
||||
"CreateRouteInput$AuthorizationScopes" : "<p>The authorization scopes supported by this\n route.</p>",
|
||||
"Route$AuthorizationScopes" : "<p>A list of authorization scopes configured on a route. The scopes are used with a\n COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization\n works by matching the route scopes against the scopes parsed from the access token in\n the incoming request. The method invocation is authorized if any route scope matches\n a claimed scope in the access token. Otherwise, the invocation is not authorized.\n When the route scope is configured, the client must provide an access token instead\n of an identity token for authorization purposes.</p>",
|
||||
"UpdateRouteInput$AuthorizationScopes" : "<p>The authorization scopes supported by this\n route.</p>"
|
||||
}
|
||||
},
|
||||
"AuthorizationType" : {
|
||||
"base" : "<p>The authorization type. Valid values are NONE for open access,\n AWS_IAM for using AWS IAM permissions, and CUSTOM for\n using a Lambda authorizer.</p>",
|
||||
"refs" : {
|
||||
"CreateRouteInput$AuthorizationType" : "<p>The authorization type for the route. Valid values are NONE for open\n access, AWS_IAM for using AWS IAM permissions, and CUSTOM\n for using a Lambda\n authorizer.</p>",
|
||||
"Route$AuthorizationType" : "<p>The authorization type for the route. Valid values are NONE for open\n access, AWS_IAM for using AWS IAM permissions, and CUSTOM\n for using a Lambda\n authorizer</p>",
|
||||
"UpdateRouteInput$AuthorizationType" : "<p>The authorization type for the route. Valid values are NONE for open\n access, AWS_IAM for using AWS IAM permissions, and CUSTOM\n for using a Lambda\n authorizer.</p>"
|
||||
}
|
||||
},
|
||||
"Authorizer" : {
|
||||
"base" : "<p>Represents an authorizer.</p>",
|
||||
"refs" : {
|
||||
"__listOfAuthorizer$member" : null
|
||||
}
|
||||
},
|
||||
"AuthorizerType" : {
|
||||
"base" : "<p>The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.</p>",
|
||||
"refs" : {
|
||||
"Authorizer$AuthorizerType" : "<p>The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.</p>",
|
||||
"CreateAuthorizerInput$AuthorizerType" : "<p>The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.</p>",
|
||||
"UpdateAuthorizerInput$AuthorizerType" : "<p>The authorizer type. Currently the only valid value is REQUEST, for a\n Lambda function using incoming request parameters.</p>"
|
||||
}
|
||||
},
|
||||
"Authorizers" : {
|
||||
"base" : "<p>Represents a collection of authorizers.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"BadRequestException" : {
|
||||
"base" : "<p>The request is not valid, for example, the input is incomplete or incorrect. See\n the accompanying error message for details.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"ConflictException" : {
|
||||
"base" : "<p>The requested operation would cause a conflict with the current state of a service\n resource associated with the request. Resolve the conflict before retrying this\n request. See the accompanying error message for details.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"ConnectionType" : {
|
||||
"base" : "<p>Represents a connection type.</p>",
|
||||
"refs" : {
|
||||
"CreateIntegrationInput$ConnectionType" : "<p>The type of the network connection to the integration endpoint. Currently the only\n valid value is INTERNET, for connections through the public routable\n internet.</p>",
|
||||
"Integration$ConnectionType" : "<p>The type of the network connection to the integration endpoint. Currently the only\n valid value is INTERNET, for connections through the public routable\n internet.</p>",
|
||||
"UpdateIntegrationInput$ConnectionType" : "<p>The type of the network connection to the integration endpoint. Currently the only\n valid value is INTERNET, for connections through the public routable\n internet.</p>"
|
||||
}
|
||||
},
|
||||
"ContentHandlingStrategy" : {
|
||||
"base" : "<p>Specifies how to handle response payload content type conversions.</p>",
|
||||
"refs" : {
|
||||
"CreateIntegrationInput$ContentHandlingStrategy" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>",
|
||||
"CreateIntegrationResponseInput$ContentHandlingStrategy" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>",
|
||||
"Integration$ContentHandlingStrategy" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>",
|
||||
"IntegrationResponse$ContentHandlingStrategy" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>",
|
||||
"UpdateIntegrationInput$ContentHandlingStrategy" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>",
|
||||
"UpdateIntegrationResponseInput$ContentHandlingStrategy" : "<p>Specifies how to handle response payload content type conversions. Supported\n values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the\n following behaviors:</p><p>\n CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded\n string to the corresponding binary blob.</p><p>\n CONVERT_TO_TEXT: Converts a response payload from a binary blob to a\n Base64-encoded string.</p><p>If this property is not defined, the response payload will be passed through from\n the integration response to the route response or method response without\n modification.</p>"
|
||||
}
|
||||
},
|
||||
"CreateApiInput" : {
|
||||
"base" : "<p>Represents the input parameters for a CreateApi request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"CreateApiMappingInput" : {
|
||||
"base" : "<p>Represents the input parameters for a CreateApiMapping\n request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"CreateAuthorizerInput" : {
|
||||
"base" : "<p>Represents the input parameters for a CreateAuthorizer\n request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"CreateDeploymentInput" : {
|
||||
"base" : "<p>Represents the input parameters for a CreateDeployment\n request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"CreateDomainNameInput" : {
|
||||
"base" : "<p>Represents the input parameters for a CreateDomainName\n request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"CreateIntegrationInput" : {
|
||||
"base" : "<p>Represents the input parameters for a CreateIntegration\n request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"CreateIntegrationResponseInput" : {
|
||||
"base" : "<p>Represents the input parameters for a CreateIntegrationResponse\n request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"CreateModelInput" : {
|
||||
"base" : "<p>Represents the input parameters for a CreateModel request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"CreateRouteInput" : {
|
||||
"base" : "<p>Represents the input parameters for a CreateRoute request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"CreateRouteResponseInput" : {
|
||||
"base" : "<p>Represents the input parameters for an CreateRouteResponse\n request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"CreateStageInput" : {
|
||||
"base" : "<p>Represents the input parameters for a CreateStage request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"Deployment" : {
|
||||
"base" : "<p>An immutable representation of an API that can be called by users. A\n Deployment must be associated with a Stage for it to be\n callable over the internet.</p>",
|
||||
"refs" : {
|
||||
"__listOfDeployment$member" : null
|
||||
}
|
||||
},
|
||||
"DeploymentStatus" : {
|
||||
"base" : "<p>Represents a deployment status.</p>",
|
||||
"refs" : {
|
||||
"Deployment$DeploymentStatus" : "<p>The status of the deployment: PENDING, FAILED, or\n SUCCEEDED.</p>"
|
||||
}
|
||||
},
|
||||
"Deployments" : {
|
||||
"base" : "<p>A collection resource that contains zero or more references to your existing\n deployments, and links that guide you on how to interact with your collection. The\n collection offers a paginated view of the contained deployments.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"DomainName" : {
|
||||
"base" : "<p>Represents a domain name.</p>",
|
||||
"refs" : {
|
||||
"__listOfDomainName$member" : null
|
||||
}
|
||||
},
|
||||
"DomainNameConfiguration" : {
|
||||
"base" : "<p>The domain name configuration.</p>",
|
||||
"refs" : {
|
||||
"DomainNameConfigurations$member" : null
|
||||
}
|
||||
},
|
||||
"DomainNameConfigurations" : {
|
||||
"base" : "<p>The domain name configurations.</p>",
|
||||
"refs" : {
|
||||
"CreateDomainNameInput$DomainNameConfigurations" : "<p>The domain name configurations.</p>",
|
||||
"DomainName$DomainNameConfigurations" : "<p>The domain name configurations.</p>",
|
||||
"UpdateDomainNameInput$DomainNameConfigurations" : "<p>The domain name configurations.</p>"
|
||||
}
|
||||
},
|
||||
"DomainNames" : {
|
||||
"base" : "<p>Represents a collection of domain names.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"EndpointType" : {
|
||||
"base" : "<p>Represents an endpoint type.</p>",
|
||||
"refs" : {
|
||||
"DomainNameConfiguration$EndpointType" : "<p>The endpoint type.</p>"
|
||||
}
|
||||
},
|
||||
"Id" : {
|
||||
"base" : "<p>The identifier.</p>",
|
||||
"refs" : {
|
||||
"Api$ApiId" : "<p>The API ID.</p>",
|
||||
"ApiMapping$ApiId" : "<p>The API identifier.</p>",
|
||||
"ApiMapping$ApiMappingId" : "<p>The API mapping identifier.</p>",
|
||||
"Authorizer$AuthorizerId" : "<p>The authorizer identifier.</p>",
|
||||
"CreateApiMappingInput$ApiId" : "<p>The API identifier.</p>",
|
||||
"CreateRouteInput$AuthorizerId" : "<p>The identifier of the Authorizer resource to be associated with this\n route, if the authorizationType is CUSTOM\n . The authorizer identifier is generated by API Gateway\n when you created the authorizer.</p>",
|
||||
"CreateStageInput$ClientCertificateId" : "<p>The identifier of a client certificate for a Stage.</p>",
|
||||
"CreateStageInput$DeploymentId" : "<p>The deployment identifier of the API stage.</p>",
|
||||
"Deployment$DeploymentId" : "<p>The identifier for the deployment.</p>",
|
||||
"Integration$IntegrationId" : "<p>Represents the identifier of an integration.</p>",
|
||||
"IntegrationResponse$IntegrationResponseId" : "<p>The integration response ID.</p>",
|
||||
"Model$ModelId" : "<p>The model identifier.</p>",
|
||||
"Route$AuthorizerId" : "<p>The identifier of the Authorizer resource to be associated with this\n route, if the authorizationType is CUSTOM\n . The authorizer identifier is generated by API Gateway\n when you created the authorizer.</p>",
|
||||
"Route$RouteId" : "<p>The route ID.</p>",
|
||||
"RouteResponse$RouteResponseId" : "<p>Represents the identifier of a route response.</p>",
|
||||
"Stage$ClientCertificateId" : "<p>The identifier of a client certificate for a Stage.</p>",
|
||||
"Stage$DeploymentId" : "<p>The identifier of the Deployment that the Stage is\n associated with.</p>",
|
||||
"UpdateApiMappingInput$ApiId" : "<p>The API identifier.</p>",
|
||||
"UpdateRouteInput$AuthorizerId" : "<p>The identifier of the Authorizer resource to be associated with this\n route, if the authorizationType is CUSTOM\n . The authorizer identifier is generated by API Gateway\n when you created the authorizer.</p>",
|
||||
"UpdateStageInput$ClientCertificateId" : "<p>The identifier of a client certificate for a Stage.</p>",
|
||||
"UpdateStageInput$DeploymentId" : "<p>The deployment identifier for the API stage.</p>"
|
||||
}
|
||||
},
|
||||
"IdentitySourceList" : {
|
||||
"base" : "<p>The identity source for which authorization is requested. For the REQUEST\n authorizer, this is required when authorization caching is enabled. The value is a\n comma-separated string of one or more mapping expressions of the specified request\n parameters. For example, if an Auth header, a Name query string parameter are defined\n as identity sources, this value is $method.request.header.Auth,\n $method.request.querystring.Name. These parameters will be used to derive\n the authorization caching key and to perform runtime validation of the REQUEST\n authorizer by verifying all of the identity-related request parameters are present,\n not null and non-empty. Only when this is true does the authorizer invoke the\n authorizer Lambda function, otherwise, it returns a 401 Unauthorized\n response without calling the Lambda function. The valid value is a string of\n comma-separated mapping expressions of the specified request parameters. When the\n authorization caching is not enabled, this property is optional.</p>",
|
||||
"refs" : {
|
||||
"Authorizer$IdentitySource" : "<p>The identity source for which authorization is requested.</p><p>For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping\n expressions of the specified request parameters. For example, if an Auth\n header and a Name query string parameters are defined as identity\n sources, this value is method.request.header.Auth,\n method.request.querystring.Name. These parameters will be used to\n derive the authorization caching key and to perform runtime validation of the\n REQUEST authorizer by verifying all of the identity-related request\n parameters are present, not null, and non-empty. Only when this is true does the\n authorizer invoke the authorizer Lambda function, otherwise, it returns a 401\n Unauthorized response without calling the Lambda function. The valid value\n is a string of comma-separated mapping expressions of the specified request\n parameters. When the authorization caching is not enabled, this property is\n optional.</p>",
|
||||
"CreateAuthorizerInput$IdentitySource" : "<p>The identity source for which authorization is requested.</p><p>For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping\n expressions of the specified request parameters. For example, if an Auth\n header and a Name query string parameters are defined as identity\n sources, this value is method.request.header.Auth,\n method.request.querystring.Name. These parameters will be used to\n derive the authorization caching key and to perform runtime validation of the\n REQUEST authorizer by verifying all of the identity-related request\n parameters are present, not null, and non-empty. Only when this is true does the\n authorizer invoke the authorizer Lambda function, otherwise, it returns a 401\n Unauthorized response without calling the Lambda function. The valid value\n is a string of comma-separated mapping expressions of the specified request\n parameters. When the authorization caching is not enabled, this property is\n optional.</p>",
|
||||
"UpdateAuthorizerInput$IdentitySource" : "<p>The identity source for which authorization is requested.</p><p>For the REQUEST authorizer, this is required when authorization\n caching is enabled. The value is a comma-separated string of one or more mapping\n expressions of the specified request parameters. For example, if an Auth header, a\n Name query string parameter are defined as identity sources, this value is\n $method.request.header.Auth, $method.request.querystring.Name. These\n parameters will be used to derive the authorization caching key and to perform\n runtime validation of the REQUEST authorizer by verifying all of the\n identity-related request parameters are present, not null and non-empty. Only when\n this is true does the authorizer invoke the authorizer Lambda function, otherwise, it\n returns a 401 Unauthorized response without calling the Lambda function.\n The valid value is a string of comma-separated mapping expressions of the specified\n request parameters. When the authorization caching is not enabled, this property is\n optional.</p>"
|
||||
}
|
||||
},
|
||||
"IntegerWithLengthBetween0And3600" : {
|
||||
"base" : "<p>An integer with a value between [0-3600].</p>",
|
||||
"refs" : {
|
||||
"Authorizer$AuthorizerResultTtlInSeconds" : "<p>The time to live (TTL), in seconds, of cached authorizer results. If it equals 0,\n authorization caching is disabled. If it is greater than 0, API Gateway will cache\n authorizer responses. If this field is not set, the default value is 300. The maximum\n value is 3600, or 1 hour.</p>",
|
||||
"CreateAuthorizerInput$AuthorizerResultTtlInSeconds" : "<p>The time to live (TTL), in seconds, of cached authorizer results. If it equals 0,\n authorization caching is disabled. If it is greater than 0, API Gateway will cache\n authorizer responses. If this field is not set, the default value is 300. The maximum\n value is 3600, or 1 hour.</p>",
|
||||
"UpdateAuthorizerInput$AuthorizerResultTtlInSeconds" : "<p>The time to live (TTL), in seconds, of cached authorizer results. If it is zero,\n authorization caching is disabled. If it is greater than zero, API Gateway will cache\n authorizer responses. If this field is not set, the default value is 300. The maximum\n value is 3600, or 1 hour.</p>"
|
||||
}
|
||||
},
|
||||
"IntegerWithLengthBetween50And29000" : {
|
||||
"base" : "<p>An integer with a value between [50-29000].</p>",
|
||||
"refs" : {
|
||||
"CreateIntegrationInput$TimeoutInMillis" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000\n milliseconds or 29 seconds.</p>",
|
||||
"Integration$TimeoutInMillis" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000\n milliseconds or 29 seconds.</p>",
|
||||
"UpdateIntegrationInput$TimeoutInMillis" : "<p>Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000\n milliseconds or 29 seconds.</p>"
|
||||
}
|
||||
},
|
||||
"Integration" : {
|
||||
"base" : "<p>Represents an integration.</p>",
|
||||
"refs" : {
|
||||
"__listOfIntegration$member" : null
|
||||
}
|
||||
},
|
||||
"IntegrationParameters" : {
|
||||
"base" : "<p>A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of method.response.header.{name}, where name is a\n valid and unique header name. The mapped non-static value must match the pattern of\n integration.response.header.{name} or integration.response.body.{JSON-expression},\n where name is a valid and unique response header name and JSON-expression is a valid\n JSON expression without the $ prefix.</p>",
|
||||
"refs" : {
|
||||
"CreateIntegrationInput$RequestParameters" : "<p>A key-value map specifying request parameters that are passed from the method\n request to the backend. The key is an integration request parameter name and the\n associated value is a method request parameter value or static value that must be\n enclosed within single quotes and pre-encoded as required by the backend. The method\n request parameter value must match the pattern of\n method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.</p>",
|
||||
"CreateIntegrationResponseInput$ResponseParameters" : "<p>A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of method.response.header.{name},\n where {name} is a valid and unique header name. The mapped non-static\n value must match the pattern of integration.response.header.{name} or\n integration.response.body.{JSON-expression}, where\n {name} is a valid and unique response header name and\n {JSON-expression} is a valid JSON expression without the $\n prefix.</p>",
|
||||
"Integration$RequestParameters" : "<p>A key-value map specifying request parameters that are passed from the method\n request to the backend. The key is an integration request parameter name and the\n associated value is a method request parameter value or static value that must be\n enclosed within single quotes and pre-encoded as required by the backend. The method\n request parameter value must match the pattern of\n method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.</p>",
|
||||
"IntegrationResponse$ResponseParameters" : "<p>A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of method.response.header.{name}, where name is a\n valid and unique header name. The mapped non-static value must match the pattern of\n integration.response.header.{name} or integration.response.body.{JSON-expression},\n where name is a valid and unique response header name and JSON-expression is a valid\n JSON expression without the $ prefix.</p>",
|
||||
"UpdateIntegrationInput$RequestParameters" : "<p>A key-value map specifying request parameters that are passed from the method\n request to the backend. The key is an integration request parameter name and the\n associated value is a method request parameter value or static value that must be\n enclosed within single quotes and pre-encoded as required by the backend. The method\n request parameter value must match the pattern of\n method.request.{location}.{name}\n , where \n {location}\n is querystring, path, or header; and \n {name}\n must be a valid and unique method request parameter name.</p>",
|
||||
"UpdateIntegrationResponseInput$ResponseParameters" : "<p>A key-value map specifying response parameters that are passed to the method\n response from the backend. The key is a method response header parameter name and the\n mapped value is an integration response header value, a static value enclosed within\n a pair of single quotes, or a JSON expression from the integration response body. The\n mapping key must match the pattern of\n method.response.header.{name}\n , where name is a valid and unique header name. The mapped non-static value\n must match the pattern of\n integration.response.header.{name}\n or\n integration.response.body.{JSON-expression}\n , where \n {name}\n is a valid and unique response header name and \n {JSON-expression}\n is a valid JSON expression without the $ prefix.</p>"
|
||||
}
|
||||
},
|
||||
"IntegrationResponse" : {
|
||||
"base" : "<p>Represents an integration response.</p>",
|
||||
"refs" : {
|
||||
"__listOfIntegrationResponse$member" : null
|
||||
}
|
||||
},
|
||||
"IntegrationResponses" : {
|
||||
"base" : "<p>Represents a collection of integration responses.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"IntegrationType" : {
|
||||
"base" : "<p>Represents an API method integration type.</p>",
|
||||
"refs" : {
|
||||
"CreateIntegrationInput$IntegrationType" : "<p>The integration type of an integration. One of the following:</p><p>\n AWS: for integrating the route or method request with an AWS service\n action, including the Lambda function-invoking action. With the Lambda\n function-invoking action, this is referred to as the Lambda custom integration. With\n any other AWS service action, this is known as AWS integration.</p><p>\n AWS_PROXY: for integrating the route or method request with the Lambda\n function-invoking action with the client request passed through as-is. This\n integration is also referred to as Lambda proxy integration.</p><p>\n HTTP: for integrating the route or method request with an HTTP\n endpoint. This\n integration is also referred to as HTTP custom integration.</p><p>\n HTTP_PROXY: for integrating route or method request with an HTTP\n endpoint, with the client\n request passed through as-is. This is also referred to as HTTP proxy\n integration.</p><p>\n MOCK: for integrating the route or method request with API Gateway as a\n \"loopback\" endpoint without invoking any backend.</p>",
|
||||
"Integration$IntegrationType" : "<p>The integration type of an integration. One of the following:</p><p>\n AWS: for integrating the route or method request with an AWS service\n action, including the Lambda function-invoking action. With the Lambda\n function-invoking action, this is referred to as the Lambda custom integration. With\n any other AWS service action, this is known as AWS integration.</p><p>\n AWS_PROXY: for integrating the route or method request with the Lambda\n function-invoking action with the client request passed through as-is. This\n integration is also referred to as Lambda proxy integration.</p><p>\n HTTP: for integrating the route or method request with an HTTP\n endpoint. This\n integration is also referred to as the HTTP custom integration.</p><p>\n HTTP_PROXY: for integrating route or method request with an HTTP\n endpoint, with the client\n request passed through as-is. This is also referred to as HTTP proxy\n integration.</p><p>\n MOCK: for integrating the route or method request with API Gateway as a\n \"loopback\" endpoint without invoking any backend.</p>",
|
||||
"UpdateIntegrationInput$IntegrationType" : "<p>The integration type of an integration. One of the following:</p><p>\n AWS: for integrating the route or method request with an AWS service\n action, including the Lambda function-invoking action. With the Lambda\n function-invoking action, this is referred to as the Lambda custom integration. With\n any other AWS service action, this is known as AWS integration.</p><p>\n AWS_PROXY: for integrating the route or method request with the Lambda\n function-invoking action with the client request passed through as-is. This\n integration is also referred to as Lambda proxy integration.</p><p>\n HTTP: for integrating the route or method request with an HTTP\n endpoint. This\n integration is also referred to as the HTTP custom integration.</p><p>\n HTTP_PROXY: for integrating route or method request with an HTTP\n endpoint, with the client\n request passed through as-is. This is also referred to as HTTP proxy\n integration.</p><p>\n MOCK: for integrating the route or method request with API Gateway as a\n \"loopback\" endpoint without invoking any backend.</p>"
|
||||
}
|
||||
},
|
||||
"Integrations" : {
|
||||
"base" : "<p>Represents a collection of integrations.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"LimitExceededException" : {
|
||||
"base" : "<p>A limit has been exceeded. See the accompanying error message for details.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"LoggingLevel" : {
|
||||
"base" : "<p>The logging level.</p>",
|
||||
"refs" : {
|
||||
"RouteSettings$LoggingLevel" : "<p>Specifies the logging level for this route: DEBUG, INFO,\n or WARN. This property affects the log entries pushed to Amazon\n CloudWatch Logs.</p>"
|
||||
}
|
||||
},
|
||||
"Model" : {
|
||||
"base" : "<p>Represents a data model for an API. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html\">Create Models and Mapping Templates for Request and Response\n Mappings</a>.</p>",
|
||||
"refs" : {
|
||||
"__listOfModel$member" : null
|
||||
}
|
||||
},
|
||||
"Models" : {
|
||||
"base" : "<p>Represents a collection of data models. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/models-mappings.html\">Create Models and Mapping Templates for Request and Response\n Mappings</a>.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"NextToken" : {
|
||||
"base" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>",
|
||||
"refs" : {
|
||||
"ApiMappings$NextToken" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>",
|
||||
"Apis$NextToken" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>",
|
||||
"Authorizers$NextToken" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>",
|
||||
"Deployments$NextToken" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>",
|
||||
"DomainNames$NextToken" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>",
|
||||
"IntegrationResponses$NextToken" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>",
|
||||
"Integrations$NextToken" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>",
|
||||
"Models$NextToken" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>",
|
||||
"RouteResponses$NextToken" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>",
|
||||
"Routes$NextToken" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>",
|
||||
"Stages$NextToken" : "<p>The next page of elements from this collection. Not valid for the last element of\n the collection.</p>"
|
||||
}
|
||||
},
|
||||
"NotFoundException" : {
|
||||
"base" : "<p>The resource specified in the request was not found. See the message\n field for more information.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"ParameterConstraints" : {
|
||||
"base" : "<p>Validation constraints imposed on parameters of a request (path, query string,\n headers).</p>",
|
||||
"refs" : {
|
||||
"RouteParameters$member" : null
|
||||
}
|
||||
},
|
||||
"PassthroughBehavior" : {
|
||||
"base" : "<p>Represents passthrough behavior for an integration response.</p>",
|
||||
"refs" : {
|
||||
"CreateIntegrationInput$PassthroughBehavior" : "<p>Specifies the pass-through behavior for incoming requests based on the\n Content-Type header in the request, and the available mapping\n templates specified as the requestTemplates property on the\n Integration resource. There are three valid values:\n WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\n NEVER.</p><p>\n WHEN_NO_MATCH passes the request body for unmapped content types through\n to the integration backend without transformation.</p><p>\n NEVER rejects unmapped content types with an HTTP 415 Unsupported\n Media Type response.</p><p>\n WHEN_NO_TEMPLATES allows pass-through when the integration has no\n content types mapped to templates. However, if there is at least one content type\n defined, unmapped content types will be rejected with the same HTTP 415\n Unsupported Media Type response.</p>",
|
||||
"Integration$PassthroughBehavior" : "<p>Specifies the pass-through behavior for incoming requests based on the\n Content-Type header in the request, and the available mapping\n templates specified as the requestTemplates property on the\n Integration resource. There are three valid values:\n WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\n NEVER.</p><p>\n WHEN_NO_MATCH passes the request body for unmapped content types through\n to the integration backend without transformation.</p><p>\n NEVER rejects unmapped content types with an HTTP 415 Unsupported\n Media Type response.</p><p>\n WHEN_NO_TEMPLATES allows pass-through when the integration has no\n content types mapped to templates. However, if there is at least one content type\n defined, unmapped content types will be rejected with the same HTTP 415\n Unsupported Media Type response.</p>",
|
||||
"UpdateIntegrationInput$PassthroughBehavior" : "<p>Specifies the pass-through behavior for incoming requests based on the\n Content-Type header in the request, and the available mapping\n templates specified as the requestTemplates property on the\n Integration resource. There are three valid values:\n WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and\n NEVER.</p><p>\n WHEN_NO_MATCH passes the request body for unmapped content types through\n to the integration backend without transformation.</p><p>\n NEVER rejects unmapped content types with an HTTP 415 Unsupported\n Media Type response.</p><p>\n WHEN_NO_TEMPLATES allows pass-through when the integration has no\n content types mapped to templates. However, if there is at least one content type\n defined, unmapped content types will be rejected with the same HTTP 415\n Unsupported Media Type response.</p>"
|
||||
}
|
||||
},
|
||||
"ProtocolType" : {
|
||||
"base" : "",
|
||||
"refs" : {
|
||||
"Api$ProtocolType" : "<p>The API protocol: Currently only WEBSOCKET is supported.</p>",
|
||||
"CreateApiInput$ProtocolType" : "<p>The API protocol: Currently only WEBSOCKET is supported.</p>"
|
||||
}
|
||||
},
|
||||
"ProviderArnList" : {
|
||||
"base" : "<p>For REQUEST authorizer, this is not defined.</p>",
|
||||
"refs" : {
|
||||
"Authorizer$ProviderArns" : "<p>For\n REQUEST authorizer, this is not\n defined.</p>",
|
||||
"CreateAuthorizerInput$ProviderArns" : "<p>For\n REQUEST authorizer, this is not\n defined.</p>",
|
||||
"UpdateAuthorizerInput$ProviderArns" : "<p>For\n REQUEST authorizer, this is not\n defined.</p>"
|
||||
}
|
||||
},
|
||||
"Route" : {
|
||||
"base" : "<p>Represents a route.</p>",
|
||||
"refs" : {
|
||||
"__listOfRoute$member" : null
|
||||
}
|
||||
},
|
||||
"RouteModels" : {
|
||||
"base" : "<p>The route models.</p>",
|
||||
"refs" : {
|
||||
"CreateRouteInput$RequestModels" : "<p>The request models for the route.</p>",
|
||||
"CreateRouteResponseInput$ResponseModels" : "<p>The response models for the route response.</p>",
|
||||
"Route$RequestModels" : "<p>The request models for the route.</p>",
|
||||
"RouteResponse$ResponseModels" : "<p>Represents the response models of a route response.</p>",
|
||||
"UpdateRouteInput$RequestModels" : "<p>The request models for the route.</p>",
|
||||
"UpdateRouteResponseInput$ResponseModels" : "<p>The response models for the route response.</p>"
|
||||
}
|
||||
},
|
||||
"RouteParameters" : {
|
||||
"base" : "<p>The route parameters.</p>",
|
||||
"refs" : {
|
||||
"CreateRouteInput$RequestParameters" : "<p>The request parameters for the route.</p>",
|
||||
"CreateRouteResponseInput$ResponseParameters" : "<p>The route response parameters.</p>",
|
||||
"Route$RequestParameters" : "<p>The request parameters for the route.</p>",
|
||||
"RouteResponse$ResponseParameters" : "<p>Represents the response parameters of a route response.</p>",
|
||||
"UpdateRouteInput$RequestParameters" : "<p>The request parameters for the route.</p>",
|
||||
"UpdateRouteResponseInput$ResponseParameters" : "<p>The route response parameters.</p>"
|
||||
}
|
||||
},
|
||||
"RouteResponse" : {
|
||||
"base" : "<p>Represents a route response.</p>",
|
||||
"refs" : {
|
||||
"__listOfRouteResponse$member" : null
|
||||
}
|
||||
},
|
||||
"RouteResponses" : {
|
||||
"base" : "<p>Represents a collection of route responses.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"RouteSettings" : {
|
||||
"base" : "<p>Represents a collection of route settings.</p>",
|
||||
"refs" : {
|
||||
"CreateStageInput$DefaultRouteSettings" : "<p>The default route settings for the stage.</p>",
|
||||
"RouteSettingsMap$member" : null,
|
||||
"Stage$DefaultRouteSettings" : "<p>Default route settings for the stage.</p>",
|
||||
"UpdateStageInput$DefaultRouteSettings" : "<p>The default route settings for the stage.</p>"
|
||||
}
|
||||
},
|
||||
"RouteSettingsMap" : {
|
||||
"base" : "<p>The route settings map.</p>",
|
||||
"refs" : {
|
||||
"CreateStageInput$RouteSettings" : "<p>Route settings for the stage.</p>",
|
||||
"Stage$RouteSettings" : "<p>Route settings for the stage.</p>",
|
||||
"UpdateStageInput$RouteSettings" : "<p>Route settings for the stage.</p>"
|
||||
}
|
||||
},
|
||||
"Routes" : {
|
||||
"base" : "<p>Represents a collection of routes.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"SelectionExpression" : {
|
||||
"base" : "<p>An expression used to extract information at runtime. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for more information.</p>",
|
||||
"refs" : {
|
||||
"Api$ApiKeySelectionExpression" : "<p>An API key selection expression. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>",
|
||||
"Api$RouteSelectionExpression" : "<p>The route selection expression for the API.</p>",
|
||||
"CreateApiInput$ApiKeySelectionExpression" : "<p>An API key selection expression. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>",
|
||||
"CreateApiInput$RouteSelectionExpression" : "<p>The route selection expression for the API.</p>",
|
||||
"CreateIntegrationInput$TemplateSelectionExpression" : "<p>The template selection expression for the integration.</p>",
|
||||
"CreateIntegrationResponseInput$TemplateSelectionExpression" : "<p>The template selection expression for the integration response.</p>",
|
||||
"CreateRouteInput$ModelSelectionExpression" : "<p>The model selection expression for the route.</p>",
|
||||
"CreateRouteInput$RouteResponseSelectionExpression" : "<p>The route response selection expression for the route.</p>",
|
||||
"CreateRouteResponseInput$ModelSelectionExpression" : "<p>The model selection expression for the route response.</p>",
|
||||
"DomainName$ApiMappingSelectionExpression" : "<p>The API mapping selection expression.</p>",
|
||||
"Integration$IntegrationResponseSelectionExpression" : "<p>The integration response selection expression for the integration. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-integration-response-selection-expressions\">Integration Response Selection Expressions</a>.</p>",
|
||||
"Integration$TemplateSelectionExpression" : "<p>The template selection expression for the integration.</p>",
|
||||
"IntegrationResponse$TemplateSelectionExpression" : "<p>The template selection expressions for the integration response.</p>",
|
||||
"Route$ModelSelectionExpression" : "<p>The model selection expression for the route.</p>",
|
||||
"Route$RouteResponseSelectionExpression" : "<p>The route response selection expression for the route.</p>",
|
||||
"RouteResponse$ModelSelectionExpression" : "<p>Represents the model selection expression of a route response.</p>",
|
||||
"UpdateApiInput$ApiKeySelectionExpression" : "<p>An API key selection expression. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">API Key Selection Expressions</a>.</p>",
|
||||
"UpdateApiInput$RouteSelectionExpression" : "<p>The route selection expression for the API.</p>",
|
||||
"UpdateIntegrationInput$TemplateSelectionExpression" : "<p>The template selection expression for the integration.</p>",
|
||||
"UpdateIntegrationResponseInput$TemplateSelectionExpression" : "<p>The template selection expression for the integration response.</p>",
|
||||
"UpdateRouteInput$ModelSelectionExpression" : "<p>The model selection expression for the route.</p>",
|
||||
"UpdateRouteInput$RouteResponseSelectionExpression" : "<p>The route response selection expression for the route.</p>",
|
||||
"UpdateRouteResponseInput$ModelSelectionExpression" : "<p>The model selection expression for the route response.</p>"
|
||||
}
|
||||
},
|
||||
"SelectionKey" : {
|
||||
"base" : "<p>After evaulating a selection expression, the result is compared against one or\n more selection keys to find a matching key. See <a href=\"https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-selection-expressions.html#apigateway-websocket-api-apikey-selection-expressions\">Selection Expressions</a> for a list of expressions and each expression's\n associated selection key type.</p>",
|
||||
"refs" : {
|
||||
"ApiMapping$ApiMappingKey" : "<p>The API mapping key.</p>",
|
||||
"CreateApiMappingInput$ApiMappingKey" : "",
|
||||
"CreateIntegrationResponseInput$IntegrationResponseKey" : "<p>The integration response key.</p>",
|
||||
"CreateRouteInput$RouteKey" : "<p>The route key for the route.</p>",
|
||||
"CreateRouteResponseInput$RouteResponseKey" : "<p>The route response key.</p>",
|
||||
"IntegrationResponse$IntegrationResponseKey" : "<p>The integration response key.</p>",
|
||||
"Route$RouteKey" : "<p>The route key for the route.</p>",
|
||||
"RouteResponse$RouteResponseKey" : "<p>Represents the route response key of a route response.</p>",
|
||||
"UpdateApiMappingInput$ApiMappingKey" : "<p>The API mapping key.</p>",
|
||||
"UpdateIntegrationResponseInput$IntegrationResponseKey" : "<p>The integration response key.</p>",
|
||||
"UpdateRouteInput$RouteKey" : "<p>The route key for the route.</p>",
|
||||
"UpdateRouteResponseInput$RouteResponseKey" : "<p>The route response key.</p>"
|
||||
}
|
||||
},
|
||||
"Stage" : {
|
||||
"base" : "<p>Represents an API stage.</p>",
|
||||
"refs" : {
|
||||
"__listOfStage$member" : null
|
||||
}
|
||||
},
|
||||
"StageVariablesMap" : {
|
||||
"base" : "<p>The stage variable map.</p>",
|
||||
"refs" : {
|
||||
"CreateStageInput$StageVariables" : "<p>A map that defines the stage variables for a Stage. Variable names\n can have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.</p>",
|
||||
"Stage$StageVariables" : "<p>A map that defines the stage variables for a stage resource. Variable names can\n have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.</p>",
|
||||
"UpdateStageInput$StageVariables" : "<p>A map that defines the stage variables for a Stage. Variable names\n can have alphanumeric and underscore characters, and the values must match\n [A-Za-z0-9-._~:/?#&=,]+.</p>"
|
||||
}
|
||||
},
|
||||
"Stages" : {
|
||||
"base" : "<p>A collection of Stage resources that are associated with the ApiKey\n resource.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"StringWithLengthBetween0And1024" : {
|
||||
"base" : "<p>A string with a length between [0-1024].</p>",
|
||||
"refs" : {
|
||||
"Api$Description" : "<p>The description of the API.</p>",
|
||||
"Authorizer$IdentityValidationExpression" : "<p>The\n validation expression does not apply to the REQUEST authorizer.</p>",
|
||||
"CreateApiInput$Description" : "<p>The description of the API.</p>",
|
||||
"CreateAuthorizerInput$IdentityValidationExpression" : "<p>The\n validation expression does not apply to the REQUEST authorizer.</p>",
|
||||
"CreateDeploymentInput$Description" : "<p>The description for the deployment resource.</p>",
|
||||
"CreateIntegrationInput$Description" : "<p>The description of the integration.</p>",
|
||||
"CreateModelInput$Description" : "<p>The description of the model.</p>",
|
||||
"CreateStageInput$Description" : "<p>The description for the API stage.</p>",
|
||||
"Deployment$Description" : "<p>The description for the deployment.</p>",
|
||||
"Integration$Description" : "<p>Represents the description of an integration.</p>",
|
||||
"Model$Description" : "<p>The description of the model.</p>",
|
||||
"Stage$Description" : "<p>The description of the stage.</p>",
|
||||
"UpdateApiInput$Description" : "<p>The description of the API.</p>",
|
||||
"UpdateAuthorizerInput$IdentityValidationExpression" : "<p>The\n validation expression does not apply to the REQUEST authorizer.</p>",
|
||||
"UpdateDeploymentInput$Description" : "<p>The description for the deployment resource.</p>",
|
||||
"UpdateIntegrationInput$Description" : "<p>The description of the integration</p>",
|
||||
"UpdateModelInput$Description" : "<p>The description of the model.</p>",
|
||||
"UpdateStageInput$Description" : "<p>The description for the API stage.</p>"
|
||||
}
|
||||
},
|
||||
"StringWithLengthBetween0And2048" : {
|
||||
"base" : "<p>A string with a length between [0-2048].</p>",
|
||||
"refs" : {
|
||||
"StageVariablesMap$member" : null
|
||||
}
|
||||
},
|
||||
"StringWithLengthBetween0And32K" : {
|
||||
"base" : "<p>A string with a length between [0-32768].</p>",
|
||||
"refs" : {
|
||||
"CreateModelInput$Schema" : "<p>The schema for the model. For application/json models, this should be JSON schema\n draft 4 model.</p>",
|
||||
"Model$Schema" : "<p>The schema for the model. For application/json models, this should be JSON schema\n draft 4 model.</p>",
|
||||
"TemplateMap$member" : null,
|
||||
"UpdateModelInput$Schema" : "<p>The schema for the model. For application/json models, this should be JSON schema\n draft 4 model.</p>"
|
||||
}
|
||||
},
|
||||
"StringWithLengthBetween1And1024" : {
|
||||
"base" : "<p>A string with a length between [1-1024].</p>",
|
||||
"refs" : {
|
||||
"AccessLogSettings$Format" : "<p>A single line format of the access logs of data, as specified by selected $context\n variables. The format must include at least $context.requestId.</p>",
|
||||
"CreateIntegrationInput$ConnectionId" : "<p>The connection ID.</p>",
|
||||
"Integration$ConnectionId" : "<p>The connection ID.</p>",
|
||||
"UpdateIntegrationInput$ConnectionId" : "<p>The connection ID.</p>"
|
||||
}
|
||||
},
|
||||
"StringWithLengthBetween1And128" : {
|
||||
"base" : "<p>A string with a length between [1-128].</p>",
|
||||
"refs" : {
|
||||
"Api$Name" : "<p>The name of the API.</p>",
|
||||
"ApiMapping$Stage" : "<p>The API stage.</p>",
|
||||
"Authorizer$Name" : "<p>The name of the authorizer.</p>",
|
||||
"CreateApiInput$Name" : "<p>The name of the API.</p>",
|
||||
"CreateApiMappingInput$Stage" : "<p>The API stage.</p>",
|
||||
"CreateAuthorizerInput$Name" : "<p>The name of the authorizer.</p>",
|
||||
"CreateDeploymentInput$StageName" : "<p>The name of the Stage resource for the Deployment\n resource to create.</p>",
|
||||
"CreateModelInput$Name" : "<p>The name of the model. Must be alphanumeric.</p>",
|
||||
"CreateRouteInput$Target" : "<p>The target for the route.</p>",
|
||||
"CreateStageInput$StageName" : "<p>The name of the stage.</p>",
|
||||
"DomainNameConfiguration$CertificateName" : "<p>The user-friendly name of the certificate that will be used by the edge-optimized\n endpoint for this domain name.</p>",
|
||||
"Model$Name" : "<p>The name of the model. Must be alphanumeric.</p>",
|
||||
"Route$Target" : "<p>The target for the route.</p>",
|
||||
"RouteModels$member" : null,
|
||||
"Stage$StageName" : "<p>The name of the stage.</p>",
|
||||
"UpdateApiInput$Name" : "<p>The name of the API.</p>",
|
||||
"UpdateApiMappingInput$Stage" : "<p>The API stage.</p>",
|
||||
"UpdateAuthorizerInput$Name" : "<p>The name of the authorizer.</p>",
|
||||
"UpdateModelInput$Name" : "<p>The name of the model.</p>",
|
||||
"UpdateRouteInput$Target" : "<p>The target for the route.</p>"
|
||||
}
|
||||
},
|
||||
"StringWithLengthBetween1And256" : {
|
||||
"base" : "<p>A string with a length between [1-256].</p>",
|
||||
"refs" : {
|
||||
"CreateModelInput$ContentType" : "<p>The content-type for the model, for example, \"application/json\".</p>",
|
||||
"Model$ContentType" : "<p>The content-type for the model, for example, \"application/json\".</p>",
|
||||
"UpdateModelInput$ContentType" : "<p>The content-type for the model, for example, \"application/json\".</p>"
|
||||
}
|
||||
},
|
||||
"StringWithLengthBetween1And512" : {
|
||||
"base" : "<p>A string with a length between [1-512].</p>",
|
||||
"refs" : {
|
||||
"CreateDomainNameInput$DomainName" : "<p>The domain name.</p>",
|
||||
"DomainName$DomainName" : "<p>The name of the DomainName resource.</p>",
|
||||
"IntegrationParameters$member" : null
|
||||
}
|
||||
},
|
||||
"StringWithLengthBetween1And64" : {
|
||||
"base" : "<p>A string with a length between [1-64].</p>",
|
||||
"refs" : {
|
||||
"Api$Version" : "<p>A version identifier for the API.</p>",
|
||||
"AuthorizationScopes$member" : null,
|
||||
"CreateApiInput$Version" : "<p>A version identifier for the API.</p>",
|
||||
"CreateIntegrationInput$IntegrationMethod" : "<p>Specifies the integration's HTTP method type.</p>",
|
||||
"CreateRouteInput$OperationName" : "<p>The operation name for the route.</p>",
|
||||
"Integration$IntegrationMethod" : "<p>Specifies the integration's HTTP method type.</p>",
|
||||
"Route$OperationName" : "<p>The operation name for the route.</p>",
|
||||
"UpdateApiInput$Version" : "<p>A version identifier for the API.</p>",
|
||||
"UpdateIntegrationInput$IntegrationMethod" : "<p>Specifies the integration's HTTP method type.</p>",
|
||||
"UpdateRouteInput$OperationName" : "<p>The operation name for the route.</p>"
|
||||
}
|
||||
},
|
||||
"TagResourceInput" : {
|
||||
"base" : "<p>Represents the input parameters for a TagResource request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"Tags" : {
|
||||
"base" : "<p>A key value pair of string with key length between[1-128] and value length between[1-256]</p>",
|
||||
"refs" : {
|
||||
"Api$Tags" : "<p>Tags for the API.</p>",
|
||||
"CreateApiInput$Tags" : "<p>Tags for the API.</p>",
|
||||
"CreateDomainNameInput$Tags" : "<p>Tags for the DomainName.</p>",
|
||||
"CreateStageInput$Tags" : "<p>Tags for the Stage.</p>",
|
||||
"DomainName$Tags" : "<p>Tags for the DomainName.</p>",
|
||||
"Stage$Tags" : "<p>Tags for the Stage.</p>",
|
||||
"TagResourceInput$Tags" : "<p>Tags for the resource arn.</p>"
|
||||
}
|
||||
},
|
||||
"StringWithLengthBetween1And1600" : {
|
||||
"base" : "<p>A string with a length between [1-1600].</p>",
|
||||
"refs" : {
|
||||
"Tags$member" : "<p>A tag for the resource.</p>"
|
||||
}
|
||||
},
|
||||
"Template" : {
|
||||
"base" : "<p>Represents a template.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"TemplateMap" : {
|
||||
"base" : "<p>A mapping of identifier keys to templates. The value is an actual template script.\n The key is typically a SelectionKey which is chosen based on evaluating\n a selection expression.</p>",
|
||||
"refs" : {
|
||||
"CreateIntegrationInput$RequestTemplates" : "<p>Represents a map of Velocity templates that are applied on the request payload\n based on the value of the Content-Type header sent by the client. The content type\n value is the key in this map, and the template (as a String) is the value.</p>",
|
||||
"CreateIntegrationResponseInput$ResponseTemplates" : "<p>The collection of response templates for the integration response as a\n string-to-string map of key-value pairs. Response templates are represented as a\n key/value map, with a content-type as the key and a template as the value.</p>",
|
||||
"Integration$RequestTemplates" : "<p>Represents a map of Velocity templates that are applied on the request payload\n based on the value of the Content-Type header sent by the client. The content type\n value is the key in this map, and the template (as a String) is the value.</p>",
|
||||
"IntegrationResponse$ResponseTemplates" : "<p>The collection of response templates for the integration response as a\n string-to-string map of key-value pairs. Response templates are represented as a\n key/value map, with a content-type as the key and a template as the value.</p>",
|
||||
"UpdateIntegrationInput$RequestTemplates" : "<p>Represents a map of Velocity templates that are applied on the request payload\n based on the value of the Content-Type header sent by the client. The content type\n value is the key in this map, and the template (as a String) is the value.</p>",
|
||||
"UpdateIntegrationResponseInput$ResponseTemplates" : "<p>The collection of response templates for the integration response as a\n string-to-string map of key-value pairs. Response templates are represented as a\n key/value map, with a content-type as the key and a template as the value.</p>"
|
||||
}
|
||||
},
|
||||
"TooManyRequestsException" : {
|
||||
"base" : "<p>A limit has been exceeded. See the accompanying error message for details.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"UpdateApiInput" : {
|
||||
"base" : "<p>Represents the input parameters for an UpdateApi request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"UpdateApiMappingInput" : {
|
||||
"base" : "<p>Represents the input parameters for an UpdateApiMapping\n request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"UpdateAuthorizerInput" : {
|
||||
"base" : "<p>The input parameters for an UpdateAuthorizer request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"UpdateDeploymentInput" : {
|
||||
"base" : "<p>Represents the input parameters for an UpdateDeployment\n request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"UpdateDomainNameInput" : {
|
||||
"base" : "<p>Represents the input parameters for an UpdateDomainName\n request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"UpdateIntegrationInput" : {
|
||||
"base" : "<p>Represents the input parameters for an UpdateIntegration\n request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"UpdateIntegrationResponseInput" : {
|
||||
"base" : "<p>Represents the input parameters for an UpdateIntegrationResponse\n request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"UpdateModelInput" : {
|
||||
"base" : "<p>Represents the input parameters for an UpdateModel request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"UpdateRouteInput" : {
|
||||
"base" : "<p>Represents the input parameters for an UpdateRoute request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"UpdateRouteResponseInput" : {
|
||||
"base" : "<p>Represents the input parameters for an UpdateRouteResponse\n request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"UpdateStageInput" : {
|
||||
"base" : "<p>Represents the input parameters for an UpdateStage request.</p>",
|
||||
"refs" : { }
|
||||
},
|
||||
"UriWithLengthBetween1And2048" : {
|
||||
"base" : "<p>A string representation of a URI with a length between [1-2048].</p>",
|
||||
"refs" : {
|
||||
"Authorizer$AuthorizerUri" : "<p>The authorizer's Uniform Resource Identifier (URI).\n ForREQUEST authorizers, this must be a\n well-formed Lambda function URI, for example,\n arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations.\n In general, the URI has this form:\n arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda\n function, path indicates that the remaining substring in the URI should be treated as\n the path to the resource, including the initial /. For Lambda functions,\n this is usually of the form\n /2015-03-31/functions/[FunctionARN]/invocations.</p>",
|
||||
"CreateAuthorizerInput$AuthorizerUri" : "<p>The authorizer's Uniform Resource Identifier (URI). For\n REQUEST authorizers, this must be a\n well-formed Lambda function URI, for example,\n arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations.\n In general, the URI has this form:\n arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda\n function, path indicates that the remaining substring in the URI should be treated as\n the path to the resource, including the initial /. For Lambda functions,\n this is usually of the form\n /2015-03-31/functions/[FunctionARN]/invocations.</p>",
|
||||
"CreateIntegrationInput$IntegrationUri" : "<p>For a Lambda proxy integration, this is the URI of the Lambda function.</p>",
|
||||
"Integration$IntegrationUri" : "<p>For a Lambda proxy integration, this is the URI of the Lambda function.</p>",
|
||||
"UpdateAuthorizerInput$AuthorizerUri" : "<p>The authorizer's Uniform Resource Identifier (URI). For\n REQUEST authorizers, this must be a\n well-formed Lambda function URI, for example,\n arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations.\n In general, the URI has this form:\n arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda\n function, path indicates that the remaining substring in the URI should be treated as\n the path to the resource, including the initial /. For Lambda functions,\n this is usually of the form\n /2015-03-31/functions/[FunctionARN]/invocations.</p>",
|
||||
"UpdateIntegrationInput$IntegrationUri" : "<p>For a Lambda proxy integration, this is the URI of the Lambda function.</p>"
|
||||
}
|
||||
},
|
||||
"__boolean" : {
|
||||
"base" : null,
|
||||
"refs" : {
|
||||
"Api$DisableSchemaValidation" : "<p>Avoid validating models when creating a deployment.</p>",
|
||||
"CreateApiInput$DisableSchemaValidation" : "<p>Avoid validating models when creating a deployment.</p>",
|
||||
"CreateRouteInput$ApiKeyRequired" : "<p>Specifies whether an API key is required for the route.</p>",
|
||||
"ParameterConstraints$Required" : "<p>Whether or not the parameter is required.</p>",
|
||||
"Route$ApiKeyRequired" : "<p>Specifies whether an API key is required for this route.</p>",
|
||||
"RouteSettings$DataTraceEnabled" : "<p>Specifies whether (true) or not (false) data trace\n logging is enabled for this route. This property affects the log entries pushed to\n Amazon CloudWatch Logs.</p>",
|
||||
"RouteSettings$DetailedMetricsEnabled" : "<p>Specifies whether detailed metrics are enabled.</p>",
|
||||
"UpdateApiInput$DisableSchemaValidation" : "<p>Avoid validating models when creating a deployment.</p>",
|
||||
"UpdateRouteInput$ApiKeyRequired" : "<p>Specifies whether an API key is required for the route.</p>"
|
||||
}
|
||||
},
|
||||
"__double" : {
|
||||
"base" : null,
|
||||
"refs" : {
|
||||
"RouteSettings$ThrottlingRateLimit" : "<p>Specifies the throttling rate limit.</p>"
|
||||
}
|
||||
},
|
||||
"__integer" : {
|
||||
"base" : null,
|
||||
"refs" : {
|
||||
"RouteSettings$ThrottlingBurstLimit" : "<p>Specifies the throttling burst limit.</p>"
|
||||
}
|
||||
},
|
||||
"__listOfApi" : {
|
||||
"base" : null,
|
||||
"refs" : {
|
||||
"Apis$Items" : "<p>The elements from this collection.</p>"
|
||||
}
|
||||
},
|
||||
"__listOfApiMapping" : {
|
||||
"base" : null,
|
||||
"refs" : {
|
||||
"ApiMappings$Items" : "<p>The elements from this collection.</p>"
|
||||
}
|
||||
},
|
||||
"__listOfAuthorizer" : {
|
||||
"base" : null,
|
||||
"refs" : {
|
||||
"Authorizers$Items" : "<p>The elements from this collection.</p>"
|
||||
}
|
||||
},
|
||||
"__listOfDeployment" : {
|
||||
"base" : null,
|
||||
"refs" : {
|
||||
"Deployments$Items" : "<p>The elements from this collection.</p>"
|
||||
}
|
||||
},
|
||||
"__listOfDomainName" : {
|
||||
"base" : null,
|
||||
"refs" : {
|
||||
"DomainNames$Items" : "<p>The elements from this collection.</p>"
|
||||
}
|
||||
},
|
||||
"__listOfIntegration" : {
|
||||
"base" : null,
|
||||
"refs" : {
|
||||
"Integrations$Items" : "<p>The elements from this collection.</p>"
|
||||
}
|
||||
},
|
||||
"__listOfIntegrationResponse" : {
|
||||
"base" : null,
|
||||
"refs" : {
|
||||
"IntegrationResponses$Items" : "<p>The elements from this collection.</p>"
|
||||
}
|
||||
},
|
||||
"__listOfModel" : {
|
||||
"base" : null,
|
||||
"refs" : {
|
||||
"Models$Items" : "<p>The elements from this collection.</p>"
|
||||
}
|
||||
},
|
||||
"__listOfRoute" : {
|
||||
"base" : null,
|
||||
"refs" : {
|
||||
"Routes$Items" : "<p>The elements from this collection.</p>"
|
||||
}
|
||||
},
|
||||
"__listOfRouteResponse" : {
|
||||
"base" : null,
|
||||
"refs" : {
|
||||
"RouteResponses$Items" : "<p>The elements from this collection.</p>"
|
||||
}
|
||||
},
|
||||
"__listOfStage" : {
|
||||
"base" : null,
|
||||
"refs" : {
|
||||
"Stages$Items" : "<p>The elements from this collection.</p>"
|
||||
}
|
||||
},
|
||||
"__listOf__string" : {
|
||||
"base" : null,
|
||||
"refs" : {
|
||||
"Api$Warnings" : "<p>The warning messages reported when failonwarnings is turned on during\n API import.</p>"
|
||||
}
|
||||
},
|
||||
"__string" : {
|
||||
"base" : null,
|
||||
"refs" : {
|
||||
"Api$ApiEndpoint" : "<p>The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The\n stage name is typically appended to this URI to form a complete path to a deployed\n API stage.</p>",
|
||||
"BadRequestException$Message" : "<p>Describes the error encountered.</p>",
|
||||
"ConflictException$Message" : "<p>Describes the error encountered.</p>",
|
||||
"Deployment$DeploymentStatusMessage" : "<p>May contain additional feedback on the status of an API deployment.</p>",
|
||||
"DomainNameConfiguration$ApiGatewayDomainName" : "<p>A domain name for the WebSocket API.</p>",
|
||||
"DomainNameConfiguration$HostedZoneId" : "<p>The Amazon Route 53 Hosted Zone ID of the endpoint.</p>",
|
||||
"DomainNameConfiguration$SecurityPolicy" : "<p>The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.</p>",
|
||||
"DomainNameConfiguration$DomainNameStatus" : "<p>The status of the domain name migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.</p>",
|
||||
"DomainNameConfiguration$DomainNameStatusMessage" : "<p>An optional text message containing detailed information about status of the domain name migration.</p>",
|
||||
"IdentitySourceList$member" : null,
|
||||
"LimitExceededException$LimitType" : "<p>The limit type.</p>",
|
||||
"LimitExceededException$Message" : "<p>Describes the error encountered.</p>",
|
||||
"NotFoundException$Message" : "<p>Describes the error encountered.</p>",
|
||||
"NotFoundException$ResourceType" : "<p>The resource type.</p>",
|
||||
"Template$Value" : "<p>The template value.</p>",
|
||||
"__listOf__string$member" : null
|
||||
}
|
||||
},
|
||||
"__timestampIso8601" : {
|
||||
"base" : null,
|
||||
"refs" : {
|
||||
"Api$CreatedDate" : "<p>The timestamp when the API was created.</p>",
|
||||
"Deployment$CreatedDate" : "<p>The date and time when the Deployment resource was created.</p>",
|
||||
"DomainNameConfiguration$CertificateUploadDate" : "<p>The timestamp when the certificate that was used by edge-optimized endpoint for\n this domain name was uploaded.</p>",
|
||||
"Stage$CreatedDate" : "<p>The timestamp when the stage was created.</p>",
|
||||
"Stage$LastUpdatedDate" : "<p>The timestamp when the stage was last updated.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+3
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"pagination" : { }
|
||||
}
|
||||
Generated
Vendored
+8
-4
@@ -240,7 +240,8 @@
|
||||
"required":[
|
||||
"ServiceNamespace",
|
||||
"ScheduledActionName",
|
||||
"ResourceId"
|
||||
"ResourceId",
|
||||
"ScalableDimension"
|
||||
],
|
||||
"members":{
|
||||
"ServiceNamespace":{"shape":"ServiceNamespace"},
|
||||
@@ -492,7 +493,8 @@
|
||||
"required":[
|
||||
"ServiceNamespace",
|
||||
"ScheduledActionName",
|
||||
"ResourceId"
|
||||
"ResourceId",
|
||||
"ScalableDimension"
|
||||
],
|
||||
"members":{
|
||||
"ServiceNamespace":{"shape":"ServiceNamespace"},
|
||||
@@ -563,7 +565,8 @@
|
||||
"dynamodb:index:ReadCapacityUnits",
|
||||
"dynamodb:index:WriteCapacityUnits",
|
||||
"rds:cluster:ReadReplicaCount",
|
||||
"sagemaker:variant:DesiredInstanceCount"
|
||||
"sagemaker:variant:DesiredInstanceCount",
|
||||
"custom-resource:ResourceType:Property"
|
||||
]
|
||||
},
|
||||
"ScalableTarget":{
|
||||
@@ -710,7 +713,8 @@
|
||||
"appstream",
|
||||
"dynamodb",
|
||||
"rds",
|
||||
"sagemaker"
|
||||
"sagemaker",
|
||||
"custom-resource"
|
||||
]
|
||||
},
|
||||
"StepAdjustment":{
|
||||
|
||||
Generated
Vendored
+76
-76
@@ -1,17 +1,17 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<p>With Application Auto Scaling, you can configure automatic scaling for your scalable AWS resources. You can use Application Auto Scaling to accomplish the following tasks:</p> <ul> <li> <p>Define scaling policies to automatically scale your AWS resources</p> </li> <li> <p>Scale your resources in response to CloudWatch alarms</p> </li> <li> <p>Schedule one-time or recurring scaling actions</p> </li> <li> <p>View the history of your scaling events</p> </li> </ul> <p>Application Auto Scaling can scale the following AWS resources:</p> <ul> <li> <p>Amazon ECS services. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html\">Service Auto Scaling</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </li> <li> <p>Amazon EC2 Spot fleets. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-auto-scaling.html\">Automatic Scaling for Spot Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p> </li> <li> <p>Amazon EMR clusters. For more information, see <a href=\"http://docs.aws.amazon.com/ElasticMapReduce/latest/ManagementGuide/emr-automatic-scaling.html\">Using Automatic Scaling in Amazon EMR</a> in the <i>Amazon EMR Management Guide</i>.</p> </li> <li> <p>AppStream 2.0 fleets. For more information, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/autoscaling.html\">Fleet Auto Scaling for Amazon AppStream 2.0</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p> </li> <li> <p>Provisioned read and write capacity for Amazon DynamoDB tables and global secondary indexes. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/AutoScaling.html\">Managing Throughput Capacity Automatically with DynamoDB Auto Scaling</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> </li> <li> <p>Amazon Aurora Replicas. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Integrating.AutoScaling.html\">Using Amazon Aurora Auto Scaling with Aurora Replicas</a>.</p> </li> <li> <p>Amazon SageMaker endpoints. For more information, see <a href=\"http://docs.aws.amazon.com/sagemaker/latest/dg/endpoint-auto-scaling.html\">Automatically Scaling Amazon SageMaker Models</a>.</p> </li> </ul> <p>To configure automatic scaling for multiple resources across multiple services, use AWS Auto Scaling to create a scaling plan for your application. For more information, see <a href=\"http://aws.amazon.com/autoscaling\">AWS Auto Scaling</a>.</p> <p>For a list of supported regions, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#as-app_region\">AWS Regions and Endpoints: Application Auto Scaling</a> in the <i>AWS General Reference</i>.</p>",
|
||||
"service": "<p>With Application Auto Scaling, you can configure automatic scaling for your scalable resources. You can use Application Auto Scaling to accomplish the following tasks:</p> <ul> <li> <p>Define scaling policies to automatically scale your AWS or custom resources</p> </li> <li> <p>Scale your resources in response to CloudWatch alarms</p> </li> <li> <p>Schedule one-time or recurring scaling actions</p> </li> <li> <p>View the history of your scaling events</p> </li> </ul> <p>Application Auto Scaling can scale the following resources:</p> <ul> <li> <p>Amazon ECS services. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html\">Service Auto Scaling</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </li> <li> <p>Amazon EC2 Spot fleets. For more information, see <a href=\"https://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=\"https://docs.aws.amazon.com/ElasticMapReduce/latest/ManagementGuide/emr-automatic-scaling.html\">Using Automatic Scaling in Amazon EMR</a> in the <i>Amazon EMR Management Guide</i>.</p> </li> <li> <p>AppStream 2.0 fleets. For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/autoscaling.html\">Fleet Auto Scaling for Amazon AppStream 2.0</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p> </li> <li> <p>Provisioned read and write capacity for Amazon DynamoDB tables and global secondary indexes. For more information, see <a href=\"https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/AutoScaling.html\">Managing Throughput Capacity Automatically with DynamoDB Auto Scaling</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> </li> <li> <p>Amazon Aurora Replicas. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Integrating.AutoScaling.html\">Using Amazon Aurora Auto Scaling with Aurora Replicas</a>.</p> </li> <li> <p>Amazon SageMaker endpoint variants. For more information, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/endpoint-auto-scaling.html\">Automatically Scaling Amazon SageMaker Models</a>.</p> </li> <li> <p>Custom resources provided by your own applications or services. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>. </p> </li> </ul> <p>To learn more about Application Auto Scaling, including information about granting IAM users required permissions for Application Auto Scaling actions, see the <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html\">Application Auto Scaling User Guide</a>.</p>",
|
||||
"operations": {
|
||||
"DeleteScalingPolicy": "<p>Deletes the specified Application Auto Scaling scaling policy.</p> <p>Deleting a policy deletes the underlying alarm action, but does not delete the CloudWatch alarm associated with the scaling policy, even if it no longer has an associated action.</p> <p>To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>.</p>",
|
||||
"DeleteScheduledAction": "<p>Deletes the specified Application Auto Scaling scheduled action.</p>",
|
||||
"DeregisterScalableTarget": "<p>Deregisters a scalable target.</p> <p>Deregistering a scalable target deletes the scaling policies that are associated with it.</p> <p>To create a scalable target or update an existing one, see <a>RegisterScalableTarget</a>.</p>",
|
||||
"DeregisterScalableTarget": "<p>Deregisters a scalable target.</p> <p>Deregistering a scalable target deletes the scaling policies that are associated with it.</p> <p>To create a scalable target or update an existing one, see <a>RegisterScalableTarget</a>. </p>",
|
||||
"DescribeScalableTargets": "<p>Gets information about the scalable targets in the specified namespace.</p> <p>You can filter the results using the <code>ResourceIds</code> and <code>ScalableDimension</code> parameters.</p> <p>To create a scalable target or update an existing one, see <a>RegisterScalableTarget</a>. If you are no longer using a scalable target, you can deregister it using <a>DeregisterScalableTarget</a>.</p>",
|
||||
"DescribeScalingActivities": "<p>Provides descriptive information about the scaling activities in the specified namespace from the previous six weeks.</p> <p>You can filter the results using the <code>ResourceId</code> and <code>ScalableDimension</code> parameters.</p> <p>Scaling activities are triggered by CloudWatch alarms that are associated with scaling policies. To view the scaling policies for a service namespace, see <a>DescribeScalingPolicies</a>. To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>.</p>",
|
||||
"DescribeScalingPolicies": "<p>Describes the scaling policies for the specified service namespace.</p> <p>You can filter the results using the <code>ResourceId</code>, <code>ScalableDimension</code>, and <code>PolicyNames</code> parameters.</p> <p>To create a scaling policy or update an existing one, see <a>PutScalingPolicy</a>. If you are no longer using a scaling policy, you can delete it using <a>DeleteScalingPolicy</a>.</p>",
|
||||
"DescribeScheduledActions": "<p>Describes the scheduled actions for the specified service namespace.</p> <p>You can filter the results using the <code>ResourceId</code>, <code>ScalableDimension</code>, and <code>ScheduledActionNames</code> parameters.</p> <p>To create a scheduled action or update an existing one, see <a>PutScheduledAction</a>. If you are no longer using a scheduled action, you can delete it using <a>DeleteScheduledAction</a>.</p>",
|
||||
"PutScalingPolicy": "<p>Creates or updates a policy for an Application Auto Scaling scalable target.</p> <p>Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you register the scalable target using <a>RegisterScalableTarget</a>.</p> <p>To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request.</p> <p>You can view the scaling policies for a service namespace using <a>DescribeScalingPolicies</a>. If you are no longer using a scaling policy, you can delete it using <a>DeleteScalingPolicy</a>.</p>",
|
||||
"PutScheduledAction": "<p>Creates or updates a scheduled action for an Application Auto Scaling scalable target.</p> <p>Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you register the scalable target using <a>RegisterScalableTarget</a>.</p> <p>To update an action, specify its name and the parameters that you want to change. If you don't specify start and end times, the old values are deleted. Any other parameters that you don't specify are not changed by this update request.</p> <p>You can view the scheduled actions using <a>DescribeScheduledActions</a>. If you are no longer using a scheduled action, you can delete it using <a>DeleteScheduledAction</a>.</p>",
|
||||
"RegisterScalableTarget": "<p>Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out or scale in. After you have registered a scalable target, you can use this operation to update the minimum and maximum values for its scalable dimension.</p> <p>After you register a scalable target, you can create and apply scaling policies using <a>PutScalingPolicy</a>. You can view the scaling policies for a service namespace using <a>DescribeScalableTargets</a>. If you no longer need a scalable target, you can deregister it using <a>DeregisterScalableTarget</a>.</p>"
|
||||
"PutScalingPolicy": "<p>Creates or updates a policy for an Application Auto Scaling scalable target.</p> <p>Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy until you have registered the resource as 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> <p>Multiple scaling policies can be in force at the same time for the same scalable target. You can have one or more target tracking scaling policies, one or more step scaling policies, or both. However, there is a chance that multiple policies could conflict, instructing the scalable target to scale out or in at the same time. Application Auto Scaling gives precedence to the policy that provides the largest capacity for both scale in and scale out. For example, if one policy increases capacity by 3, another policy increases capacity by 200 percent, and the current capacity is 10, Application Auto Scaling uses the policy with the highest calculated capacity (200% of 10 = 20) and scales out to 30. </p> <p>Learn more about how to work with scaling policies in the <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html\">Application Auto Scaling User Guide</a>.</p>",
|
||||
"PutScheduledAction": "<p>Creates or updates a scheduled action for an Application Auto Scaling scalable target.</p> <p>Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scheduled action applies to the scalable target identified by those three attributes. You cannot create a scheduled action until you have registered the resource as a scalable target using <a>RegisterScalableTarget</a>. </p> <p>To update an action, specify its name and the parameters that you want to change. If you don't specify start and end times, the old values are deleted. Any other parameters that you don't specify are not changed by this update request.</p> <p>You can view the scheduled actions using <a>DescribeScheduledActions</a>. If you are no longer using a scheduled action, you can delete it using <a>DeleteScheduledAction</a>.</p> <p>Learn more about how to work with scheduled actions in the <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/what-is-application-auto-scaling.html\">Application Auto Scaling User Guide</a>.</p>",
|
||||
"RegisterScalableTarget": "<p>Registers or updates a scalable target. A scalable target is a resource that Application Auto Scaling can scale out and scale in. Each scalable target has a resource ID, scalable dimension, and namespace, as well as values for minimum and maximum capacity. </p> <p>After you register a scalable target, you do not need to register it again to use other Application Auto Scaling operations. To see which resources have been registered, use <a>DescribeScalableTargets</a>. You can also view the scaling policies for a service namespace using <a>DescribeScalableTargets</a>. </p> <p>If you no longer need a scalable target, you can deregister it using <a>DeregisterScalableTarget</a>.</p>"
|
||||
},
|
||||
"shapes": {
|
||||
"AdjustmentType": {
|
||||
@@ -29,7 +29,7 @@
|
||||
"Alarms": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PutScalingPolicyResponse$Alarms": "<p>The CloudWatch alarms created for the target tracking policy.</p>",
|
||||
"PutScalingPolicyResponse$Alarms": "<p>The CloudWatch alarms created for the target tracking scaling policy.</p>",
|
||||
"ScalingPolicy$Alarms": "<p>The CloudWatch alarms associated with the scaling policy.</p>"
|
||||
}
|
||||
},
|
||||
@@ -41,15 +41,15 @@
|
||||
"Cooldown": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StepScalingPolicyConfiguration$Cooldown": "<p>The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.</p> <p>For scale out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the Cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.</p> <p>For scale in policies, the cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.</p>",
|
||||
"TargetTrackingScalingPolicyConfiguration$ScaleOutCooldown": "<p>The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.</p> <p>While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.</p>",
|
||||
"TargetTrackingScalingPolicyConfiguration$ScaleInCooldown": "<p>The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.</p> <p>The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.</p>"
|
||||
"StepScalingPolicyConfiguration$Cooldown": "<p>The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.</p> <p>For scale-out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale-out event are considered part of that capacity and only 1 additional task is added to the desired count.</p> <p>For scale-in policies, the cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.</p>",
|
||||
"TargetTrackingScalingPolicyConfiguration$ScaleOutCooldown": "<p>The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start.</p> <p>While the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.</p>",
|
||||
"TargetTrackingScalingPolicyConfiguration$ScaleInCooldown": "<p>The amount of time, in seconds, after a scale-in activity completes before another scale in activity can start.</p> <p>The cooldown period is used to block subsequent scale-in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.</p>"
|
||||
}
|
||||
},
|
||||
"CustomizedMetricSpecification": {
|
||||
"base": "<p>Configures a customized metric for a target tracking policy.</p>",
|
||||
"base": "<p>Represents a CloudWatch metric of your choosing for a target tracking scaling policy to use with Application Auto Scaling.</p> <p>To create your customized metric specification:</p> <ul> <li> <p>Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html\">Publish Custom Metrics</a> in the <i>Amazon CloudWatch User Guide</i>.</p> </li> <li> <p>Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases. </p> </li> </ul> <p>For more information about CloudWatch, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html\">Amazon CloudWatch Concepts</a>. </p>",
|
||||
"refs": {
|
||||
"TargetTrackingScalingPolicyConfiguration$CustomizedMetricSpecification": "<p>A customized metric.</p>"
|
||||
"TargetTrackingScalingPolicyConfiguration$CustomizedMetricSpecification": "<p>A customized metric. You can specify either a predefined metric or a customized metric.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteScalingPolicyRequest": {
|
||||
@@ -125,7 +125,7 @@
|
||||
"DisableScaleIn": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"TargetTrackingScalingPolicyConfiguration$DisableScaleIn": "<p>Indicates whether scale in by the target tracking policy is disabled. If the value is <code>true</code>, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is <code>false</code>.</p>"
|
||||
"TargetTrackingScalingPolicyConfiguration$DisableScaleIn": "<p>Indicates whether scale in by the target tracking scaling policy is disabled. If the value is <code>true</code>, scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. The default value is <code>false</code>.</p>"
|
||||
}
|
||||
},
|
||||
"ErrorMessage": {
|
||||
@@ -141,7 +141,7 @@
|
||||
}
|
||||
},
|
||||
"FailedResourceAccessException": {
|
||||
"base": "<p>Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have permission to call the CloudWatch <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html\">DescribeAlarms</a> on your behalf.</p>",
|
||||
"base": "<p>Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have permission to call the CloudWatch <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html\">DescribeAlarms</a> on your behalf.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -156,7 +156,7 @@
|
||||
}
|
||||
},
|
||||
"LimitExceededException": {
|
||||
"base": "<p>A per-account resource limit is exceeded. For more information, see <a href=\"http://docs.aws.amazon.com/ApplicationAutoScaling/latest/userguide/application-auto-scaling-limits.html\">Application Auto Scaling Limits</a>.</p>",
|
||||
"base": "<p>A per-account resource limit is exceeded. For more information, see <a href=\"https://docs.aws.amazon.com/ApplicationAutoScaling/latest/userguide/application-auto-scaling-limits.html\">Application Auto Scaling Limits</a>.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -172,11 +172,11 @@
|
||||
"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>"
|
||||
"StepScalingPolicyConfiguration$MetricAggregationType": "<p>The aggregation type for the CloudWatch metrics. Valid values are <code>Minimum</code>, <code>Maximum</code>, and <code>Average</code>. If the aggregation type is null, the value is treated as <code>Average</code>.</p>"
|
||||
}
|
||||
},
|
||||
"MetricDimension": {
|
||||
"base": "<p>Describes the dimension of a metric.</p>",
|
||||
"base": "<p>Describes the dimension names and values associated with a metric.</p>",
|
||||
"refs": {
|
||||
"MetricDimensions$member": null
|
||||
}
|
||||
@@ -196,13 +196,13 @@
|
||||
"MetricDimensions": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CustomizedMetricSpecification$Dimensions": "<p>The dimensions of the metric.</p>"
|
||||
"CustomizedMetricSpecification$Dimensions": "<p>The dimensions of the metric. </p> <p>Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.</p>"
|
||||
}
|
||||
},
|
||||
"MetricName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CustomizedMetricSpecification$MetricName": "<p>The name of the metric.</p>"
|
||||
"CustomizedMetricSpecification$MetricName": "<p>The name of the metric. </p>"
|
||||
}
|
||||
},
|
||||
"MetricNamespace": {
|
||||
@@ -240,7 +240,7 @@
|
||||
"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>"
|
||||
"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> <p>For example, suppose that you create a step scaling policy to scale out an Amazon ECS service by 25 percent and you specify a <code>MinAdjustmentMagnitude</code> of 2. If the service has 4 tasks and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a <code>MinAdjustmentMagnitude</code> of 2, Application Auto Scaling scales out the service by 2 tasks.</p>"
|
||||
}
|
||||
},
|
||||
"ObjectNotFoundException": {
|
||||
@@ -258,14 +258,14 @@
|
||||
"PolicyType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PutScalingPolicyRequest$PolicyType": "<p>The policy type. This parameter is required if you are creating a policy.</p> <p>For DynamoDB, only <code>TargetTrackingScaling</code> is supported. For Amazon ECS, Spot Fleet, and Amazon RDS, both <code>StepScaling</code> and <code>TargetTrackingScaling</code> are supported. For any other service, only <code>StepScaling</code> is supported.</p>",
|
||||
"PutScalingPolicyRequest$PolicyType": "<p>The policy type. This parameter is required if you are creating a scaling policy.</p> <p>For information on which services do not support <code>StepScaling</code> or <code>TargetTrackingScaling</code>, see the information about <b>Limits</b> in <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-step-scaling-policies.html\">Step Scaling Policies</a> and <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-target-tracking.html\">Target Tracking Scaling Policies</a> in the <i>Application Auto Scaling User Guide</i>.</p>",
|
||||
"ScalingPolicy$PolicyType": "<p>The scaling policy type.</p>"
|
||||
}
|
||||
},
|
||||
"PredefinedMetricSpecification": {
|
||||
"base": "<p>Configures a predefined metric for a target tracking policy.</p>",
|
||||
"base": "<p>Represents a predefined metric for a target tracking scaling policy to use with Application Auto Scaling.</p>",
|
||||
"refs": {
|
||||
"TargetTrackingScalingPolicyConfiguration$PredefinedMetricSpecification": "<p>A predefined metric.</p>"
|
||||
"TargetTrackingScalingPolicyConfiguration$PredefinedMetricSpecification": "<p>A predefined metric. You can specify either a predefined metric or a customized metric.</p>"
|
||||
}
|
||||
},
|
||||
"PutScalingPolicyRequest": {
|
||||
@@ -301,10 +301,10 @@
|
||||
"ResourceCapacity": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"RegisterScalableTargetRequest$MinCapacity": "<p>The minimum value to scale to in response to a scale in event. This parameter is required if you are registering a scalable target.</p>",
|
||||
"RegisterScalableTargetRequest$MaxCapacity": "<p>The maximum value to scale to in response to a scale out event. This parameter is required if you are registering a scalable target.</p>",
|
||||
"ScalableTarget$MinCapacity": "<p>The minimum value to scale to in response to a scale in event.</p>",
|
||||
"ScalableTarget$MaxCapacity": "<p>The maximum value to scale to in response to a scale out event.</p>",
|
||||
"RegisterScalableTargetRequest$MinCapacity": "<p>The minimum value to scale to in response to a scale-in event. This parameter is required to register a scalable target.</p>",
|
||||
"RegisterScalableTargetRequest$MaxCapacity": "<p>The maximum value to scale to in response to a scale-out event. This parameter is required to register a scalable target.</p>",
|
||||
"ScalableTarget$MinCapacity": "<p>The minimum value to scale to in response to a scale-in event.</p>",
|
||||
"ScalableTarget$MaxCapacity": "<p>The maximum value to scale to in response to a scale-out event.</p>",
|
||||
"ScalableTargetAction$MinCapacity": "<p>The minimum capacity.</p>",
|
||||
"ScalableTargetAction$MaxCapacity": "<p>The maximum capacity.</p>"
|
||||
}
|
||||
@@ -321,34 +321,34 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DeleteScalingPolicyRequest$PolicyName": "<p>The name of the scaling policy.</p>",
|
||||
"DeleteScalingPolicyRequest$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
|
||||
"DeleteScalingPolicyRequest$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>",
|
||||
"DeleteScheduledActionRequest$ScheduledActionName": "<p>The name of the scheduled action.</p>",
|
||||
"DeleteScheduledActionRequest$ResourceId": "<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
|
||||
"DeregisterScalableTargetRequest$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
|
||||
"DescribeScalingActivitiesRequest$ResourceId": "<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
|
||||
"DescribeScalingPoliciesRequest$ResourceId": "<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
|
||||
"DescribeScheduledActionsRequest$ResourceId": "<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
|
||||
"PutScalingPolicyRequest$ResourceId": "<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
|
||||
"DeleteScheduledActionRequest$ResourceId": "<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>",
|
||||
"DeregisterScalableTargetRequest$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>",
|
||||
"DescribeScalingActivitiesRequest$ResourceId": "<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>",
|
||||
"DescribeScalingPoliciesRequest$ResourceId": "<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>",
|
||||
"DescribeScheduledActionsRequest$ResourceId": "<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>",
|
||||
"PutScalingPolicyRequest$ResourceId": "<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>",
|
||||
"PutScalingPolicyResponse$PolicyARN": "<p>The Amazon Resource Name (ARN) of the resulting scaling policy.</p>",
|
||||
"PutScheduledActionRequest$Schedule": "<p>The schedule for this action. The following formats are supported:</p> <ul> <li> <p>At expressions - <code>at(<i>yyyy</i>-<i>mm</i>-<i>dd</i>T<i>hh</i>:<i>mm</i>:<i>ss</i>)</code> </p> </li> <li> <p>Rate expressions - <code>rate(<i>value</i> <i>unit</i>)</code> </p> </li> <li> <p>Cron expressions - <code>cron(<i>fields</i>)</code> </p> </li> </ul> <p>At expressions are useful for one-time schedules. Specify the time, in UTC.</p> <p>For rate expressions, <i>value</i> is a positive integer and <i>unit</i> is <code>minute</code> | <code>minutes</code> | <code>hour</code> | <code>hours</code> | <code>day</code> | <code>days</code>.</p> <p>For more information about cron expressions, see <a href=\"https://en.wikipedia.org/wiki/Cron\">Cron</a>.</p>",
|
||||
"PutScheduledActionRequest$ResourceId": "<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
|
||||
"RegisterScalableTargetRequest$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
|
||||
"RegisterScalableTargetRequest$RoleARN": "<p>Application Auto Scaling creates a service-linked role that grants it permissions to modify the scalable target on your behalf. For more information, see <a href=\"http://docs.aws.amazon.com/ApplicationAutoScaling/latest/APIReference/application-autoscaling-service-linked-roles.html\">Service-Linked Roles for Application Auto Scaling</a>.</p> <p>For resources that are not supported using a service-linked role, this parameter is required and must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.</p>",
|
||||
"PutScheduledActionRequest$Schedule": "<p>The schedule for this action. The following formats are supported:</p> <ul> <li> <p>At expressions - \"<code>at(<i>yyyy</i>-<i>mm</i>-<i>dd</i>T<i>hh</i>:<i>mm</i>:<i>ss</i>)</code>\"</p> </li> <li> <p>Rate expressions - \"<code>rate(<i>value</i> <i>unit</i>)</code>\"</p> </li> <li> <p>Cron expressions - \"<code>cron(<i>fields</i>)</code>\"</p> </li> </ul> <p>At expressions are useful for one-time schedules. Specify the time, in UTC.</p> <p>For rate expressions, <i>value</i> is a positive integer and <i>unit</i> is <code>minute</code> | <code>minutes</code> | <code>hour</code> | <code>hours</code> | <code>day</code> | <code>days</code>.</p> <p>For more information about cron expressions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions\">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p>",
|
||||
"PutScheduledActionRequest$ResourceId": "<p>The identifier of the resource associated with the scheduled action. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>",
|
||||
"RegisterScalableTargetRequest$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>",
|
||||
"RegisterScalableTargetRequest$RoleARN": "<p>Application Auto Scaling creates a service-linked role that grants it permissions to modify the scalable target on your behalf. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/application/userguide/application-auto-scaling-service-linked-roles.html\">Service-Linked Roles for Application Auto Scaling</a>.</p> <p>For resources that are not supported using a service-linked role, this parameter is required and must specify the ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.</p>",
|
||||
"ResourceIdsMaxLen1600$member": null,
|
||||
"ScalableTarget$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
|
||||
"ScalableTarget$ResourceId": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>",
|
||||
"ScalableTarget$RoleARN": "<p>The ARN of an IAM role that allows Application Auto Scaling to modify the scalable target on your behalf.</p>",
|
||||
"ScalingActivity$ResourceId": "<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
|
||||
"ScalingActivity$ResourceId": "<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>",
|
||||
"ScalingPolicy$PolicyARN": "<p>The Amazon Resource Name (ARN) of the scaling policy.</p>",
|
||||
"ScalingPolicy$ResourceId": "<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
|
||||
"ScalingPolicy$ResourceId": "<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>",
|
||||
"ScheduledAction$ScheduledActionARN": "<p>The Amazon Resource Name (ARN) of the scheduled action.</p>",
|
||||
"ScheduledAction$Schedule": "<p>The schedule for this action. The following formats are supported:</p> <ul> <li> <p>At expressions - <code>at(<i>yyyy</i>-<i>mm</i>-<i>dd</i>T<i>hh</i>:<i>mm</i>:<i>ss</i>)</code> </p> </li> <li> <p>Rate expressions - <code>rate(<i>value</i> <i>unit</i>)</code> </p> </li> <li> <p>Cron expressions - <code>cron(<i>fields</i>)</code> </p> </li> </ul> <p>At expressions are useful for one-time schedules. Specify the time, in UTC.</p> <p>For rate expressions, <i>value</i> is a positive integer and <i>unit</i> is <code>minute</code> | <code>minutes</code> | <code>hour</code> | <code>hours</code> | <code>day</code> | <code>days</code>.</p> <p>For more information about cron expressions, see <a href=\"https://en.wikipedia.org/wiki/Cron\">Cron</a>.</p>",
|
||||
"ScheduledAction$ResourceId": "<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>"
|
||||
"ScheduledAction$Schedule": "<p>The schedule for this action. The following formats are supported:</p> <ul> <li> <p>At expressions - \"<code>at(<i>yyyy</i>-<i>mm</i>-<i>dd</i>T<i>hh</i>:<i>mm</i>:<i>ss</i>)</code>\"</p> </li> <li> <p>Rate expressions - \"<code>rate(<i>value</i> <i>unit</i>)</code>\"</p> </li> <li> <p>Cron expressions - \"<code>cron(<i>fields</i>)</code>\"</p> </li> </ul> <p>At expressions are useful for one-time schedules. Specify the time, in UTC.</p> <p>For rate expressions, <i>value</i> is a positive integer and <i>unit</i> is <code>minute</code> | <code>minutes</code> | <code>hour</code> | <code>hours</code> | <code>day</code> | <code>days</code>.</p> <p>For more information about cron expressions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions\">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p>",
|
||||
"ScheduledAction$ResourceId": "<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"ResourceIdsMaxLen1600": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeScalableTargetsRequest$ResourceIds": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> </ul>",
|
||||
"DescribeScalableTargetsRequest$ResourceIds": "<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> <li> <p>Amazon SageMaker endpoint variants - The resource type is <code>variant</code> and the unique identifier is the resource ID. Example: <code>endpoint/my-end-point/variant/KMeansClustering</code>.</p> </li> <li> <p>Custom resources are not supported with a resource type. This parameter must specify the <code>OutputValue</code> from the CloudFormation template stack used to access the resources. The unique identifier is defined by the service provider. More information is available in our <a href=\"https://github.com/aws/aws-auto-scaling-custom-resource\">GitHub repository</a>.</p> </li> </ul>",
|
||||
"DescribeScalingPoliciesRequest$PolicyNames": "<p>The names of the scaling policies to describe.</p>",
|
||||
"DescribeScheduledActionsRequest$ScheduledActionNames": "<p>The names of the scheduled actions to describe.</p>"
|
||||
}
|
||||
@@ -362,20 +362,20 @@
|
||||
"ScalableDimension": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DeleteScalingPolicyRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
|
||||
"DeleteScheduledActionRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
|
||||
"DeregisterScalableTargetRequest$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
|
||||
"DescribeScalableTargetsRequest$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
|
||||
"DescribeScalingActivitiesRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
|
||||
"DescribeScalingPoliciesRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
|
||||
"DescribeScheduledActionsRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
|
||||
"PutScalingPolicyRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
|
||||
"PutScheduledActionRequest$ScalableDimension": "<p>The scalable dimension. This parameter is required if you are creating a scheduled action. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
|
||||
"RegisterScalableTargetRequest$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
|
||||
"ScalableTarget$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
|
||||
"ScalingActivity$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
|
||||
"ScalingPolicy$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>",
|
||||
"ScheduledAction$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> </ul>"
|
||||
"DeleteScalingPolicyRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>",
|
||||
"DeleteScheduledActionRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>",
|
||||
"DeregisterScalableTargetRequest$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>",
|
||||
"DescribeScalableTargetsRequest$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>",
|
||||
"DescribeScalingActivitiesRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>",
|
||||
"DescribeScalingPoliciesRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>",
|
||||
"DescribeScheduledActionsRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>",
|
||||
"PutScalingPolicyRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>",
|
||||
"PutScheduledActionRequest$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>",
|
||||
"RegisterScalableTargetRequest$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>",
|
||||
"ScalableTarget$ScalableDimension": "<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>",
|
||||
"ScalingActivity$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>",
|
||||
"ScalingPolicy$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>",
|
||||
"ScheduledAction$ScalableDimension": "<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> <li> <p> <code>sagemaker:variant:DesiredInstanceCount</code> - The number of EC2 instances for an Amazon SageMaker model endpoint variant.</p> </li> <li> <p> <code>custom-resource:ResourceType:Property</code> - The scalable dimension for a custom resource provided by your own application or service.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"ScalableTarget": {
|
||||
@@ -428,7 +428,7 @@
|
||||
}
|
||||
},
|
||||
"ScalingPolicy": {
|
||||
"base": "<p>Represents a scaling policy.</p>",
|
||||
"base": "<p>Represents a scaling policy to use with Application Auto Scaling.</p>",
|
||||
"refs": {
|
||||
"ScalingPolicies$member": null
|
||||
}
|
||||
@@ -455,20 +455,20 @@
|
||||
"ServiceNamespace": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DeleteScalingPolicyRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"DeleteScheduledActionRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"DeregisterScalableTargetRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"DescribeScalableTargetsRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"DescribeScalingActivitiesRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"DescribeScalingPoliciesRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"DescribeScheduledActionsRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"PutScalingPolicyRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"PutScheduledActionRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"RegisterScalableTargetRequest$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"ScalableTarget$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"ScalingActivity$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"ScalingPolicy$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"ScheduledAction$ServiceNamespace": "<p>The namespace of the AWS service. For more information, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>"
|
||||
"DeleteScalingPolicyRequest$ServiceNamespace": "<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"DeleteScheduledActionRequest$ServiceNamespace": "<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://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 that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://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 that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://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 that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://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 that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"DescribeScheduledActionsRequest$ServiceNamespace": "<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://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 that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"PutScheduledActionRequest$ServiceNamespace": "<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://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 that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://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 that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://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 that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://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 that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#genref-aws-service-namespaces\">AWS Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>",
|
||||
"ScheduledAction$ServiceNamespace": "<p>The namespace of the AWS service that provides the resource or <code>custom-resource</code> for a resource provided by your own application or service. For more information, see <a href=\"https://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": {
|
||||
@@ -484,17 +484,17 @@
|
||||
}
|
||||
},
|
||||
"StepScalingPolicyConfiguration": {
|
||||
"base": "<p>Represents a step scaling policy configuration.</p>",
|
||||
"base": "<p>Represents a step scaling policy configuration to use with Application Auto Scaling.</p>",
|
||||
"refs": {
|
||||
"PutScalingPolicyRequest$StepScalingPolicyConfiguration": "<p>A step scaling policy.</p> <p>This parameter is required if you are creating a policy and the policy type is <code>StepScaling</code>.</p>",
|
||||
"ScalingPolicy$StepScalingPolicyConfiguration": "<p>A step scaling policy.</p>"
|
||||
}
|
||||
},
|
||||
"TargetTrackingScalingPolicyConfiguration": {
|
||||
"base": "<p>Represents a target tracking scaling policy configuration.</p>",
|
||||
"base": "<p>Represents a target tracking scaling policy configuration to use with Application Auto Scaling.</p>",
|
||||
"refs": {
|
||||
"PutScalingPolicyRequest$TargetTrackingScalingPolicyConfiguration": "<p>A target tracking policy.</p> <p>This parameter is required if you are creating a policy and the policy type is <code>TargetTrackingScaling</code>.</p>",
|
||||
"ScalingPolicy$TargetTrackingScalingPolicyConfiguration": "<p>A target tracking policy.</p>"
|
||||
"PutScalingPolicyRequest$TargetTrackingScalingPolicyConfiguration": "<p>A target tracking scaling policy. Includes support for predefined or customized metrics.</p> <p>This parameter is required if you are creating a policy and the policy type is <code>TargetTrackingScaling</code>.</p>",
|
||||
"ScalingPolicy$TargetTrackingScalingPolicyConfiguration": "<p>A target tracking scaling policy.</p>"
|
||||
}
|
||||
},
|
||||
"TimestampType": {
|
||||
|
||||
Generated
Vendored
+684
@@ -0,0 +1,684 @@
|
||||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"apiVersion":"2018-11-25",
|
||||
"endpointPrefix":"applicationinsights",
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceAbbreviation":"Application Insights",
|
||||
"serviceFullName":"Amazon CloudWatch Application Insights",
|
||||
"serviceId":"Application Insights",
|
||||
"signatureVersion":"v4",
|
||||
"signingName":"applicationinsights",
|
||||
"targetPrefix":"EC2WindowsBarleyService",
|
||||
"uid":"application-insights-2018-11-25"
|
||||
},
|
||||
"operations":{
|
||||
"CreateApplication":{
|
||||
"name":"CreateApplication",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateApplicationRequest"},
|
||||
"output":{"shape":"CreateApplicationResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceInUseException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"CreateComponent":{
|
||||
"name":"CreateComponent",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateComponentRequest"},
|
||||
"output":{"shape":"CreateComponentResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceInUseException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"DeleteApplication":{
|
||||
"name":"DeleteApplication",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteApplicationRequest"},
|
||||
"output":{"shape":"DeleteApplicationResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"DeleteComponent":{
|
||||
"name":"DeleteComponent",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteComponentRequest"},
|
||||
"output":{"shape":"DeleteComponentResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"DescribeApplication":{
|
||||
"name":"DescribeApplication",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeApplicationRequest"},
|
||||
"output":{"shape":"DescribeApplicationResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"DescribeComponent":{
|
||||
"name":"DescribeComponent",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeComponentRequest"},
|
||||
"output":{"shape":"DescribeComponentResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"DescribeComponentConfiguration":{
|
||||
"name":"DescribeComponentConfiguration",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeComponentConfigurationRequest"},
|
||||
"output":{"shape":"DescribeComponentConfigurationResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"DescribeComponentConfigurationRecommendation":{
|
||||
"name":"DescribeComponentConfigurationRecommendation",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeComponentConfigurationRecommendationRequest"},
|
||||
"output":{"shape":"DescribeComponentConfigurationRecommendationResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"DescribeObservation":{
|
||||
"name":"DescribeObservation",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeObservationRequest"},
|
||||
"output":{"shape":"DescribeObservationResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"DescribeProblem":{
|
||||
"name":"DescribeProblem",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeProblemRequest"},
|
||||
"output":{"shape":"DescribeProblemResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"DescribeProblemObservations":{
|
||||
"name":"DescribeProblemObservations",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeProblemObservationsRequest"},
|
||||
"output":{"shape":"DescribeProblemObservationsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"ListApplications":{
|
||||
"name":"ListApplications",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListApplicationsRequest"},
|
||||
"output":{"shape":"ListApplicationsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"ListComponents":{
|
||||
"name":"ListComponents",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListComponentsRequest"},
|
||||
"output":{"shape":"ListComponentsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"ListProblems":{
|
||||
"name":"ListProblems",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListProblemsRequest"},
|
||||
"output":{"shape":"ListProblemsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"UpdateComponent":{
|
||||
"name":"UpdateComponent",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateComponentRequest"},
|
||||
"output":{"shape":"UpdateComponentResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceInUseException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
},
|
||||
"UpdateComponentConfiguration":{
|
||||
"name":"UpdateComponentConfiguration",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateComponentConfigurationRequest"},
|
||||
"output":{"shape":"UpdateComponentConfigurationResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InternalServerException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AffectedResource":{"type":"string"},
|
||||
"ApplicationComponent":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ComponentName":{"shape":"ComponentName"},
|
||||
"ResourceType":{"shape":"ResourceType"},
|
||||
"Tier":{"shape":"Tier"},
|
||||
"Monitor":{"shape":"Monitor"}
|
||||
}
|
||||
},
|
||||
"ApplicationComponentList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ApplicationComponent"}
|
||||
},
|
||||
"ApplicationInfo":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ResourceGroupName":{"shape":"ResourceGroupName"},
|
||||
"LifeCycle":{"shape":"LifeCycle"},
|
||||
"Remarks":{"shape":"Remarks"}
|
||||
}
|
||||
},
|
||||
"ApplicationInfoList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ApplicationInfo"}
|
||||
},
|
||||
"BadRequestException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMsg"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ComponentConfiguration":{"type":"string"},
|
||||
"ComponentName":{"type":"string"},
|
||||
"CreateApplicationRequest":{
|
||||
"type":"structure",
|
||||
"required":["ResourceGroupName"],
|
||||
"members":{
|
||||
"ResourceGroupName":{"shape":"ResourceGroupName"}
|
||||
}
|
||||
},
|
||||
"CreateApplicationResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ApplicationInfo":{"shape":"ApplicationInfo"}
|
||||
}
|
||||
},
|
||||
"CreateComponentRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResourceGroupName",
|
||||
"ComponentName",
|
||||
"ResourceList"
|
||||
],
|
||||
"members":{
|
||||
"ResourceGroupName":{"shape":"ResourceGroupName"},
|
||||
"ComponentName":{"shape":"ComponentName"},
|
||||
"ResourceList":{"shape":"ResourceList"}
|
||||
}
|
||||
},
|
||||
"CreateComponentResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteApplicationRequest":{
|
||||
"type":"structure",
|
||||
"required":["ResourceGroupName"],
|
||||
"members":{
|
||||
"ResourceGroupName":{"shape":"ResourceGroupName"}
|
||||
}
|
||||
},
|
||||
"DeleteApplicationResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteComponentRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResourceGroupName",
|
||||
"ComponentName"
|
||||
],
|
||||
"members":{
|
||||
"ResourceGroupName":{"shape":"ResourceGroupName"},
|
||||
"ComponentName":{"shape":"ComponentName"}
|
||||
}
|
||||
},
|
||||
"DeleteComponentResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DescribeApplicationRequest":{
|
||||
"type":"structure",
|
||||
"required":["ResourceGroupName"],
|
||||
"members":{
|
||||
"ResourceGroupName":{"shape":"ResourceGroupName"}
|
||||
}
|
||||
},
|
||||
"DescribeApplicationResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ApplicationInfo":{"shape":"ApplicationInfo"}
|
||||
}
|
||||
},
|
||||
"DescribeComponentConfigurationRecommendationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResourceGroupName",
|
||||
"ComponentName",
|
||||
"Tier"
|
||||
],
|
||||
"members":{
|
||||
"ResourceGroupName":{"shape":"ResourceGroupName"},
|
||||
"ComponentName":{"shape":"ComponentName"},
|
||||
"Tier":{"shape":"Tier"}
|
||||
}
|
||||
},
|
||||
"DescribeComponentConfigurationRecommendationResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ComponentConfiguration":{"shape":"ComponentConfiguration"}
|
||||
}
|
||||
},
|
||||
"DescribeComponentConfigurationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResourceGroupName",
|
||||
"ComponentName"
|
||||
],
|
||||
"members":{
|
||||
"ResourceGroupName":{"shape":"ResourceGroupName"},
|
||||
"ComponentName":{"shape":"ComponentName"}
|
||||
}
|
||||
},
|
||||
"DescribeComponentConfigurationResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Monitor":{"shape":"Monitor"},
|
||||
"Tier":{"shape":"Tier"},
|
||||
"ComponentConfiguration":{"shape":"ComponentConfiguration"}
|
||||
}
|
||||
},
|
||||
"DescribeComponentRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResourceGroupName",
|
||||
"ComponentName"
|
||||
],
|
||||
"members":{
|
||||
"ResourceGroupName":{"shape":"ResourceGroupName"},
|
||||
"ComponentName":{"shape":"ComponentName"}
|
||||
}
|
||||
},
|
||||
"DescribeComponentResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ApplicationComponent":{"shape":"ApplicationComponent"},
|
||||
"ResourceList":{"shape":"ResourceList"}
|
||||
}
|
||||
},
|
||||
"DescribeObservationRequest":{
|
||||
"type":"structure",
|
||||
"required":["ObservationId"],
|
||||
"members":{
|
||||
"ObservationId":{"shape":"ObservationId"}
|
||||
}
|
||||
},
|
||||
"DescribeObservationResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Observation":{"shape":"Observation"}
|
||||
}
|
||||
},
|
||||
"DescribeProblemObservationsRequest":{
|
||||
"type":"structure",
|
||||
"required":["ProblemId"],
|
||||
"members":{
|
||||
"ProblemId":{"shape":"ProblemId"}
|
||||
}
|
||||
},
|
||||
"DescribeProblemObservationsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"RelatedObservations":{"shape":"RelatedObservations"}
|
||||
}
|
||||
},
|
||||
"DescribeProblemRequest":{
|
||||
"type":"structure",
|
||||
"required":["ProblemId"],
|
||||
"members":{
|
||||
"ProblemId":{"shape":"ProblemId"}
|
||||
}
|
||||
},
|
||||
"DescribeProblemResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Problem":{"shape":"Problem"}
|
||||
}
|
||||
},
|
||||
"EndTime":{"type":"timestamp"},
|
||||
"ErrorMsg":{"type":"string"},
|
||||
"Feedback":{
|
||||
"type":"map",
|
||||
"key":{"shape":"FeedbackKey"},
|
||||
"value":{"shape":"FeedbackValue"},
|
||||
"max":10
|
||||
},
|
||||
"FeedbackKey":{
|
||||
"type":"string",
|
||||
"enum":["INSIGHTS_FEEDBACK"]
|
||||
},
|
||||
"FeedbackValue":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"NOT_SPECIFIED",
|
||||
"USEFUL",
|
||||
"NOT_USEFUL"
|
||||
]
|
||||
},
|
||||
"Insights":{"type":"string"},
|
||||
"InternalServerException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMsg"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"LifeCycle":{"type":"string"},
|
||||
"LineTime":{"type":"timestamp"},
|
||||
"ListApplicationsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"MaxResults":{"shape":"MaxEntities"},
|
||||
"NextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListApplicationsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ApplicationInfoList":{"shape":"ApplicationInfoList"},
|
||||
"NextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListComponentsRequest":{
|
||||
"type":"structure",
|
||||
"required":["ResourceGroupName"],
|
||||
"members":{
|
||||
"ResourceGroupName":{"shape":"ResourceGroupName"},
|
||||
"MaxResults":{"shape":"MaxEntities"},
|
||||
"NextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListComponentsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ApplicationComponentList":{"shape":"ApplicationComponentList"},
|
||||
"NextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListProblemsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ResourceGroupName":{"shape":"ResourceGroupName"},
|
||||
"StartTime":{"shape":"StartTime"},
|
||||
"EndTime":{"shape":"EndTime"},
|
||||
"MaxResults":{"shape":"MaxEntities"},
|
||||
"NextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListProblemsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ProblemList":{"shape":"ProblemList"},
|
||||
"NextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"LogFilter":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ERROR",
|
||||
"WARN",
|
||||
"INFO"
|
||||
]
|
||||
},
|
||||
"LogGroup":{"type":"string"},
|
||||
"LogText":{"type":"string"},
|
||||
"MaxEntities":{
|
||||
"type":"integer",
|
||||
"max":40,
|
||||
"min":1
|
||||
},
|
||||
"MetricName":{"type":"string"},
|
||||
"MetricNamespace":{"type":"string"},
|
||||
"Monitor":{"type":"boolean"},
|
||||
"NewComponentName":{"type":"string"},
|
||||
"Observation":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Id":{"shape":"ObservationId"},
|
||||
"StartTime":{"shape":"StartTime"},
|
||||
"EndTime":{"shape":"EndTime"},
|
||||
"SourceType":{"shape":"SourceType"},
|
||||
"SourceARN":{"shape":"SourceARN"},
|
||||
"LogGroup":{"shape":"LogGroup"},
|
||||
"LineTime":{"shape":"LineTime"},
|
||||
"LogText":{"shape":"LogText"},
|
||||
"LogFilter":{"shape":"LogFilter"},
|
||||
"MetricNamespace":{"shape":"MetricNamespace"},
|
||||
"MetricName":{"shape":"MetricName"},
|
||||
"Unit":{"shape":"Unit"},
|
||||
"Value":{"shape":"Value"}
|
||||
}
|
||||
},
|
||||
"ObservationId":{"type":"string"},
|
||||
"ObservationList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Observation"}
|
||||
},
|
||||
"PaginationToken":{"type":"string"},
|
||||
"Problem":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Id":{"shape":"ProblemId"},
|
||||
"Title":{"shape":"Title"},
|
||||
"Insights":{"shape":"Insights"},
|
||||
"Status":{"shape":"Status"},
|
||||
"AffectedResource":{"shape":"AffectedResource"},
|
||||
"StartTime":{"shape":"StartTime"},
|
||||
"EndTime":{"shape":"EndTime"},
|
||||
"SeverityLevel":{"shape":"SeverityLevel"},
|
||||
"ResourceGroupName":{"shape":"ResourceGroupName"},
|
||||
"Feedback":{"shape":"Feedback"}
|
||||
}
|
||||
},
|
||||
"ProblemId":{"type":"string"},
|
||||
"ProblemList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Problem"}
|
||||
},
|
||||
"RelatedObservations":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ObservationList":{"shape":"ObservationList"}
|
||||
}
|
||||
},
|
||||
"Remarks":{"type":"string"},
|
||||
"ResourceARN":{"type":"string"},
|
||||
"ResourceGroupName":{"type":"string"},
|
||||
"ResourceInUseException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMsg"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ResourceList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ResourceARN"}
|
||||
},
|
||||
"ResourceNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMsg"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ResourceType":{"type":"string"},
|
||||
"SeverityLevel":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"LOW",
|
||||
"MEDIUM",
|
||||
"HIGH"
|
||||
]
|
||||
},
|
||||
"SourceARN":{"type":"string"},
|
||||
"SourceType":{"type":"string"},
|
||||
"StartTime":{"type":"timestamp"},
|
||||
"Status":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"IGNORE",
|
||||
"RESOLVED",
|
||||
"PENDING"
|
||||
]
|
||||
},
|
||||
"Tier":{"type":"string"},
|
||||
"Title":{"type":"string"},
|
||||
"Unit":{"type":"string"},
|
||||
"UpdateComponentConfigurationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResourceGroupName",
|
||||
"ComponentName"
|
||||
],
|
||||
"members":{
|
||||
"ResourceGroupName":{"shape":"ResourceGroupName"},
|
||||
"ComponentName":{"shape":"ComponentName"},
|
||||
"Monitor":{"shape":"Monitor"},
|
||||
"Tier":{"shape":"Tier"},
|
||||
"ComponentConfiguration":{"shape":"ComponentConfiguration"}
|
||||
}
|
||||
},
|
||||
"UpdateComponentConfigurationResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"UpdateComponentRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResourceGroupName",
|
||||
"ComponentName"
|
||||
],
|
||||
"members":{
|
||||
"ResourceGroupName":{"shape":"ResourceGroupName"},
|
||||
"ComponentName":{"shape":"ComponentName"},
|
||||
"NewComponentName":{"shape":"NewComponentName"},
|
||||
"ResourceList":{"shape":"ResourceList"}
|
||||
}
|
||||
},
|
||||
"UpdateComponentResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"ValidationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMsg"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"Value":{"type":"double"}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+531
@@ -0,0 +1,531 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<fullname>Amazon CloudWatch Application Insights for .NET and SQL Server</fullname> <p> Amazon CloudWatch Application Insights for .NET and SQL Server is a service that helps you detect common problems with your .NET and SQL Server-based applications. It enables you to pinpoint the source of issues in your applications (built with technologies such as Microsoft IIS, .NET, and Microsoft SQL Server), by providing key insights into detected problems.</p> <p>After you onboard your application, CloudWatch Application Insights for .NET and SQL Server identifies, recommends, and sets up metrics and logs. It continuously analyzes and correlates your metrics and logs for unusual behavior to surface actionable problems with your application. For example, if your application is slow and unresponsive and leading to HTTP 500 errors in your Application Load Balancer (ALB), Application Insights informs you that a memory pressure problem with your SQL Server database is occurring. It bases this analysis on impactful metrics and log errors. </p>",
|
||||
"operations": {
|
||||
"CreateApplication": "<p>Adds an application that is created from a resource group.</p>",
|
||||
"CreateComponent": "<p>Creates a custom component by grouping similar standalone instances to monitor.</p>",
|
||||
"DeleteApplication": "<p>Removes the specified application from monitoring. Does not delete the application.</p>",
|
||||
"DeleteComponent": "<p>Ungroups a custom component. When you ungroup custom components, all applicable monitors that are set up for the component are removed and the instances revert to their standalone status.</p>",
|
||||
"DescribeApplication": "<p>Describes the application.</p>",
|
||||
"DescribeComponent": "<p>Describes a component and lists the resources that are grouped together in a component.</p>",
|
||||
"DescribeComponentConfiguration": "<p>Describes the monitoring configuration of the component.</p>",
|
||||
"DescribeComponentConfigurationRecommendation": "<p>Describes the recommended monitoring configuration of the component.</p>",
|
||||
"DescribeObservation": "<p>Describes an anomaly or error with the application.</p>",
|
||||
"DescribeProblem": "<p>Describes an application problem.</p>",
|
||||
"DescribeProblemObservations": "<p>Describes the anomalies or errors associated with the problem.</p>",
|
||||
"ListApplications": "<p>Lists the IDs of the applications that you are monitoring. </p>",
|
||||
"ListComponents": "<p>Lists the auto-grouped, standalone, and custom components of the application.</p>",
|
||||
"ListProblems": "<p>Lists the problems with your application.</p>",
|
||||
"UpdateComponent": "<p>Updates the custom component name and/or the list of resources that make up the component.</p>",
|
||||
"UpdateComponentConfiguration": "<p>Updates the monitoring configurations for the component. The configuration input parameter is an escaped JSON of the configuration and should match the schema of what is returned by <code>DescribeComponentConfigurationRecommendation</code>.</p>"
|
||||
},
|
||||
"shapes": {
|
||||
"AffectedResource": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Problem$AffectedResource": "<p>The resource affected by the problem.</p>"
|
||||
}
|
||||
},
|
||||
"ApplicationComponent": {
|
||||
"base": "<p>Describes a standalone resource or similarly grouped resources that the application is made up of.</p>",
|
||||
"refs": {
|
||||
"ApplicationComponentList$member": null,
|
||||
"DescribeComponentResponse$ApplicationComponent": null
|
||||
}
|
||||
},
|
||||
"ApplicationComponentList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListComponentsResponse$ApplicationComponentList": "<p>The list of application components.</p>"
|
||||
}
|
||||
},
|
||||
"ApplicationInfo": {
|
||||
"base": "<p>Describes the status of the application.</p>",
|
||||
"refs": {
|
||||
"ApplicationInfoList$member": null,
|
||||
"CreateApplicationResponse$ApplicationInfo": "<p>Information about the application.</p>",
|
||||
"DescribeApplicationResponse$ApplicationInfo": "<p>Information about the application.</p>"
|
||||
}
|
||||
},
|
||||
"ApplicationInfoList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListApplicationsResponse$ApplicationInfoList": "<p>The list of applications.</p>"
|
||||
}
|
||||
},
|
||||
"BadRequestException": {
|
||||
"base": "<p>The request is not understood by the server.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ComponentConfiguration": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeComponentConfigurationRecommendationResponse$ComponentConfiguration": "<p>The recommended configuration settings of the component. The value is the escaped JSON of the configuration.</p>",
|
||||
"DescribeComponentConfigurationResponse$ComponentConfiguration": "<p>The configuration settings of the component. The value is the escaped JSON of the configuration.</p>",
|
||||
"UpdateComponentConfigurationRequest$ComponentConfiguration": "<p>The configuration settings of the component. The value is the escaped JSON of the configuration. For more information about the JSON format, see <a href=\"https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/working-with-json.html\">Working with JSON</a>. You can send a request to <code>DescribeComponentConfigurationRecommendation</code> to see the recommended configuration for a component.</p>"
|
||||
}
|
||||
},
|
||||
"ComponentName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ApplicationComponent$ComponentName": "<p>The name of the component.</p>",
|
||||
"CreateComponentRequest$ComponentName": "<p>The name of the component.</p>",
|
||||
"DeleteComponentRequest$ComponentName": "<p>The name of the component.</p>",
|
||||
"DescribeComponentConfigurationRecommendationRequest$ComponentName": "<p>The name of the component.</p>",
|
||||
"DescribeComponentConfigurationRequest$ComponentName": "<p>The name of the component.</p>",
|
||||
"DescribeComponentRequest$ComponentName": "<p>The name of the component.</p>",
|
||||
"UpdateComponentConfigurationRequest$ComponentName": "<p>The name of the component.</p>",
|
||||
"UpdateComponentRequest$ComponentName": "<p>The name of the component.</p>"
|
||||
}
|
||||
},
|
||||
"CreateApplicationRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateApplicationResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateComponentRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateComponentResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteApplicationRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteApplicationResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteComponentRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteComponentResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeApplicationRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeApplicationResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeComponentConfigurationRecommendationRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeComponentConfigurationRecommendationResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeComponentConfigurationRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeComponentConfigurationResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeComponentRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeComponentResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeObservationRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeObservationResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeProblemObservationsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeProblemObservationsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeProblemRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeProblemResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"EndTime": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListProblemsRequest$EndTime": "<p>The time when the problem ended, in epoch seconds. If not specified, problems within the past seven days are returned.</p>",
|
||||
"Observation$EndTime": "<p>The time when the observation ended, in epoch seconds.</p>",
|
||||
"Problem$EndTime": "<p>The time when the problem ended, in epoch seconds.</p>"
|
||||
}
|
||||
},
|
||||
"ErrorMsg": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BadRequestException$Message": null,
|
||||
"InternalServerException$Message": null,
|
||||
"ResourceInUseException$Message": null,
|
||||
"ResourceNotFoundException$Message": null,
|
||||
"ValidationException$Message": null
|
||||
}
|
||||
},
|
||||
"Feedback": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Problem$Feedback": "<p>Feedback provided by the user about the problem.</p>"
|
||||
}
|
||||
},
|
||||
"FeedbackKey": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Feedback$key": null
|
||||
}
|
||||
},
|
||||
"FeedbackValue": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Feedback$value": null
|
||||
}
|
||||
},
|
||||
"Insights": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Problem$Insights": "<p>A detailed analysis of the problem using machine learning.</p>"
|
||||
}
|
||||
},
|
||||
"InternalServerException": {
|
||||
"base": "<p>The server encountered an internal error and is unable to complete the request.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"LifeCycle": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ApplicationInfo$LifeCycle": "<p>The lifecycle of the application. </p>"
|
||||
}
|
||||
},
|
||||
"LineTime": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Observation$LineTime": "<p>The timestamp in the CloudWatch Logs that specifies when the matched line occurred.</p>"
|
||||
}
|
||||
},
|
||||
"ListApplicationsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListApplicationsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListComponentsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListComponentsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListProblemsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListProblemsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"LogFilter": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Observation$LogFilter": "<p>The log filter of the observation.</p>"
|
||||
}
|
||||
},
|
||||
"LogGroup": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Observation$LogGroup": "<p>The log group name.</p>"
|
||||
}
|
||||
},
|
||||
"LogText": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Observation$LogText": "<p>The log text of the observation.</p>"
|
||||
}
|
||||
},
|
||||
"MaxEntities": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListApplicationsRequest$MaxResults": "<p>The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p>",
|
||||
"ListComponentsRequest$MaxResults": "<p>The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p>",
|
||||
"ListProblemsRequest$MaxResults": "<p>The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p>"
|
||||
}
|
||||
},
|
||||
"MetricName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Observation$MetricName": "<p>The name of the observation metric.</p>"
|
||||
}
|
||||
},
|
||||
"MetricNamespace": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Observation$MetricNamespace": "<p>The namespace of the observation metric.</p>"
|
||||
}
|
||||
},
|
||||
"Monitor": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ApplicationComponent$Monitor": "<p>Indicates whether the application component is monitored. </p>",
|
||||
"DescribeComponentConfigurationResponse$Monitor": "<p>Indicates whether the application component is monitored.</p>",
|
||||
"UpdateComponentConfigurationRequest$Monitor": "<p>Indicates whether the application component is monitored.</p>"
|
||||
}
|
||||
},
|
||||
"NewComponentName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"UpdateComponentRequest$NewComponentName": "<p>The new name of the component.</p>"
|
||||
}
|
||||
},
|
||||
"Observation": {
|
||||
"base": "<p>Describes an anomaly or error with the application.</p>",
|
||||
"refs": {
|
||||
"DescribeObservationResponse$Observation": "<p>Information about the observation.</p>",
|
||||
"ObservationList$member": null
|
||||
}
|
||||
},
|
||||
"ObservationId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeObservationRequest$ObservationId": "<p>The ID of the observation.</p>",
|
||||
"Observation$Id": "<p>The ID of the observation type.</p>"
|
||||
}
|
||||
},
|
||||
"ObservationList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"RelatedObservations$ObservationList": "<p>The list of observations related to the problem.</p>"
|
||||
}
|
||||
},
|
||||
"PaginationToken": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListApplicationsRequest$NextToken": "<p>The token to request the next page of results.</p>",
|
||||
"ListApplicationsResponse$NextToken": "<p>The token used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </p>",
|
||||
"ListComponentsRequest$NextToken": "<p>The token to request the next page of results.</p>",
|
||||
"ListComponentsResponse$NextToken": "<p>The token to request the next page of results.</p>",
|
||||
"ListProblemsRequest$NextToken": "<p>The token to request the next page of results.</p>",
|
||||
"ListProblemsResponse$NextToken": "<p>The token used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return. </p>"
|
||||
}
|
||||
},
|
||||
"Problem": {
|
||||
"base": "<p>Describes a problem that is detected by correlating observations.</p>",
|
||||
"refs": {
|
||||
"DescribeProblemResponse$Problem": "<p>Information about the problem. </p>",
|
||||
"ProblemList$member": null
|
||||
}
|
||||
},
|
||||
"ProblemId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeProblemObservationsRequest$ProblemId": "<p>The ID of the problem.</p>",
|
||||
"DescribeProblemRequest$ProblemId": "<p>The ID of the problem.</p>",
|
||||
"Problem$Id": "<p>The ID of the problem.</p>"
|
||||
}
|
||||
},
|
||||
"ProblemList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListProblemsResponse$ProblemList": "<p>The list of problems. </p>"
|
||||
}
|
||||
},
|
||||
"RelatedObservations": {
|
||||
"base": "<p>Describes observations related to the problem.</p>",
|
||||
"refs": {
|
||||
"DescribeProblemObservationsResponse$RelatedObservations": "<p>Observations related to the problem.</p>"
|
||||
}
|
||||
},
|
||||
"Remarks": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ApplicationInfo$Remarks": "<p>The issues on the user side that are blocking Application Insights from fully monitoring the application.</p>"
|
||||
}
|
||||
},
|
||||
"ResourceARN": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ResourceList$member": null
|
||||
}
|
||||
},
|
||||
"ResourceGroupName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ApplicationInfo$ResourceGroupName": "<p>The name of the resource group used for the application.</p>",
|
||||
"CreateApplicationRequest$ResourceGroupName": "<p>The name of the resource group.</p>",
|
||||
"CreateComponentRequest$ResourceGroupName": "<p>The name of the resource group.</p>",
|
||||
"DeleteApplicationRequest$ResourceGroupName": "<p>The name of the resource group.</p>",
|
||||
"DeleteComponentRequest$ResourceGroupName": "<p>The name of the resource group.</p>",
|
||||
"DescribeApplicationRequest$ResourceGroupName": "<p>The name of the resource group.</p>",
|
||||
"DescribeComponentConfigurationRecommendationRequest$ResourceGroupName": "<p>The name of the resource group.</p>",
|
||||
"DescribeComponentConfigurationRequest$ResourceGroupName": "<p>The name of the resource group.</p>",
|
||||
"DescribeComponentRequest$ResourceGroupName": "<p>The name of the resource group.</p>",
|
||||
"ListComponentsRequest$ResourceGroupName": "<p>The name of the resource group.</p>",
|
||||
"ListProblemsRequest$ResourceGroupName": "<p>The name of the resource group.</p>",
|
||||
"Problem$ResourceGroupName": "<p>The name of the resource group affected by the problem.</p>",
|
||||
"UpdateComponentConfigurationRequest$ResourceGroupName": "<p>The name of the resource group.</p>",
|
||||
"UpdateComponentRequest$ResourceGroupName": "<p>The name of the resource group.</p>"
|
||||
}
|
||||
},
|
||||
"ResourceInUseException": {
|
||||
"base": "<p>The resource is already created or in use.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ResourceList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateComponentRequest$ResourceList": "<p>The list of resource ARNs that belong to the component.</p>",
|
||||
"DescribeComponentResponse$ResourceList": "<p>The list of resource ARNs that belong to the component.</p>",
|
||||
"UpdateComponentRequest$ResourceList": "<p>The list of resource ARNs that belong to the component.</p>"
|
||||
}
|
||||
},
|
||||
"ResourceNotFoundException": {
|
||||
"base": "<p>The resource does not exist in the customer account.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ResourceType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ApplicationComponent$ResourceType": "<p>The resource type. Supported resource types include EC2 instances, Auto Scaling group, Classic ELB, Application ELB, and SQS Queue.</p>"
|
||||
}
|
||||
},
|
||||
"SeverityLevel": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Problem$SeverityLevel": "<p>A measure of the level of impact of the problem.</p>"
|
||||
}
|
||||
},
|
||||
"SourceARN": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Observation$SourceARN": "<p>The source resource ARN of the observation.</p>"
|
||||
}
|
||||
},
|
||||
"SourceType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Observation$SourceType": "<p>The source type of the observation.</p>"
|
||||
}
|
||||
},
|
||||
"StartTime": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListProblemsRequest$StartTime": "<p>The time when the problem was detected, in epoch seconds. If you don't specify a time frame for the request, problems within the past seven days are returned.</p>",
|
||||
"Observation$StartTime": "<p>The time when the observation was first detected, in epoch seconds.</p>",
|
||||
"Problem$StartTime": "<p>The time when the problem started, in epoch seconds.</p>"
|
||||
}
|
||||
},
|
||||
"Status": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Problem$Status": "<p>The status of the problem.</p>"
|
||||
}
|
||||
},
|
||||
"Tier": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ApplicationComponent$Tier": "<p>The stack tier of the application component.</p>",
|
||||
"DescribeComponentConfigurationRecommendationRequest$Tier": "<p>The tier of the application component. Supported tiers include <code>DOT_NET_WORKER</code>, <code>DOT_NET_WEB_TIER</code>, <code>SQL_SERVER</code>, and <code>DEFAULT</code>.</p>",
|
||||
"DescribeComponentConfigurationResponse$Tier": "<p>The tier of the application component. Supported tiers include <code>DOT_NET_WORKER</code>, <code>DOT_NET_WEB_TIER</code>, <code>SQL_SERVER</code>, and <code>DEFAULT</code> </p>",
|
||||
"UpdateComponentConfigurationRequest$Tier": "<p>The tier of the application component. Supported tiers include <code>DOT_NET_WORKER</code>, <code>DOT_NET_WEB_TIER</code>, <code>SQL_SERVER</code>, and <code>DEFAULT</code>.</p>"
|
||||
}
|
||||
},
|
||||
"Title": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Problem$Title": "<p>The name of the problem.</p>"
|
||||
}
|
||||
},
|
||||
"Unit": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Observation$Unit": "<p>The unit of the source observation metric.</p>"
|
||||
}
|
||||
},
|
||||
"UpdateComponentConfigurationRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateComponentConfigurationResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateComponentRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateComponentResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ValidationException": {
|
||||
"base": "<p>The parameter is not valid.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Value": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Observation$Value": "<p>The value of the source observation metric.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Generated
Vendored
+19
@@ -0,0 +1,19 @@
|
||||
{
|
||||
"pagination": {
|
||||
"ListApplications": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListComponents": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListProblems": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
}
|
||||
}
|
||||
}
|
||||
+3071
File diff suppressed because it is too large
Load Diff
+988
@@ -0,0 +1,988 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<p>AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and\n control microservices. App Mesh standardizes how your microservices communicate, giving you\n end-to-end visibility and helping to ensure high availability for your applications.</p>\n <p>App Mesh gives you consistent visibility and network traffic controls for every\n microservice in an application. You can use App Mesh with AWS Fargate, Amazon ECS, Amazon EKS,\n Kubernetes on AWS, and Amazon EC2.</p>\n <note>\n <p>App Mesh supports microservice applications that use service discovery naming for their\n components. For more information about service discovery on Amazon ECS, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html\">Service Discovery</a> in the\n <i>Amazon Elastic Container Service Developer Guide</i>. Kubernetes <code>kube-dns</code> and\n <code>coredns</code> are supported. For more information, see <a href=\"https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/\">DNS\n for Services and Pods</a> in the Kubernetes documentation.</p>\n </note>",
|
||||
"operations": {
|
||||
"CreateMesh": "<p>Creates a service mesh. A service mesh is a logical boundary for network traffic between\n the services that reside within it.</p>\n <p>After you create your service mesh, you can create virtual services, virtual nodes,\n virtual routers, and routes to distribute traffic between the applications in your\n mesh.</p>",
|
||||
"CreateRoute": "<p>Creates a route that is associated with a virtual router.</p>\n <p>You can use the <code>prefix</code> parameter in your route specification for path-based\n routing of requests. For example, if your virtual service name is\n <code>my-service.local</code> and you want the route to match requests to\n <code>my-service.local/metrics</code>, your prefix should be\n <code>/metrics</code>.</p>\n <p>If your route matches a request, you can distribute traffic to one or more target\n virtual nodes with relative weighting.</p>",
|
||||
"CreateVirtualNode": "<p>Creates a virtual node within a service mesh.</p>\n <p>A virtual node acts as a logical pointer to a particular task group, such as an Amazon ECS\n service or a Kubernetes deployment. When you create a virtual node, you can specify the\n service discovery information for your task group.</p>\n <p>Any inbound traffic that your virtual node expects should be specified as a\n <code>listener</code>. Any outbound traffic that your virtual node expects to reach\n should be specified as a <code>backend</code>.</p>\n <p>The response metadata for your new virtual node contains the <code>arn</code> that is\n associated with the virtual node. Set this value (either the full ARN or the truncated\n resource name: for example, <code>mesh/default/virtualNode/simpleapp</code>) as the\n <code>APPMESH_VIRTUAL_NODE_NAME</code> environment variable for your task group's Envoy\n proxy container in your task definition or pod spec. This is then mapped to the\n <code>node.id</code> and <code>node.cluster</code> Envoy parameters.</p>\n <note>\n <p>If you require your Envoy stats or tracing to use a different name, you can override\n the <code>node.cluster</code> value that is set by\n <code>APPMESH_VIRTUAL_NODE_NAME</code> with the\n <code>APPMESH_VIRTUAL_NODE_CLUSTER</code> environment variable.</p>\n </note>",
|
||||
"CreateVirtualRouter": "<p>Creates a virtual router within a service mesh.</p>\n <p>Any inbound traffic that your virtual router expects should be specified as a\n <code>listener</code>. </p>\n <p>Virtual routers handle traffic for one or more virtual services within your mesh. After\n you create your virtual router, create and associate routes for your virtual router that\n direct incoming requests to different virtual nodes.</p>",
|
||||
"CreateVirtualService": "<p>Creates a virtual service within a service mesh.</p>\n <p>A virtual service is an abstraction of a real service that is provided by a virtual node\n directly or indirectly by means of a virtual router. Dependent services call your virtual\n service by its <code>virtualServiceName</code>, and those requests are routed to the\n virtual node or virtual router that is specified as the provider for the virtual\n service.</p>",
|
||||
"DeleteMesh": "<p>Deletes an existing service mesh.</p>\n <p>You must delete all resources (virtual services, routes, virtual routers, and virtual\n nodes) in the service mesh before you can delete the mesh itself.</p>",
|
||||
"DeleteRoute": "<p>Deletes an existing route.</p>",
|
||||
"DeleteVirtualNode": "<p>Deletes an existing virtual node.</p>\n <p>You must delete any virtual services that list a virtual node as a service provider\n before you can delete the virtual node itself.</p>",
|
||||
"DeleteVirtualRouter": "<p>Deletes an existing virtual router.</p>\n <p>You must delete any routes associated with the virtual router before you can delete the\n router itself.</p>",
|
||||
"DeleteVirtualService": "<p>Deletes an existing virtual service.</p>",
|
||||
"DescribeMesh": "<p>Describes an existing service mesh.</p>",
|
||||
"DescribeRoute": "<p>Describes an existing route.</p>",
|
||||
"DescribeVirtualNode": "<p>Describes an existing virtual node.</p>",
|
||||
"DescribeVirtualRouter": "<p>Describes an existing virtual router.</p>",
|
||||
"DescribeVirtualService": "<p>Describes an existing virtual service.</p>",
|
||||
"ListMeshes": "<p>Returns a list of existing service meshes.</p>",
|
||||
"ListRoutes": "<p>Returns a list of existing routes in a service mesh.</p>",
|
||||
"ListTagsForResource": "<p>List the tags for an App Mesh resource.</p>",
|
||||
"ListVirtualNodes": "<p>Returns a list of existing virtual nodes.</p>",
|
||||
"ListVirtualRouters": "<p>Returns a list of existing virtual routers in a service mesh.</p>",
|
||||
"ListVirtualServices": "<p>Returns a list of existing virtual services in a service mesh.</p>",
|
||||
"TagResource": "<p>Associates the specified tags to a resource with the specified <code>resourceArn</code>.\n If existing tags on a resource aren't specified in the request parameters, they aren't\n changed. When a resource is deleted, the tags associated with that resource are also\n deleted.</p>",
|
||||
"UntagResource": "<p>Deletes specified tags from a resource.</p>",
|
||||
"UpdateMesh": "<p>Updates an existing service mesh.</p>",
|
||||
"UpdateRoute": "<p>Updates an existing route for a specified service mesh and virtual router.</p>",
|
||||
"UpdateVirtualNode": "<p>Updates an existing virtual node in a specified service mesh.</p>",
|
||||
"UpdateVirtualRouter": "<p>Updates an existing virtual router in a specified service mesh.</p>",
|
||||
"UpdateVirtualService": "<p>Updates an existing virtual service in a specified service mesh.</p>"
|
||||
},
|
||||
"shapes": {
|
||||
"AccessLog": {
|
||||
"base": "<p>An object representing the access logging information for a virtual node.</p>",
|
||||
"refs": {
|
||||
"AccessLog$file": "<p>The file object to send virtual node access logs to.</p>"
|
||||
}
|
||||
},
|
||||
"Arn": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"AwsCloudMapInstanceAttribute": {
|
||||
"base": "<p>An object representing the AWS Cloud Map attribute information for your virtual node.</p>",
|
||||
"refs": {
|
||||
"AwsCloudMapInstanceAttribute$key": "<p>The name of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service instance\n that contains the specified key and value is returned.</p>",
|
||||
"AwsCloudMapInstanceAttribute$value": "<p>The value of an AWS Cloud Map service instance attribute key. Any AWS Cloud Map service\n instance that contains the specified key and value is returned.</p>"
|
||||
}
|
||||
},
|
||||
"AwsCloudMapInstanceAttributeKey": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"AwsCloudMapInstanceAttributeValue": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"AwsCloudMapInstanceAttributes": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AwsCloudMapInstanceAttributes$member": null
|
||||
}
|
||||
},
|
||||
"AwsCloudMapName": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"AwsCloudMapServiceDiscovery": {
|
||||
"base": "<p>An object representing the AWS Cloud Map service discovery information for your virtual\n node.</p>",
|
||||
"refs": {
|
||||
"AwsCloudMapServiceDiscovery$attributes": "<p>A string map that contains attributes with values that you can use to filter instances\n by any custom attribute that you specified when you registered the instance. Only instances\n that match all of the specified key/value pairs will be returned.</p>",
|
||||
"AwsCloudMapServiceDiscovery$namespaceName": "<p>The name of the AWS Cloud Map namespace to use.</p>",
|
||||
"AwsCloudMapServiceDiscovery$serviceName": "<p>The name of the AWS Cloud Map service to use.</p>"
|
||||
}
|
||||
},
|
||||
"Backend": {
|
||||
"base": "<p>An object representing the backends that a virtual node is expected to send outbound\n traffic to. </p>",
|
||||
"refs": {
|
||||
"Backend$virtualService": "<p>Specifies a virtual service to use as a backend for a virtual node. </p>"
|
||||
}
|
||||
},
|
||||
"Backends": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Backends$member": null
|
||||
}
|
||||
},
|
||||
"BadRequestException": {
|
||||
"base": "<p>The request syntax was malformed. Check your request syntax and try again.</p>",
|
||||
"refs": { }
|
||||
},
|
||||
"ConflictException": {
|
||||
"base": "<p>The request contains a client token that was used for a previous update resource call\n with different specifications. Try the request again with a new client token.</p>",
|
||||
"refs": { }
|
||||
},
|
||||
"CreateMeshInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"CreateMeshInput$clientToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"CreateMeshInput$meshName": "<p>The name to use for the service mesh.</p>",
|
||||
"CreateMeshInput$spec": "<p>The service mesh specification to apply.</p>",
|
||||
"CreateMeshInput$tags": "<p>Optional metadata that you can apply to the service mesh to assist with categorization\n and organization. Each tag consists of a key and an optional value, both of which you\n define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>"
|
||||
}
|
||||
},
|
||||
"CreateMeshOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"CreateMeshOutput$mesh": "<p>The full description of your service mesh following the create call.</p>"
|
||||
}
|
||||
},
|
||||
"CreateRouteInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"CreateRouteInput$clientToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"CreateRouteInput$meshName": "<p>The name of the service mesh to create the route in.</p>",
|
||||
"CreateRouteInput$routeName": "<p>The name to use for the route.</p>",
|
||||
"CreateRouteInput$spec": "<p>The route specification to apply.</p>",
|
||||
"CreateRouteInput$tags": "<p>Optional metadata that you can apply to the route to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>",
|
||||
"CreateRouteInput$virtualRouterName": "<p>The name of the virtual router in which to create the route.</p>"
|
||||
}
|
||||
},
|
||||
"CreateRouteOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"CreateRouteOutput$route": "<p>The full description of your mesh following the create call.</p>"
|
||||
}
|
||||
},
|
||||
"CreateVirtualNodeInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"CreateVirtualNodeInput$clientToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"CreateVirtualNodeInput$meshName": "<p>The name of the service mesh to create the virtual node in.</p>",
|
||||
"CreateVirtualNodeInput$spec": "<p>The virtual node specification to apply.</p>",
|
||||
"CreateVirtualNodeInput$tags": "<p>Optional metadata that you can apply to the virtual node to assist with categorization\n and organization. Each tag consists of a key and an optional value, both of which you\n define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>",
|
||||
"CreateVirtualNodeInput$virtualNodeName": "<p>The name to use for the virtual node.</p>"
|
||||
}
|
||||
},
|
||||
"CreateVirtualNodeOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"CreateVirtualNodeOutput$virtualNode": "<p>The full description of your virtual node following the create call.</p>"
|
||||
}
|
||||
},
|
||||
"CreateVirtualRouterInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"CreateVirtualRouterInput$clientToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"CreateVirtualRouterInput$meshName": "<p>The name of the service mesh to create the virtual router in.</p>",
|
||||
"CreateVirtualRouterInput$spec": "<p>The virtual router specification to apply.</p>",
|
||||
"CreateVirtualRouterInput$tags": "<p>Optional metadata that you can apply to the virtual router to assist with categorization\n and organization. Each tag consists of a key and an optional value, both of which you\n define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>",
|
||||
"CreateVirtualRouterInput$virtualRouterName": "<p>The name to use for the virtual router.</p>"
|
||||
}
|
||||
},
|
||||
"CreateVirtualRouterOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"CreateVirtualRouterOutput$virtualRouter": "<p>The full description of your virtual router following the create call.</p>"
|
||||
}
|
||||
},
|
||||
"CreateVirtualServiceInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"CreateVirtualServiceInput$clientToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"CreateVirtualServiceInput$meshName": "<p>The name of the service mesh to create the virtual service in.</p>",
|
||||
"CreateVirtualServiceInput$spec": "<p>The virtual service specification to apply.</p>",
|
||||
"CreateVirtualServiceInput$tags": "<p>Optional metadata that you can apply to the virtual service to assist with\n categorization and organization. Each tag consists of a key and an optional value, both of\n which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>",
|
||||
"CreateVirtualServiceInput$virtualServiceName": "<p>The name to use for the virtual service.</p>"
|
||||
}
|
||||
},
|
||||
"CreateVirtualServiceOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"CreateVirtualServiceOutput$virtualService": "<p>The full description of your virtual service following the create call.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteMeshInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DeleteMeshInput$meshName": "<p>The name of the service mesh to delete.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteMeshOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DeleteMeshOutput$mesh": "<p>The service mesh that was deleted.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteRouteInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DeleteRouteInput$meshName": "<p>The name of the service mesh to delete the route in.</p>",
|
||||
"DeleteRouteInput$routeName": "<p>The name of the route to delete.</p>",
|
||||
"DeleteRouteInput$virtualRouterName": "<p>The name of the virtual router to delete the route in.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteRouteOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DeleteRouteOutput$route": "<p>The route that was deleted.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteVirtualNodeInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DeleteVirtualNodeInput$meshName": "<p>The name of the service mesh to delete the virtual node in.</p>",
|
||||
"DeleteVirtualNodeInput$virtualNodeName": "<p>The name of the virtual node to delete.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteVirtualNodeOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DeleteVirtualNodeOutput$virtualNode": "<p>The virtual node that was deleted.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteVirtualRouterInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DeleteVirtualRouterInput$meshName": "<p>The name of the service mesh to delete the virtual router in.</p>",
|
||||
"DeleteVirtualRouterInput$virtualRouterName": "<p>The name of the virtual router to delete.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteVirtualRouterOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DeleteVirtualRouterOutput$virtualRouter": "<p>The virtual router that was deleted.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteVirtualServiceInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DeleteVirtualServiceInput$meshName": "<p>The name of the service mesh to delete the virtual service in.</p>",
|
||||
"DeleteVirtualServiceInput$virtualServiceName": "<p>The name of the virtual service to delete.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteVirtualServiceOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DeleteVirtualServiceOutput$virtualService": "<p>The virtual service that was deleted.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeMeshInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DescribeMeshInput$meshName": "<p>The name of the service mesh to describe.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeMeshOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DescribeMeshOutput$mesh": "<p>The full description of your service mesh.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeRouteInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DescribeRouteInput$meshName": "<p>The name of the service mesh that the route resides in.</p>",
|
||||
"DescribeRouteInput$routeName": "<p>The name of the route to describe.</p>",
|
||||
"DescribeRouteInput$virtualRouterName": "<p>The name of the virtual router that the route is associated with.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeRouteOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DescribeRouteOutput$route": "<p>The full description of your route.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeVirtualNodeInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DescribeVirtualNodeInput$meshName": "<p>The name of the service mesh that the virtual node resides in.</p>",
|
||||
"DescribeVirtualNodeInput$virtualNodeName": "<p>The name of the virtual node to describe.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeVirtualNodeOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DescribeVirtualNodeOutput$virtualNode": "<p>The full description of your virtual node.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeVirtualRouterInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DescribeVirtualRouterInput$meshName": "<p>The name of the service mesh that the virtual router resides in.</p>",
|
||||
"DescribeVirtualRouterInput$virtualRouterName": "<p>The name of the virtual router to describe.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeVirtualRouterOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DescribeVirtualRouterOutput$virtualRouter": "<p>The full description of your virtual router.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeVirtualServiceInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DescribeVirtualServiceInput$meshName": "<p>The name of the service mesh that the virtual service resides in.</p>",
|
||||
"DescribeVirtualServiceInput$virtualServiceName": "<p>The name of the virtual service to describe.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeVirtualServiceOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"DescribeVirtualServiceOutput$virtualService": "<p>The full description of your virtual service.</p>"
|
||||
}
|
||||
},
|
||||
"DnsServiceDiscovery": {
|
||||
"base": "<p>An object representing the DNS service discovery information for your virtual\n node.</p>",
|
||||
"refs": {
|
||||
"DnsServiceDiscovery$hostname": "<p>Specifies the DNS service discovery hostname for the virtual node. </p>"
|
||||
}
|
||||
},
|
||||
"EgressFilter": {
|
||||
"base": "<p>An object representing the egress filter rules for a service mesh.</p>",
|
||||
"refs": {
|
||||
"EgressFilter$type": "<p>The egress filter type. By default, the type is <code>DROP_ALL</code>, which allows\n egress only from virtual nodes to other defined resources in the service mesh (and any\n traffic to <code>*.amazonaws.com</code> for AWS API calls). You can set the egress filter\n type to <code>ALLOW_ALL</code> to allow egress to any endpoint inside or outside of the\n service mesh.</p>"
|
||||
}
|
||||
},
|
||||
"EgressFilterType": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"FileAccessLog": {
|
||||
"base": "<p>An object representing an access log file.</p>",
|
||||
"refs": {
|
||||
"FileAccessLog$path": "<p>The file path to write access logs to. You can use <code>/dev/stdout</code> to send\n access logs to standard out and configure your Envoy container to use a log driver, such as\n <code>awslogs</code>, to export the access logs to a log storage service such as Amazon\n CloudWatch Logs. You can also specify a path in the Envoy container's file system to write\n the files to disk.</p>\n <note>\n <p>The Envoy process must have write permissions to the path that you specify here.\n Otherwise, Envoy fails to bootstrap properly.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"FilePath": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"ForbiddenException": {
|
||||
"base": "<p>You don't have permissions to perform this action.</p>",
|
||||
"refs": { }
|
||||
},
|
||||
"HealthCheckIntervalMillis": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"HealthCheckPolicy": {
|
||||
"base": "<p>An object representing the health check policy for a virtual node's listener.</p>",
|
||||
"refs": {
|
||||
"HealthCheckPolicy$healthyThreshold": "<p>The number of consecutive successful health checks that must occur before declaring\n listener healthy.</p>",
|
||||
"HealthCheckPolicy$intervalMillis": "<p>The time period in milliseconds between each health check execution.</p>",
|
||||
"HealthCheckPolicy$path": "<p>The destination path for the health check request. This is required only if the\n specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.</p>",
|
||||
"HealthCheckPolicy$port": "<p>The destination port for the health check request. This port must match the port defined\n in the <a>PortMapping</a> for the listener.</p>",
|
||||
"HealthCheckPolicy$protocol": "<p>The protocol for the health check request.</p>",
|
||||
"HealthCheckPolicy$timeoutMillis": "<p>The amount of time to wait when receiving a response from the health check, in\n milliseconds.</p>",
|
||||
"HealthCheckPolicy$unhealthyThreshold": "<p>The number of consecutive failed health checks that must occur before declaring a\n virtual node unhealthy. </p>"
|
||||
}
|
||||
},
|
||||
"HealthCheckThreshold": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"HealthCheckTimeoutMillis": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"Hostname": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"HttpRoute": {
|
||||
"base": "<p>An object representing the HTTP routing specification for a route.</p>",
|
||||
"refs": {
|
||||
"HttpRoute$action": "<p>The action to take if a match is determined.</p>",
|
||||
"HttpRoute$match": "<p>The criteria for determining an HTTP request match.</p>"
|
||||
}
|
||||
},
|
||||
"HttpRouteAction": {
|
||||
"base": "<p>An object representing the traffic distribution requirements for matched HTTP\n requests.</p>",
|
||||
"refs": {
|
||||
"HttpRouteAction$weightedTargets": "<p>The targets that traffic is routed to when a request matches the route. You can specify\n one or more targets and their relative weights to distribute traffic with.</p>"
|
||||
}
|
||||
},
|
||||
"HttpRouteMatch": {
|
||||
"base": "<p>An object representing the requirements for a route to match HTTP requests for a virtual\n router.</p>",
|
||||
"refs": {
|
||||
"HttpRouteMatch$prefix": "<p>Specifies the path to match requests with. This parameter must always start with\n <code>/</code>, which by itself matches all requests to the virtual service name. You\n can also match for path-based routing of requests. For example, if your virtual service\n name is <code>my-service.local</code> and you want the route to match requests to\n <code>my-service.local/metrics</code>, your prefix should be\n <code>/metrics</code>.</p>"
|
||||
}
|
||||
},
|
||||
"InternalServerErrorException": {
|
||||
"base": "<p>The request processing has failed because of an unknown error, exception, or\n failure.</p>",
|
||||
"refs": { }
|
||||
},
|
||||
"LimitExceededException": {
|
||||
"base": "<p>You have exceeded a service limit for your account. For more information, see <a href=\"https://docs.aws.amazon.com/app-mesh/latest/userguide/service_limits.html\">Service\n Limits</a> in the <i>AWS App Mesh User Guide</i>.</p>",
|
||||
"refs": { }
|
||||
},
|
||||
"ListMeshesInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"ListMeshesInput$limit": "<p>The maximum number of results returned by <code>ListMeshes</code> in paginated output.\n When you use this parameter, <code>ListMeshes</code> returns only <code>limit</code>\n results in a single page along with a <code>nextToken</code> response element. You can see\n the remaining results of the initial request by sending another <code>ListMeshes</code>\n request with the returned <code>nextToken</code> value. This value can be between\n 1 and 100. If you don't use this parameter,\n <code>ListMeshes</code> returns up to 100 results and a\n <code>nextToken</code> value if applicable.</p>",
|
||||
"ListMeshesInput$nextToken": "<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListMeshes</code> request where <code>limit</code> was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the <code>nextToken</code> value.</p> \n <note>\n <p>This token should be treated as an opaque identifier that is used only to\n retrieve the next items in a list and not for other programmatic purposes.</p>\n </note>"
|
||||
}
|
||||
},
|
||||
"ListMeshesLimit": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"ListMeshesOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"ListMeshesOutput$meshes": "<p>The list of existing service meshes.</p>",
|
||||
"ListMeshesOutput$nextToken": "<p>The <code>nextToken</code> value to include in a future <code>ListMeshes</code> request.\n When the results of a <code>ListMeshes</code> request exceed <code>limit</code>, you can\n use this value to retrieve the next page of results. This value is <code>null</code> when\n there are no more results to return.</p>"
|
||||
}
|
||||
},
|
||||
"ListRoutesInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"ListRoutesInput$limit": "<p>The maximum number of results returned by <code>ListRoutes</code> in paginated output.\n When you use this parameter, <code>ListRoutes</code> returns only <code>limit</code>\n results in a single page along with a <code>nextToken</code> response element. You can see\n the remaining results of the initial request by sending another <code>ListRoutes</code>\n request with the returned <code>nextToken</code> value. This value can be between\n 1 and 100. If you don't use this parameter,\n <code>ListRoutes</code> returns up to 100 results and a\n <code>nextToken</code> value if applicable.</p>",
|
||||
"ListRoutesInput$meshName": "<p>The name of the service mesh to list routes in.</p>",
|
||||
"ListRoutesInput$nextToken": "<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListRoutes</code> request where <code>limit</code> was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the <code>nextToken</code> value.</p>",
|
||||
"ListRoutesInput$virtualRouterName": "<p>The name of the virtual router to list routes in.</p>"
|
||||
}
|
||||
},
|
||||
"ListRoutesLimit": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"ListRoutesOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"ListRoutesOutput$nextToken": "<p>The <code>nextToken</code> value to include in a future <code>ListRoutes</code> request.\n When the results of a <code>ListRoutes</code> request exceed <code>limit</code>, you can\n use this value to retrieve the next page of results. This value is <code>null</code> when\n there are no more results to return.</p>",
|
||||
"ListRoutesOutput$routes": "<p>The list of existing routes for the specified service mesh and virtual router.</p>"
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"ListTagsForResourceInput$limit": "<p>The maximum number of tag results returned by <code>ListTagsForResource</code> in\n paginated output. When this parameter is used, <code>ListTagsForResource</code> returns\n only <code>limit</code> results in a single page along with a <code>nextToken</code>\n response element. You can see the remaining results of the initial request by sending\n another <code>ListTagsForResource</code> request with the returned <code>nextToken</code>\n value. This value can be between 1 and 100. If you don't use\n this parameter, <code>ListTagsForResource</code> returns up to 100\n results and a <code>nextToken</code> value if applicable.</p>",
|
||||
"ListTagsForResourceInput$nextToken": "<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListTagsForResource</code> request where <code>limit</code> was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the <code>nextToken</code> value.</p>",
|
||||
"ListTagsForResourceInput$resourceArn": "<p>The Amazon Resource Name (ARN) that identifies the resource to list the tags for.</p>"
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"ListTagsForResourceOutput$nextToken": "<p>The <code>nextToken</code> value to include in a future <code>ListTagsForResource</code>\n request. When the results of a <code>ListTagsForResource</code> request exceed\n <code>limit</code>, you can use this value to retrieve the next page of results. This\n value is <code>null</code> when there are no more results to return.</p>",
|
||||
"ListTagsForResourceOutput$tags": "<p>The tags for the resource.</p>"
|
||||
}
|
||||
},
|
||||
"ListVirtualNodesInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"ListVirtualNodesInput$limit": "<p>The maximum number of results returned by <code>ListVirtualNodes</code> in paginated\n output. When you use this parameter, <code>ListVirtualNodes</code> returns only\n <code>limit</code> results in a single page along with a <code>nextToken</code> response\n element. You can see the remaining results of the initial request by sending another\n <code>ListVirtualNodes</code> request with the returned <code>nextToken</code> value.\n This value can be between 1 and 100. If you don't use this\n parameter, <code>ListVirtualNodes</code> returns up to 100 results and a\n <code>nextToken</code> value if applicable.</p>",
|
||||
"ListVirtualNodesInput$meshName": "<p>The name of the service mesh to list virtual nodes in.</p>",
|
||||
"ListVirtualNodesInput$nextToken": "<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListVirtualNodes</code> request where <code>limit</code> was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the <code>nextToken</code> value.</p>"
|
||||
}
|
||||
},
|
||||
"ListVirtualNodesLimit": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"ListVirtualNodesOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"ListVirtualNodesOutput$nextToken": "<p>The <code>nextToken</code> value to include in a future <code>ListVirtualNodes</code>\n request. When the results of a <code>ListVirtualNodes</code> request exceed\n <code>limit</code>, you can use this value to retrieve the next page of results. This\n value is <code>null</code> when there are no more results to return.</p>",
|
||||
"ListVirtualNodesOutput$virtualNodes": "<p>The list of existing virtual nodes for the specified service mesh.</p>"
|
||||
}
|
||||
},
|
||||
"ListVirtualRoutersInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"ListVirtualRoutersInput$limit": "<p>The maximum number of results returned by <code>ListVirtualRouters</code> in paginated\n output. When you use this parameter, <code>ListVirtualRouters</code> returns only\n <code>limit</code> results in a single page along with a <code>nextToken</code> response\n element. You can see the remaining results of the initial request by sending another\n <code>ListVirtualRouters</code> request with the returned <code>nextToken</code> value.\n This value can be between 1 and 100. If you don't use this\n parameter, <code>ListVirtualRouters</code> returns up to 100 results and\n a <code>nextToken</code> value if applicable.</p>",
|
||||
"ListVirtualRoutersInput$meshName": "<p>The name of the service mesh to list virtual routers in.</p>",
|
||||
"ListVirtualRoutersInput$nextToken": "<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListVirtualRouters</code> request where <code>limit</code> was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the <code>nextToken</code> value.</p>"
|
||||
}
|
||||
},
|
||||
"ListVirtualRoutersLimit": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"ListVirtualRoutersOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"ListVirtualRoutersOutput$nextToken": "<p>The <code>nextToken</code> value to include in a future <code>ListVirtualRouters</code>\n request. When the results of a <code>ListVirtualRouters</code> request exceed\n <code>limit</code>, you can use this value to retrieve the next page of results. This\n value is <code>null</code> when there are no more results to return.</p>",
|
||||
"ListVirtualRoutersOutput$virtualRouters": "<p>The list of existing virtual routers for the specified service mesh.</p>"
|
||||
}
|
||||
},
|
||||
"ListVirtualServicesInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"ListVirtualServicesInput$limit": "<p>The maximum number of results returned by <code>ListVirtualServices</code> in paginated\n output. When you use this parameter, <code>ListVirtualServices</code> returns only\n <code>limit</code> results in a single page along with a <code>nextToken</code> response\n element. You can see the remaining results of the initial request by sending another\n <code>ListVirtualServices</code> request with the returned <code>nextToken</code> value.\n This value can be between 1 and 100. If you don't use this\n parameter, <code>ListVirtualServices</code> returns up to 100 results and\n a <code>nextToken</code> value if applicable.</p>",
|
||||
"ListVirtualServicesInput$meshName": "<p>The name of the service mesh to list virtual services in.</p>",
|
||||
"ListVirtualServicesInput$nextToken": "<p>The <code>nextToken</code> value returned from a previous paginated\n <code>ListVirtualServices</code> request where <code>limit</code> was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the <code>nextToken</code> value.</p>"
|
||||
}
|
||||
},
|
||||
"ListVirtualServicesLimit": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"ListVirtualServicesOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"ListVirtualServicesOutput$nextToken": "<p>The <code>nextToken</code> value to include in a future <code>ListVirtualServices</code>\n request. When the results of a <code>ListVirtualServices</code> request exceed\n <code>limit</code>, you can use this value to retrieve the next page of results. This\n value is <code>null</code> when there are no more results to return.</p>",
|
||||
"ListVirtualServicesOutput$virtualServices": "<p>The list of existing virtual services for the specified service mesh.</p>"
|
||||
}
|
||||
},
|
||||
"Listener": {
|
||||
"base": "<p>An object representing a listener for a virtual node.</p>",
|
||||
"refs": {
|
||||
"Listener$healthCheck": "<p>The health check information for the listener.</p>",
|
||||
"Listener$portMapping": "<p>The port mapping information for the listener.</p>"
|
||||
}
|
||||
},
|
||||
"Listeners": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Listeners$member": null
|
||||
}
|
||||
},
|
||||
"Logging": {
|
||||
"base": "<p>An object representing the logging information for a virtual node.</p>",
|
||||
"refs": {
|
||||
"Logging$accessLog": "<p>The access log configuration for a virtual node.</p>"
|
||||
}
|
||||
},
|
||||
"Long": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"MeshData": {
|
||||
"base": "<p>An object representing a service mesh returned by a describe operation.</p>",
|
||||
"refs": {
|
||||
"MeshData$meshName": "<p>The name of the service mesh.</p>",
|
||||
"MeshData$metadata": "<p>The associated metadata for the service mesh.</p>",
|
||||
"MeshData$spec": "<p>The associated specification for the service mesh.</p>",
|
||||
"MeshData$status": "<p>The status of the service mesh.</p>"
|
||||
}
|
||||
},
|
||||
"MeshList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"MeshList$member": null
|
||||
}
|
||||
},
|
||||
"MeshRef": {
|
||||
"base": "<p>An object representing a service mesh returned by a list operation.</p>",
|
||||
"refs": {
|
||||
"MeshRef$arn": "<p>The full Amazon Resource Name (ARN) of the service mesh.</p>",
|
||||
"MeshRef$meshName": "<p>The name of the service mesh.</p>"
|
||||
}
|
||||
},
|
||||
"MeshSpec": {
|
||||
"base": "<p>An object representing the specification of a service mesh.</p>",
|
||||
"refs": {
|
||||
"MeshSpec$egressFilter": "<p>The egress filter rules for the service mesh.</p>"
|
||||
}
|
||||
},
|
||||
"MeshStatus": {
|
||||
"base": "<p>An object representing the status of a service mesh.</p>",
|
||||
"refs": {
|
||||
"MeshStatus$status": "<p>The current mesh status.</p>"
|
||||
}
|
||||
},
|
||||
"MeshStatusCode": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"NotFoundException": {
|
||||
"base": "<p>The specified resource doesn't exist. Check your request syntax and try again.</p>",
|
||||
"refs": { }
|
||||
},
|
||||
"PercentInt": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"PortMapping": {
|
||||
"base": "<p>An object representing a virtual node or virtual router listener port mapping.</p>",
|
||||
"refs": {
|
||||
"PortMapping$port": "<p>The port used for the port mapping.</p>",
|
||||
"PortMapping$protocol": "<p>The protocol used for the port mapping.</p>"
|
||||
}
|
||||
},
|
||||
"PortNumber": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"PortProtocol": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"ResourceInUseException": {
|
||||
"base": "<p>You can't delete the specified resource because it's in use or required by another\n resource.</p>",
|
||||
"refs": { }
|
||||
},
|
||||
"ResourceMetadata": {
|
||||
"base": "<p>An object representing metadata for a resource.</p>",
|
||||
"refs": {
|
||||
"ResourceMetadata$arn": "<p>The full Amazon Resource Name (ARN) for the resource.</p>",
|
||||
"ResourceMetadata$createdAt": "<p>The Unix epoch timestamp in seconds for when the resource was created.</p>",
|
||||
"ResourceMetadata$lastUpdatedAt": "<p>The Unix epoch timestamp in seconds for when the resource was last updated.</p>",
|
||||
"ResourceMetadata$uid": "<p>The unique identifier for the resource.</p>",
|
||||
"ResourceMetadata$version": "<p>The version of the resource. Resources are created at version 1, and this version is\n incremented each time that they're updated.</p>"
|
||||
}
|
||||
},
|
||||
"ResourceName": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"RouteData": {
|
||||
"base": "<p>An object representing a route returned by a describe operation.</p>",
|
||||
"refs": {
|
||||
"RouteData$meshName": "<p>The name of the service mesh that the route resides in.</p>",
|
||||
"RouteData$metadata": "<p>The associated metadata for the route.</p>",
|
||||
"RouteData$routeName": "<p>The name of the route.</p>",
|
||||
"RouteData$spec": "<p>The specifications of the route.</p>",
|
||||
"RouteData$status": "<p>The status of the route.</p>",
|
||||
"RouteData$virtualRouterName": "<p>The virtual router that the route is associated with.</p>"
|
||||
}
|
||||
},
|
||||
"RouteList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"RouteList$member": null
|
||||
}
|
||||
},
|
||||
"RouteRef": {
|
||||
"base": "<p>An object representing a route returned by a list operation.</p>",
|
||||
"refs": {
|
||||
"RouteRef$arn": "<p>The full Amazon Resource Name (ARN) for the route.</p>",
|
||||
"RouteRef$meshName": "<p>The name of the service mesh that the route resides in.</p>",
|
||||
"RouteRef$routeName": "<p>The name of the route.</p>",
|
||||
"RouteRef$virtualRouterName": "<p>The virtual router that the route is associated with.</p>"
|
||||
}
|
||||
},
|
||||
"RouteSpec": {
|
||||
"base": "<p>An object representing the specification of a route.</p>",
|
||||
"refs": {
|
||||
"RouteSpec$httpRoute": "<p>The HTTP routing information for the route.</p>",
|
||||
"RouteSpec$tcpRoute": "<p>The TCP routing information for the route.</p>"
|
||||
}
|
||||
},
|
||||
"RouteStatus": {
|
||||
"base": "<p>An object representing the current status of a route.</p>",
|
||||
"refs": {
|
||||
"RouteStatus$status": "<p>The current status for the route.</p>"
|
||||
}
|
||||
},
|
||||
"RouteStatusCode": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"ServiceDiscovery": {
|
||||
"base": "<p>An object representing the service discovery information for a virtual node.</p>",
|
||||
"refs": {
|
||||
"ServiceDiscovery$awsCloudMap": "<p>Specifies any AWS Cloud Map information for the virtual node.</p>",
|
||||
"ServiceDiscovery$dns": "<p>Specifies the DNS information for the virtual node.</p>"
|
||||
}
|
||||
},
|
||||
"ServiceName": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"ServiceUnavailableException": {
|
||||
"base": "<p>The request has failed due to a temporary failure of the service.</p>",
|
||||
"refs": { }
|
||||
},
|
||||
"String": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"TagKey": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"TagKeyList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"TagKeyList$member": null
|
||||
}
|
||||
},
|
||||
"TagList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"TagList$member": null
|
||||
}
|
||||
},
|
||||
"TagRef": {
|
||||
"base": "<p>Optional metadata that you apply to a resource to assist with categorization and\n organization. Each tag consists of a key and an optional value, both of which you define.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>",
|
||||
"refs": {
|
||||
"TagRef$key": "<p>One part of a key-value pair that make up a tag. A <code>key</code> is a general label\n that acts like a category for more specific tag values.</p>",
|
||||
"TagRef$value": "<p>The optional part of a key-value pair that make up a tag. A <code>value</code> acts as a\n descriptor within a tag category (key).</p>"
|
||||
}
|
||||
},
|
||||
"TagResourceInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"TagResourceInput$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource to add tags to.</p>",
|
||||
"TagResourceInput$tags": "<p>The tags to add to the resource. A tag is an array of key-value pairs.\n Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.</p>"
|
||||
}
|
||||
},
|
||||
"TagResourceOutput": {
|
||||
"base": "",
|
||||
"refs": { }
|
||||
},
|
||||
"TagValue": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"TagsLimit": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"TcpRoute": {
|
||||
"base": "<p>An object representing the TCP routing specification for a route.</p>",
|
||||
"refs": {
|
||||
"TcpRoute$action": "<p>The action to take if a match is determined.</p>"
|
||||
}
|
||||
},
|
||||
"TcpRouteAction": {
|
||||
"base": "<p>An object representing the traffic distribution requirements for matched TCP\n requests.</p>",
|
||||
"refs": {
|
||||
"TcpRouteAction$weightedTargets": "<p>The targets that traffic is routed to when a request matches the route. You can specify\n one or more targets and their relative weights to distribute traffic with.</p>"
|
||||
}
|
||||
},
|
||||
"Timestamp": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"TooManyRequestsException": {
|
||||
"base": "<p>The maximum request rate permitted by the App Mesh APIs has been exceeded for your\n account. For best results, use an increasing or variable sleep interval between\n requests.</p>",
|
||||
"refs": { }
|
||||
},
|
||||
"TooManyTagsException": {
|
||||
"base": "<p>The request exceeds the maximum allowed number of tags allowed per resource. The current\n limit is 50 user tags per resource. You must reduce the number of tags in the request. None\n of the tags in this request were applied.</p>",
|
||||
"refs": { }
|
||||
},
|
||||
"UntagResourceInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"UntagResourceInput$resourceArn": "<p>The Amazon Resource Name (ARN) of the resource to delete tags from.</p>",
|
||||
"UntagResourceInput$tagKeys": "<p>The keys of the tags to be removed.</p>"
|
||||
}
|
||||
},
|
||||
"UntagResourceOutput": {
|
||||
"base": "",
|
||||
"refs": { }
|
||||
},
|
||||
"UpdateMeshInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"UpdateMeshInput$clientToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"UpdateMeshInput$meshName": "<p>The name of the service mesh to update.</p>",
|
||||
"UpdateMeshInput$spec": "<p>The service mesh specification to apply.</p>"
|
||||
}
|
||||
},
|
||||
"UpdateMeshOutput": {
|
||||
"base": "",
|
||||
"refs": { }
|
||||
},
|
||||
"UpdateRouteInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"UpdateRouteInput$clientToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"UpdateRouteInput$meshName": "<p>The name of the service mesh that the route resides in.</p>",
|
||||
"UpdateRouteInput$routeName": "<p>The name of the route to update.</p>",
|
||||
"UpdateRouteInput$spec": "<p>The new route specification to apply. This overwrites the existing data.</p>",
|
||||
"UpdateRouteInput$virtualRouterName": "<p>The name of the virtual router that the route is associated with.</p>"
|
||||
}
|
||||
},
|
||||
"UpdateRouteOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"UpdateRouteOutput$route": "<p>A full description of the route that was updated.</p>"
|
||||
}
|
||||
},
|
||||
"UpdateVirtualNodeInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"UpdateVirtualNodeInput$clientToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"UpdateVirtualNodeInput$meshName": "<p>The name of the service mesh that the virtual node resides in.</p>",
|
||||
"UpdateVirtualNodeInput$spec": "<p>The new virtual node specification to apply. This overwrites the existing data.</p>",
|
||||
"UpdateVirtualNodeInput$virtualNodeName": "<p>The name of the virtual node to update.</p>"
|
||||
}
|
||||
},
|
||||
"UpdateVirtualNodeOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"UpdateVirtualNodeOutput$virtualNode": "<p>A full description of the virtual node that was updated.</p>"
|
||||
}
|
||||
},
|
||||
"UpdateVirtualRouterInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"UpdateVirtualRouterInput$clientToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"UpdateVirtualRouterInput$meshName": "<p>The name of the service mesh that the virtual router resides in.</p>",
|
||||
"UpdateVirtualRouterInput$spec": "<p>The new virtual router specification to apply. This overwrites the existing data.</p>",
|
||||
"UpdateVirtualRouterInput$virtualRouterName": "<p>The name of the virtual router to update.</p>"
|
||||
}
|
||||
},
|
||||
"UpdateVirtualRouterOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"UpdateVirtualRouterOutput$virtualRouter": "<p>A full description of the virtual router that was updated.</p>"
|
||||
}
|
||||
},
|
||||
"UpdateVirtualServiceInput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"UpdateVirtualServiceInput$clientToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.</p>",
|
||||
"UpdateVirtualServiceInput$meshName": "<p>The name of the service mesh that the virtual service resides in.</p>",
|
||||
"UpdateVirtualServiceInput$spec": "<p>The new virtual service specification to apply. This overwrites the existing\n data.</p>",
|
||||
"UpdateVirtualServiceInput$virtualServiceName": "<p>The name of the virtual service to update.</p>"
|
||||
}
|
||||
},
|
||||
"UpdateVirtualServiceOutput": {
|
||||
"base": "",
|
||||
"refs": {
|
||||
"UpdateVirtualServiceOutput$virtualService": "<p>A full description of the virtual service that was updated.</p>"
|
||||
}
|
||||
},
|
||||
"VirtualNodeData": {
|
||||
"base": "<p>An object representing a virtual node returned by a describe operation.</p>",
|
||||
"refs": {
|
||||
"VirtualNodeData$meshName": "<p>The name of the service mesh that the virtual node resides in.</p>",
|
||||
"VirtualNodeData$metadata": "<p>The associated metadata for the virtual node.</p>",
|
||||
"VirtualNodeData$spec": "<p>The specifications of the virtual node.</p>",
|
||||
"VirtualNodeData$status": "<p>The current status for the virtual node.</p>",
|
||||
"VirtualNodeData$virtualNodeName": "<p>The name of the virtual node.</p>"
|
||||
}
|
||||
},
|
||||
"VirtualNodeList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"VirtualNodeList$member": null
|
||||
}
|
||||
},
|
||||
"VirtualNodeRef": {
|
||||
"base": "<p>An object representing a virtual node returned by a list operation.</p>",
|
||||
"refs": {
|
||||
"VirtualNodeRef$arn": "<p>The full Amazon Resource Name (ARN) for the virtual node.</p>",
|
||||
"VirtualNodeRef$meshName": "<p>The name of the service mesh that the virtual node resides in.</p>",
|
||||
"VirtualNodeRef$virtualNodeName": "<p>The name of the virtual node.</p>"
|
||||
}
|
||||
},
|
||||
"VirtualNodeServiceProvider": {
|
||||
"base": "<p>An object representing a virtual node service provider.</p>",
|
||||
"refs": {
|
||||
"VirtualNodeServiceProvider$virtualNodeName": "<p>The name of the virtual node that is acting as a service provider.</p>"
|
||||
}
|
||||
},
|
||||
"VirtualNodeSpec": {
|
||||
"base": "<p>An object representing the specification of a virtual node.</p>",
|
||||
"refs": {
|
||||
"VirtualNodeSpec$backends": "<p>The backends that the virtual node is expected to send outbound traffic to.</p>",
|
||||
"VirtualNodeSpec$listeners": "<p>The listeners that the virtual node is expected to receive inbound traffic from.\n Currently only one listener is supported per virtual node.</p>",
|
||||
"VirtualNodeSpec$logging": "<p>The inbound and outbound access logging information for the virtual node.</p>",
|
||||
"VirtualNodeSpec$serviceDiscovery": "<p>The service discovery information for the virtual node. If your virtual node does not\n expect ingress traffic, you can omit this parameter.</p>"
|
||||
}
|
||||
},
|
||||
"VirtualNodeStatus": {
|
||||
"base": "<p>An object representing the current status of the virtual node.</p>",
|
||||
"refs": {
|
||||
"VirtualNodeStatus$status": "<p>The current status of the virtual node.</p>"
|
||||
}
|
||||
},
|
||||
"VirtualNodeStatusCode": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"VirtualRouterData": {
|
||||
"base": "<p>An object representing a virtual router returned by a describe operation.</p>",
|
||||
"refs": {
|
||||
"VirtualRouterData$meshName": "<p>The name of the service mesh that the virtual router resides in.</p>",
|
||||
"VirtualRouterData$metadata": "<p>The associated metadata for the virtual router.</p>",
|
||||
"VirtualRouterData$spec": "<p>The specifications of the virtual router.</p>",
|
||||
"VirtualRouterData$status": "<p>The current status of the virtual router.</p>",
|
||||
"VirtualRouterData$virtualRouterName": "<p>The name of the virtual router.</p>"
|
||||
}
|
||||
},
|
||||
"VirtualRouterList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"VirtualRouterList$member": null
|
||||
}
|
||||
},
|
||||
"VirtualRouterListener": {
|
||||
"base": "<p>An object representing a virtual router listener.</p>",
|
||||
"refs": { }
|
||||
},
|
||||
"VirtualRouterListeners": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"VirtualRouterListeners$member": null
|
||||
}
|
||||
},
|
||||
"VirtualRouterRef": {
|
||||
"base": "<p>An object representing a virtual router returned by a list operation.</p>",
|
||||
"refs": {
|
||||
"VirtualRouterRef$arn": "<p>The full Amazon Resource Name (ARN) for the virtual router.</p>",
|
||||
"VirtualRouterRef$meshName": "<p>The name of the service mesh that the virtual router resides in.</p>",
|
||||
"VirtualRouterRef$virtualRouterName": "<p>The name of the virtual router.</p>"
|
||||
}
|
||||
},
|
||||
"VirtualRouterServiceProvider": {
|
||||
"base": "<p>An object representing a virtual node service provider.</p>",
|
||||
"refs": {
|
||||
"VirtualRouterServiceProvider$virtualRouterName": "<p>The name of the virtual router that is acting as a service provider.</p>"
|
||||
}
|
||||
},
|
||||
"VirtualRouterSpec": {
|
||||
"base": "<p>An object representing the specification of a virtual router.</p>",
|
||||
"refs": {
|
||||
"VirtualRouterSpec$listeners": "<p>The listeners that the virtual router is expected to receive inbound traffic from.\n Currently only one listener is supported per virtual router.</p>"
|
||||
}
|
||||
},
|
||||
"VirtualRouterStatus": {
|
||||
"base": "<p>An object representing the status of a virtual router. </p>",
|
||||
"refs": {
|
||||
"VirtualRouterStatus$status": "<p>The current status of the virtual router.</p>"
|
||||
}
|
||||
},
|
||||
"VirtualRouterStatusCode": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"VirtualServiceBackend": {
|
||||
"base": "<p>An object representing a virtual service backend for a virtual node.</p>",
|
||||
"refs": {
|
||||
"VirtualServiceBackend$virtualServiceName": "<p>The name of the virtual service that is acting as a virtual node backend.</p>"
|
||||
}
|
||||
},
|
||||
"VirtualServiceData": {
|
||||
"base": "<p>An object representing a virtual service returned by a describe operation.</p>",
|
||||
"refs": {
|
||||
"VirtualServiceData$meshName": "<p>The name of the service mesh that the virtual service resides in.</p>",
|
||||
"VirtualServiceData$spec": "<p>The specifications of the virtual service.</p>",
|
||||
"VirtualServiceData$status": "<p>The current status of the virtual service.</p>",
|
||||
"VirtualServiceData$virtualServiceName": "<p>The name of the virtual service.</p>"
|
||||
}
|
||||
},
|
||||
"VirtualServiceList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"VirtualServiceList$member": null
|
||||
}
|
||||
},
|
||||
"VirtualServiceProvider": {
|
||||
"base": "<p>An object representing the provider for a virtual service.</p>",
|
||||
"refs": {
|
||||
"VirtualServiceProvider$virtualNode": "<p>The virtual node associated with a virtual service.</p>",
|
||||
"VirtualServiceProvider$virtualRouter": "<p>The virtual router associated with a virtual service.</p>"
|
||||
}
|
||||
},
|
||||
"VirtualServiceRef": {
|
||||
"base": "<p>An object representing a virtual service returned by a list operation.</p>",
|
||||
"refs": {
|
||||
"VirtualServiceRef$arn": "<p>The full Amazon Resource Name (ARN) for the virtual service.</p>",
|
||||
"VirtualServiceRef$meshName": "<p>The name of the service mesh that the virtual service resides in.</p>",
|
||||
"VirtualServiceRef$virtualServiceName": "<p>The name of the virtual service.</p>"
|
||||
}
|
||||
},
|
||||
"VirtualServiceSpec": {
|
||||
"base": "<p>An object representing the specification of a virtual service.</p>",
|
||||
"refs": {
|
||||
"VirtualServiceSpec$provider": "<p>The App Mesh object that is acting as the provider for a virtual service. You can specify\n a single virtual node or virtual router.</p>"
|
||||
}
|
||||
},
|
||||
"VirtualServiceStatus": {
|
||||
"base": "<p>An object representing the status of a virtual service.</p>",
|
||||
"refs": {
|
||||
"VirtualServiceStatus$status": "<p>The current status of the virtual service.</p>"
|
||||
}
|
||||
},
|
||||
"VirtualServiceStatusCode": {
|
||||
"base": null,
|
||||
"refs": { }
|
||||
},
|
||||
"WeightedTarget": {
|
||||
"base": "<p>An object representing a target and its relative weight. Traffic is distributed across\n targets according to their relative weight. For example, a weighted target with a relative\n weight of 50 receives five times as much traffic as one with a relative weight of\n 10.</p>",
|
||||
"refs": {
|
||||
"WeightedTarget$virtualNode": "<p>The virtual node to associate with the weighted target.</p>",
|
||||
"WeightedTarget$weight": "<p>The relative weight of the weighted target.</p>"
|
||||
}
|
||||
},
|
||||
"WeightedTargets": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"WeightedTargets$member": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
+4
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"version": "1.0",
|
||||
"examples": { }
|
||||
}
|
||||
Generated
Vendored
+40
@@ -0,0 +1,40 @@
|
||||
{
|
||||
"pagination": {
|
||||
"ListMeshes": {
|
||||
"input_token": "nextToken",
|
||||
"limit_key": "limit",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "meshes"
|
||||
},
|
||||
"ListRoutes": {
|
||||
"input_token": "nextToken",
|
||||
"limit_key": "limit",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "routes"
|
||||
},
|
||||
"ListTagsForResource": {
|
||||
"input_token": "nextToken",
|
||||
"limit_key": "limit",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "tags"
|
||||
},
|
||||
"ListVirtualNodes": {
|
||||
"input_token": "nextToken",
|
||||
"limit_key": "limit",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "virtualNodes"
|
||||
},
|
||||
"ListVirtualRouters": {
|
||||
"input_token": "nextToken",
|
||||
"limit_key": "limit",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "virtualRouters"
|
||||
},
|
||||
"ListVirtualServices": {
|
||||
"input_token": "nextToken",
|
||||
"limit_key": "limit",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "virtualServices"
|
||||
}
|
||||
}
|
||||
}
|
||||
+695
-23
File diff suppressed because it is too large
Load Diff
+536
-89
@@ -1,40 +1,54 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<fullname>Amazon AppStream 2.0</fullname> <p>You can use Amazon AppStream 2.0 to stream desktop applications to any device running a web browser, without rewriting them.</p>",
|
||||
"service": "<fullname>Amazon AppStream 2.0</fullname> <p>This is the <i>Amazon AppStream 2.0 API Reference</i>. This documentation provides descriptions and syntax for each of the actions and data types in AppStream 2.0. AppStream 2.0 is a fully managed, secure application streaming service that lets you stream desktop applications to users without rewriting applications. AppStream 2.0 manages the AWS resources that are required to host and run your applications, scales automatically, and provides access to your users on demand.</p> <p>To learn more about AppStream 2.0, see the following resources:</p> <ul> <li> <p> <a href=\"http://aws.amazon.com/appstream2\">Amazon AppStream 2.0 product page</a> </p> </li> <li> <p> <a href=\"http://aws.amazon.com/documentation/appstream2\">Amazon AppStream 2.0 documentation</a> </p> </li> </ul>",
|
||||
"operations": {
|
||||
"AssociateFleet": "<p>Associates the specified fleet with the specified stack.</p>",
|
||||
"BatchAssociateUserStack": "<p>Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.</p>",
|
||||
"BatchDisassociateUserStack": "<p>Disassociates the specified users from the specified stacks.</p>",
|
||||
"CopyImage": "<p>Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.</p>",
|
||||
"CreateDirectoryConfig": "<p>Creates a directory configuration.</p>",
|
||||
"CreateFleet": "<p>Creates a fleet.</p>",
|
||||
"CreateImageBuilder": "<p>Creates an image builder.</p> <p>The initial state of the builder is <code>PENDING</code>. When it is ready, the state is <code>RUNNING</code>.</p>",
|
||||
"CreateDirectoryConfig": "<p>Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.</p>",
|
||||
"CreateFleet": "<p>Creates a fleet. A fleet consists of streaming instances that run a specified image.</p>",
|
||||
"CreateImageBuilder": "<p>Creates an image builder. An image builder is a virtual machine that is used to create an image.</p> <p>The initial state of the builder is <code>PENDING</code>. When it is ready, the state is <code>RUNNING</code>.</p>",
|
||||
"CreateImageBuilderStreamingURL": "<p>Creates a URL to start an image builder streaming session.</p>",
|
||||
"CreateStack": "<p>Creates a stack.</p>",
|
||||
"CreateStreamingURL": "<p>Creates a URL to start a streaming session for the specified user.</p>",
|
||||
"DeleteDirectoryConfig": "<p>Deletes the specified directory configuration.</p>",
|
||||
"CreateStack": "<p>Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations. </p>",
|
||||
"CreateStreamingURL": "<p>Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup. </p>",
|
||||
"CreateUsageReportSubscription": "<p>Creates a usage report subscription. Usage reports are generated daily.</p>",
|
||||
"CreateUser": "<p>Creates a new user in the user pool.</p>",
|
||||
"DeleteDirectoryConfig": "<p>Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.</p>",
|
||||
"DeleteFleet": "<p>Deletes the specified fleet.</p>",
|
||||
"DeleteImage": "<p>Deletes the specified image. You cannot delete an image that is currently in use. After you delete an image, you cannot provision new capacity using the image.</p>",
|
||||
"DeleteImage": "<p>Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image.</p>",
|
||||
"DeleteImageBuilder": "<p>Deletes the specified image builder and releases the capacity.</p>",
|
||||
"DeleteStack": "<p>Deletes the specified stack. After this operation completes, the environment can no longer be activated and any reservations made for the stack are released.</p>",
|
||||
"DescribeDirectoryConfigs": "<p>Describes the specified directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response. </p>",
|
||||
"DescribeFleets": "<p>Describes the specified fleets or all fleets in the account.</p>",
|
||||
"DescribeImageBuilders": "<p>Describes the specified image builders or all image builders in the account.</p>",
|
||||
"DescribeImages": "<p>Describes the specified images or all images in the account.</p>",
|
||||
"DescribeSessions": "<p>Describes the streaming sessions for the specified stack and fleet. If a user ID is provided, only the streaming sessions for only that user are returned. If an authentication type is not provided, the default is to authenticate users using a streaming URL.</p>",
|
||||
"DescribeStacks": "<p>Describes the specified stacks or all stacks in the account.</p>",
|
||||
"DeleteImagePermissions": "<p>Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.</p>",
|
||||
"DeleteStack": "<p>Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.</p>",
|
||||
"DeleteUsageReportSubscription": "<p>Disables usage report generation.</p>",
|
||||
"DeleteUser": "<p>Deletes a user from the user pool.</p>",
|
||||
"DescribeDirectoryConfigs": "<p>Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains. </p> <p>Although the response syntax in this topic includes the account password, this password is not returned in the actual response.</p>",
|
||||
"DescribeFleets": "<p>Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.</p>",
|
||||
"DescribeImageBuilders": "<p>Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.</p>",
|
||||
"DescribeImagePermissions": "<p>Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own. </p>",
|
||||
"DescribeImages": "<p>Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.</p>",
|
||||
"DescribeSessions": "<p>Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.</p>",
|
||||
"DescribeStacks": "<p>Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.</p>",
|
||||
"DescribeUsageReportSubscriptions": "<p>Retrieves a list that describes one or more usage report subscriptions.</p>",
|
||||
"DescribeUserStackAssociations": "<p>Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following:</p> <ul> <li> <p>The stack name</p> </li> <li> <p>The user name (email address of the user associated with the stack) and the authentication type for the user</p> </li> </ul>",
|
||||
"DescribeUsers": "<p>Retrieves a list that describes one or more specified users in the user pool.</p>",
|
||||
"DisableUser": "<p>Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user. </p>",
|
||||
"DisassociateFleet": "<p>Disassociates the specified fleet from the specified stack.</p>",
|
||||
"ExpireSession": "<p>Stops the specified streaming session.</p>",
|
||||
"ListAssociatedFleets": "<p>Lists the fleets associated with the specified stack.</p>",
|
||||
"ListAssociatedStacks": "<p>Lists the stacks associated with the specified fleet.</p>",
|
||||
"ListTagsForResource": "<p>Lists the tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>For more information about tags, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>",
|
||||
"EnableUser": "<p>Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned.</p>",
|
||||
"ExpireSession": "<p>Immediately stops the specified streaming session.</p>",
|
||||
"ListAssociatedFleets": "<p>Retrieves the name of the fleet that is associated with the specified stack.</p>",
|
||||
"ListAssociatedStacks": "<p>Retrieves the name of the stack with which the specified fleet is associated.</p>",
|
||||
"ListTagsForResource": "<p>Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>",
|
||||
"StartFleet": "<p>Starts the specified fleet.</p>",
|
||||
"StartImageBuilder": "<p>Starts the specified image builder.</p>",
|
||||
"StopFleet": "<p>Stops the specified fleet.</p>",
|
||||
"StopImageBuilder": "<p>Stops the specified image builder.</p>",
|
||||
"TagResource": "<p>Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.</p> <p>To list the current tags for your resources, use <a>ListTagsForResource</a>. To disassociate tags from your resources, use <a>UntagResource</a>.</p> <p>For more information about tags, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>",
|
||||
"UntagResource": "<p>Disassociates the specified tags from the specified AppStream 2.0 resource.</p> <p>To list the current tags for your resources, use <a>ListTagsForResource</a>.</p> <p>For more information about tags, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>",
|
||||
"UpdateDirectoryConfig": "<p>Updates the specified directory configuration.</p>",
|
||||
"UpdateFleet": "<p>Updates the specified fleet.</p> <p>If the fleet is in the <code>STOPPED</code> state, you can update any attribute except the fleet name. If the fleet is in the <code>RUNNING</code> state, you can update the <code>DisplayName</code> and <code>ComputeCapacity</code> attributes. If the fleet is in the <code>STARTING</code> or <code>STOPPING</code> state, you can't update it.</p>",
|
||||
"UpdateStack": "<p>Updates the specified stack.</p>"
|
||||
"TagResource": "<p>Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks.</p> <p>Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value.</p> <p>To list the current tags for your resources, use <a>ListTagsForResource</a>. To disassociate tags from your resources, use <a>UntagResource</a>.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>",
|
||||
"UntagResource": "<p>Disassociates one or more specified tags from the specified AppStream 2.0 resource.</p> <p>To list the current tags for your resources, use <a>ListTagsForResource</a>.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>",
|
||||
"UpdateDirectoryConfig": "<p>Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.</p>",
|
||||
"UpdateFleet": "<p>Updates the specified fleet.</p> <p>If the fleet is in the <code>STOPPED</code> state, you can update any attribute except the fleet name. If the fleet is in the <code>RUNNING</code> state, you can update the <code>DisplayName</code>, <code>ComputeCapacity</code>, <code>ImageARN</code>, <code>ImageName</code>, and <code>DisconnectTimeoutInSeconds</code> attributes. If the fleet is in the <code>STARTING</code> or <code>STOPPING</code> state, you can't update it.</p>",
|
||||
"UpdateImagePermissions": "<p>Adds or updates permissions for the specified private image. </p>",
|
||||
"UpdateStack": "<p>Updates the specified fields for the specified stack.</p>"
|
||||
},
|
||||
"shapes": {
|
||||
"AccountName": {
|
||||
@@ -49,12 +63,31 @@
|
||||
"ServiceAccountCredentials$AccountPassword": "<p>The password for the account.</p>"
|
||||
}
|
||||
},
|
||||
"Action": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"UserSetting$Action": "<p>The action that is enabled or disabled.</p>"
|
||||
}
|
||||
},
|
||||
"Application": {
|
||||
"base": "<p>Describes an application in the application catalog.</p>",
|
||||
"refs": {
|
||||
"Applications$member": null
|
||||
}
|
||||
},
|
||||
"ApplicationSettings": {
|
||||
"base": "<p>The persistent application settings for users of a stack.</p>",
|
||||
"refs": {
|
||||
"CreateStackRequest$ApplicationSettings": "<p>The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.</p>",
|
||||
"UpdateStackRequest$ApplicationSettings": "<p>The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.</p>"
|
||||
}
|
||||
},
|
||||
"ApplicationSettingsResponse": {
|
||||
"base": "<p>Describes the persistent application settings for users of a stack.</p>",
|
||||
"refs": {
|
||||
"Stack$ApplicationSettings": "<p>The persistent application settings for users of the stack.</p>"
|
||||
}
|
||||
},
|
||||
"Applications": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -66,14 +99,18 @@
|
||||
"refs": {
|
||||
"CreateImageBuilderRequest$AppstreamAgentVersion": "<p>The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST]. </p>",
|
||||
"Image$AppstreamAgentVersion": "<p>The version of the AppStream 2.0 agent to use for instances that are launched from this image. </p>",
|
||||
"ImageBuilder$AppstreamAgentVersion": "<p>The version of the AppStream 2.0 agent that is currently being used by this image builder. </p>",
|
||||
"ImageBuilder$AppstreamAgentVersion": "<p>The version of the AppStream 2.0 agent that is currently being used by the image builder. </p>",
|
||||
"StartImageBuilderRequest$AppstreamAgentVersion": "<p>The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST]. </p>"
|
||||
}
|
||||
},
|
||||
"Arn": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ArnList$member": null,
|
||||
"CreateFleetRequest$ImageArn": "<p>The ARN of the public, private, or shared image to use.</p>",
|
||||
"CreateImageBuilderRequest$ImageArn": "<p>The ARN of the public, private, or shared image to use.</p>",
|
||||
"Fleet$Arn": "<p>The ARN for the fleet.</p>",
|
||||
"Fleet$ImageArn": "<p>The ARN for the public, private, or shared image.</p>",
|
||||
"Image$Arn": "<p>The ARN of the image.</p>",
|
||||
"Image$BaseImageArn": "<p>The ARN of the image from which this image was created.</p>",
|
||||
"ImageBuilder$Arn": "<p>The ARN for the image builder.</p>",
|
||||
@@ -81,7 +118,15 @@
|
||||
"ListTagsForResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>",
|
||||
"Stack$Arn": "<p>The ARN of the stack.</p>",
|
||||
"TagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>",
|
||||
"UntagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>"
|
||||
"UntagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource.</p>",
|
||||
"UpdateFleetRequest$ImageArn": "<p>The ARN of the public, private, or shared image to use.</p>",
|
||||
"User$Arn": "<p>The ARN of the user.</p>"
|
||||
}
|
||||
},
|
||||
"ArnList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeImagesRequest$Arns": "<p>The ARNs of the public, private, and shared images to describe.</p>"
|
||||
}
|
||||
},
|
||||
"AssociateFleetRequest": {
|
||||
@@ -97,17 +142,64 @@
|
||||
"AuthenticationType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateUserRequest$AuthenticationType": "<p>The authentication type for the user. You must specify USERPOOL. </p>",
|
||||
"DeleteUserRequest$AuthenticationType": "<p>The authentication type for the user. You must specify USERPOOL.</p>",
|
||||
"DescribeSessionsRequest$AuthenticationType": "<p>The authentication method. Specify <code>API</code> for a user authenticated using a streaming URL or <code>SAML</code> for a SAML federated user. The default is to authenticate users using a streaming URL.</p>",
|
||||
"Session$AuthenticationType": "<p>The authentication method. The user is authenticated using a streaming URL (<code>API</code>) or SAML federation (<code>SAML</code>).</p>"
|
||||
"DescribeUserStackAssociationsRequest$AuthenticationType": "<p>The authentication type for the user who is associated with the stack. You must specify USERPOOL.</p>",
|
||||
"DescribeUsersRequest$AuthenticationType": "<p>The authentication type for the users in the user pool to describe. You must specify USERPOOL.</p>",
|
||||
"DisableUserRequest$AuthenticationType": "<p>The authentication type for the user. You must specify USERPOOL.</p>",
|
||||
"EnableUserRequest$AuthenticationType": "<p>The authentication type for the user. You must specify USERPOOL.</p>",
|
||||
"Session$AuthenticationType": "<p>The authentication method. The user is authenticated using a streaming URL (<code>API</code>) or SAML 2.0 federation (<code>SAML</code>).</p>",
|
||||
"User$AuthenticationType": "<p>The authentication type for the user.</p>",
|
||||
"UserStackAssociation$AuthenticationType": "<p>The authentication type for the user.</p>"
|
||||
}
|
||||
},
|
||||
"AwsAccountId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AwsAccountIdList$member": null,
|
||||
"DeleteImagePermissionsRequest$SharedAccountId": "<p>The 12-digit identifier of the AWS account for which to delete image permissions.</p>",
|
||||
"SharedImagePermissions$sharedAccountId": "<p>The 12-digit identifier of the AWS account with which the image is shared.</p>",
|
||||
"UpdateImagePermissionsRequest$SharedAccountId": "<p>The 12-digit identifier of the AWS account for which you want add or update image permissions.</p>"
|
||||
}
|
||||
},
|
||||
"AwsAccountIdList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeImagePermissionsRequest$SharedAwsAccountIds": "<p>The 12-digit identifier of one or more AWS accounts with which the image is shared.</p>"
|
||||
}
|
||||
},
|
||||
"BatchAssociateUserStackRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"BatchAssociateUserStackResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"BatchDisassociateUserStackRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"BatchDisassociateUserStackResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Boolean": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Application$Enabled": "<p>If there is a problem, the application can be disabled after image creation.</p>",
|
||||
"ApplicationSettings$Enabled": "<p>Enables or disables persistent application settings for users during their streaming sessions. </p>",
|
||||
"ApplicationSettingsResponse$Enabled": "<p>Specifies whether persistent application settings are enabled for users during their streaming sessions.</p>",
|
||||
"Image$ImageBuilderSupported": "<p>Indicates whether an image builder can be launched from this image.</p>",
|
||||
"UpdateFleetRequest$DeleteVpcConfig": "<p>Deletes the VPC association for the specified fleet.</p>",
|
||||
"UpdateStackRequest$DeleteStorageConnectors": "<p>Deletes the storage connectors currently enabled for the stack.</p>"
|
||||
"UpdateStackRequest$DeleteStorageConnectors": "<p>Deletes the storage connectors currently enabled for the stack.</p>",
|
||||
"User$Enabled": "<p>Specifies whether the user in the user pool is enabled.</p>",
|
||||
"UserStackAssociation$SendEmailNotification": "<p>Specifies whether a welcome email is sent to a user after the user is created in the user pool.</p>"
|
||||
}
|
||||
},
|
||||
"BooleanObject": {
|
||||
@@ -117,6 +209,8 @@
|
||||
"CreateImageBuilderRequest$EnableDefaultInternetAccess": "<p>Enables or disables default internet access for the image builder.</p>",
|
||||
"Fleet$EnableDefaultInternetAccess": "<p>Indicates whether default internet access is enabled for the fleet.</p>",
|
||||
"ImageBuilder$EnableDefaultInternetAccess": "<p>Enables or disables default internet access for the image builder.</p>",
|
||||
"ImagePermissions$allowFleet": "<p>Indicates whether the image can be used for a fleet.</p>",
|
||||
"ImagePermissions$allowImageBuilder": "<p>Indicates whether the image can be used for an image builder.</p>",
|
||||
"UpdateFleetRequest$EnableDefaultInternetAccess": "<p>Enables or disables default internet access for the fleet.</p>"
|
||||
}
|
||||
},
|
||||
@@ -208,6 +302,26 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateUsageReportSubscriptionRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateUsageReportSubscriptionResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateUserRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateUserResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteDirectoryConfigRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -238,6 +352,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteImagePermissionsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteImagePermissionsResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteImageRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -258,6 +382,26 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteUsageReportSubscriptionRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteUsageReportSubscriptionResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteUserRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteUserResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeDirectoryConfigsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -288,6 +432,22 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeImagePermissionsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeImagePermissionsResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeImagesMaxResults": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeImagesRequest$MaxResults": "<p>The maximum size of each page of results.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeImagesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -318,23 +478,53 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeUsageReportSubscriptionsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeUsageReportSubscriptionsResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeUserStackAssociationsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeUserStackAssociationsResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeUsersRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeUsersResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Description": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CopyImageRequest$DestinationImageDescription": "<p>The description that the image will have when it is copied to the destination.</p>",
|
||||
"CreateFleetRequest$Description": "<p>The description for display.</p>",
|
||||
"CreateImageBuilderRequest$Description": "<p>The description for display.</p>",
|
||||
"CreateStackRequest$Description": "<p>The description for display.</p>",
|
||||
"UpdateFleetRequest$Description": "<p>The description for display.</p>",
|
||||
"UpdateStackRequest$Description": "<p>The description for display.</p>"
|
||||
"CreateFleetRequest$Description": "<p>The description to display.</p>",
|
||||
"CreateImageBuilderRequest$Description": "<p>The description to display.</p>",
|
||||
"CreateStackRequest$Description": "<p>The description to display.</p>",
|
||||
"UpdateFleetRequest$Description": "<p>The description to display.</p>",
|
||||
"UpdateStackRequest$Description": "<p>The description to display.</p>"
|
||||
}
|
||||
},
|
||||
"DirectoryConfig": {
|
||||
"base": "<p>Configuration information for the directory used to join domains.</p>",
|
||||
"base": "<p>Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.</p>",
|
||||
"refs": {
|
||||
"CreateDirectoryConfigResult$DirectoryConfig": "<p>Information about the directory configuration.</p>",
|
||||
"DirectoryConfigList$member": null,
|
||||
"UpdateDirectoryConfigResult$DirectoryConfig": "<p>Information about the directory configuration.</p>"
|
||||
"UpdateDirectoryConfigResult$DirectoryConfig": "<p>Information about the Directory Config object.</p>"
|
||||
}
|
||||
},
|
||||
"DirectoryConfigList": {
|
||||
@@ -351,7 +541,7 @@
|
||||
"DirectoryConfig$DirectoryName": "<p>The fully qualified name of the directory (for example, corp.example.com).</p>",
|
||||
"DirectoryNameList$member": null,
|
||||
"DomainJoinInfo$DirectoryName": "<p>The fully qualified name of the directory (for example, corp.example.com).</p>",
|
||||
"UpdateDirectoryConfigRequest$DirectoryName": "<p>The name of the directory configuration.</p>"
|
||||
"UpdateDirectoryConfigRequest$DirectoryName": "<p>The name of the Directory Config object.</p>"
|
||||
}
|
||||
},
|
||||
"DirectoryNameList": {
|
||||
@@ -360,6 +550,16 @@
|
||||
"DescribeDirectoryConfigsRequest$DirectoryNames": "<p>The directory names.</p>"
|
||||
}
|
||||
},
|
||||
"DisableUserRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DisableUserResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DisassociateFleetRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -373,21 +573,43 @@
|
||||
"DisplayName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateFleetRequest$DisplayName": "<p>The fleet name for display.</p>",
|
||||
"CreateImageBuilderRequest$DisplayName": "<p>The image builder name for display.</p>",
|
||||
"CreateStackRequest$DisplayName": "<p>The stack name for display.</p>",
|
||||
"UpdateFleetRequest$DisplayName": "<p>The fleet name for display.</p>",
|
||||
"UpdateStackRequest$DisplayName": "<p>The stack name for display.</p>"
|
||||
"CreateFleetRequest$DisplayName": "<p>The fleet name to display.</p>",
|
||||
"CreateImageBuilderRequest$DisplayName": "<p>The image builder name to display.</p>",
|
||||
"CreateStackRequest$DisplayName": "<p>The stack name to display.</p>",
|
||||
"UpdateFleetRequest$DisplayName": "<p>The fleet name to display.</p>",
|
||||
"UpdateStackRequest$DisplayName": "<p>The stack name to display.</p>"
|
||||
}
|
||||
},
|
||||
"Domain": {
|
||||
"base": "GSuite domain for GDrive integration.",
|
||||
"refs": {
|
||||
"DomainList$member": null
|
||||
}
|
||||
},
|
||||
"DomainJoinInfo": {
|
||||
"base": "<p>Contains the information needed to join a Microsoft Active Directory domain.</p>",
|
||||
"base": "<p>Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.</p>",
|
||||
"refs": {
|
||||
"CreateFleetRequest$DomainJoinInfo": "<p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. </p>",
|
||||
"CreateImageBuilderRequest$DomainJoinInfo": "<p>The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. </p>",
|
||||
"Fleet$DomainJoinInfo": "<p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. </p>",
|
||||
"ImageBuilder$DomainJoinInfo": "<p>The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain. </p>",
|
||||
"UpdateFleetRequest$DomainJoinInfo": "<p>The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. </p>"
|
||||
}
|
||||
},
|
||||
"DomainList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StorageConnector$Domains": "<p>The names of the domains for the account.</p>"
|
||||
}
|
||||
},
|
||||
"EnableUserRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"EnableUserResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateFleetRequest$DomainJoinInfo": "<p>The information needed to join a Microsoft Active Directory domain.</p>",
|
||||
"CreateImageBuilderRequest$DomainJoinInfo": "<p>The information needed to join a Microsoft Active Directory domain.</p>",
|
||||
"Fleet$DomainJoinInfo": "<p>The information needed to join a Microsoft Active Directory domain.</p>",
|
||||
"ImageBuilder$DomainJoinInfo": "<p>The information needed to join a Microsoft Active Directory domain.</p>",
|
||||
"UpdateFleetRequest$DomainJoinInfo": "<p>The information needed to join a Microsoft Active Directory domain.</p>"
|
||||
}
|
||||
},
|
||||
"ErrorMessage": {
|
||||
@@ -421,11 +643,11 @@
|
||||
"refs": {
|
||||
"CreateStackRequest$FeedbackURL": "<p>The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</p>",
|
||||
"Stack$FeedbackURL": "<p>The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</p>",
|
||||
"UpdateStackRequest$FeedbackURL": "<p>The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</p>"
|
||||
"UpdateStackRequest$FeedbackURL": "<p>The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.</p>"
|
||||
}
|
||||
},
|
||||
"Fleet": {
|
||||
"base": "<p>Contains the parameters for a fleet.</p>",
|
||||
"base": "<p>Describes a fleet.</p>",
|
||||
"refs": {
|
||||
"CreateFleetResult$Fleet": "<p>Information about the fleet.</p>",
|
||||
"FleetList$member": null,
|
||||
@@ -490,7 +712,7 @@
|
||||
}
|
||||
},
|
||||
"ImageBuilder": {
|
||||
"base": "<p>Describes a streaming instance used for editing an image. New images are created from a snapshot through an image builder.</p>",
|
||||
"base": "<p>Describes a virtual machine that is used to create an image. </p>",
|
||||
"refs": {
|
||||
"CreateImageBuilderResult$ImageBuilder": "<p>Information about the image builder.</p>",
|
||||
"DeleteImageBuilderResult$ImageBuilder": "<p>Information about the image builder.</p>",
|
||||
@@ -529,6 +751,14 @@
|
||||
"DescribeImagesResult$Images": "<p>Information about the images.</p>"
|
||||
}
|
||||
},
|
||||
"ImagePermissions": {
|
||||
"base": "<p>Describes the permissions for an image. </p>",
|
||||
"refs": {
|
||||
"Image$ImagePermissions": "<p>The permissions to provide to the destination AWS account for the specified image.</p>",
|
||||
"SharedImagePermissions$imagePermissions": "<p>Describes the permissions for a shared image.</p>",
|
||||
"UpdateImagePermissionsRequest$ImagePermissions": "<p>The permissions for the image.</p>"
|
||||
}
|
||||
},
|
||||
"ImageState": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -560,15 +790,20 @@
|
||||
"ComputeCapacityStatus$Running": "<p>The total number of simultaneous streaming instances that are running.</p>",
|
||||
"ComputeCapacityStatus$InUse": "<p>The number of instances in use for streaming.</p>",
|
||||
"ComputeCapacityStatus$Available": "<p>The number of currently available instances that can be used to stream sessions.</p>",
|
||||
"CreateFleetRequest$MaxUserDurationInSeconds": "<p>The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.</p>",
|
||||
"CreateFleetRequest$DisconnectTimeoutInSeconds": "<p>The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.</p>",
|
||||
"CreateFleetRequest$MaxUserDurationInSeconds": "<p>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.</p> <p>Specify a value between 600 and 360000.</p>",
|
||||
"CreateFleetRequest$DisconnectTimeoutInSeconds": "<p>The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. </p> <p>Specify a value between 60 and 360000.</p>",
|
||||
"CreateFleetRequest$IdleDisconnectTimeoutInSeconds": "<p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in <code>DisconnectTimeoutInSeconds</code> elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in <code>IdleDisconnectTimeoutInSeconds</code> elapses, they are disconnected.</p> <p>To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.</p> <note> <p>If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity. </p> </note>",
|
||||
"DescribeDirectoryConfigsRequest$MaxResults": "<p>The maximum size of each page of results.</p>",
|
||||
"DescribeImageBuildersRequest$MaxResults": "<p>The maximum size of each page of results.</p>",
|
||||
"DescribeSessionsRequest$Limit": "<p>The size of each page of results. The default value is 20 and the maximum value is 50.</p>",
|
||||
"Fleet$MaxUserDurationInSeconds": "<p>The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.</p>",
|
||||
"Fleet$DisconnectTimeoutInSeconds": "<p>The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.</p>",
|
||||
"UpdateFleetRequest$MaxUserDurationInSeconds": "<p>The maximum time that a streaming session can run, in seconds. Specify a value between 600 and 57600.</p>",
|
||||
"UpdateFleetRequest$DisconnectTimeoutInSeconds": "<p>The time after disconnection when a session is considered to have ended, in seconds. If a user who was disconnected reconnects within this time interval, the user is connected to their previous session. Specify a value between 60 and 57600.</p>"
|
||||
"DescribeUsageReportSubscriptionsRequest$MaxResults": "<p>The maximum size of each page of results.</p>",
|
||||
"DescribeUsersRequest$MaxResults": "<p>The maximum size of each page of results.</p>",
|
||||
"Fleet$MaxUserDurationInSeconds": "<p>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance. </p> <p>Specify a value between 600 and 360000.</p>",
|
||||
"Fleet$DisconnectTimeoutInSeconds": "<p>The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.</p> <p>Specify a value between 60 and 360000.</p>",
|
||||
"Fleet$IdleDisconnectTimeoutInSeconds": "<p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in <code>DisconnectTimeoutInSeconds</code> elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in <code>IdleDisconnectTimeoutInSeconds</code> elapses, they are disconnected.</p> <p>To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.</p> <note> <p>If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity. </p> </note>",
|
||||
"UpdateFleetRequest$MaxUserDurationInSeconds": "<p>The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.</p> <p>Specify a value between 600 and 360000.</p>",
|
||||
"UpdateFleetRequest$DisconnectTimeoutInSeconds": "<p>The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. </p> <p>Specify a value between 60 and 360000.</p>",
|
||||
"UpdateFleetRequest$IdleDisconnectTimeoutInSeconds": "<p>The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the <code>DisconnectTimeoutInSeconds</code> time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in <code>DisconnectTimeoutInSeconds</code> elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in <code>IdleDisconnectTimeoutInSeconds</code> elapses, they are disconnected. </p> <p>To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0.</p> <note> <p>If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity. </p> </note>"
|
||||
}
|
||||
},
|
||||
"InvalidAccountStatusException": {
|
||||
@@ -586,6 +821,18 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"LastReportGenerationExecutionError": {
|
||||
"base": "<p>Describes the error that is returned when a usage report can't be generated.</p>",
|
||||
"refs": {
|
||||
"LastReportGenerationExecutionErrors$member": null
|
||||
}
|
||||
},
|
||||
"LastReportGenerationExecutionErrors": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"UsageReportSubscription$SubscriptionErrors": "<p>The errors that were returned if usage reports couldn't be generated.</p>"
|
||||
}
|
||||
},
|
||||
"LimitExceededException": {
|
||||
"base": "<p>The requested limit exceeds the permitted limit for an account.</p>",
|
||||
"refs": {
|
||||
@@ -628,6 +875,19 @@
|
||||
"CreateStreamingURLRequest$Validity": "<p>The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.</p>"
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeImagePermissionsRequest$MaxResults": "<p>The maximum size of each page of results.</p>",
|
||||
"DescribeUserStackAssociationsRequest$MaxResults": "<p>The maximum size of each page of results.</p>"
|
||||
}
|
||||
},
|
||||
"MessageAction": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateUserRequest$MessageAction": "<p>The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent. </p> <note> <p>The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.</p> </note>"
|
||||
}
|
||||
},
|
||||
"Metadata": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -642,8 +902,20 @@
|
||||
"CopyImageResponse$DestinationImageName": "<p>The name of the destination image.</p>",
|
||||
"CreateFleetRequest$Name": "<p>A unique name for the fleet.</p>",
|
||||
"CreateImageBuilderRequest$Name": "<p>A unique name for the image builder.</p>",
|
||||
"CreateStackRequest$Name": "<p>The name of the stack.</p>",
|
||||
"DeleteImageBuilderRequest$Name": "<p>The name of the image builder.</p>",
|
||||
"DeleteImageRequest$Name": "<p>The name of the image.</p>"
|
||||
"DeleteImagePermissionsRequest$Name": "<p>The name of the private image.</p>",
|
||||
"DeleteImageRequest$Name": "<p>The name of the image.</p>",
|
||||
"DescribeImagePermissionsRequest$Name": "<p>The name of the private image for which to describe permissions. The image must be one that you own. </p>",
|
||||
"DescribeImagePermissionsResult$Name": "<p>The name of the private image.</p>",
|
||||
"UpdateImagePermissionsRequest$Name": "<p>The name of the private image.</p>"
|
||||
}
|
||||
},
|
||||
"NetworkAccessConfiguration": {
|
||||
"base": "<p>Describes the network details of the fleet or image builder instance.</p>",
|
||||
"refs": {
|
||||
"ImageBuilder$NetworkAccessConfiguration": null,
|
||||
"Session$NetworkAccessConfiguration": "<p>The network details for the streaming session.</p>"
|
||||
}
|
||||
},
|
||||
"OperationNotPermittedException": {
|
||||
@@ -666,6 +938,12 @@
|
||||
"UpdateDirectoryConfigRequest$OrganizationalUnitDistinguishedNames": "<p>The distinguished names of the organizational units for computer accounts.</p>"
|
||||
}
|
||||
},
|
||||
"Permission": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"UserSetting$Permission": "<p>Indicates whether the action is enabled or disabled.</p>"
|
||||
}
|
||||
},
|
||||
"PlatformType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -726,17 +1004,17 @@
|
||||
}
|
||||
},
|
||||
"SecurityGroupIdList": {
|
||||
"base": "<p>The security group IDs.</p>",
|
||||
"base": "<p>The security group identifiers.</p>",
|
||||
"refs": {
|
||||
"VpcConfig$SecurityGroupIds": "<p>The security groups for the fleet.</p>"
|
||||
"VpcConfig$SecurityGroupIds": "<p>The identifiers of the security groups for the fleet or image builder.</p>"
|
||||
}
|
||||
},
|
||||
"ServiceAccountCredentials": {
|
||||
"base": "<p>Describes the credentials for the service account used by the streaming instance to connect to the directory.</p>",
|
||||
"base": "<p>Describes the credentials for the service account used by the fleet or image builder to connect to the directory.</p>",
|
||||
"refs": {
|
||||
"CreateDirectoryConfigRequest$ServiceAccountCredentials": "<p>The credentials for the service account used by the streaming instance to connect to the directory.</p>",
|
||||
"DirectoryConfig$ServiceAccountCredentials": "<p>The credentials for the service account used by the streaming instance to connect to the directory.</p>",
|
||||
"UpdateDirectoryConfigRequest$ServiceAccountCredentials": "<p>The credentials for the service account used by the streaming instance to connect to the directory.</p>"
|
||||
"CreateDirectoryConfigRequest$ServiceAccountCredentials": "<p>The credentials for the service account used by the fleet or image builder to connect to the directory.</p>",
|
||||
"DirectoryConfig$ServiceAccountCredentials": "<p>The credentials for the service account used by the fleet or image builder to connect to the directory.</p>",
|
||||
"UpdateDirectoryConfigRequest$ServiceAccountCredentials": "<p>The credentials for the service account used by the fleet or image builder to connect to the directory.</p>"
|
||||
}
|
||||
},
|
||||
"Session": {
|
||||
@@ -745,6 +1023,12 @@
|
||||
"SessionList$member": null
|
||||
}
|
||||
},
|
||||
"SessionConnectionState": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Session$ConnectionState": "<p>Specifies whether a user is connected to the streaming session.</p>"
|
||||
}
|
||||
},
|
||||
"SessionList": {
|
||||
"base": "<p>List of sessions.</p>",
|
||||
"refs": {
|
||||
@@ -757,6 +1041,25 @@
|
||||
"Session$State": "<p>The current state of the streaming session.</p>"
|
||||
}
|
||||
},
|
||||
"SettingsGroup": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ApplicationSettings$SettingsGroup": "<p>The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack. </p>",
|
||||
"ApplicationSettingsResponse$SettingsGroup": "<p>The path prefix for the S3 bucket where users’ persistent application settings are stored.</p>"
|
||||
}
|
||||
},
|
||||
"SharedImagePermissions": {
|
||||
"base": "<p>Describes the permissions that are available to the specified AWS account for a shared image.</p>",
|
||||
"refs": {
|
||||
"SharedImagePermissionsList$member": null
|
||||
}
|
||||
},
|
||||
"SharedImagePermissionsList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeImagePermissionsResult$SharedImagePermissionsList": "<p>The permissions for a private image that you own. </p>"
|
||||
}
|
||||
},
|
||||
"Stack": {
|
||||
"base": "<p>Describes a stack.</p>",
|
||||
"refs": {
|
||||
@@ -842,7 +1145,7 @@
|
||||
}
|
||||
},
|
||||
"StorageConnector": {
|
||||
"base": "<p>Describes a storage connector.</p>",
|
||||
"base": "<p>Describes a connector that enables persistent storage for users.</p>",
|
||||
"refs": {
|
||||
"StorageConnectorList$member": null
|
||||
}
|
||||
@@ -864,31 +1167,32 @@
|
||||
"StreamingUrlUserId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateStreamingURLRequest$UserId": "<p>The ID of the user.</p>"
|
||||
"CreateStreamingURLRequest$UserId": "<p>The identifier of the user.</p>"
|
||||
}
|
||||
},
|
||||
"String": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Application$Name": "<p>The name of the application.</p>",
|
||||
"Application$DisplayName": "<p>The application name for display.</p>",
|
||||
"Application$DisplayName": "<p>The application name to display.</p>",
|
||||
"Application$IconURL": "<p>The URL for the application icon. This URL might be time-limited.</p>",
|
||||
"Application$LaunchPath": "<p>The path to the application executable in the instance.</p>",
|
||||
"Application$LaunchParameters": "<p>The arguments that are passed to the application at launch.</p>",
|
||||
"ApplicationSettingsResponse$S3BucketName": "<p>The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region. </p>",
|
||||
"AssociateFleetRequest$FleetName": "<p>The name of the fleet. </p>",
|
||||
"AssociateFleetRequest$StackName": "<p>The name of the stack.</p>",
|
||||
"CreateFleetRequest$ImageName": "<p>The name of the image used to create the fleet.</p>",
|
||||
"CreateFleetRequest$InstanceType": "<p>The instance type to use when launching fleet instances. The following instance types are available:</p> <ul> <li> <p>stream.standard.medium</p> </li> <li> <p>stream.standard.large</p> </li> <li> <p>stream.compute.large</p> </li> <li> <p>stream.compute.xlarge</p> </li> <li> <p>stream.compute.2xlarge</p> </li> <li> <p>stream.compute.4xlarge</p> </li> <li> <p>stream.compute.8xlarge</p> </li> <li> <p>stream.memory.large</p> </li> <li> <p>stream.memory.xlarge</p> </li> <li> <p>stream.memory.2xlarge</p> </li> <li> <p>stream.memory.4xlarge</p> </li> <li> <p>stream.memory.8xlarge</p> </li> <li> <p>stream.graphics-design.large</p> </li> <li> <p>stream.graphics-design.xlarge</p> </li> <li> <p>stream.graphics-design.2xlarge</p> </li> <li> <p>stream.graphics-design.4xlarge</p> </li> <li> <p>stream.graphics-desktop.2xlarge</p> </li> <li> <p>stream.graphics-pro.4xlarge</p> </li> <li> <p>stream.graphics-pro.8xlarge</p> </li> <li> <p>stream.graphics-pro.16xlarge</p> </li> </ul>",
|
||||
"CreateImageBuilderRequest$ImageName": "<p>The name of the image used to create the builder.</p>",
|
||||
"CreateImageBuilderRequest$ImageName": "<p>The name of the image used to create the image builder.</p>",
|
||||
"CreateImageBuilderRequest$InstanceType": "<p>The instance type to use when launching the image builder.</p>",
|
||||
"CreateImageBuilderStreamingURLRequest$Name": "<p>The name of the image builder.</p>",
|
||||
"CreateImageBuilderStreamingURLResult$StreamingURL": "<p>The URL to start the AppStream 2.0 streaming session.</p>",
|
||||
"CreateStackRequest$Name": "<p>The name of the stack.</p>",
|
||||
"CreateStreamingURLRequest$StackName": "<p>The name of the stack.</p>",
|
||||
"CreateStreamingURLRequest$FleetName": "<p>The name of the fleet.</p>",
|
||||
"CreateStreamingURLRequest$ApplicationId": "<p>The name of the application to launch after the session starts. This is the name that you specified as <b>Name</b> in the Image Assistant.</p>",
|
||||
"CreateStreamingURLRequest$SessionContext": "<p>The session context. For more information, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/managing-stacks-fleets.html#managing-stacks-fleets-parameters\">Session Context</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>",
|
||||
"CreateStreamingURLRequest$SessionContext": "<p>The session context. For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/managing-stacks-fleets.html#managing-stacks-fleets-parameters\">Session Context</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>",
|
||||
"CreateStreamingURLResult$StreamingURL": "<p>The URL to start the AppStream 2.0 streaming session.</p>",
|
||||
"CreateUsageReportSubscriptionResult$S3BucketName": "<p>The Amazon S3 bucket where generated reports are stored.</p> <p>If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.</p>",
|
||||
"DeleteFleetRequest$Name": "<p>The name of the fleet.</p>",
|
||||
"DeleteStackRequest$Name": "<p>The name of the stack.</p>",
|
||||
"DescribeDirectoryConfigsRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>",
|
||||
@@ -897,30 +1201,43 @@
|
||||
"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>",
|
||||
"DescribeImageBuildersRequest$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>",
|
||||
"DescribeImageBuildersResult$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>",
|
||||
"DescribeImagePermissionsRequest$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>",
|
||||
"DescribeImagePermissionsResult$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>",
|
||||
"DescribeImagesRequest$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>",
|
||||
"DescribeImagesResult$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. This value is case-sensitive.</p>",
|
||||
"DescribeSessionsRequest$FleetName": "<p>The name of the fleet. This value is case-sensitive.</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>",
|
||||
"DescribeUsageReportSubscriptionsRequest$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>",
|
||||
"DescribeUsageReportSubscriptionsResult$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>",
|
||||
"DescribeUserStackAssociationsRequest$StackName": "<p>The name of the stack that is associated with the user.</p>",
|
||||
"DescribeUserStackAssociationsRequest$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>",
|
||||
"DescribeUserStackAssociationsResult$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>",
|
||||
"DescribeUsersRequest$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>",
|
||||
"DescribeUsersResult$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.</p>",
|
||||
"DisassociateFleetRequest$StackName": "<p>The name of the stack.</p>",
|
||||
"ExpireSessionRequest$SessionId": "<p>The ID of the streaming session.</p>",
|
||||
"ExpireSessionRequest$SessionId": "<p>The identifier of the streaming session.</p>",
|
||||
"Fleet$Name": "<p>The name of the fleet.</p>",
|
||||
"Fleet$DisplayName": "<p>The fleet name for display.</p>",
|
||||
"Fleet$Description": "<p>The description for display.</p>",
|
||||
"Fleet$DisplayName": "<p>The fleet name to display.</p>",
|
||||
"Fleet$Description": "<p>The description to display.</p>",
|
||||
"Fleet$ImageName": "<p>The name of the image used to create the fleet.</p>",
|
||||
"Fleet$InstanceType": "<p>The instance type to use when launching fleet instances.</p>",
|
||||
"FleetError$ErrorMessage": "<p>The error message.</p>",
|
||||
"Image$Name": "<p>The name of the image.</p>",
|
||||
"Image$DisplayName": "<p>The image name for display.</p>",
|
||||
"Image$Description": "<p>The description for display.</p>",
|
||||
"Image$DisplayName": "<p>The image name to display.</p>",
|
||||
"Image$ImageBuilderName": "<p>The name of the image builder that was used to create the private image. If the image is shared, this value is null.</p>",
|
||||
"Image$Description": "<p>The description to display.</p>",
|
||||
"ImageBuilder$Name": "<p>The name of the image builder.</p>",
|
||||
"ImageBuilder$Description": "<p>The description for display.</p>",
|
||||
"ImageBuilder$DisplayName": "<p>The image builder name for display.</p>",
|
||||
"ImageBuilder$Description": "<p>The description to display.</p>",
|
||||
"ImageBuilder$DisplayName": "<p>The image builder name to display.</p>",
|
||||
"ImageBuilder$InstanceType": "<p>The instance type for the image builder.</p>",
|
||||
"ImageBuilderStateChangeReason$Message": "<p>The state change reason message.</p>",
|
||||
"ImageStateChangeReason$Message": "<p>The state change reason message.</p>",
|
||||
"LastReportGenerationExecutionError$ErrorMessage": "<p>The error message for the error that is returned when a usage report can't be generated.</p>",
|
||||
"ListAssociatedFleetsRequest$StackName": "<p>The name of the stack.</p>",
|
||||
"ListAssociatedFleetsRequest$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.</p>",
|
||||
"ListAssociatedFleetsResult$NextToken": "<p>The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.</p>",
|
||||
@@ -929,14 +1246,16 @@
|
||||
"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,
|
||||
"NetworkAccessConfiguration$EniPrivateIpAddress": "<p>The private IP address of the elastic network interface that is attached to instances in your VPC.</p>",
|
||||
"NetworkAccessConfiguration$EniId": "<p>The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.</p>",
|
||||
"ResourceError$ErrorMessage": "<p>The error message.</p>",
|
||||
"SecurityGroupIdList$member": null,
|
||||
"Session$Id": "<p>The ID of the streaming session.</p>",
|
||||
"Session$Id": "<p>The identifier of the streaming session.</p>",
|
||||
"Session$StackName": "<p>The name of the stack for the streaming session.</p>",
|
||||
"Session$FleetName": "<p>The name of the fleet for the streaming session.</p>",
|
||||
"Stack$Name": "<p>The name of the stack.</p>",
|
||||
"Stack$Description": "<p>The description for display.</p>",
|
||||
"Stack$DisplayName": "<p>The stack name for display.</p>",
|
||||
"Stack$Description": "<p>The description to display.</p>",
|
||||
"Stack$DisplayName": "<p>The stack name to display.</p>",
|
||||
"StackError$ErrorMessage": "<p>The error message.</p>",
|
||||
"StartFleetRequest$Name": "<p>The name of the fleet.</p>",
|
||||
"StartImageBuilderRequest$Name": "<p>The name of the image builder.</p>",
|
||||
@@ -947,7 +1266,11 @@
|
||||
"UpdateFleetRequest$ImageName": "<p>The name of the image used to create the fleet.</p>",
|
||||
"UpdateFleetRequest$Name": "<p>A unique name for the fleet.</p>",
|
||||
"UpdateFleetRequest$InstanceType": "<p>The instance type to use when launching fleet instances. The following instance types are available:</p> <ul> <li> <p>stream.standard.medium</p> </li> <li> <p>stream.standard.large</p> </li> <li> <p>stream.compute.large</p> </li> <li> <p>stream.compute.xlarge</p> </li> <li> <p>stream.compute.2xlarge</p> </li> <li> <p>stream.compute.4xlarge</p> </li> <li> <p>stream.compute.8xlarge</p> </li> <li> <p>stream.memory.large</p> </li> <li> <p>stream.memory.xlarge</p> </li> <li> <p>stream.memory.2xlarge</p> </li> <li> <p>stream.memory.4xlarge</p> </li> <li> <p>stream.memory.8xlarge</p> </li> <li> <p>stream.graphics-design.large</p> </li> <li> <p>stream.graphics-design.xlarge</p> </li> <li> <p>stream.graphics-design.2xlarge</p> </li> <li> <p>stream.graphics-design.4xlarge</p> </li> <li> <p>stream.graphics-desktop.2xlarge</p> </li> <li> <p>stream.graphics-pro.4xlarge</p> </li> <li> <p>stream.graphics-pro.8xlarge</p> </li> <li> <p>stream.graphics-pro.16xlarge</p> </li> </ul>",
|
||||
"UpdateStackRequest$Name": "<p>The name of the stack.</p>"
|
||||
"UpdateStackRequest$Name": "<p>The name of the stack.</p>",
|
||||
"UsageReportSubscription$S3BucketName": "<p>The Amazon S3 bucket where generated reports are stored.</p> <p>If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.</p>",
|
||||
"User$Status": "<p>The status of the user in the user pool. The status can be one of the following:</p> <ul> <li> <p>UNCONFIRMED – The user is created but not confirmed.</p> </li> <li> <p>CONFIRMED – The user is confirmed.</p> </li> <li> <p>ARCHIVED – The user is no longer active.</p> </li> <li> <p>COMPROMISED – The user is disabled because of a potential security threat.</p> </li> <li> <p>UNKNOWN – The user status is not known.</p> </li> </ul>",
|
||||
"UserStackAssociation$StackName": "<p>The name of the stack that is associated with the user.</p>",
|
||||
"UserStackAssociationError$ErrorMessage": "<p>The error message for the error that is returned when a user can’t be associated with or disassociated from a stack.</p>"
|
||||
}
|
||||
},
|
||||
"StringList": {
|
||||
@@ -955,16 +1278,16 @@
|
||||
"refs": {
|
||||
"DescribeFleetsRequest$Names": "<p>The names of the fleets to describe.</p>",
|
||||
"DescribeImageBuildersRequest$Names": "<p>The names of the image builders to describe.</p>",
|
||||
"DescribeImagesRequest$Names": "<p>The names of the images to describe.</p>",
|
||||
"DescribeImagesRequest$Names": "<p>The names of the public or private images to describe.</p>",
|
||||
"DescribeStacksRequest$Names": "<p>The names of the stacks to describe.</p>",
|
||||
"ListAssociatedFleetsResult$Names": "<p>The names of the fleets.</p>",
|
||||
"ListAssociatedStacksResult$Names": "<p>The names of the stacks.</p>"
|
||||
"ListAssociatedFleetsResult$Names": "<p>The name of the fleet.</p>",
|
||||
"ListAssociatedStacksResult$Names": "<p>The name of the stack.</p>"
|
||||
}
|
||||
},
|
||||
"SubnetIdList": {
|
||||
"base": "<p>The subnet IDs.</p>",
|
||||
"base": "<p>The subnet identifiers.</p>",
|
||||
"refs": {
|
||||
"VpcConfig$SubnetIds": "<p>The subnets to which a network interface is established from the fleet instance.</p>"
|
||||
"VpcConfig$SubnetIds": "<p>The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.</p>"
|
||||
}
|
||||
},
|
||||
"TagKey": {
|
||||
@@ -999,8 +1322,11 @@
|
||||
"Tags": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateFleetRequest$Tags": "<p>The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p> <p>_ . : / = + \\ - @</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>",
|
||||
"CreateImageBuilderRequest$Tags": "<p>The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p> <p>_ . : / = + \\ - @</p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>",
|
||||
"CreateStackRequest$Tags": "<p>The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p> <p>_ . : / = + \\ - @</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/appstream2/latest/developerguide/tagging-basic.html\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>",
|
||||
"ListTagsForResourceResponse$Tags": "<p>The information about the tags.</p>",
|
||||
"TagResourceRequest$Tags": "<p>The tags to associate. A tag is a key-value pair (the value is optional). For example, <code>Environment=Test</code>, or, if you do not specify a value, <code>Environment=</code>. </p> <p>If you do not specify a value, we set the value to an empty string.</p>"
|
||||
"TagResourceRequest$Tags": "<p>The tags to associate. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. </p> <p>If you do not specify a value, the value is set to an empty string.</p> <p>Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: </p> <p>_ . : / = + \\ - @</p>"
|
||||
}
|
||||
},
|
||||
"Timestamp": {
|
||||
@@ -1014,7 +1340,11 @@
|
||||
"Image$PublicBaseImageReleasedDate": "<p>The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.</p>",
|
||||
"ImageBuilder$CreatedTime": "<p>The time stamp when the image builder was created.</p>",
|
||||
"ResourceError$ErrorTimestamp": "<p>The time the error occurred.</p>",
|
||||
"Stack$CreatedTime": "<p>The time the stack was created.</p>"
|
||||
"Session$StartTime": "<p>The time when a streaming instance is dedicated for the user.</p>",
|
||||
"Session$MaxExpirationTime": "<p>The time when the streaming session is set to expire. This time is based on the <code>MaxUserDurationinSeconds</code> value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in <code>SessionMaxExpirationTime</code>, when the <code>DisconnectTimeOutInSeconds</code> elapses or the user chooses to end his or her session. If the <code>DisconnectTimeOutInSeconds</code> elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.</p>",
|
||||
"Stack$CreatedTime": "<p>The time the stack was created.</p>",
|
||||
"UsageReportSubscription$LastGeneratedReportDate": "<p>The time when the last usage report was generated.</p>",
|
||||
"User$CreatedTime": "<p>The date and time the user was created in the user pool.</p>"
|
||||
}
|
||||
},
|
||||
"UntagResourceRequest": {
|
||||
@@ -1047,6 +1377,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateImagePermissionsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateImagePermissionsResult": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateStackRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -1057,21 +1397,128 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UsageReportExecutionErrorCode": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"LastReportGenerationExecutionError$ErrorCode": "<p>The error code for the error that is returned when a usage report can't be generated.</p>"
|
||||
}
|
||||
},
|
||||
"UsageReportSchedule": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateUsageReportSubscriptionResult$Schedule": "<p>The schedule for generating usage reports.</p>",
|
||||
"UsageReportSubscription$Schedule": "<p>The schedule for generating usage reports.</p>"
|
||||
}
|
||||
},
|
||||
"UsageReportSubscription": {
|
||||
"base": "<p>Describes information about the usage report subscription.</p>",
|
||||
"refs": {
|
||||
"UsageReportSubscriptionList$member": null
|
||||
}
|
||||
},
|
||||
"UsageReportSubscriptionList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeUsageReportSubscriptionsResult$UsageReportSubscriptions": "<p>Information about the usage report subscription.</p>"
|
||||
}
|
||||
},
|
||||
"User": {
|
||||
"base": "<p>Describes a user in the user pool.</p>",
|
||||
"refs": {
|
||||
"UserList$member": null
|
||||
}
|
||||
},
|
||||
"UserAttributeValue": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateUserRequest$FirstName": "<p>The first name, or given name, of the user.</p>",
|
||||
"CreateUserRequest$LastName": "<p>The last name, or surname, of the user.</p>",
|
||||
"User$FirstName": "<p>The first name, or given name, of the user.</p>",
|
||||
"User$LastName": "<p>The last name, or surname, of the user.</p>"
|
||||
}
|
||||
},
|
||||
"UserId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeSessionsRequest$UserId": "<p>The user ID.</p>",
|
||||
"DescribeSessionsRequest$UserId": "<p>The user identifier.</p>",
|
||||
"Session$UserId": "<p>The identifier of the user for whom the session was created.</p>"
|
||||
}
|
||||
},
|
||||
"UserList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeUsersResult$Users": "<p>Information about users in the user pool.</p>"
|
||||
}
|
||||
},
|
||||
"UserSetting": {
|
||||
"base": "<p>Describes an action and whether the action is enabled or disabled for users during their streaming sessions.</p>",
|
||||
"refs": {
|
||||
"UserSettingList$member": null
|
||||
}
|
||||
},
|
||||
"UserSettingList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateStackRequest$UserSettings": "<p>The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled. </p>",
|
||||
"Stack$UserSettings": "<p>The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.</p>",
|
||||
"UpdateStackRequest$UserSettings": "<p>The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.</p>"
|
||||
}
|
||||
},
|
||||
"UserStackAssociation": {
|
||||
"base": "<p>Describes a user in the user pool and the associated stack.</p>",
|
||||
"refs": {
|
||||
"UserStackAssociationError$UserStackAssociation": "<p>Information about the user and associated stack.</p>",
|
||||
"UserStackAssociationList$member": null
|
||||
}
|
||||
},
|
||||
"UserStackAssociationError": {
|
||||
"base": "<p>Describes the error that is returned when a user can’t be associated with or disassociated from a stack. </p>",
|
||||
"refs": {
|
||||
"UserStackAssociationErrorList$member": null
|
||||
}
|
||||
},
|
||||
"UserStackAssociationErrorCode": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"UserStackAssociationError$ErrorCode": "<p>The error code for the error that is returned when a user can’t be associated with or disassociated from a stack.</p>"
|
||||
}
|
||||
},
|
||||
"UserStackAssociationErrorList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchAssociateUserStackResult$errors": "<p>The list of UserStackAssociationError objects.</p>",
|
||||
"BatchDisassociateUserStackResult$errors": "<p>The list of UserStackAssociationError objects.</p>"
|
||||
}
|
||||
},
|
||||
"UserStackAssociationList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchAssociateUserStackRequest$UserStackAssociations": "<p>The list of UserStackAssociation objects.</p>",
|
||||
"BatchDisassociateUserStackRequest$UserStackAssociations": "<p>The list of UserStackAssociation objects.</p>",
|
||||
"DescribeUserStackAssociationsResult$UserStackAssociations": "<p>The UserStackAssociation objects.</p>"
|
||||
}
|
||||
},
|
||||
"Username": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateUserRequest$UserName": "<p>The email address of the user.</p> <note> <p>Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a \"user does not exist\" error message displays.</p> </note>",
|
||||
"DeleteUserRequest$UserName": "<p>The email address of the user.</p> <note> <p>Users' email addresses are case-sensitive.</p> </note>",
|
||||
"DescribeUserStackAssociationsRequest$UserName": "<p>The email address of the user who is associated with the stack.</p> <note> <p>Users' email addresses are case-sensitive.</p> </note>",
|
||||
"DisableUserRequest$UserName": "<p>The email address of the user.</p> <note> <p>Users' email addresses are case-sensitive.</p> </note>",
|
||||
"EnableUserRequest$UserName": "<p>The email address of the user.</p> <note> <p>Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a \"user does not exist\" error message displays. </p> </note>",
|
||||
"User$UserName": "<p>The email address of the user.</p> <note> <p>Users' email addresses are case-sensitive.</p> </note>",
|
||||
"UserStackAssociation$UserName": "<p>The email address of the user who is associated with the stack.</p> <note> <p>Users' email addresses are case-sensitive.</p> </note>"
|
||||
}
|
||||
},
|
||||
"VisibilityType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeImagesRequest$Type": "<p>The type of image (public, private, or shared) to describe. </p>",
|
||||
"Image$Visibility": "<p>Indicates whether the image is public or private.</p>"
|
||||
}
|
||||
},
|
||||
"VpcConfig": {
|
||||
"base": "<p>Describes VPC configuration information.</p>",
|
||||
"base": "<p>Describes VPC configuration information for fleets and image builders.</p>",
|
||||
"refs": {
|
||||
"CreateFleetRequest$VpcConfig": "<p>The VPC configuration for the fleet.</p>",
|
||||
"CreateImageBuilderRequest$VpcConfig": "<p>The VPC configuration for the image builder. You can specify only one subnet.</p>",
|
||||
|
||||
Generated
Vendored
+10
@@ -1,4 +1,14 @@
|
||||
{
|
||||
"pagination": {
|
||||
"DescribeImagePermissions": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"DescribeImages": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"version": 1,
|
||||
"defaultRegion": "us-west-2",
|
||||
"testCases": [
|
||||
{
|
||||
"operationName": "DescribeStacks",
|
||||
"input": {},
|
||||
"errorExpectedFromService": false
|
||||
}
|
||||
]
|
||||
}
|
||||
+604
-19
@@ -7,6 +7,7 @@
|
||||
"protocol":"rest-json",
|
||||
"serviceAbbreviation":"AWSAppSync",
|
||||
"serviceFullName":"AWS AppSync",
|
||||
"serviceId":"AppSync",
|
||||
"signatureVersion":"v4",
|
||||
"signingName":"appsync",
|
||||
"uid":"appsync-2017-07-25"
|
||||
@@ -47,6 +48,21 @@
|
||||
{"shape":"InternalFailureException"}
|
||||
]
|
||||
},
|
||||
"CreateFunction":{
|
||||
"name":"CreateFunction",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/v1/apis/{apiId}/functions"
|
||||
},
|
||||
"input":{"shape":"CreateFunctionRequest"},
|
||||
"output":{"shape":"CreateFunctionResponse"},
|
||||
"errors":[
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
]
|
||||
},
|
||||
"CreateGraphqlApi":{
|
||||
"name":"CreateGraphqlApi",
|
||||
"http":{
|
||||
@@ -61,7 +77,6 @@
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InternalFailureException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ApiLimitExceededException"}
|
||||
]
|
||||
},
|
||||
@@ -127,6 +142,21 @@
|
||||
{"shape":"InternalFailureException"}
|
||||
]
|
||||
},
|
||||
"DeleteFunction":{
|
||||
"name":"DeleteFunction",
|
||||
"http":{
|
||||
"method":"DELETE",
|
||||
"requestUri":"/v1/apis/{apiId}/functions/{functionId}"
|
||||
},
|
||||
"input":{"shape":"DeleteFunctionRequest"},
|
||||
"output":{"shape":"DeleteFunctionResponse"},
|
||||
"errors":[
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
]
|
||||
},
|
||||
"DeleteGraphqlApi":{
|
||||
"name":"DeleteGraphqlApi",
|
||||
"http":{
|
||||
@@ -140,7 +170,8 @@
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
{"shape":"InternalFailureException"},
|
||||
{"shape":"AccessDeniedException"}
|
||||
]
|
||||
},
|
||||
"DeleteResolver":{
|
||||
@@ -190,6 +221,20 @@
|
||||
{"shape":"InternalFailureException"}
|
||||
]
|
||||
},
|
||||
"GetFunction":{
|
||||
"name":"GetFunction",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/v1/apis/{apiId}/functions/{functionId}"
|
||||
},
|
||||
"input":{"shape":"GetFunctionRequest"},
|
||||
"output":{"shape":"GetFunctionResponse"},
|
||||
"errors":[
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"UnauthorizedException"}
|
||||
]
|
||||
},
|
||||
"GetGraphqlApi":{
|
||||
"name":"GetGraphqlApi",
|
||||
"http":{
|
||||
@@ -202,7 +247,8 @@
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
{"shape":"InternalFailureException"},
|
||||
{"shape":"AccessDeniedException"}
|
||||
]
|
||||
},
|
||||
"GetIntrospectionSchema":{
|
||||
@@ -295,6 +341,21 @@
|
||||
{"shape":"InternalFailureException"}
|
||||
]
|
||||
},
|
||||
"ListFunctions":{
|
||||
"name":"ListFunctions",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/v1/apis/{apiId}/functions"
|
||||
},
|
||||
"input":{"shape":"ListFunctionsRequest"},
|
||||
"output":{"shape":"ListFunctionsResponse"},
|
||||
"errors":[
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
]
|
||||
},
|
||||
"ListGraphqlApis":{
|
||||
"name":"ListGraphqlApis",
|
||||
"http":{
|
||||
@@ -324,6 +385,38 @@
|
||||
{"shape":"InternalFailureException"}
|
||||
]
|
||||
},
|
||||
"ListResolversByFunction":{
|
||||
"name":"ListResolversByFunction",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/v1/apis/{apiId}/functions/{functionId}/resolvers"
|
||||
},
|
||||
"input":{"shape":"ListResolversByFunctionRequest"},
|
||||
"output":{"shape":"ListResolversByFunctionResponse"},
|
||||
"errors":[
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
]
|
||||
},
|
||||
"ListTagsForResource":{
|
||||
"name":"ListTagsForResource",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/v1/tags/{resourceArn}"
|
||||
},
|
||||
"input":{"shape":"ListTagsForResourceRequest"},
|
||||
"output":{"shape":"ListTagsForResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InternalFailureException"},
|
||||
{"shape":"AccessDeniedException"}
|
||||
]
|
||||
},
|
||||
"ListTypes":{
|
||||
"name":"ListTypes",
|
||||
"http":{
|
||||
@@ -356,6 +449,40 @@
|
||||
{"shape":"InternalFailureException"}
|
||||
]
|
||||
},
|
||||
"TagResource":{
|
||||
"name":"TagResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/v1/tags/{resourceArn}"
|
||||
},
|
||||
"input":{"shape":"TagResourceRequest"},
|
||||
"output":{"shape":"TagResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InternalFailureException"},
|
||||
{"shape":"AccessDeniedException"}
|
||||
]
|
||||
},
|
||||
"UntagResource":{
|
||||
"name":"UntagResource",
|
||||
"http":{
|
||||
"method":"DELETE",
|
||||
"requestUri":"/v1/tags/{resourceArn}"
|
||||
},
|
||||
"input":{"shape":"UntagResourceRequest"},
|
||||
"output":{"shape":"UntagResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"BadRequestException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InternalFailureException"},
|
||||
{"shape":"AccessDeniedException"}
|
||||
]
|
||||
},
|
||||
"UpdateApiKey":{
|
||||
"name":"UpdateApiKey",
|
||||
"http":{
|
||||
@@ -389,6 +516,21 @@
|
||||
{"shape":"InternalFailureException"}
|
||||
]
|
||||
},
|
||||
"UpdateFunction":{
|
||||
"name":"UpdateFunction",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/v1/apis/{apiId}/functions/{functionId}"
|
||||
},
|
||||
"input":{"shape":"UpdateFunctionRequest"},
|
||||
"output":{"shape":"UpdateFunctionResponse"},
|
||||
"errors":[
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
]
|
||||
},
|
||||
"UpdateGraphqlApi":{
|
||||
"name":"UpdateGraphqlApi",
|
||||
"http":{
|
||||
@@ -402,7 +544,8 @@
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"UnauthorizedException"},
|
||||
{"shape":"InternalFailureException"}
|
||||
{"shape":"InternalFailureException"},
|
||||
{"shape":"AccessDeniedException"}
|
||||
]
|
||||
},
|
||||
"UpdateResolver":{
|
||||
@@ -438,6 +581,26 @@
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AccessDeniedException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"String"}
|
||||
},
|
||||
"error":{"httpStatusCode":403},
|
||||
"exception":true
|
||||
},
|
||||
"AdditionalAuthenticationProvider":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"authenticationType":{"shape":"AuthenticationType"},
|
||||
"openIDConnectConfig":{"shape":"OpenIDConnectConfig"},
|
||||
"userPoolConfig":{"shape":"CognitoUserPoolConfig"}
|
||||
}
|
||||
},
|
||||
"AdditionalAuthenticationProviders":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AdditionalAuthenticationProvider"}
|
||||
},
|
||||
"ApiKey":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -479,9 +642,29 @@
|
||||
"enum":[
|
||||
"API_KEY",
|
||||
"AWS_IAM",
|
||||
"AMAZON_COGNITO_USER_POOLS"
|
||||
"AMAZON_COGNITO_USER_POOLS",
|
||||
"OPENID_CONNECT"
|
||||
]
|
||||
},
|
||||
"AuthorizationConfig":{
|
||||
"type":"structure",
|
||||
"required":["authorizationType"],
|
||||
"members":{
|
||||
"authorizationType":{"shape":"AuthorizationType"},
|
||||
"awsIamConfig":{"shape":"AwsIamConfig"}
|
||||
}
|
||||
},
|
||||
"AuthorizationType":{
|
||||
"type":"string",
|
||||
"enum":["AWS_IAM"]
|
||||
},
|
||||
"AwsIamConfig":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"signingRegion":{"shape":"String"},
|
||||
"signingServiceName":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"BadRequestException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -492,6 +675,19 @@
|
||||
},
|
||||
"Blob":{"type":"blob"},
|
||||
"Boolean":{"type":"boolean"},
|
||||
"BooleanValue":{"type":"boolean"},
|
||||
"CognitoUserPoolConfig":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"userPoolId",
|
||||
"awsRegion"
|
||||
],
|
||||
"members":{
|
||||
"userPoolId":{"shape":"String"},
|
||||
"awsRegion":{"shape":"String"},
|
||||
"appIdClientRegex":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ConcurrentModificationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -538,7 +734,9 @@
|
||||
"serviceRoleArn":{"shape":"String"},
|
||||
"dynamodbConfig":{"shape":"DynamodbDataSourceConfig"},
|
||||
"lambdaConfig":{"shape":"LambdaDataSourceConfig"},
|
||||
"elasticsearchConfig":{"shape":"ElasticsearchDataSourceConfig"}
|
||||
"elasticsearchConfig":{"shape":"ElasticsearchDataSourceConfig"},
|
||||
"httpConfig":{"shape":"HttpDataSourceConfig"},
|
||||
"relationalDatabaseConfig":{"shape":"RelationalDatabaseDataSourceConfig"}
|
||||
}
|
||||
},
|
||||
"CreateDataSourceResponse":{
|
||||
@@ -547,6 +745,35 @@
|
||||
"dataSource":{"shape":"DataSource"}
|
||||
}
|
||||
},
|
||||
"CreateFunctionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"apiId",
|
||||
"name",
|
||||
"dataSourceName",
|
||||
"requestMappingTemplate",
|
||||
"functionVersion"
|
||||
],
|
||||
"members":{
|
||||
"apiId":{
|
||||
"shape":"String",
|
||||
"location":"uri",
|
||||
"locationName":"apiId"
|
||||
},
|
||||
"name":{"shape":"ResourceName"},
|
||||
"description":{"shape":"String"},
|
||||
"dataSourceName":{"shape":"ResourceName"},
|
||||
"requestMappingTemplate":{"shape":"MappingTemplate"},
|
||||
"responseMappingTemplate":{"shape":"MappingTemplate"},
|
||||
"functionVersion":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"CreateFunctionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"functionConfiguration":{"shape":"FunctionConfiguration"}
|
||||
}
|
||||
},
|
||||
"CreateGraphqlApiRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -555,8 +782,12 @@
|
||||
],
|
||||
"members":{
|
||||
"name":{"shape":"String"},
|
||||
"logConfig":{"shape":"LogConfig"},
|
||||
"authenticationType":{"shape":"AuthenticationType"},
|
||||
"userPoolConfig":{"shape":"UserPoolConfig"}
|
||||
"userPoolConfig":{"shape":"UserPoolConfig"},
|
||||
"openIDConnectConfig":{"shape":"OpenIDConnectConfig"},
|
||||
"tags":{"shape":"TagMap"},
|
||||
"additionalAuthenticationProviders":{"shape":"AdditionalAuthenticationProviders"}
|
||||
}
|
||||
},
|
||||
"CreateGraphqlApiResponse":{
|
||||
@@ -571,7 +802,6 @@
|
||||
"apiId",
|
||||
"typeName",
|
||||
"fieldName",
|
||||
"dataSourceName",
|
||||
"requestMappingTemplate"
|
||||
],
|
||||
"members":{
|
||||
@@ -588,7 +818,9 @@
|
||||
"fieldName":{"shape":"ResourceName"},
|
||||
"dataSourceName":{"shape":"ResourceName"},
|
||||
"requestMappingTemplate":{"shape":"MappingTemplate"},
|
||||
"responseMappingTemplate":{"shape":"MappingTemplate"}
|
||||
"responseMappingTemplate":{"shape":"MappingTemplate"},
|
||||
"kind":{"shape":"ResolverKind"},
|
||||
"pipelineConfig":{"shape":"PipelineConfig"}
|
||||
}
|
||||
},
|
||||
"CreateResolverResponse":{
|
||||
@@ -630,7 +862,9 @@
|
||||
"serviceRoleArn":{"shape":"String"},
|
||||
"dynamodbConfig":{"shape":"DynamodbDataSourceConfig"},
|
||||
"lambdaConfig":{"shape":"LambdaDataSourceConfig"},
|
||||
"elasticsearchConfig":{"shape":"ElasticsearchDataSourceConfig"}
|
||||
"elasticsearchConfig":{"shape":"ElasticsearchDataSourceConfig"},
|
||||
"httpConfig":{"shape":"HttpDataSourceConfig"},
|
||||
"relationalDatabaseConfig":{"shape":"RelationalDatabaseDataSourceConfig"}
|
||||
}
|
||||
},
|
||||
"DataSourceType":{
|
||||
@@ -639,7 +873,9 @@
|
||||
"AWS_LAMBDA",
|
||||
"AMAZON_DYNAMODB",
|
||||
"AMAZON_ELASTICSEARCH",
|
||||
"NONE"
|
||||
"NONE",
|
||||
"HTTP",
|
||||
"RELATIONAL_DATABASE"
|
||||
]
|
||||
},
|
||||
"DataSources":{
|
||||
@@ -701,6 +937,30 @@
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteFunctionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"apiId",
|
||||
"functionId"
|
||||
],
|
||||
"members":{
|
||||
"apiId":{
|
||||
"shape":"String",
|
||||
"location":"uri",
|
||||
"locationName":"apiId"
|
||||
},
|
||||
"functionId":{
|
||||
"shape":"ResourceName",
|
||||
"location":"uri",
|
||||
"locationName":"functionId"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteFunctionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteGraphqlApiRequest":{
|
||||
"type":"structure",
|
||||
"required":["apiId"],
|
||||
@@ -795,6 +1055,35 @@
|
||||
}
|
||||
},
|
||||
"ErrorMessage":{"type":"string"},
|
||||
"FieldLogLevel":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"NONE",
|
||||
"ERROR",
|
||||
"ALL"
|
||||
]
|
||||
},
|
||||
"FunctionConfiguration":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"functionId":{"shape":"String"},
|
||||
"functionArn":{"shape":"String"},
|
||||
"name":{"shape":"ResourceName"},
|
||||
"description":{"shape":"String"},
|
||||
"dataSourceName":{"shape":"ResourceName"},
|
||||
"requestMappingTemplate":{"shape":"MappingTemplate"},
|
||||
"responseMappingTemplate":{"shape":"MappingTemplate"},
|
||||
"functionVersion":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"Functions":{
|
||||
"type":"list",
|
||||
"member":{"shape":"FunctionConfiguration"}
|
||||
},
|
||||
"FunctionsIds":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"GetDataSourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -820,6 +1109,31 @@
|
||||
"dataSource":{"shape":"DataSource"}
|
||||
}
|
||||
},
|
||||
"GetFunctionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"apiId",
|
||||
"functionId"
|
||||
],
|
||||
"members":{
|
||||
"apiId":{
|
||||
"shape":"String",
|
||||
"location":"uri",
|
||||
"locationName":"apiId"
|
||||
},
|
||||
"functionId":{
|
||||
"shape":"ResourceName",
|
||||
"location":"uri",
|
||||
"locationName":"functionId"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetFunctionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"functionConfiguration":{"shape":"FunctionConfiguration"}
|
||||
}
|
||||
},
|
||||
"GetGraphqlApiRequest":{
|
||||
"type":"structure",
|
||||
"required":["apiId"],
|
||||
@@ -853,6 +1167,11 @@
|
||||
"shape":"OutputType",
|
||||
"location":"querystring",
|
||||
"locationName":"format"
|
||||
},
|
||||
"includeDirectives":{
|
||||
"shape":"BooleanValue",
|
||||
"location":"querystring",
|
||||
"locationName":"includeDirectives"
|
||||
}
|
||||
}
|
||||
},
|
||||
@@ -957,15 +1276,26 @@
|
||||
"name":{"shape":"ResourceName"},
|
||||
"apiId":{"shape":"String"},
|
||||
"authenticationType":{"shape":"AuthenticationType"},
|
||||
"logConfig":{"shape":"LogConfig"},
|
||||
"userPoolConfig":{"shape":"UserPoolConfig"},
|
||||
"openIDConnectConfig":{"shape":"OpenIDConnectConfig"},
|
||||
"arn":{"shape":"String"},
|
||||
"uris":{"shape":"MapOfStringToString"}
|
||||
"uris":{"shape":"MapOfStringToString"},
|
||||
"tags":{"shape":"TagMap"},
|
||||
"additionalAuthenticationProviders":{"shape":"AdditionalAuthenticationProviders"}
|
||||
}
|
||||
},
|
||||
"GraphqlApis":{
|
||||
"type":"list",
|
||||
"member":{"shape":"GraphqlApi"}
|
||||
},
|
||||
"HttpDataSourceConfig":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"endpoint":{"shape":"String"},
|
||||
"authorizationConfig":{"shape":"AuthorizationConfig"}
|
||||
}
|
||||
},
|
||||
"InternalFailureException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1046,6 +1376,34 @@
|
||||
"nextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListFunctionsRequest":{
|
||||
"type":"structure",
|
||||
"required":["apiId"],
|
||||
"members":{
|
||||
"apiId":{
|
||||
"shape":"String",
|
||||
"location":"uri",
|
||||
"locationName":"apiId"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"location":"querystring",
|
||||
"locationName":"nextToken"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"location":"querystring",
|
||||
"locationName":"maxResults"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListFunctionsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"functions":{"shape":"Functions"},
|
||||
"nextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListGraphqlApisRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1068,6 +1426,42 @@
|
||||
"nextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListResolversByFunctionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"apiId",
|
||||
"functionId"
|
||||
],
|
||||
"members":{
|
||||
"apiId":{
|
||||
"shape":"String",
|
||||
"location":"uri",
|
||||
"locationName":"apiId"
|
||||
},
|
||||
"functionId":{
|
||||
"shape":"String",
|
||||
"location":"uri",
|
||||
"locationName":"functionId"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"location":"querystring",
|
||||
"locationName":"nextToken"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"location":"querystring",
|
||||
"locationName":"maxResults"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListResolversByFunctionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"resolvers":{"shape":"Resolvers"},
|
||||
"nextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListResolversRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -1104,6 +1498,23 @@
|
||||
"nextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":["resourceArn"],
|
||||
"members":{
|
||||
"resourceArn":{
|
||||
"shape":"ResourceArn",
|
||||
"location":"uri",
|
||||
"locationName":"resourceArn"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"tags":{"shape":"TagMap"}
|
||||
}
|
||||
},
|
||||
"ListTypesRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -1140,6 +1551,17 @@
|
||||
"nextToken":{"shape":"PaginationToken"}
|
||||
}
|
||||
},
|
||||
"LogConfig":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"fieldLogLevel",
|
||||
"cloudWatchLogsRoleArn"
|
||||
],
|
||||
"members":{
|
||||
"fieldLogLevel":{"shape":"FieldLogLevel"},
|
||||
"cloudWatchLogsRoleArn":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"Long":{"type":"long"},
|
||||
"MapOfStringToString":{
|
||||
"type":"map",
|
||||
@@ -1149,7 +1571,7 @@
|
||||
"MappingTemplate":{
|
||||
"type":"string",
|
||||
"max":65536,
|
||||
"min":0
|
||||
"min":1
|
||||
},
|
||||
"MaxResults":{
|
||||
"type":"integer",
|
||||
@@ -1164,6 +1586,16 @@
|
||||
"error":{"httpStatusCode":404},
|
||||
"exception":true
|
||||
},
|
||||
"OpenIDConnectConfig":{
|
||||
"type":"structure",
|
||||
"required":["issuer"],
|
||||
"members":{
|
||||
"issuer":{"shape":"String"},
|
||||
"clientId":{"shape":"String"},
|
||||
"iatTTL":{"shape":"Long"},
|
||||
"authTTL":{"shape":"Long"}
|
||||
}
|
||||
},
|
||||
"OutputType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
@@ -1175,6 +1607,33 @@
|
||||
"type":"string",
|
||||
"pattern":"[\\\\S]+"
|
||||
},
|
||||
"PipelineConfig":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"functions":{"shape":"FunctionsIds"}
|
||||
}
|
||||
},
|
||||
"RdsHttpEndpointConfig":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"awsRegion":{"shape":"String"},
|
||||
"dbClusterIdentifier":{"shape":"String"},
|
||||
"databaseName":{"shape":"String"},
|
||||
"schema":{"shape":"String"},
|
||||
"awsSecretStoreArn":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"RelationalDatabaseDataSourceConfig":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"relationalDatabaseSourceType":{"shape":"RelationalDatabaseSourceType"},
|
||||
"rdsHttpEndpointConfig":{"shape":"RdsHttpEndpointConfig"}
|
||||
}
|
||||
},
|
||||
"RelationalDatabaseSourceType":{
|
||||
"type":"string",
|
||||
"enum":["RDS_HTTP_ENDPOINT"]
|
||||
},
|
||||
"Resolver":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1183,13 +1642,28 @@
|
||||
"dataSourceName":{"shape":"ResourceName"},
|
||||
"resolverArn":{"shape":"String"},
|
||||
"requestMappingTemplate":{"shape":"MappingTemplate"},
|
||||
"responseMappingTemplate":{"shape":"MappingTemplate"}
|
||||
"responseMappingTemplate":{"shape":"MappingTemplate"},
|
||||
"kind":{"shape":"ResolverKind"},
|
||||
"pipelineConfig":{"shape":"PipelineConfig"}
|
||||
}
|
||||
},
|
||||
"ResolverKind":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"UNIT",
|
||||
"PIPELINE"
|
||||
]
|
||||
},
|
||||
"Resolvers":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Resolver"}
|
||||
},
|
||||
"ResourceArn":{
|
||||
"type":"string",
|
||||
"max":75,
|
||||
"min":70,
|
||||
"pattern":"^arn:aws:appsync:[A-Za-z0-9_/.-]{0,63}:\\d{12}:apis/[0-9A-Za-z_-]{26}$"
|
||||
},
|
||||
"ResourceName":{
|
||||
"type":"string",
|
||||
"pattern":"[_A-Za-z][_0-9A-Za-z]*"
|
||||
@@ -1199,7 +1673,10 @@
|
||||
"enum":[
|
||||
"PROCESSING",
|
||||
"ACTIVE",
|
||||
"DELETING"
|
||||
"DELETING",
|
||||
"FAILED",
|
||||
"SUCCESS",
|
||||
"NOT_APPLICABLE"
|
||||
]
|
||||
},
|
||||
"StartSchemaCreationRequest":{
|
||||
@@ -1224,6 +1701,49 @@
|
||||
}
|
||||
},
|
||||
"String":{"type":"string"},
|
||||
"TagKey":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":1,
|
||||
"pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$"
|
||||
},
|
||||
"TagKeyList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"TagKey"},
|
||||
"max":50,
|
||||
"min":1
|
||||
},
|
||||
"TagMap":{
|
||||
"type":"map",
|
||||
"key":{"shape":"TagKey"},
|
||||
"value":{"shape":"TagValue"},
|
||||
"max":50,
|
||||
"min":1
|
||||
},
|
||||
"TagResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"resourceArn",
|
||||
"tags"
|
||||
],
|
||||
"members":{
|
||||
"resourceArn":{
|
||||
"shape":"ResourceArn",
|
||||
"location":"uri",
|
||||
"locationName":"resourceArn"
|
||||
},
|
||||
"tags":{"shape":"TagMap"}
|
||||
}
|
||||
},
|
||||
"TagResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"TagValue":{
|
||||
"type":"string",
|
||||
"max":256
|
||||
},
|
||||
"Type":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1253,6 +1773,30 @@
|
||||
"error":{"httpStatusCode":401},
|
||||
"exception":true
|
||||
},
|
||||
"UntagResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"resourceArn",
|
||||
"tagKeys"
|
||||
],
|
||||
"members":{
|
||||
"resourceArn":{
|
||||
"shape":"ResourceArn",
|
||||
"location":"uri",
|
||||
"locationName":"resourceArn"
|
||||
},
|
||||
"tagKeys":{
|
||||
"shape":"TagKeyList",
|
||||
"location":"querystring",
|
||||
"locationName":"tagKeys"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UntagResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"UpdateApiKeyRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -1303,7 +1847,9 @@
|
||||
"serviceRoleArn":{"shape":"String"},
|
||||
"dynamodbConfig":{"shape":"DynamodbDataSourceConfig"},
|
||||
"lambdaConfig":{"shape":"LambdaDataSourceConfig"},
|
||||
"elasticsearchConfig":{"shape":"ElasticsearchDataSourceConfig"}
|
||||
"elasticsearchConfig":{"shape":"ElasticsearchDataSourceConfig"},
|
||||
"httpConfig":{"shape":"HttpDataSourceConfig"},
|
||||
"relationalDatabaseConfig":{"shape":"RelationalDatabaseDataSourceConfig"}
|
||||
}
|
||||
},
|
||||
"UpdateDataSourceResponse":{
|
||||
@@ -1312,6 +1858,41 @@
|
||||
"dataSource":{"shape":"DataSource"}
|
||||
}
|
||||
},
|
||||
"UpdateFunctionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"apiId",
|
||||
"name",
|
||||
"functionId",
|
||||
"dataSourceName",
|
||||
"requestMappingTemplate",
|
||||
"functionVersion"
|
||||
],
|
||||
"members":{
|
||||
"apiId":{
|
||||
"shape":"String",
|
||||
"location":"uri",
|
||||
"locationName":"apiId"
|
||||
},
|
||||
"name":{"shape":"ResourceName"},
|
||||
"description":{"shape":"String"},
|
||||
"functionId":{
|
||||
"shape":"ResourceName",
|
||||
"location":"uri",
|
||||
"locationName":"functionId"
|
||||
},
|
||||
"dataSourceName":{"shape":"ResourceName"},
|
||||
"requestMappingTemplate":{"shape":"MappingTemplate"},
|
||||
"responseMappingTemplate":{"shape":"MappingTemplate"},
|
||||
"functionVersion":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"UpdateFunctionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"functionConfiguration":{"shape":"FunctionConfiguration"}
|
||||
}
|
||||
},
|
||||
"UpdateGraphqlApiRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -1325,8 +1906,11 @@
|
||||
"locationName":"apiId"
|
||||
},
|
||||
"name":{"shape":"String"},
|
||||
"logConfig":{"shape":"LogConfig"},
|
||||
"authenticationType":{"shape":"AuthenticationType"},
|
||||
"userPoolConfig":{"shape":"UserPoolConfig"}
|
||||
"userPoolConfig":{"shape":"UserPoolConfig"},
|
||||
"openIDConnectConfig":{"shape":"OpenIDConnectConfig"},
|
||||
"additionalAuthenticationProviders":{"shape":"AdditionalAuthenticationProviders"}
|
||||
}
|
||||
},
|
||||
"UpdateGraphqlApiResponse":{
|
||||
@@ -1341,7 +1925,6 @@
|
||||
"apiId",
|
||||
"typeName",
|
||||
"fieldName",
|
||||
"dataSourceName",
|
||||
"requestMappingTemplate"
|
||||
],
|
||||
"members":{
|
||||
@@ -1362,7 +1945,9 @@
|
||||
},
|
||||
"dataSourceName":{"shape":"ResourceName"},
|
||||
"requestMappingTemplate":{"shape":"MappingTemplate"},
|
||||
"responseMappingTemplate":{"shape":"MappingTemplate"}
|
||||
"responseMappingTemplate":{"shape":"MappingTemplate"},
|
||||
"kind":{"shape":"ResolverKind"},
|
||||
"pipelineConfig":{"shape":"PipelineConfig"}
|
||||
}
|
||||
},
|
||||
"UpdateResolverResponse":{
|
||||
|
||||
+362
-34
@@ -4,35 +4,63 @@
|
||||
"operations": {
|
||||
"CreateApiKey": "<p>Creates a unique key that you can distribute to clients who are executing your API.</p>",
|
||||
"CreateDataSource": "<p>Creates a <code>DataSource</code> object.</p>",
|
||||
"CreateFunction": "<p>Creates a <code>Function</code> object.</p> <p>A function is a reusable entity. Multiple functions can be used to compose the resolver logic.</p>",
|
||||
"CreateGraphqlApi": "<p>Creates a <code>GraphqlApi</code> object.</p>",
|
||||
"CreateResolver": "<p>Creates a <code>Resolver</code> object.</p> <p>A resolver converts incoming requests into a format that a data source can understand and converts the data source's responses into GraphQL.</p>",
|
||||
"CreateType": "<p>Creates a <code>Type</code> object.</p>",
|
||||
"DeleteApiKey": "<p>Deletes an API key.</p>",
|
||||
"DeleteDataSource": "<p>Deletes a <code>DataSource</code> object.</p>",
|
||||
"DeleteFunction": "<p>Deletes a <code>Function</code>.</p>",
|
||||
"DeleteGraphqlApi": "<p>Deletes a <code>GraphqlApi</code> object.</p>",
|
||||
"DeleteResolver": "<p>Deletes a <code>Resolver</code> object.</p>",
|
||||
"DeleteType": "<p>Deletes a <code>Type</code> object.</p>",
|
||||
"GetDataSource": "<p>Retrieves a <code>DataSource</code> object.</p>",
|
||||
"GetFunction": "<p>Get a <code>Function</code>.</p>",
|
||||
"GetGraphqlApi": "<p>Retrieves a <code>GraphqlApi</code> object.</p>",
|
||||
"GetIntrospectionSchema": "<p>Retrieves the introspection schema for a GraphQL API.</p>",
|
||||
"GetResolver": "<p>Retrieves a <code>Resolver</code> object.</p>",
|
||||
"GetSchemaCreationStatus": "<p>Retrieves the current status of a schema creation operation.</p>",
|
||||
"GetType": "<p>Retrieves a <code>Type</code> object.</p>",
|
||||
"ListApiKeys": "<p>Lists the API keys for a given API.</p>",
|
||||
"ListApiKeys": "<p>Lists the API keys for a given API.</p> <note> <p>API keys are deleted automatically sometime after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call <code>DeleteApiKey</code> to manually delete a key before it's automatically deleted.</p> </note>",
|
||||
"ListDataSources": "<p>Lists the data sources for a given API.</p>",
|
||||
"ListFunctions": "<p>List multiple functions.</p>",
|
||||
"ListGraphqlApis": "<p>Lists your GraphQL APIs.</p>",
|
||||
"ListResolvers": "<p>Lists the resolvers for a given API and type.</p>",
|
||||
"ListResolversByFunction": "<p>List the resolvers that are associated with a specific function.</p>",
|
||||
"ListTagsForResource": "<p>Lists the tags for a resource.</p>",
|
||||
"ListTypes": "<p>Lists the types for a given API.</p>",
|
||||
"StartSchemaCreation": "<p>Adds a new schema to your GraphQL API.</p> <p>This operation is asynchronous. Use to determine when it has completed.</p>",
|
||||
"TagResource": "<p>Tags a resource with user-supplied tags.</p>",
|
||||
"UntagResource": "<p>Untags a resource.</p>",
|
||||
"UpdateApiKey": "<p>Updates an API key.</p>",
|
||||
"UpdateDataSource": "<p>Updates a <code>DataSource</code> object.</p>",
|
||||
"UpdateFunction": "<p>Updates a <code>Function</code> object.</p>",
|
||||
"UpdateGraphqlApi": "<p>Updates a <code>GraphqlApi</code> object.</p>",
|
||||
"UpdateResolver": "<p>Updates a <code>Resolver</code> object.</p>",
|
||||
"UpdateType": "<p>Updates a <code>Type</code> object.</p>"
|
||||
},
|
||||
"shapes": {
|
||||
"AccessDeniedException": {
|
||||
"base": "<p>You do not have access to perform this operation on this resource.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"AdditionalAuthenticationProvider": {
|
||||
"base": "<p>Describes an additional authentication provider.</p>",
|
||||
"refs": {
|
||||
"AdditionalAuthenticationProviders$member": null
|
||||
}
|
||||
},
|
||||
"AdditionalAuthenticationProviders": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateGraphqlApiRequest$additionalAuthenticationProviders": "<p>A list of additional authentication providers for the <code>GraphqlApi</code> API.</p>",
|
||||
"GraphqlApi$additionalAuthenticationProviders": "<p>A list of additional authentication providers for the <code>GraphqlApi</code> API.</p>",
|
||||
"UpdateGraphqlApiRequest$additionalAuthenticationProviders": "<p>A list of additional authentication providers for the <code>GraphqlApi</code> API.</p>"
|
||||
}
|
||||
},
|
||||
"ApiKey": {
|
||||
"base": "<p>Describes an API key.</p>",
|
||||
"base": "<p>Describes an API key.</p> <p>Customers invoke AWS AppSync GraphQL API operations with API keys as an identity mechanism. There are two key versions:</p> <p> <b>da1</b>: This version was introduced at launch in November 2017. These keys always expire after 7 days. Key expiration is managed by Amazon DynamoDB TTL. The keys ceased to be valid after February 21, 2018 and should not be used after that date.</p> <ul> <li> <p> <code>ListApiKeys</code> returns the expiration time in milliseconds.</p> </li> <li> <p> <code>CreateApiKey</code> returns the expiration time in milliseconds.</p> </li> <li> <p> <code>UpdateApiKey</code> is not available for this key version.</p> </li> <li> <p> <code>DeleteApiKey</code> deletes the item from the table.</p> </li> <li> <p>Expiration is stored in Amazon DynamoDB as milliseconds. This results in a bug where keys are not automatically deleted because DynamoDB expects the TTL to be stored in seconds. As a one-time action, we will delete these keys from the table after February 21, 2018.</p> </li> </ul> <p> <b>da2</b>: This version was introduced in February 2018 when AppSync added support to extend key expiration.</p> <ul> <li> <p> <code>ListApiKeys</code> returns the expiration time in seconds.</p> </li> <li> <p> <code>CreateApiKey</code> returns the expiration time in seconds and accepts a user-provided expiration time in seconds.</p> </li> <li> <p> <code>UpdateApiKey</code> returns the expiration time in seconds and accepts a user-provided expiration time in seconds. Key expiration can only be updated while the key has not expired.</p> </li> <li> <p> <code>DeleteApiKey</code> deletes the item from the table.</p> </li> <li> <p>Expiration is stored in Amazon DynamoDB as seconds.</p> </li> </ul>",
|
||||
"refs": {
|
||||
"ApiKeys$member": null,
|
||||
"CreateApiKeyResponse$apiKey": "<p>The API key.</p>",
|
||||
@@ -45,7 +73,7 @@
|
||||
}
|
||||
},
|
||||
"ApiKeyValidityOutOfBoundsException": {
|
||||
"base": "<p>The API key expiration must be set to a value between 1 and 365 days.</p>",
|
||||
"base": "<p>The API key expiration must be set to a value between 1 and 365 days from creation (for <code>CreateApiKey</code>) or from update (for <code>UpdateApiKey</code>).</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -63,13 +91,32 @@
|
||||
"AuthenticationType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateGraphqlApiRequest$authenticationType": "<p>The authentication type: API key, IAM, or Amazon Cognito User Pools.</p>",
|
||||
"AdditionalAuthenticationProvider$authenticationType": "<p>The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.</p>",
|
||||
"CreateGraphqlApiRequest$authenticationType": "<p>The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.</p>",
|
||||
"GraphqlApi$authenticationType": "<p>The authentication type.</p>",
|
||||
"UpdateGraphqlApiRequest$authenticationType": "<p>The new authentication type for the <code>GraphqlApi</code> object.</p>"
|
||||
}
|
||||
},
|
||||
"AuthorizationConfig": {
|
||||
"base": "<p>The authorization config in case the HTTP endpoint requires authorization.</p>",
|
||||
"refs": {
|
||||
"HttpDataSourceConfig$authorizationConfig": "<p>The authorization config in case the HTTP endpoint requires authorization.</p>"
|
||||
}
|
||||
},
|
||||
"AuthorizationType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AuthorizationConfig$authorizationType": "<p>The authorization type required by the HTTP endpoint.</p> <ul> <li> <p> <b>AWS_IAM</b>: The authorization type is Sigv4.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"AwsIamConfig": {
|
||||
"base": "<p>The AWS IAM configuration.</p>",
|
||||
"refs": {
|
||||
"AuthorizationConfig$awsIamConfig": "<p>The AWS IAM settings.</p>"
|
||||
}
|
||||
},
|
||||
"BadRequestException": {
|
||||
"base": "<p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again. </p>",
|
||||
"base": "<p>The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and then try again. </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -86,8 +133,20 @@
|
||||
"DynamodbDataSourceConfig$useCallerCredentials": "<p>Set to TRUE to use Amazon Cognito credentials with this data source.</p>"
|
||||
}
|
||||
},
|
||||
"BooleanValue": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetIntrospectionSchemaRequest$includeDirectives": "<p>A flag that specifies whether the schema introspection should contain directives.</p>"
|
||||
}
|
||||
},
|
||||
"CognitoUserPoolConfig": {
|
||||
"base": "<p>Describes an Amazon Cognito user pool configuration.</p>",
|
||||
"refs": {
|
||||
"AdditionalAuthenticationProvider$userPoolConfig": "<p>The Amazon Cognito user pool configuration.</p>"
|
||||
}
|
||||
},
|
||||
"ConcurrentModificationException": {
|
||||
"base": "<p>Another modification is being made. That modification must complete before you can make your change. </p>",
|
||||
"base": "<p>Another modification is in progress at this time and it must complete before you can make your change. </p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -111,6 +170,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateFunctionRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateFunctionResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateGraphqlApiRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -154,7 +223,7 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateDataSourceRequest$type": "<p>The type of the <code>DataSource</code>.</p>",
|
||||
"DataSource$type": "<p>The type of the data source.</p> <ul> <li> <p> <b>AMAZON_DYNAMODB</b>: The data source is an Amazon DynamoDB table.</p> </li> <li> <p> <b>AMAZON_ELASTICSEARCH</b>: The data source is an Amazon Elasticsearch Service domain.</p> </li> <li> <p> <b>AWS_LAMBDA</b>: The data source is an AWS Lambda function.</p> </li> <li> <p> <b>NONE</b>: There is no data source. This type is used when the required information can be computed on the fly without connecting to a back-end data source.</p> </li> </ul>",
|
||||
"DataSource$type": "<p>The type of the data source.</p> <ul> <li> <p> <b>AMAZON_DYNAMODB</b>: The data source is an Amazon DynamoDB table.</p> </li> <li> <p> <b>AMAZON_ELASTICSEARCH</b>: The data source is an Amazon Elasticsearch Service domain.</p> </li> <li> <p> <b>AWS_LAMBDA</b>: The data source is an AWS Lambda function.</p> </li> <li> <p> <b>NONE</b>: There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation.</p> </li> <li> <p> <b>HTTP</b>: The data source is an HTTP endpoint.</p> </li> <li> <p> <b>RELATIONAL_DATABASE</b>: The data source is a relational database.</p> </li> </ul>",
|
||||
"UpdateDataSourceRequest$type": "<p>The new data source type.</p>"
|
||||
}
|
||||
},
|
||||
@@ -167,7 +236,7 @@
|
||||
"DefaultAction": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"UserPoolConfig$defaultAction": "<p>The action that you want your GraphQL API to take when a request that uses Amazon Cognito User Pool authentication doesn't match the Amazon Cognito User Pool configuration.</p>"
|
||||
"UserPoolConfig$defaultAction": "<p>The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteApiKeyRequest": {
|
||||
@@ -190,6 +259,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteFunctionRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteFunctionResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteGraphqlApiRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -221,19 +300,19 @@
|
||||
}
|
||||
},
|
||||
"DynamodbDataSourceConfig": {
|
||||
"base": "<p>Describes a DynamoDB data source configuration.</p>",
|
||||
"base": "<p>Describes an Amazon DynamoDB data source configuration.</p>",
|
||||
"refs": {
|
||||
"CreateDataSourceRequest$dynamodbConfig": "<p>DynamoDB settings.</p>",
|
||||
"DataSource$dynamodbConfig": "<p>DynamoDB settings.</p>",
|
||||
"UpdateDataSourceRequest$dynamodbConfig": "<p>The new DynamoDB configuration.</p>"
|
||||
"CreateDataSourceRequest$dynamodbConfig": "<p>Amazon DynamoDB settings.</p>",
|
||||
"DataSource$dynamodbConfig": "<p>Amazon DynamoDB settings.</p>",
|
||||
"UpdateDataSourceRequest$dynamodbConfig": "<p>The new Amazon DynamoDB configuration.</p>"
|
||||
}
|
||||
},
|
||||
"ElasticsearchDataSourceConfig": {
|
||||
"base": "<p>Describes an Elasticsearch data source configuration.</p>",
|
||||
"refs": {
|
||||
"CreateDataSourceRequest$elasticsearchConfig": "<p>Amazon Elasticsearch settings.</p>",
|
||||
"DataSource$elasticsearchConfig": "<p>Amazon Elasticsearch settings.</p>",
|
||||
"UpdateDataSourceRequest$elasticsearchConfig": "<p>The new Elasticsearch configuration.</p>"
|
||||
"CreateDataSourceRequest$elasticsearchConfig": "<p>Amazon Elasticsearch Service settings.</p>",
|
||||
"DataSource$elasticsearchConfig": "<p>Amazon Elasticsearch Service settings.</p>",
|
||||
"UpdateDataSourceRequest$elasticsearchConfig": "<p>The new Elasticsearch Service configuration.</p>"
|
||||
}
|
||||
},
|
||||
"ErrorMessage": {
|
||||
@@ -244,6 +323,33 @@
|
||||
"GraphQLSchemaException$message": null
|
||||
}
|
||||
},
|
||||
"FieldLogLevel": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"LogConfig$fieldLogLevel": "<p>The field logging level. Values can be NONE, ERROR, or ALL. </p> <ul> <li> <p> <b>NONE</b>: No field-level logs are captured.</p> </li> <li> <p> <b>ERROR</b>: Logs the following information only for the fields that are in error:</p> <ul> <li> <p>The error section in the server response.</p> </li> <li> <p>Field-level errors.</p> </li> <li> <p>The generated request/response functions that got resolved for error fields.</p> </li> </ul> </li> <li> <p> <b>ALL</b>: The following information is logged for all fields in the query:</p> <ul> <li> <p>Field-level tracing information.</p> </li> <li> <p>The generated request/response functions that got resolved for each field.</p> </li> </ul> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"FunctionConfiguration": {
|
||||
"base": "<p>A function is a reusable entity. Multiple functions can be used to compose the resolver logic.</p>",
|
||||
"refs": {
|
||||
"CreateFunctionResponse$functionConfiguration": "<p>The <code>Function</code> object.</p>",
|
||||
"Functions$member": null,
|
||||
"GetFunctionResponse$functionConfiguration": "<p>The <code>Function</code> object.</p>",
|
||||
"UpdateFunctionResponse$functionConfiguration": "<p>The <code>Function</code> object.</p>"
|
||||
}
|
||||
},
|
||||
"Functions": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListFunctionsResponse$functions": "<p>A list of <code>Function</code> objects.</p>"
|
||||
}
|
||||
},
|
||||
"FunctionsIds": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PipelineConfig$functions": "<p>A list of <code>Function</code> objects.</p>"
|
||||
}
|
||||
},
|
||||
"GetDataSourceRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -254,6 +360,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetFunctionRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetFunctionResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetGraphqlApiRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -324,17 +440,25 @@
|
||||
"ListGraphqlApisResponse$graphqlApis": "<p>The <code>GraphqlApi</code> objects.</p>"
|
||||
}
|
||||
},
|
||||
"HttpDataSourceConfig": {
|
||||
"base": "<p>Describes an HTTP data source configuration.</p>",
|
||||
"refs": {
|
||||
"CreateDataSourceRequest$httpConfig": "<p>HTTP endpoint settings.</p>",
|
||||
"DataSource$httpConfig": "<p>HTTP endpoint settings.</p>",
|
||||
"UpdateDataSourceRequest$httpConfig": "<p>The new HTTP endpoint configuration.</p>"
|
||||
}
|
||||
},
|
||||
"InternalFailureException": {
|
||||
"base": "<p>An internal AWS AppSync error occurred. Try your request again.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"LambdaDataSourceConfig": {
|
||||
"base": "<p>Describes a Lambda data source configuration.</p>",
|
||||
"base": "<p>Describes an AWS Lambda data source configuration.</p>",
|
||||
"refs": {
|
||||
"CreateDataSourceRequest$lambdaConfig": "<p>AWS Lambda settings.</p>",
|
||||
"DataSource$lambdaConfig": "<p>Lambda settings.</p>",
|
||||
"UpdateDataSourceRequest$lambdaConfig": "<p>The new Lambda configuration.</p>"
|
||||
"DataSource$lambdaConfig": "<p>AWS Lambda settings.</p>",
|
||||
"UpdateDataSourceRequest$lambdaConfig": "<p>The new AWS Lambda configuration.</p>"
|
||||
}
|
||||
},
|
||||
"LimitExceededException": {
|
||||
@@ -362,6 +486,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListFunctionsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListFunctionsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListGraphqlApisRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -372,6 +506,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListResolversByFunctionRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListResolversByFunctionResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListResolversRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -382,6 +526,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListTypesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -392,12 +546,22 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"LogConfig": {
|
||||
"base": "<p>The CloudWatch Logs configuration.</p>",
|
||||
"refs": {
|
||||
"CreateGraphqlApiRequest$logConfig": "<p>The Amazon CloudWatch Logs configuration.</p>",
|
||||
"GraphqlApi$logConfig": "<p>The Amazon CloudWatch Logs configuration.</p>",
|
||||
"UpdateGraphqlApiRequest$logConfig": "<p>The Amazon CloudWatch Logs configuration for the <code>GraphqlApi</code> object.</p>"
|
||||
}
|
||||
},
|
||||
"Long": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ApiKey$expires": "<p>The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.</p>",
|
||||
"CreateApiKeyRequest$expires": "<p>The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time.</p>",
|
||||
"UpdateApiKeyRequest$expires": "<p>The time after which the API key expires. The date is represented as seconds since the epoch.</p>"
|
||||
"CreateApiKeyRequest$expires": "<p>The time from creation time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. For more information, see .</p>",
|
||||
"OpenIDConnectConfig$iatTTL": "<p>The number of milliseconds a token is valid after being issued to a user.</p>",
|
||||
"OpenIDConnectConfig$authTTL": "<p>The number of milliseconds a token is valid after being authenticated.</p>",
|
||||
"UpdateApiKeyRequest$expires": "<p>The time from update time after which the API key expires. The date is represented as seconds since the epoch. For more information, see .</p>"
|
||||
}
|
||||
},
|
||||
"MapOfStringToString": {
|
||||
@@ -409,10 +573,16 @@
|
||||
"MappingTemplate": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateFunctionRequest$requestMappingTemplate": "<p>The <code>Function</code> request mapping template. Functions support only the 2018-05-29 version of the request mapping template.</p>",
|
||||
"CreateFunctionRequest$responseMappingTemplate": "<p>The <code>Function</code> response mapping template. </p>",
|
||||
"CreateResolverRequest$requestMappingTemplate": "<p>The mapping template to be used for requests.</p> <p>A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).</p>",
|
||||
"CreateResolverRequest$responseMappingTemplate": "<p>The mapping template to be used for responses from the data source.</p>",
|
||||
"FunctionConfiguration$requestMappingTemplate": "<p>The <code>Function</code> request mapping template. Functions support only the 2018-05-29 version of the request mapping template.</p>",
|
||||
"FunctionConfiguration$responseMappingTemplate": "<p>The <code>Function</code> response mapping template.</p>",
|
||||
"Resolver$requestMappingTemplate": "<p>The request mapping template.</p>",
|
||||
"Resolver$responseMappingTemplate": "<p>The response mapping template.</p>",
|
||||
"UpdateFunctionRequest$requestMappingTemplate": "<p>The <code>Function</code> request mapping template. Functions support only the 2018-05-29 version of the request mapping template.</p>",
|
||||
"UpdateFunctionRequest$responseMappingTemplate": "<p>The <code>Function</code> request mapping template. </p>",
|
||||
"UpdateResolverRequest$requestMappingTemplate": "<p>The new request mapping template.</p>",
|
||||
"UpdateResolverRequest$responseMappingTemplate": "<p>The new response mapping template.</p>"
|
||||
}
|
||||
@@ -422,16 +592,27 @@
|
||||
"refs": {
|
||||
"ListApiKeysRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>",
|
||||
"ListDataSourcesRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>",
|
||||
"ListFunctionsRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>",
|
||||
"ListGraphqlApisRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>",
|
||||
"ListResolversByFunctionRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>",
|
||||
"ListResolversRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>",
|
||||
"ListTypesRequest$maxResults": "<p>The maximum number of results you want the request to return.</p>"
|
||||
}
|
||||
},
|
||||
"NotFoundException": {
|
||||
"base": "<p>The resource specified in the request was not found. Check the resource and try again.</p>",
|
||||
"base": "<p>The resource specified in the request was not found. Check the resource, and then try again.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"OpenIDConnectConfig": {
|
||||
"base": "<p>Describes an OpenID Connect configuration.</p>",
|
||||
"refs": {
|
||||
"AdditionalAuthenticationProvider$openIDConnectConfig": "<p>The OpenID Connect configuration.</p>",
|
||||
"CreateGraphqlApiRequest$openIDConnectConfig": "<p>The OpenID Connect configuration.</p>",
|
||||
"GraphqlApi$openIDConnectConfig": "<p>The OpenID Connect configuration.</p>",
|
||||
"UpdateGraphqlApiRequest$openIDConnectConfig": "<p>The OpenID Connect configuration for the <code>GraphqlApi</code> object.</p>"
|
||||
}
|
||||
},
|
||||
"OutputType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -445,14 +626,46 @@
|
||||
"ListApiKeysResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>",
|
||||
"ListDataSourcesRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. </p>",
|
||||
"ListDataSourcesResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>",
|
||||
"ListFunctionsRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>",
|
||||
"ListFunctionsResponse$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>",
|
||||
"ListGraphqlApisRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. </p>",
|
||||
"ListGraphqlApisResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>",
|
||||
"ListResolversByFunctionRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.</p>",
|
||||
"ListResolversByFunctionResponse$nextToken": "<p>An identifier that can be used to return the next set of items in the list.</p>",
|
||||
"ListResolversRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. </p>",
|
||||
"ListResolversResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>",
|
||||
"ListTypesRequest$nextToken": "<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list. </p>",
|
||||
"ListTypesResponse$nextToken": "<p>An identifier to be passed in the next request to this operation to return the next set of items in the list.</p>"
|
||||
}
|
||||
},
|
||||
"PipelineConfig": {
|
||||
"base": "<p>The pipeline configuration for a resolver of kind <code>PIPELINE</code>.</p>",
|
||||
"refs": {
|
||||
"CreateResolverRequest$pipelineConfig": "<p>The <code>PipelineConfig</code>.</p>",
|
||||
"Resolver$pipelineConfig": "<p>The <code>PipelineConfig</code>.</p>",
|
||||
"UpdateResolverRequest$pipelineConfig": "<p>The <code>PipelineConfig</code>.</p>"
|
||||
}
|
||||
},
|
||||
"RdsHttpEndpointConfig": {
|
||||
"base": "<p>The Amazon RDS HTTP endpoint configuration.</p>",
|
||||
"refs": {
|
||||
"RelationalDatabaseDataSourceConfig$rdsHttpEndpointConfig": "<p>Amazon RDS HTTP endpoint settings.</p>"
|
||||
}
|
||||
},
|
||||
"RelationalDatabaseDataSourceConfig": {
|
||||
"base": "<p>Describes a relational database data source configuration.</p>",
|
||||
"refs": {
|
||||
"CreateDataSourceRequest$relationalDatabaseConfig": "<p>Relational database settings.</p>",
|
||||
"DataSource$relationalDatabaseConfig": "<p>Relational database settings.</p>",
|
||||
"UpdateDataSourceRequest$relationalDatabaseConfig": "<p>The new relational database configuration.</p>"
|
||||
}
|
||||
},
|
||||
"RelationalDatabaseSourceType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"RelationalDatabaseDataSourceConfig$relationalDatabaseSourceType": "<p>Source type for the relational database.</p> <ul> <li> <p> <b>RDS_HTTP_ENDPOINT</b>: The relational database source type is an Amazon RDS HTTP endpoint.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"Resolver": {
|
||||
"base": "<p>Describes a resolver.</p>",
|
||||
"refs": {
|
||||
@@ -462,25 +675,48 @@
|
||||
"UpdateResolverResponse$resolver": "<p>The updated <code>Resolver</code> object.</p>"
|
||||
}
|
||||
},
|
||||
"ResolverKind": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateResolverRequest$kind": "<p>The resolver type.</p> <ul> <li> <p> <b>UNIT</b>: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.</p> </li> <li> <p> <b>PIPELINE</b>: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of <code>Function</code> in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.</p> </li> </ul>",
|
||||
"Resolver$kind": "<p>The resolver type.</p> <ul> <li> <p> <b>UNIT</b>: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.</p> </li> <li> <p> <b>PIPELINE</b>: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of <code>Function</code> in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.</p> </li> </ul>",
|
||||
"UpdateResolverRequest$kind": "<p>The resolver type.</p> <ul> <li> <p> <b>UNIT</b>: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source.</p> </li> <li> <p> <b>PIPELINE</b>: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of <code>Function</code> in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"Resolvers": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListResolversByFunctionResponse$resolvers": "<p>The list of resolvers.</p>",
|
||||
"ListResolversResponse$resolvers": "<p>The <code>Resolver</code> objects.</p>"
|
||||
}
|
||||
},
|
||||
"ResourceArn": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListTagsForResourceRequest$resourceArn": "<p>The <code>GraphqlApi</code> ARN.</p>",
|
||||
"TagResourceRequest$resourceArn": "<p>The <code>GraphqlApi</code> ARN.</p>",
|
||||
"UntagResourceRequest$resourceArn": "<p>The <code>GraphqlApi</code> ARN.</p>"
|
||||
}
|
||||
},
|
||||
"ResourceName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateDataSourceRequest$name": "<p>A user-supplied name for the <code>DataSource</code>.</p>",
|
||||
"CreateFunctionRequest$name": "<p>The <code>Function</code> name. The function name does not have to be unique.</p>",
|
||||
"CreateFunctionRequest$dataSourceName": "<p>The <code>Function</code> <code>DataSource</code> name.</p>",
|
||||
"CreateResolverRequest$typeName": "<p>The name of the <code>Type</code>.</p>",
|
||||
"CreateResolverRequest$fieldName": "<p>The name of the field to attach the resolver to.</p>",
|
||||
"CreateResolverRequest$dataSourceName": "<p>The name of the data source for which the resolver is being created.</p>",
|
||||
"DataSource$name": "<p>The name of the data source.</p>",
|
||||
"DeleteDataSourceRequest$name": "<p>The name of the data source.</p>",
|
||||
"DeleteFunctionRequest$functionId": "<p>The <code>Function</code> ID.</p>",
|
||||
"DeleteResolverRequest$typeName": "<p>The name of the resolver type.</p>",
|
||||
"DeleteResolverRequest$fieldName": "<p>The resolver field name.</p>",
|
||||
"DeleteTypeRequest$typeName": "<p>The type name.</p>",
|
||||
"FunctionConfiguration$name": "<p>The name of the <code>Function</code> object.</p>",
|
||||
"FunctionConfiguration$dataSourceName": "<p>The name of the <code>DataSource</code>.</p>",
|
||||
"GetDataSourceRequest$name": "<p>The name of the data source.</p>",
|
||||
"GetFunctionRequest$functionId": "<p>The <code>Function</code> ID.</p>",
|
||||
"GetResolverRequest$typeName": "<p>The resolver type name.</p>",
|
||||
"GetResolverRequest$fieldName": "<p>The resolver field name.</p>",
|
||||
"GetTypeRequest$typeName": "<p>The type name.</p>",
|
||||
@@ -490,6 +726,9 @@
|
||||
"Resolver$dataSourceName": "<p>The resolver data source name.</p>",
|
||||
"Type$name": "<p>The type name.</p>",
|
||||
"UpdateDataSourceRequest$name": "<p>The new name for the data source.</p>",
|
||||
"UpdateFunctionRequest$name": "<p>The <code>Function</code> name.</p>",
|
||||
"UpdateFunctionRequest$functionId": "<p>The function ID.</p>",
|
||||
"UpdateFunctionRequest$dataSourceName": "<p>The <code>Function</code> <code>DataSource</code> name.</p>",
|
||||
"UpdateResolverRequest$typeName": "<p>The new type name.</p>",
|
||||
"UpdateResolverRequest$fieldName": "<p>The new field name.</p>",
|
||||
"UpdateResolverRequest$dataSourceName": "<p>The new data source name.</p>",
|
||||
@@ -499,8 +738,8 @@
|
||||
"SchemaStatus": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetSchemaCreationStatusResponse$status": "<p>The current state of the schema (PROCESSING, ACTIVE, or DELETING). Once the schema is in the ACTIVE state, you can add data.</p>",
|
||||
"StartSchemaCreationResponse$status": "<p>The current state of the schema (PROCESSING, ACTIVE, or DELETING). Once the schema is in the ACTIVE state, you can add data.</p>"
|
||||
"GetSchemaCreationStatusResponse$status": "<p>The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.</p>",
|
||||
"StartSchemaCreationResponse$status": "<p>The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.</p>"
|
||||
}
|
||||
},
|
||||
"StartSchemaCreationRequest": {
|
||||
@@ -516,34 +755,50 @@
|
||||
"String": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AccessDeniedException$message": null,
|
||||
"ApiKey$id": "<p>The API key ID.</p>",
|
||||
"ApiKey$description": "<p>A description of the purpose of the API key.</p>",
|
||||
"ApiKeyLimitExceededException$message": null,
|
||||
"ApiKeyValidityOutOfBoundsException$message": null,
|
||||
"ApiLimitExceededException$message": null,
|
||||
"AwsIamConfig$signingRegion": "<p>The signing region for AWS IAM authorization.</p>",
|
||||
"AwsIamConfig$signingServiceName": "<p>The signing service name for AWS IAM authorization.</p>",
|
||||
"CognitoUserPoolConfig$userPoolId": "<p>The user pool ID.</p>",
|
||||
"CognitoUserPoolConfig$awsRegion": "<p>The AWS Region in which the user pool was created.</p>",
|
||||
"CognitoUserPoolConfig$appIdClientRegex": "<p>A regular expression for validating the incoming Amazon Cognito user pool app client ID.</p>",
|
||||
"CreateApiKeyRequest$apiId": "<p>The ID for your GraphQL API.</p>",
|
||||
"CreateApiKeyRequest$description": "<p>A description of the purpose of the API key.</p>",
|
||||
"CreateDataSourceRequest$apiId": "<p>The API ID for the GraphQL API for the <code>DataSource</code>.</p>",
|
||||
"CreateDataSourceRequest$description": "<p>A description of the <code>DataSource</code>.</p>",
|
||||
"CreateDataSourceRequest$serviceRoleArn": "<p>The IAM service role ARN for the data source. The system assumes this role when accessing the data source.</p>",
|
||||
"CreateDataSourceRequest$serviceRoleArn": "<p>The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.</p>",
|
||||
"CreateFunctionRequest$apiId": "<p>The GraphQL API ID.</p>",
|
||||
"CreateFunctionRequest$description": "<p>The <code>Function</code> description.</p>",
|
||||
"CreateFunctionRequest$functionVersion": "<p>The <code>version</code> of the request mapping template. Currently the supported value is 2018-05-29. </p>",
|
||||
"CreateGraphqlApiRequest$name": "<p>A user-supplied name for the <code>GraphqlApi</code>.</p>",
|
||||
"CreateResolverRequest$apiId": "<p>The ID for the GraphQL API for which the resolver is being created.</p>",
|
||||
"CreateTypeRequest$apiId": "<p>The API ID.</p>",
|
||||
"CreateTypeRequest$definition": "<p>The type definition, in GraphQL Schema Definition Language (SDL) format.</p> <p>For more information, see the <a href=\"http://graphql.org/learn/schema/\">GraphQL SDL documentation</a>.</p>",
|
||||
"DataSource$dataSourceArn": "<p>The data source ARN.</p>",
|
||||
"DataSource$description": "<p>The description of the data source.</p>",
|
||||
"DataSource$serviceRoleArn": "<p>The IAM service role ARN for the data source. The system assumes this role when accessing the data source.</p>",
|
||||
"DataSource$serviceRoleArn": "<p>The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.</p>",
|
||||
"DeleteApiKeyRequest$apiId": "<p>The API ID.</p>",
|
||||
"DeleteApiKeyRequest$id": "<p>The ID for the API key.</p>",
|
||||
"DeleteDataSourceRequest$apiId": "<p>The API ID.</p>",
|
||||
"DeleteFunctionRequest$apiId": "<p>The GraphQL API ID.</p>",
|
||||
"DeleteGraphqlApiRequest$apiId": "<p>The API ID.</p>",
|
||||
"DeleteResolverRequest$apiId": "<p>The API ID.</p>",
|
||||
"DeleteTypeRequest$apiId": "<p>The API ID.</p>",
|
||||
"DynamodbDataSourceConfig$tableName": "<p>The table name.</p>",
|
||||
"DynamodbDataSourceConfig$awsRegion": "<p>The AWS region.</p>",
|
||||
"DynamodbDataSourceConfig$awsRegion": "<p>The AWS Region.</p>",
|
||||
"ElasticsearchDataSourceConfig$endpoint": "<p>The endpoint.</p>",
|
||||
"ElasticsearchDataSourceConfig$awsRegion": "<p>The AWS region.</p>",
|
||||
"ElasticsearchDataSourceConfig$awsRegion": "<p>The AWS Region.</p>",
|
||||
"FunctionConfiguration$functionId": "<p>A unique ID representing the <code>Function</code> object.</p>",
|
||||
"FunctionConfiguration$functionArn": "<p>The ARN of the <code>Function</code> object.</p>",
|
||||
"FunctionConfiguration$description": "<p>The <code>Function</code> description.</p>",
|
||||
"FunctionConfiguration$functionVersion": "<p>The version of the request mapping template. Currently only the 2018-05-29 version of the template is supported.</p>",
|
||||
"FunctionsIds$member": null,
|
||||
"GetDataSourceRequest$apiId": "<p>The API ID.</p>",
|
||||
"GetFunctionRequest$apiId": "<p>The GraphQL API ID.</p>",
|
||||
"GetGraphqlApiRequest$apiId": "<p>The API ID for the GraphQL API.</p>",
|
||||
"GetIntrospectionSchemaRequest$apiId": "<p>The API ID.</p>",
|
||||
"GetResolverRequest$apiId": "<p>The API ID.</p>",
|
||||
@@ -552,37 +807,90 @@
|
||||
"GetTypeRequest$apiId": "<p>The API ID.</p>",
|
||||
"GraphqlApi$apiId": "<p>The API ID.</p>",
|
||||
"GraphqlApi$arn": "<p>The ARN.</p>",
|
||||
"HttpDataSourceConfig$endpoint": "<p>The HTTP URL endpoint. You can either specify the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If the port is not specified, AWS AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.</p>",
|
||||
"InternalFailureException$message": null,
|
||||
"LambdaDataSourceConfig$lambdaFunctionArn": "<p>The ARN for the Lambda function.</p>",
|
||||
"LimitExceededException$message": null,
|
||||
"ListApiKeysRequest$apiId": "<p>The API ID.</p>",
|
||||
"ListDataSourcesRequest$apiId": "<p>The API ID.</p>",
|
||||
"ListFunctionsRequest$apiId": "<p>The GraphQL API ID.</p>",
|
||||
"ListResolversByFunctionRequest$apiId": "<p>The API ID.</p>",
|
||||
"ListResolversByFunctionRequest$functionId": "<p>The Function ID.</p>",
|
||||
"ListResolversRequest$apiId": "<p>The API ID.</p>",
|
||||
"ListResolversRequest$typeName": "<p>The type name.</p>",
|
||||
"ListTypesRequest$apiId": "<p>The API ID.</p>",
|
||||
"LogConfig$cloudWatchLogsRoleArn": "<p>The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account. </p>",
|
||||
"MapOfStringToString$key": null,
|
||||
"MapOfStringToString$value": null,
|
||||
"NotFoundException$message": null,
|
||||
"OpenIDConnectConfig$issuer": "<p>The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of <code>iss</code> in the ID token.</p>",
|
||||
"OpenIDConnectConfig$clientId": "<p>The client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.</p>",
|
||||
"RdsHttpEndpointConfig$awsRegion": "<p>AWS Region for RDS HTTP endpoint.</p>",
|
||||
"RdsHttpEndpointConfig$dbClusterIdentifier": "<p>Amazon RDS cluster identifier.</p>",
|
||||
"RdsHttpEndpointConfig$databaseName": "<p>Logical database name.</p>",
|
||||
"RdsHttpEndpointConfig$schema": "<p>Logical schema name.</p>",
|
||||
"RdsHttpEndpointConfig$awsSecretStoreArn": "<p>AWS secret store ARN for database credentials.</p>",
|
||||
"Resolver$resolverArn": "<p>The resolver ARN.</p>",
|
||||
"StartSchemaCreationRequest$apiId": "<p>The API ID.</p>",
|
||||
"Type$description": "<p>The type description.</p>",
|
||||
"Type$arn": "<p>The type ARN.</p>",
|
||||
"Type$definition": "<p>The type definition.</p>",
|
||||
"UnauthorizedException$message": null,
|
||||
"UpdateApiKeyRequest$apiId": "<p>The ID for the GraphQL API</p>",
|
||||
"UpdateApiKeyRequest$apiId": "<p>The ID for the GraphQL API.</p>",
|
||||
"UpdateApiKeyRequest$id": "<p>The API key ID.</p>",
|
||||
"UpdateApiKeyRequest$description": "<p>A description of the purpose of the API key.</p>",
|
||||
"UpdateDataSourceRequest$apiId": "<p>The API ID.</p>",
|
||||
"UpdateDataSourceRequest$description": "<p>The new description for the data source.</p>",
|
||||
"UpdateDataSourceRequest$serviceRoleArn": "<p>The new service role ARN for the data source.</p>",
|
||||
"UpdateFunctionRequest$apiId": "<p>The GraphQL API ID.</p>",
|
||||
"UpdateFunctionRequest$description": "<p>The <code>Function</code> description.</p>",
|
||||
"UpdateFunctionRequest$functionVersion": "<p>The <code>version</code> of the request mapping template. Currently the supported value is 2018-05-29. </p>",
|
||||
"UpdateGraphqlApiRequest$apiId": "<p>The API ID.</p>",
|
||||
"UpdateGraphqlApiRequest$name": "<p>The new name for the <code>GraphqlApi</code> object.</p>",
|
||||
"UpdateResolverRequest$apiId": "<p>The API ID.</p>",
|
||||
"UpdateTypeRequest$apiId": "<p>The API ID.</p>",
|
||||
"UpdateTypeRequest$definition": "<p>The new definition.</p>",
|
||||
"UserPoolConfig$userPoolId": "<p>The user pool ID.</p>",
|
||||
"UserPoolConfig$awsRegion": "<p>The AWS region in which the user pool was created.</p>",
|
||||
"UserPoolConfig$appIdClientRegex": "<p>A regular expression for validating the incoming Amazon Cognito User Pool app client ID.</p>"
|
||||
"UserPoolConfig$awsRegion": "<p>The AWS Region in which the user pool was created.</p>",
|
||||
"UserPoolConfig$appIdClientRegex": "<p>A regular expression for validating the incoming Amazon Cognito user pool app client ID.</p>"
|
||||
}
|
||||
},
|
||||
"TagKey": {
|
||||
"base": "<p>The key for the tag.</p>",
|
||||
"refs": {
|
||||
"TagKeyList$member": null,
|
||||
"TagMap$key": null
|
||||
}
|
||||
},
|
||||
"TagKeyList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"UntagResourceRequest$tagKeys": "<p>A list of <code>TagKey</code> objects.</p>"
|
||||
}
|
||||
},
|
||||
"TagMap": {
|
||||
"base": "<p>A map with keys of <code>TagKey</code> objects and values of <code>TagValue</code> objects.</p>",
|
||||
"refs": {
|
||||
"CreateGraphqlApiRequest$tags": "<p>A <code>TagMap</code> object.</p>",
|
||||
"GraphqlApi$tags": "<p>The tags.</p>",
|
||||
"ListTagsForResourceResponse$tags": "<p>A <code>TagMap</code> object.</p>",
|
||||
"TagResourceRequest$tags": "<p>A <code>TagMap</code> object.</p>"
|
||||
}
|
||||
},
|
||||
"TagResourceRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"TagResourceResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"TagValue": {
|
||||
"base": "<p>The value for the tag.</p>",
|
||||
"refs": {
|
||||
"TagMap$value": null
|
||||
}
|
||||
},
|
||||
"Type": {
|
||||
@@ -615,6 +923,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UntagResourceRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UntagResourceResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateApiKeyRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -635,6 +953,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateFunctionRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateFunctionResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateGraphqlApiRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -666,11 +994,11 @@
|
||||
}
|
||||
},
|
||||
"UserPoolConfig": {
|
||||
"base": "<p>Describes an Amazon Cognito User Pool configuration.</p>",
|
||||
"base": "<p>Describes an Amazon Cognito user pool configuration.</p>",
|
||||
"refs": {
|
||||
"CreateGraphqlApiRequest$userPoolConfig": "<p>The Amazon Cognito User Pool configuration.</p>",
|
||||
"GraphqlApi$userPoolConfig": "<p>The Amazon Cognito User Pool configuration.</p>",
|
||||
"UpdateGraphqlApiRequest$userPoolConfig": "<p>The new Amazon Cognito User Pool configuration for the <code>GraphqlApi</code> object.</p>"
|
||||
"CreateGraphqlApiRequest$userPoolConfig": "<p>The Amazon Cognito user pool configuration.</p>",
|
||||
"GraphqlApi$userPoolConfig": "<p>The Amazon Cognito user pool configuration.</p>",
|
||||
"UpdateGraphqlApiRequest$userPoolConfig": "<p>The new Amazon Cognito user pool configuration for the <code>GraphqlApi</code> object.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+380
-13
@@ -6,6 +6,7 @@
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceFullName":"Amazon Athena",
|
||||
"serviceId":"Athena",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"AmazonAthena",
|
||||
"uid":"athena-2017-05-18"
|
||||
@@ -51,6 +52,19 @@
|
||||
],
|
||||
"idempotent":true
|
||||
},
|
||||
"CreateWorkGroup":{
|
||||
"name":"CreateWorkGroup",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateWorkGroupInput"},
|
||||
"output":{"shape":"CreateWorkGroupOutput"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"DeleteNamedQuery":{
|
||||
"name":"DeleteNamedQuery",
|
||||
"http":{
|
||||
@@ -65,6 +79,20 @@
|
||||
],
|
||||
"idempotent":true
|
||||
},
|
||||
"DeleteWorkGroup":{
|
||||
"name":"DeleteWorkGroup",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteWorkGroupInput"},
|
||||
"output":{"shape":"DeleteWorkGroupOutput"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"idempotent":true
|
||||
},
|
||||
"GetNamedQuery":{
|
||||
"name":"GetNamedQuery",
|
||||
"http":{
|
||||
@@ -104,6 +132,19 @@
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"GetWorkGroup":{
|
||||
"name":"GetWorkGroup",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetWorkGroupInput"},
|
||||
"output":{"shape":"GetWorkGroupOutput"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"ListNamedQueries":{
|
||||
"name":"ListNamedQueries",
|
||||
"http":{
|
||||
@@ -130,6 +171,33 @@
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"ListTagsForResource":{
|
||||
"name":"ListTagsForResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListTagsForResourceInput"},
|
||||
"output":{"shape":"ListTagsForResourceOutput"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"ListWorkGroups":{
|
||||
"name":"ListWorkGroups",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListWorkGroupsInput"},
|
||||
"output":{"shape":"ListWorkGroupsOutput"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
},
|
||||
"StartQueryExecution":{
|
||||
"name":"StartQueryExecution",
|
||||
"http":{
|
||||
@@ -158,9 +226,55 @@
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"idempotent":true
|
||||
},
|
||||
"TagResource":{
|
||||
"name":"TagResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"TagResourceInput"},
|
||||
"output":{"shape":"TagResourceOutput"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"UntagResource":{
|
||||
"name":"UntagResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UntagResourceInput"},
|
||||
"output":{"shape":"UntagResourceOutput"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"UpdateWorkGroup":{
|
||||
"name":"UpdateWorkGroup",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateWorkGroupInput"},
|
||||
"output":{"shape":"UpdateWorkGroupOutput"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AmazonResourceName":{
|
||||
"type":"string",
|
||||
"max":1011,
|
||||
"min":1
|
||||
},
|
||||
"BatchGetNamedQueryInput":{
|
||||
"type":"structure",
|
||||
"required":["NamedQueryIds"],
|
||||
@@ -190,6 +304,11 @@
|
||||
}
|
||||
},
|
||||
"Boolean":{"type":"boolean"},
|
||||
"BoxedBoolean":{"type":"boolean"},
|
||||
"BytesScannedCutoffValue":{
|
||||
"type":"long",
|
||||
"min":10000000
|
||||
},
|
||||
"ColumnInfo":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -236,7 +355,8 @@
|
||||
"ClientRequestToken":{
|
||||
"shape":"IdempotencyToken",
|
||||
"idempotencyToken":true
|
||||
}
|
||||
},
|
||||
"WorkGroup":{"shape":"WorkGroupName"}
|
||||
}
|
||||
},
|
||||
"CreateNamedQueryOutput":{
|
||||
@@ -245,9 +365,24 @@
|
||||
"NamedQueryId":{"shape":"NamedQueryId"}
|
||||
}
|
||||
},
|
||||
"CreateWorkGroupInput":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{"shape":"WorkGroupName"},
|
||||
"Configuration":{"shape":"WorkGroupConfiguration"},
|
||||
"Description":{"shape":"WorkGroupDescriptionString"},
|
||||
"Tags":{"shape":"TagList"}
|
||||
}
|
||||
},
|
||||
"CreateWorkGroupOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DatabaseString":{
|
||||
"type":"string",
|
||||
"max":32,
|
||||
"max":255,
|
||||
"min":1
|
||||
},
|
||||
"Date":{"type":"timestamp"},
|
||||
@@ -272,6 +407,19 @@
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteWorkGroupInput":{
|
||||
"type":"structure",
|
||||
"required":["WorkGroup"],
|
||||
"members":{
|
||||
"WorkGroup":{"shape":"WorkGroupName"},
|
||||
"RecursiveDeleteOption":{"shape":"BoxedBoolean"}
|
||||
}
|
||||
},
|
||||
"DeleteWorkGroupOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DescriptionString":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
@@ -337,10 +485,24 @@
|
||||
"GetQueryResultsOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"UpdateCount":{"shape":"Long"},
|
||||
"ResultSet":{"shape":"ResultSet"},
|
||||
"NextToken":{"shape":"Token"}
|
||||
}
|
||||
},
|
||||
"GetWorkGroupInput":{
|
||||
"type":"structure",
|
||||
"required":["WorkGroup"],
|
||||
"members":{
|
||||
"WorkGroup":{"shape":"WorkGroupName"}
|
||||
}
|
||||
},
|
||||
"GetWorkGroupOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"WorkGroup":{"shape":"WorkGroup"}
|
||||
}
|
||||
},
|
||||
"IdempotencyToken":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
@@ -367,7 +529,8 @@
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{"shape":"Token"},
|
||||
"MaxResults":{"shape":"MaxNamedQueriesCount"}
|
||||
"MaxResults":{"shape":"MaxNamedQueriesCount"},
|
||||
"WorkGroup":{"shape":"WorkGroupName"}
|
||||
}
|
||||
},
|
||||
"ListNamedQueriesOutput":{
|
||||
@@ -381,7 +544,8 @@
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{"shape":"Token"},
|
||||
"MaxResults":{"shape":"MaxQueryExecutionsCount"}
|
||||
"MaxResults":{"shape":"MaxQueryExecutionsCount"},
|
||||
"WorkGroup":{"shape":"WorkGroupName"}
|
||||
}
|
||||
},
|
||||
"ListQueryExecutionsOutput":{
|
||||
@@ -391,6 +555,36 @@
|
||||
"NextToken":{"shape":"Token"}
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceInput":{
|
||||
"type":"structure",
|
||||
"required":["ResourceARN"],
|
||||
"members":{
|
||||
"ResourceARN":{"shape":"AmazonResourceName"},
|
||||
"NextToken":{"shape":"Token"},
|
||||
"MaxResults":{"shape":"MaxTagsCount"}
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Tags":{"shape":"TagList"},
|
||||
"NextToken":{"shape":"Token"}
|
||||
}
|
||||
},
|
||||
"ListWorkGroupsInput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{"shape":"Token"},
|
||||
"MaxResults":{"shape":"MaxWorkGroupsCount"}
|
||||
}
|
||||
},
|
||||
"ListWorkGroupsOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"WorkGroups":{"shape":"WorkGroupsList"},
|
||||
"NextToken":{"shape":"Token"}
|
||||
}
|
||||
},
|
||||
"Long":{"type":"long"},
|
||||
"MaxNamedQueriesCount":{
|
||||
"type":"integer",
|
||||
@@ -410,6 +604,17 @@
|
||||
"max":1000,
|
||||
"min":0
|
||||
},
|
||||
"MaxTagsCount":{
|
||||
"type":"integer",
|
||||
"box":true,
|
||||
"min":75
|
||||
},
|
||||
"MaxWorkGroupsCount":{
|
||||
"type":"integer",
|
||||
"box":true,
|
||||
"max":50,
|
||||
"min":1
|
||||
},
|
||||
"NameString":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
@@ -427,7 +632,8 @@
|
||||
"Description":{"shape":"DescriptionString"},
|
||||
"Database":{"shape":"DatabaseString"},
|
||||
"QueryString":{"shape":"QueryString"},
|
||||
"NamedQueryId":{"shape":"NamedQueryId"}
|
||||
"NamedQueryId":{"shape":"NamedQueryId"},
|
||||
"WorkGroup":{"shape":"WorkGroupName"}
|
||||
}
|
||||
},
|
||||
"NamedQueryId":{"type":"string"},
|
||||
@@ -446,10 +652,12 @@
|
||||
"members":{
|
||||
"QueryExecutionId":{"shape":"QueryExecutionId"},
|
||||
"Query":{"shape":"QueryString"},
|
||||
"StatementType":{"shape":"StatementType"},
|
||||
"ResultConfiguration":{"shape":"ResultConfiguration"},
|
||||
"QueryExecutionContext":{"shape":"QueryExecutionContext"},
|
||||
"Status":{"shape":"QueryExecutionStatus"},
|
||||
"Statistics":{"shape":"QueryExecutionStatistics"}
|
||||
"Statistics":{"shape":"QueryExecutionStatistics"},
|
||||
"WorkGroup":{"shape":"WorkGroupName"}
|
||||
}
|
||||
},
|
||||
"QueryExecutionContext":{
|
||||
@@ -500,14 +708,30 @@
|
||||
"max":262144,
|
||||
"min":1
|
||||
},
|
||||
"ResourceNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"},
|
||||
"ResourceName":{"shape":"AmazonResourceName"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ResultConfiguration":{
|
||||
"type":"structure",
|
||||
"required":["OutputLocation"],
|
||||
"members":{
|
||||
"OutputLocation":{"shape":"String"},
|
||||
"EncryptionConfiguration":{"shape":"EncryptionConfiguration"}
|
||||
}
|
||||
},
|
||||
"ResultConfigurationUpdates":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"OutputLocation":{"shape":"String"},
|
||||
"RemoveOutputLocation":{"shape":"BoxedBoolean"},
|
||||
"EncryptionConfiguration":{"shape":"EncryptionConfiguration"},
|
||||
"RemoveEncryptionConfiguration":{"shape":"BoxedBoolean"}
|
||||
}
|
||||
},
|
||||
"ResultSet":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -533,10 +757,7 @@
|
||||
},
|
||||
"StartQueryExecutionInput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"QueryString",
|
||||
"ResultConfiguration"
|
||||
],
|
||||
"required":["QueryString"],
|
||||
"members":{
|
||||
"QueryString":{"shape":"QueryString"},
|
||||
"ClientRequestToken":{
|
||||
@@ -544,7 +765,8 @@
|
||||
"idempotencyToken":true
|
||||
},
|
||||
"QueryExecutionContext":{"shape":"QueryExecutionContext"},
|
||||
"ResultConfiguration":{"shape":"ResultConfiguration"}
|
||||
"ResultConfiguration":{"shape":"ResultConfiguration"},
|
||||
"WorkGroup":{"shape":"WorkGroupName"}
|
||||
}
|
||||
},
|
||||
"StartQueryExecutionOutput":{
|
||||
@@ -553,6 +775,14 @@
|
||||
"QueryExecutionId":{"shape":"QueryExecutionId"}
|
||||
}
|
||||
},
|
||||
"StatementType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"DDL",
|
||||
"DML",
|
||||
"UTILITY"
|
||||
]
|
||||
},
|
||||
"StopQueryExecutionInput":{
|
||||
"type":"structure",
|
||||
"required":["QueryExecutionId"],
|
||||
@@ -569,11 +799,56 @@
|
||||
}
|
||||
},
|
||||
"String":{"type":"string"},
|
||||
"Tag":{
|
||||
"type":"structure",
|
||||
"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"}
|
||||
},
|
||||
"TagResourceInput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResourceARN",
|
||||
"Tags"
|
||||
],
|
||||
"members":{
|
||||
"ResourceARN":{"shape":"AmazonResourceName"},
|
||||
"Tags":{"shape":"TagList"}
|
||||
}
|
||||
},
|
||||
"TagResourceOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"TagValue":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":0
|
||||
},
|
||||
"ThrottleReason":{
|
||||
"type":"string",
|
||||
"enum":["CONCURRENT_QUERY_LIMIT_EXCEEDED"]
|
||||
},
|
||||
"Token":{"type":"string"},
|
||||
"Token":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
"min":1
|
||||
},
|
||||
"TooManyRequestsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -606,6 +881,98 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"UnprocessedQueryExecutionId"}
|
||||
},
|
||||
"UntagResourceInput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResourceARN",
|
||||
"TagKeys"
|
||||
],
|
||||
"members":{
|
||||
"ResourceARN":{"shape":"AmazonResourceName"},
|
||||
"TagKeys":{"shape":"TagKeyList"}
|
||||
}
|
||||
},
|
||||
"UntagResourceOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"UpdateWorkGroupInput":{
|
||||
"type":"structure",
|
||||
"required":["WorkGroup"],
|
||||
"members":{
|
||||
"WorkGroup":{"shape":"WorkGroupName"},
|
||||
"Description":{"shape":"WorkGroupDescriptionString"},
|
||||
"ConfigurationUpdates":{"shape":"WorkGroupConfigurationUpdates"},
|
||||
"State":{"shape":"WorkGroupState"}
|
||||
}
|
||||
},
|
||||
"UpdateWorkGroupOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"WorkGroup":{
|
||||
"type":"structure",
|
||||
"required":["Name"],
|
||||
"members":{
|
||||
"Name":{"shape":"WorkGroupName"},
|
||||
"State":{"shape":"WorkGroupState"},
|
||||
"Configuration":{"shape":"WorkGroupConfiguration"},
|
||||
"Description":{"shape":"WorkGroupDescriptionString"},
|
||||
"CreationTime":{"shape":"Date"}
|
||||
}
|
||||
},
|
||||
"WorkGroupConfiguration":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ResultConfiguration":{"shape":"ResultConfiguration"},
|
||||
"EnforceWorkGroupConfiguration":{"shape":"BoxedBoolean"},
|
||||
"PublishCloudWatchMetricsEnabled":{"shape":"BoxedBoolean"},
|
||||
"BytesScannedCutoffPerQuery":{"shape":"BytesScannedCutoffValue"}
|
||||
}
|
||||
},
|
||||
"WorkGroupConfigurationUpdates":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"EnforceWorkGroupConfiguration":{"shape":"BoxedBoolean"},
|
||||
"ResultConfigurationUpdates":{"shape":"ResultConfigurationUpdates"},
|
||||
"PublishCloudWatchMetricsEnabled":{"shape":"BoxedBoolean"},
|
||||
"BytesScannedCutoffPerQuery":{"shape":"BytesScannedCutoffValue"},
|
||||
"RemoveBytesScannedCutoffPerQuery":{"shape":"BoxedBoolean"}
|
||||
}
|
||||
},
|
||||
"WorkGroupDescriptionString":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
"min":0
|
||||
},
|
||||
"WorkGroupName":{
|
||||
"type":"string",
|
||||
"pattern":"[a-zA-z0-9._-]{1,128}"
|
||||
},
|
||||
"WorkGroupState":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ENABLED",
|
||||
"DISABLED"
|
||||
]
|
||||
},
|
||||
"WorkGroupSummary":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Name":{"shape":"WorkGroupName"},
|
||||
"State":{"shape":"WorkGroupState"},
|
||||
"Description":{"shape":"WorkGroupDescriptionString"},
|
||||
"CreationTime":{"shape":"Date"}
|
||||
}
|
||||
},
|
||||
"WorkGroupsList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"WorkGroupSummary"},
|
||||
"max":50,
|
||||
"min":0
|
||||
},
|
||||
"datumList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Datum"}
|
||||
|
||||
+290
-35
@@ -1,20 +1,37 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<p>Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay only for the queries you run. Athena scales automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For more information, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/what-is.html\">What is Amazon Athena</a> in the <i>Amazon Athena User Guide</i>.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"service": "<p>Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay only for the queries you run. Athena scales automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For more information, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/what-is.html\">What is Amazon Athena</a> in the <i>Amazon Athena User Guide</i>.</p> <p>If you connect to Athena using the JDBC driver, use version 1.1.0 of the driver or later with the Amazon Athena API. Earlier version drivers do not support the API. For more information and to download the driver, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/connect-with-jdbc.html\">Accessing Amazon Athena with JDBC</a>.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"operations": {
|
||||
"BatchGetNamedQuery": "<p>Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Use <a>ListNamedQueries</a> to get the list of named query IDs. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under <a>UnprocessedNamedQueryId</a>. Named queries are different from executed queries. Use <a>BatchGetQueryExecution</a> to get details about each unique query execution, and <a>ListQueryExecutions</a> to get a list of query execution IDs.</p>",
|
||||
"BatchGetQueryExecution": "<p>Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. To get a list of query execution IDs, use <a>ListQueryExecutions</a>. Query executions are different from named (saved) queries. Use <a>BatchGetNamedQuery</a> to get details about named queries.</p>",
|
||||
"CreateNamedQuery": "<p>Creates a named query.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"DeleteNamedQuery": "<p>Deletes a named query.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"GetNamedQuery": "<p>Returns information about a single query.</p>",
|
||||
"GetQueryExecution": "<p>Returns information about a single execution of a query. Each time a query executes, information about the query execution is saved with a unique ID.</p>",
|
||||
"GetQueryResults": "<p>Returns the results of a single query execution specified by <code>QueryExecutionId</code>. This request does not execute the query but returns results. Use <a>StartQueryExecution</a> to run a query.</p>",
|
||||
"ListNamedQueries": "<p>Provides a list of all available query IDs.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"ListQueryExecutions": "<p>Provides a list of all available query execution IDs.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"StartQueryExecution": "<p>Runs (executes) the SQL query statements contained in the <code>Query</code> string.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"StopQueryExecution": "<p>Stops a query execution.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>"
|
||||
"BatchGetNamedQuery": "<p>Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Requires you to have access to the workgroup in which the queries were saved. Use <a>ListNamedQueriesInput</a> to get the list of named query IDs in the specified workgroup. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under <a>UnprocessedNamedQueryId</a>. Named queries differ from executed queries. Use <a>BatchGetQueryExecutionInput</a> to get details about each unique query execution, and <a>ListQueryExecutionsInput</a> to get a list of query execution IDs.</p>",
|
||||
"BatchGetQueryExecution": "<p>Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. Requires you to have access to the workgroup in which the queries ran. To get a list of query execution IDs, use <a>ListQueryExecutionsInput$WorkGroup</a>. Query executions differ from named (saved) queries. Use <a>BatchGetNamedQueryInput</a> to get details about named queries.</p>",
|
||||
"CreateNamedQuery": "<p>Creates a named query in the specified workgroup. Requires that you have access to the workgroup.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"CreateWorkGroup": "<p>Creates a workgroup with the specified name.</p>",
|
||||
"DeleteNamedQuery": "<p>Deletes the named query if you have access to the workgroup in which the query was saved.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"DeleteWorkGroup": "<p>Deletes the workgroup with the specified name. The primary workgroup cannot be deleted.</p>",
|
||||
"GetNamedQuery": "<p>Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.</p>",
|
||||
"GetQueryExecution": "<p>Returns information about a single execution of a query if you have access to the workgroup in which the query ran. Each time a query executes, information about the query execution is saved with a unique ID.</p>",
|
||||
"GetQueryResults": "<p>Returns the results of a single query execution specified by <code>QueryExecutionId</code> if you have access to the workgroup in which the query ran. This request does not execute the query but returns results. Use <a>StartQueryExecution</a> to run a query.</p>",
|
||||
"GetWorkGroup": "<p>Returns information about the workgroup with the specified name.</p>",
|
||||
"ListNamedQueries": "<p>Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the workgroup.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"ListQueryExecutions": "<p>Provides a list of available query execution IDs for the queries in the specified workgroup. Requires you to have access to the workgroup in which the queries ran.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"ListTagsForResource": "<p>Lists the tags associated with this workgroup.</p>",
|
||||
"ListWorkGroups": "<p>Lists available workgroups for the account.</p>",
|
||||
"StartQueryExecution": "<p>Runs the SQL query statements contained in the <code>Query</code>. Requires you to have access to the workgroup in which the query ran.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"StopQueryExecution": "<p>Stops a query execution. Requires you to have access to the workgroup in which the query ran.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"TagResource": "<p>Adds one or more tags to the resource, such as a workgroup. A tag is a label that you assign to an AWS Athena resource (a workgroup). Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize resources (workgroups) in Athena, for example, by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account. For best practices, see <a href=\"https://aws.amazon.com/answers/account-management/aws-tagging-strategies/\">AWS Tagging Strategies</a>. The key length is from 1 (minimum) to 128 (maximum) Unicode characters in UTF-8. The tag value length is from 0 (minimum) to 256 (maximum) Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. If you specify more than one, separate them by commas.</p>",
|
||||
"UntagResource": "<p>Removes one or more tags from the workgroup resource. Takes as an input a list of TagKey Strings separated by commas, and removes their tags at the same time.</p>",
|
||||
"UpdateWorkGroup": "<p>Updates the workgroup with the specified name. The workgroup's name cannot be changed.</p>"
|
||||
},
|
||||
"shapes": {
|
||||
"AmazonResourceName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListTagsForResourceInput$ResourceARN": "<p>Lists the tags for the workgroup resource with the specified ARN.</p>",
|
||||
"ResourceNotFoundException$ResourceName": null,
|
||||
"TagResourceInput$ResourceARN": "<p>Requests that one or more tags are added to the resource (such as a workgroup) for the specified ARN.</p>",
|
||||
"UntagResourceInput$ResourceARN": "<p>Removes one or more tags from the workgroup resource for the specified ARN.</p>"
|
||||
}
|
||||
},
|
||||
"BatchGetNamedQueryInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -41,6 +58,26 @@
|
||||
"ColumnInfo$CaseSensitive": "<p>Indicates whether values in the column are case-sensitive.</p>"
|
||||
}
|
||||
},
|
||||
"BoxedBoolean": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DeleteWorkGroupInput$RecursiveDeleteOption": "<p>The option to delete the workgroup and its contents even if the workgroup contains any named queries.</p>",
|
||||
"ResultConfigurationUpdates$RemoveOutputLocation": "<p>If set to \"true\", indicates that the previously-specified query results location (also known as a client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the OutputLocation in ResultConfigurationUpdates (the client-side setting), the OutputLocation in the workgroup's ResultConfiguration will be updated with the new value. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>",
|
||||
"ResultConfigurationUpdates$RemoveEncryptionConfiguration": "<p>If set to \"true\", indicates that the previously-specified encryption configuration (also known as the client-side setting) for queries in this workgroup should be ignored and set to null. If set to \"false\" or not set, and a value is present in the EncryptionConfiguration in ResultConfigurationUpdates (the client-side setting), the EncryptionConfiguration in the workgroup's ResultConfiguration will be updated with the new value. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>",
|
||||
"WorkGroupConfiguration$EnforceWorkGroupConfiguration": "<p>If set to \"true\", the settings for the workgroup override client-side settings. If set to \"false\", client-side settings are used. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>",
|
||||
"WorkGroupConfiguration$PublishCloudWatchMetricsEnabled": "<p>Indicates that the Amazon CloudWatch metrics are enabled for the workgroup.</p>",
|
||||
"WorkGroupConfigurationUpdates$EnforceWorkGroupConfiguration": "<p>If set to \"true\", the settings for the workgroup override client-side settings. If set to \"false\" client-side settings are used. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>",
|
||||
"WorkGroupConfigurationUpdates$PublishCloudWatchMetricsEnabled": "<p>Indicates whether this workgroup enables publishing metrics to Amazon CloudWatch.</p>",
|
||||
"WorkGroupConfigurationUpdates$RemoveBytesScannedCutoffPerQuery": "<p>Indicates that the data usage control limit per query is removed. <a>WorkGroupConfiguration$BytesScannedCutoffPerQuery</a> </p>"
|
||||
}
|
||||
},
|
||||
"BytesScannedCutoffValue": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"WorkGroupConfiguration$BytesScannedCutoffPerQuery": "<p>The upper data usage limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.</p>",
|
||||
"WorkGroupConfigurationUpdates$BytesScannedCutoffPerQuery": "<p>The upper limit (cutoff) for the amount of bytes a single query in a workgroup is allowed to scan.</p>"
|
||||
}
|
||||
},
|
||||
"ColumnInfo": {
|
||||
"base": "<p>Information about the columns in a query execution result.</p>",
|
||||
"refs": {
|
||||
@@ -50,7 +87,7 @@
|
||||
"ColumnInfoList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ResultSetMetadata$ColumnInfo": "<p>Information about the columns in a query execution result.</p>"
|
||||
"ResultSetMetadata$ColumnInfo": "<p>Information about the columns returned in a query result metadata.</p>"
|
||||
}
|
||||
},
|
||||
"ColumnNullable": {
|
||||
@@ -69,6 +106,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateWorkGroupInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CreateWorkGroupOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DatabaseString": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -81,7 +128,9 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"QueryExecutionStatus$SubmissionDateTime": "<p>The date and time that the query was submitted.</p>",
|
||||
"QueryExecutionStatus$CompletionDateTime": "<p>The date and time that the query completed.</p>"
|
||||
"QueryExecutionStatus$CompletionDateTime": "<p>The date and time that the query completed.</p>",
|
||||
"WorkGroup$CreationTime": "<p>The date and time the workgroup was created.</p>",
|
||||
"WorkGroupSummary$CreationTime": "<p>The workgroup creation date and time.</p>"
|
||||
}
|
||||
},
|
||||
"Datum": {
|
||||
@@ -100,27 +149,38 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteWorkGroupInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DeleteWorkGroupOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescriptionString": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateNamedQueryInput$Description": "<p>A brief explanation of the query.</p>",
|
||||
"NamedQuery$Description": "<p>A brief description of the query.</p>"
|
||||
"CreateNamedQueryInput$Description": "<p>The query description.</p>",
|
||||
"NamedQuery$Description": "<p>The query description.</p>"
|
||||
}
|
||||
},
|
||||
"EncryptionConfiguration": {
|
||||
"base": "<p>If query results are encrypted in Amazon S3, indicates the Amazon S3 encryption option used.</p>",
|
||||
"base": "<p>If query results are encrypted in Amazon S3, indicates the encryption option used (for example, <code>SSE-KMS</code> or <code>CSE-KMS</code>) and key information.</p>",
|
||||
"refs": {
|
||||
"ResultConfiguration$EncryptionConfiguration": "<p>If query results are encrypted in S3, indicates the S3 encryption option used (for example, <code>SSE-KMS</code> or <code>CSE-KMS</code> and key information.</p>"
|
||||
"ResultConfiguration$EncryptionConfiguration": "<p>If query results are encrypted in Amazon S3, indicates the encryption option used (for example, <code>SSE-KMS</code> or <code>CSE-KMS</code>) and key information. This is a client-side setting. If workgroup settings override client-side settings, then the query uses the encryption configuration that is specified for the workgroup, and also uses the location for storing query results specified in the workgroup. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a> and <a href=\"https://docs.aws.amazon.com/athena/latest/ug/workgroups-settings-override.html\">Workgroup Settings Override Client-Side Settings</a>.</p>",
|
||||
"ResultConfigurationUpdates$EncryptionConfiguration": "<p>The encryption configuration for the query results.</p>"
|
||||
}
|
||||
},
|
||||
"EncryptionOption": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"EncryptionConfiguration$EncryptionOption": "<p>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (<code>SSE-S3</code>), server-side encryption with KMS-managed keys (<code>SSE-KMS</code>), or client-side encryption with KMS-managed keys (CSE-KMS) is used.</p>"
|
||||
"EncryptionConfiguration$EncryptionOption": "<p>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (<code>SSE-S3</code>), server-side encryption with KMS-managed keys (<code>SSE-KMS</code>), or client-side encryption with KMS-managed keys (CSE-KMS) is used.</p> <p>If a query runs in a workgroup and the workgroup overrides client-side settings, then the workgroup's setting for encryption is used. It specifies whether query results must be encrypted, for all queries that run in this workgroup. </p>"
|
||||
}
|
||||
},
|
||||
"ErrorCode": {
|
||||
"base": null,
|
||||
"base": "<p>The error code returned when the query execution failed to process, or when the processing request for the named query failed.</p>",
|
||||
"refs": {
|
||||
"InvalidRequestException$AthenaErrorCode": null,
|
||||
"UnprocessedNamedQueryId$ErrorCode": "<p>The error code returned when the processing request for the named query failed, if applicable.</p>",
|
||||
@@ -132,6 +192,7 @@
|
||||
"refs": {
|
||||
"InternalServerException$Message": null,
|
||||
"InvalidRequestException$Message": null,
|
||||
"ResourceNotFoundException$Message": null,
|
||||
"TooManyRequestsException$Message": null,
|
||||
"UnprocessedNamedQueryId$ErrorMessage": "<p>The error message returned when the processing request for the named query failed, if applicable.</p>",
|
||||
"UnprocessedQueryExecutionId$ErrorMessage": "<p>The error message returned when the query execution failed to process, if applicable.</p>"
|
||||
@@ -167,6 +228,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetWorkGroupInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetWorkGroupOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"IdempotencyToken": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -211,9 +282,30 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListTagsForResourceOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListWorkGroupsInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListWorkGroupsOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Long": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetQueryResultsOutput$UpdateCount": "<p>The number of rows inserted with a CREATE TABLE AS SELECT statement. </p>",
|
||||
"QueryExecutionStatistics$EngineExecutionTimeInMillis": "<p>The number of milliseconds that the query took to execute.</p>",
|
||||
"QueryExecutionStatistics$DataScannedInBytes": "<p>The number of bytes in the data that was queried.</p>"
|
||||
}
|
||||
@@ -236,15 +328,27 @@
|
||||
"GetQueryResultsInput$MaxResults": "<p>The maximum number of results (rows) to return in this request.</p>"
|
||||
}
|
||||
},
|
||||
"MaxTagsCount": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListTagsForResourceInput$MaxResults": "<p>The maximum number of results to be returned per request that lists the tags for the workgroup resource.</p>"
|
||||
}
|
||||
},
|
||||
"MaxWorkGroupsCount": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListWorkGroupsInput$MaxResults": "<p>The maximum number of workgroups to return in this request.</p>"
|
||||
}
|
||||
},
|
||||
"NameString": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateNamedQueryInput$Name": "<p>The plain language name for the query.</p>",
|
||||
"NamedQuery$Name": "<p>The plain-language name of the query.</p>"
|
||||
"CreateNamedQueryInput$Name": "<p>The query name.</p>",
|
||||
"NamedQuery$Name": "<p>The query name.</p>"
|
||||
}
|
||||
},
|
||||
"NamedQuery": {
|
||||
"base": "<p>A query, where <code>QueryString</code> is the SQL query statements that comprise the query.</p>",
|
||||
"base": "<p>A query, where <code>QueryString</code> is the list of SQL query statements that comprise the query.</p>",
|
||||
"refs": {
|
||||
"GetNamedQueryOutput$NamedQuery": "<p>Information about the query.</p>",
|
||||
"NamedQueryList$member": null
|
||||
@@ -316,13 +420,13 @@
|
||||
"QueryExecutionState": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"QueryExecutionStatus$State": "<p>The state of query execution. <code>SUBMITTED</code> indicates that the query is queued for execution. <code>RUNNING</code> indicates that the query is scanning data and returning results. <code>SUCCEEDED</code> indicates that the query completed without error. <code>FAILED</code> indicates that the query experienced an error and did not complete processing. <code>CANCELLED</code> indicates that user input interrupted query execution.</p>"
|
||||
"QueryExecutionStatus$State": "<p>The state of query execution. <code>QUEUED</code> state is listed but is not used by Athena and is reserved for future use. <code>RUNNING</code> indicates that the query has been submitted to the service, and Athena will execute the query as soon as resources are available. <code>SUCCEEDED</code> indicates that the query completed without errors. <code>FAILED</code> indicates that the query experienced an error and did not complete processing. <code>CANCELLED</code> indicates that a user input interrupted query execution. </p>"
|
||||
}
|
||||
},
|
||||
"QueryExecutionStatistics": {
|
||||
"base": "<p>The amount of data scanned during the query execution and the amount of time that it took to execute.</p>",
|
||||
"base": "<p>The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run.</p>",
|
||||
"refs": {
|
||||
"QueryExecution$Statistics": "<p>The amount of data scanned during the query execution and the amount of time that it took to execute.</p>"
|
||||
"QueryExecution$Statistics": "<p>The amount of data scanned during the query execution and the amount of time that it took to execute, and the type of statement that was run.</p>"
|
||||
}
|
||||
},
|
||||
"QueryExecutionStatus": {
|
||||
@@ -334,17 +438,29 @@
|
||||
"QueryString": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateNamedQueryInput$QueryString": "<p>The text of the query itself. In other words, all query statements.</p>",
|
||||
"CreateNamedQueryInput$QueryString": "<p>The contents of the query with all query statements.</p>",
|
||||
"NamedQuery$QueryString": "<p>The SQL query statements that comprise the query.</p>",
|
||||
"QueryExecution$Query": "<p>The SQL query statements which the query execution ran.</p>",
|
||||
"StartQueryExecutionInput$QueryString": "<p>The SQL query statements to be executed.</p>"
|
||||
}
|
||||
},
|
||||
"ResultConfiguration": {
|
||||
"base": "<p>The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results.</p>",
|
||||
"ResourceNotFoundException": {
|
||||
"base": "<p>A resource, such as a workgroup, was not found.</p>",
|
||||
"refs": {
|
||||
"QueryExecution$ResultConfiguration": "<p>The location in Amazon S3 where query results were stored and the encryption option, if any, used for query results.</p>",
|
||||
"StartQueryExecutionInput$ResultConfiguration": "<p>Specifies information about where and how to save the results of the query execution.</p>"
|
||||
}
|
||||
},
|
||||
"ResultConfiguration": {
|
||||
"base": "<p>The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.</p>",
|
||||
"refs": {
|
||||
"QueryExecution$ResultConfiguration": "<p>The location in Amazon S3 where query results were stored and the encryption option, if any, used for query results. These are known as \"client-side settings\". If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup.</p>",
|
||||
"StartQueryExecutionInput$ResultConfiguration": "<p>Specifies information about where and how to save the results of the query execution. If the query runs in a workgroup, then workgroup's settings may override query settings. This affects the query results location. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>",
|
||||
"WorkGroupConfiguration$ResultConfiguration": "<p>The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored and the encryption option, if any, used for query results.</p>"
|
||||
}
|
||||
},
|
||||
"ResultConfigurationUpdates": {
|
||||
"base": "<p>The information about the updates in the query results, such as output location and encryption configuration for the query results.</p>",
|
||||
"refs": {
|
||||
"WorkGroupConfigurationUpdates$ResultConfigurationUpdates": "<p>The result configuration information about the queries in this workgroup that will be updated. Includes the updated results location and an updated option for encrypting query results.</p>"
|
||||
}
|
||||
},
|
||||
"ResultSet": {
|
||||
@@ -354,7 +470,7 @@
|
||||
}
|
||||
},
|
||||
"ResultSetMetadata": {
|
||||
"base": "<p>The metadata that describes the column structure and data types of a table of query results.</p>",
|
||||
"base": "<p>The metadata that describes the column structure and data types of a table of query results. </p>",
|
||||
"refs": {
|
||||
"ResultSet$ResultSetMetadata": "<p>The metadata that describes the column structure and data types of a table of query results.</p>"
|
||||
}
|
||||
@@ -381,6 +497,12 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"StatementType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"QueryExecution$StatementType": "<p>The type of query statement that was run. <code>DDL</code> indicates DDL query statements. <code>DML</code> indicates DML (Data Manipulation Language) query statements, such as <code>CREATE TABLE AS SELECT</code>. <code>UTILITY</code> indicates query statements other than DDL and DML, such as <code>SHOW CREATE TABLE</code>, or <code>DESCRIBE <table></code>.</p>"
|
||||
}
|
||||
},
|
||||
"StopQueryExecutionInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -402,11 +524,55 @@
|
||||
"ColumnInfo$Type": "<p>The data type of the column.</p>",
|
||||
"EncryptionConfiguration$KmsKey": "<p>For <code>SSE-KMS</code> and <code>CSE-KMS</code>, this is the KMS key ARN or ID.</p>",
|
||||
"QueryExecutionStatus$StateChangeReason": "<p>Further detail about the status of the query.</p>",
|
||||
"ResultConfiguration$OutputLocation": "<p>The location in S3 where query results are stored.</p>"
|
||||
"ResultConfiguration$OutputLocation": "<p>The location in Amazon S3 where your query results are stored, such as <code>s3://path/to/query/bucket/</code>. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Queries and Query Result Files.</a> If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The \"workgroup settings override\" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>",
|
||||
"ResultConfigurationUpdates$OutputLocation": "<p>The location in Amazon S3 where your query results are stored, such as <code>s3://path/to/query/bucket/</code>. For more information, see <a href=\"https://docs.aws.amazon.com/athena/latest/ug/querying.html\">Queries and Query Result Files.</a> If workgroup settings override client-side settings, then the query uses the location for the query results and the encryption configuration that are specified for the workgroup. The \"workgroup settings override\" is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
|
||||
}
|
||||
},
|
||||
"Tag": {
|
||||
"base": "<p>A tag that you can add to a resource. A tag is a label that you assign to an AWS Athena resource (a workgroup). Each tag consists of a key and an optional value, both of which you define. Tags enable you to categorize workgroups in Athena, for example, by purpose, owner, or environment. Use a consistent set of tag keys to make it easier to search and filter workgroups in your account. The maximum tag key length is 128 Unicode characters in UTF-8. The maximum tag value length is 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys and values are case-sensitive. Tag keys must be unique per resource. </p>",
|
||||
"refs": {
|
||||
"TagList$member": null
|
||||
}
|
||||
},
|
||||
"TagKey": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Tag$Key": "<p>A tag key. The tag key length is from 1 to 128 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag keys are case-sensitive and must be unique per resource. </p>",
|
||||
"TagKeyList$member": null
|
||||
}
|
||||
},
|
||||
"TagKeyList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"UntagResourceInput$TagKeys": "<p>Removes the tags associated with one or more tag keys from the workgroup resource.</p>"
|
||||
}
|
||||
},
|
||||
"TagList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateWorkGroupInput$Tags": "<p>One or more tags, separated by commas, that you want to attach to the workgroup as you create it.</p>",
|
||||
"ListTagsForResourceOutput$Tags": "<p>The list of tags associated with this workgroup.</p>",
|
||||
"TagResourceInput$Tags": "<p>One or more tags, separated by commas, to be added to the resource, such as a workgroup.</p>"
|
||||
}
|
||||
},
|
||||
"TagResourceInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"TagResourceOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"TagValue": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Tag$Value": "<p>A tag value. The tag value length is from 0 to 256 Unicode characters in UTF-8. You can use letters and numbers representable in UTF-8, and the following characters: + - = . _ : / @. Tag values are case-sensitive. </p>"
|
||||
}
|
||||
},
|
||||
"ThrottleReason": {
|
||||
"base": null,
|
||||
"base": "<p>The reason for the query throttling, for example, when it exceeds the concurrent query limit.</p>",
|
||||
"refs": {
|
||||
"TooManyRequestsException$Reason": null
|
||||
}
|
||||
@@ -419,7 +585,11 @@
|
||||
"ListNamedQueriesInput$NextToken": "<p>The token that specifies where to start pagination if a previous request was truncated.</p>",
|
||||
"ListNamedQueriesOutput$NextToken": "<p>A token to be used by the next request if this request is truncated.</p>",
|
||||
"ListQueryExecutionsInput$NextToken": "<p>The token that specifies where to start pagination if a previous request was truncated.</p>",
|
||||
"ListQueryExecutionsOutput$NextToken": "<p>A token to be used by the next request if this request is truncated.</p>"
|
||||
"ListQueryExecutionsOutput$NextToken": "<p>A token to be used by the next request if this request is truncated.</p>",
|
||||
"ListTagsForResourceInput$NextToken": "<p>The token for the next set of results, or null if there are no additional results for this request, where the request lists the tags for the workgroup resource with the specified ARN.</p>",
|
||||
"ListTagsForResourceOutput$NextToken": "<p>A token to be used by the next request if this request is truncated.</p>",
|
||||
"ListWorkGroupsInput$NextToken": "<p>A token to be used by the next request if this request is truncated.</p>",
|
||||
"ListWorkGroupsOutput$NextToken": "<p>A token to be used by the next request if this request is truncated.</p>"
|
||||
}
|
||||
},
|
||||
"TooManyRequestsException": {
|
||||
@@ -451,6 +621,91 @@
|
||||
"BatchGetQueryExecutionOutput$UnprocessedQueryExecutionIds": "<p>Information about the query executions that failed to run.</p>"
|
||||
}
|
||||
},
|
||||
"UntagResourceInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UntagResourceOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateWorkGroupInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateWorkGroupOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"WorkGroup": {
|
||||
"base": "<p>A workgroup, which contains a name, description, creation time, state, and other configuration, listed under <a>WorkGroup$Configuration</a>. Each workgroup enables you to isolate queries for you or your group of users from other queries in the same account, to configure the query results location and the encryption configuration (known as workgroup settings), to enable sending query metrics to Amazon CloudWatch, and to establish per-query data usage control limits for all queries in a workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>",
|
||||
"refs": {
|
||||
"GetWorkGroupOutput$WorkGroup": "<p>Information about the workgroup.</p>"
|
||||
}
|
||||
},
|
||||
"WorkGroupConfiguration": {
|
||||
"base": "<p>The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query settings, and the data usage limit for the amount of data scanned per query, if it is specified. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>",
|
||||
"refs": {
|
||||
"CreateWorkGroupInput$Configuration": "<p>The configuration for the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for encrypting query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, the limit for the amount of bytes scanned (cutoff) per query, if it is specified, and whether workgroup's settings (specified with EnforceWorkGroupConfiguration) in the WorkGroupConfiguration override client-side settings. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>",
|
||||
"WorkGroup$Configuration": "<p>The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption configuration, if any, used for query results; whether the Amazon CloudWatch Metrics are enabled for the workgroup; whether workgroup settings override client-side settings; and the data usage limit for the amount of data scanned per query, if it is specified. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>.</p>"
|
||||
}
|
||||
},
|
||||
"WorkGroupConfigurationUpdates": {
|
||||
"base": "<p>The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.</p>",
|
||||
"refs": {
|
||||
"UpdateWorkGroupInput$ConfigurationUpdates": "<p>The workgroup configuration that will be updated for the given workgroup.</p>"
|
||||
}
|
||||
},
|
||||
"WorkGroupDescriptionString": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateWorkGroupInput$Description": "<p>The workgroup description.</p>",
|
||||
"UpdateWorkGroupInput$Description": "<p>The workgroup description.</p>",
|
||||
"WorkGroup$Description": "<p>The workgroup description.</p>",
|
||||
"WorkGroupSummary$Description": "<p>The workgroup description.</p>"
|
||||
}
|
||||
},
|
||||
"WorkGroupName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateNamedQueryInput$WorkGroup": "<p>The name of the workgroup in which the named query is being created.</p>",
|
||||
"CreateWorkGroupInput$Name": "<p>The workgroup name.</p>",
|
||||
"DeleteWorkGroupInput$WorkGroup": "<p>The unique name of the workgroup to delete.</p>",
|
||||
"GetWorkGroupInput$WorkGroup": "<p>The name of the workgroup.</p>",
|
||||
"ListNamedQueriesInput$WorkGroup": "<p>The name of the workgroup from which the named queries are being returned.</p>",
|
||||
"ListQueryExecutionsInput$WorkGroup": "<p>The name of the workgroup from which queries are being returned.</p>",
|
||||
"NamedQuery$WorkGroup": "<p>The name of the workgroup that contains the named query.</p>",
|
||||
"QueryExecution$WorkGroup": "<p>The name of the workgroup in which the query ran.</p>",
|
||||
"StartQueryExecutionInput$WorkGroup": "<p>The name of the workgroup in which the query is being started.</p>",
|
||||
"UpdateWorkGroupInput$WorkGroup": "<p>The specified workgroup that will be updated.</p>",
|
||||
"WorkGroup$Name": "<p>The workgroup name.</p>",
|
||||
"WorkGroupSummary$Name": "<p>The name of the workgroup.</p>"
|
||||
}
|
||||
},
|
||||
"WorkGroupState": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"UpdateWorkGroupInput$State": "<p>The workgroup state that will be updated for the given workgroup.</p>",
|
||||
"WorkGroup$State": "<p>The state of the workgroup: ENABLED or DISABLED.</p>",
|
||||
"WorkGroupSummary$State": "<p>The state of the workgroup.</p>"
|
||||
}
|
||||
},
|
||||
"WorkGroupSummary": {
|
||||
"base": "<p>The summary information for the workgroup, which includes its name, state, description, and the date and time it was created.</p>",
|
||||
"refs": {
|
||||
"WorkGroupsList$member": null
|
||||
}
|
||||
},
|
||||
"WorkGroupsList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ListWorkGroupsOutput$WorkGroups": "<p>The list of workgroups, including their names, descriptions, creation times, and states.</p>"
|
||||
}
|
||||
},
|
||||
"datumList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
|
||||
+5
@@ -14,6 +14,11 @@
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListWorkGroups": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+11
@@ -0,0 +1,11 @@
|
||||
{
|
||||
"version": 1,
|
||||
"defaultRegion": "us-west-2",
|
||||
"testCases": [
|
||||
{
|
||||
"operationName": "ListNamedQueries",
|
||||
"input": {},
|
||||
"errorExpectedFromService": false
|
||||
}
|
||||
]
|
||||
}
|
||||
Generated
Vendored
+198
-4
@@ -72,13 +72,42 @@
|
||||
{"shape":"ConcurrentUpdateException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
]
|
||||
},
|
||||
"GetScalingPlanResourceForecastData":{
|
||||
"name":"GetScalingPlanResourceForecastData",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetScalingPlanResourceForecastDataRequest"},
|
||||
"output":{"shape":"GetScalingPlanResourceForecastDataResponse"},
|
||||
"errors":[
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
]
|
||||
},
|
||||
"UpdateScalingPlan":{
|
||||
"name":"UpdateScalingPlan",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateScalingPlanRequest"},
|
||||
"output":{"shape":"UpdateScalingPlanResponse"},
|
||||
"errors":[
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ConcurrentUpdateException"},
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"ObjectNotFoundException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"ApplicationSource":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CloudFormationStackARN":{"shape":"XmlString"}
|
||||
"CloudFormationStackARN":{"shape":"XmlString"},
|
||||
"TagFilters":{"shape":"TagFilters"}
|
||||
}
|
||||
},
|
||||
"ApplicationSources":{
|
||||
@@ -113,6 +142,21 @@
|
||||
"ScalingPlanVersion":{"shape":"ScalingPlanVersion"}
|
||||
}
|
||||
},
|
||||
"CustomizedLoadMetricSpecification":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"MetricName",
|
||||
"Namespace",
|
||||
"Statistic"
|
||||
],
|
||||
"members":{
|
||||
"MetricName":{"shape":"MetricName"},
|
||||
"Namespace":{"shape":"MetricNamespace"},
|
||||
"Dimensions":{"shape":"MetricDimensions"},
|
||||
"Statistic":{"shape":"MetricStatistic"},
|
||||
"Unit":{"shape":"MetricUnit"}
|
||||
}
|
||||
},
|
||||
"CustomizedScalingMetricSpecification":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -128,6 +172,17 @@
|
||||
"Unit":{"shape":"MetricUnit"}
|
||||
}
|
||||
},
|
||||
"Datapoint":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Timestamp":{"shape":"TimestampType"},
|
||||
"Value":{"shape":"MetricScale"}
|
||||
}
|
||||
},
|
||||
"Datapoints":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Datapoint"}
|
||||
},
|
||||
"DeleteScalingPlanRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -181,8 +236,48 @@
|
||||
"NextToken":{"shape":"NextToken"}
|
||||
}
|
||||
},
|
||||
"DisableDynamicScaling":{"type":"boolean"},
|
||||
"DisableScaleIn":{"type":"boolean"},
|
||||
"ErrorMessage":{"type":"string"},
|
||||
"ForecastDataType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"CapacityForecast",
|
||||
"LoadForecast",
|
||||
"ScheduledActionMinCapacity",
|
||||
"ScheduledActionMaxCapacity"
|
||||
]
|
||||
},
|
||||
"GetScalingPlanResourceForecastDataRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ScalingPlanName",
|
||||
"ScalingPlanVersion",
|
||||
"ServiceNamespace",
|
||||
"ResourceId",
|
||||
"ScalableDimension",
|
||||
"ForecastDataType",
|
||||
"StartTime",
|
||||
"EndTime"
|
||||
],
|
||||
"members":{
|
||||
"ScalingPlanName":{"shape":"ScalingPlanName"},
|
||||
"ScalingPlanVersion":{"shape":"ScalingPlanVersion"},
|
||||
"ServiceNamespace":{"shape":"ServiceNamespace"},
|
||||
"ResourceId":{"shape":"XmlString"},
|
||||
"ScalableDimension":{"shape":"ScalableDimension"},
|
||||
"ForecastDataType":{"shape":"ForecastDataType"},
|
||||
"StartTime":{"shape":"TimestampType"},
|
||||
"EndTime":{"shape":"TimestampType"}
|
||||
}
|
||||
},
|
||||
"GetScalingPlanResourceForecastDataResponse":{
|
||||
"type":"structure",
|
||||
"required":["Datapoints"],
|
||||
"members":{
|
||||
"Datapoints":{"shape":"Datapoints"}
|
||||
}
|
||||
},
|
||||
"InternalServiceException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -204,6 +299,15 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"LoadMetricType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ASGTotalCPUUtilization",
|
||||
"ASGTotalNetworkIn",
|
||||
"ASGTotalNetworkOut",
|
||||
"ALBTargetGroupRequestCount"
|
||||
]
|
||||
},
|
||||
"MaxResults":{"type":"integer"},
|
||||
"MetricDimension":{
|
||||
"type":"structure",
|
||||
@@ -254,6 +358,14 @@
|
||||
"type":"string",
|
||||
"enum":["TargetTrackingScaling"]
|
||||
},
|
||||
"PredefinedLoadMetricSpecification":{
|
||||
"type":"structure",
|
||||
"required":["PredefinedLoadMetricType"],
|
||||
"members":{
|
||||
"PredefinedLoadMetricType":{"shape":"LoadMetricType"},
|
||||
"ResourceLabel":{"shape":"ResourceLabel"}
|
||||
}
|
||||
},
|
||||
"PredefinedScalingMetricSpecification":{
|
||||
"type":"structure",
|
||||
"required":["PredefinedScalingMetricType"],
|
||||
@@ -262,6 +374,21 @@
|
||||
"ResourceLabel":{"shape":"ResourceLabel"}
|
||||
}
|
||||
},
|
||||
"PredictiveScalingMaxCapacityBehavior":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"SetForecastCapacityToMaxCapacity",
|
||||
"SetMaxCapacityToForecastCapacity",
|
||||
"SetMaxCapacityAboveForecastCapacity"
|
||||
]
|
||||
},
|
||||
"PredictiveScalingMode":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ForecastAndScale",
|
||||
"ForecastOnly"
|
||||
]
|
||||
},
|
||||
"ResourceCapacity":{"type":"integer"},
|
||||
"ResourceIdMaxLen1600":{
|
||||
"type":"string",
|
||||
@@ -303,7 +430,15 @@
|
||||
"ScalableDimension":{"shape":"ScalableDimension"},
|
||||
"MinCapacity":{"shape":"ResourceCapacity"},
|
||||
"MaxCapacity":{"shape":"ResourceCapacity"},
|
||||
"TargetTrackingConfigurations":{"shape":"TargetTrackingConfigurations"}
|
||||
"TargetTrackingConfigurations":{"shape":"TargetTrackingConfigurations"},
|
||||
"PredefinedLoadMetricSpecification":{"shape":"PredefinedLoadMetricSpecification"},
|
||||
"CustomizedLoadMetricSpecification":{"shape":"CustomizedLoadMetricSpecification"},
|
||||
"ScheduledActionBufferTime":{"shape":"ScheduledActionBufferTime"},
|
||||
"PredictiveScalingMaxCapacityBehavior":{"shape":"PredictiveScalingMaxCapacityBehavior"},
|
||||
"PredictiveScalingMaxCapacityBuffer":{"shape":"ResourceCapacity"},
|
||||
"PredictiveScalingMode":{"shape":"PredictiveScalingMode"},
|
||||
"ScalingPolicyUpdateBehavior":{"shape":"ScalingPolicyUpdateBehavior"},
|
||||
"DisableDynamicScaling":{"shape":"DisableDynamicScaling"}
|
||||
}
|
||||
},
|
||||
"ScalingInstructions":{
|
||||
@@ -344,6 +479,7 @@
|
||||
"ScalingInstructions":{"shape":"ScalingInstructions"},
|
||||
"StatusCode":{"shape":"ScalingPlanStatusCode"},
|
||||
"StatusMessage":{"shape":"XmlString"},
|
||||
"StatusStartTime":{"shape":"TimestampType"},
|
||||
"CreationTime":{"shape":"TimestampType"}
|
||||
}
|
||||
},
|
||||
@@ -351,7 +487,7 @@
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":1,
|
||||
"pattern":"[\\p{Print}&&[^|]]+"
|
||||
"pattern":"[\\p{Print}&&[^|:/]]+"
|
||||
},
|
||||
"ScalingPlanNames":{
|
||||
"type":"list",
|
||||
@@ -390,7 +526,9 @@
|
||||
"CreationInProgress",
|
||||
"CreationFailed",
|
||||
"DeletionInProgress",
|
||||
"DeletionFailed"
|
||||
"DeletionFailed",
|
||||
"UpdateInProgress",
|
||||
"UpdateFailed"
|
||||
]
|
||||
},
|
||||
"ScalingPlanVersion":{"type":"long"},
|
||||
@@ -414,6 +552,13 @@
|
||||
"TargetTrackingConfiguration":{"shape":"TargetTrackingConfiguration"}
|
||||
}
|
||||
},
|
||||
"ScalingPolicyUpdateBehavior":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"KeepExternalPolicies",
|
||||
"ReplaceExternalPolicies"
|
||||
]
|
||||
},
|
||||
"ScalingStatusCode":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
@@ -422,6 +567,10 @@
|
||||
"Active"
|
||||
]
|
||||
},
|
||||
"ScheduledActionBufferTime":{
|
||||
"type":"integer",
|
||||
"min":0
|
||||
},
|
||||
"ServiceNamespace":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
@@ -432,6 +581,21 @@
|
||||
"dynamodb"
|
||||
]
|
||||
},
|
||||
"TagFilter":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Key":{"shape":"XmlStringMaxLen128"},
|
||||
"Values":{"shape":"TagValues"}
|
||||
}
|
||||
},
|
||||
"TagFilters":{
|
||||
"type":"list",
|
||||
"member":{"shape":"TagFilter"}
|
||||
},
|
||||
"TagValues":{
|
||||
"type":"list",
|
||||
"member":{"shape":"XmlStringMaxLen256"}
|
||||
},
|
||||
"TargetTrackingConfiguration":{
|
||||
"type":"structure",
|
||||
"required":["TargetValue"],
|
||||
@@ -450,6 +614,24 @@
|
||||
"member":{"shape":"TargetTrackingConfiguration"}
|
||||
},
|
||||
"TimestampType":{"type":"timestamp"},
|
||||
"UpdateScalingPlanRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ScalingPlanName",
|
||||
"ScalingPlanVersion"
|
||||
],
|
||||
"members":{
|
||||
"ScalingPlanName":{"shape":"ScalingPlanName"},
|
||||
"ScalingPlanVersion":{"shape":"ScalingPlanVersion"},
|
||||
"ApplicationSource":{"shape":"ApplicationSource"},
|
||||
"ScalingInstructions":{"shape":"ScalingInstructions"}
|
||||
}
|
||||
},
|
||||
"UpdateScalingPlanResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"ValidationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -460,6 +642,18 @@
|
||||
"XmlString":{
|
||||
"type":"string",
|
||||
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
|
||||
},
|
||||
"XmlStringMaxLen128":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":1,
|
||||
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
|
||||
},
|
||||
"XmlStringMaxLen256":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":1,
|
||||
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Generated
Vendored
+182
-43
@@ -1,19 +1,22 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<p>Use AWS Auto Scaling to quickly discover all the scalable AWS resources for your application and configure dynamic scaling for your scalable resources.</p> <p>To get started, create a scaling plan with a set of instructions used to configure dynamic scaling for the scalable resources in your application. AWS Auto Scaling creates target tracking scaling policies for the scalable resources in your scaling plan. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified.</p>",
|
||||
"service": "<fullname>AWS Auto Scaling</fullname> <p>Use AWS Auto Scaling to quickly discover all the scalable AWS resources for your application and configure dynamic scaling and predictive scaling for your resources using scaling plans. Use this service in conjunction with the Amazon EC2 Auto Scaling, Application Auto Scaling, Amazon CloudWatch, and AWS CloudFormation services. </p> <p>Currently, predictive scaling is only available for Amazon EC2 Auto Scaling groups.</p> <p>For more information about AWS Auto Scaling, including information about granting IAM users required permissions for AWS Auto Scaling actions, see the <a href=\"https://docs.aws.amazon.com/autoscaling/plans/userguide/what-is-aws-auto-scaling.html\">AWS Auto Scaling User Guide</a>.</p>",
|
||||
"operations": {
|
||||
"CreateScalingPlan": "<p>Creates a scaling plan.</p> <p>A scaling plan contains a set of instructions used to configure dynamic scaling for the scalable resources in your application. AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions in your scaling plan.</p>",
|
||||
"DeleteScalingPlan": "<p>Deletes the specified scaling plan.</p>",
|
||||
"CreateScalingPlan": "<p>Creates a scaling plan.</p>",
|
||||
"DeleteScalingPlan": "<p>Deletes the specified scaling plan.</p> <p>Deleting a scaling plan deletes the underlying <a>ScalingInstruction</a> for all of the scalable resources that are covered by the plan.</p> <p>If the plan has launched resources or has scaling activities in progress, you must delete those resources separately.</p>",
|
||||
"DescribeScalingPlanResources": "<p>Describes the scalable resources in the specified scaling plan.</p>",
|
||||
"DescribeScalingPlans": "<p>Describes the specified scaling plans or all of your scaling plans.</p>"
|
||||
"DescribeScalingPlans": "<p>Describes one or more of your scaling plans.</p>",
|
||||
"GetScalingPlanResourceForecastData": "<p>Retrieves the forecast data for a scalable resource.</p> <p>Capacity forecasts are represented as predicted values, or data points, that are calculated using historical data points from a specified CloudWatch load metric. Data points are available for up to 56 days. </p>",
|
||||
"UpdateScalingPlan": "<p>Updates the specified scaling plan.</p> <p>You cannot update a scaling plan if it is in the process of being created, updated, or deleted.</p>"
|
||||
},
|
||||
"shapes": {
|
||||
"ApplicationSource": {
|
||||
"base": "<p>Represents an application source.</p>",
|
||||
"refs": {
|
||||
"ApplicationSources$member": null,
|
||||
"CreateScalingPlanRequest$ApplicationSource": "<p>The source for the application.</p>",
|
||||
"ScalingPlan$ApplicationSource": "<p>The application source.</p>"
|
||||
"CreateScalingPlanRequest$ApplicationSource": "<p>A CloudFormation stack or set of tags. You can create one scaling plan per application source.</p>",
|
||||
"ScalingPlan$ApplicationSource": "<p>The application source.</p>",
|
||||
"UpdateScalingPlanRequest$ApplicationSource": "<p>A CloudFormation stack or set of tags.</p>"
|
||||
}
|
||||
},
|
||||
"ApplicationSources": {
|
||||
@@ -30,8 +33,8 @@
|
||||
"Cooldown": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"TargetTrackingConfiguration$ScaleOutCooldown": "<p>The amount of time, in seconds, after a scale out activity completes before another scale out activity can start. This value is not used if the scalable resource is an Auto Scaling group.</p> <p>While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.</p>",
|
||||
"TargetTrackingConfiguration$ScaleInCooldown": "<p>The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group.</p> <p>The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, AWS Auto Scaling scales out your scalable target immediately.</p>",
|
||||
"TargetTrackingConfiguration$ScaleOutCooldown": "<p>The amount of time, in seconds, after a scale-out activity completes before another scale-out activity can start. This value is not used if the scalable resource is an Auto Scaling group.</p> <p>While the cooldown period is in effect, the capacity that has been added by the previous scale-out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.</p>",
|
||||
"TargetTrackingConfiguration$ScaleInCooldown": "<p>The amount of time, in seconds, after a scale in activity completes before another scale in activity can start. This value is not used if the scalable resource is an Auto Scaling group.</p> <p>The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale-out policy during the cooldown period after a scale-in, AWS Auto Scaling scales out your scalable target immediately.</p>",
|
||||
"TargetTrackingConfiguration$EstimatedInstanceWarmup": "<p>The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. This value is used only if the resource is an Auto Scaling group.</p>"
|
||||
}
|
||||
},
|
||||
@@ -45,10 +48,28 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"CustomizedScalingMetricSpecification": {
|
||||
"base": "<p>Represents a customized metric for a target tracking policy.</p>",
|
||||
"CustomizedLoadMetricSpecification": {
|
||||
"base": "<p>Represents a CloudWatch metric of your choosing that can be used for predictive scaling. </p> <p>For predictive scaling to work with a customized load metric specification, AWS Auto Scaling needs access to the <code>Sum</code> and <code>Average</code> statistics that CloudWatch computes from metric data. Statistics are calculations used to aggregate data over specified time periods.</p> <p>When you choose a load metric, make sure that the required <code>Sum</code> and <code>Average</code> statistics for your metric are available in CloudWatch and that they provide relevant data for predictive scaling. The <code>Sum</code> statistic must represent the total load on the resource, and the <code>Average</code> statistic must represent the average load per capacity unit of the resource. For example, there is a metric that counts the number of requests processed by your Auto Scaling group. If the <code>Sum</code> statistic represents the total request count processed by the group, then the <code>Average</code> statistic for the specified metric must represent the average request count processed by each instance of the group.</p> <p>For information about terminology, available metrics, or how to publish new metrics, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html\">Amazon CloudWatch Concepts</a> in the <i>Amazon CloudWatch User Guide</i>. </p>",
|
||||
"refs": {
|
||||
"TargetTrackingConfiguration$CustomizedScalingMetricSpecification": "<p>A customized metric.</p>"
|
||||
"ScalingInstruction$CustomizedLoadMetricSpecification": "<p>The customized load metric to use for predictive scaling. This parameter or a <b>PredefinedLoadMetricSpecification</b> is required when configuring predictive scaling, and cannot be used otherwise. </p>"
|
||||
}
|
||||
},
|
||||
"CustomizedScalingMetricSpecification": {
|
||||
"base": "<p>Represents a CloudWatch metric of your choosing that can be used for dynamic scaling as part of a target tracking scaling policy. </p> <p>To create your customized scaling metric specification:</p> <ul> <li> <p>Add values for each required parameter from CloudWatch. You can use an existing metric, or a new metric that you create. To use your own metric, you must first publish the metric to CloudWatch. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html\">Publish Custom Metrics</a> in the <i>Amazon CloudWatch User Guide</i>.</p> </li> <li> <p>Choose a metric that changes proportionally with capacity. The value of the metric should increase or decrease in inverse proportion to the number of capacity units. That is, the value of the metric should decrease when capacity increases. </p> </li> </ul> <p>For more information about CloudWatch, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html\">Amazon CloudWatch Concepts</a>. </p>",
|
||||
"refs": {
|
||||
"TargetTrackingConfiguration$CustomizedScalingMetricSpecification": "<p>A customized metric. You can specify either a predefined metric or a customized metric. </p>"
|
||||
}
|
||||
},
|
||||
"Datapoint": {
|
||||
"base": "<p>Represents a single value in the forecast data used for predictive scaling.</p>",
|
||||
"refs": {
|
||||
"Datapoints$member": null
|
||||
}
|
||||
},
|
||||
"Datapoints": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetScalingPlanResourceForecastDataResponse$Datapoints": "<p>The data points to return.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteScalingPlanRequest": {
|
||||
@@ -81,10 +102,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DisableDynamicScaling": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ScalingInstruction$DisableDynamicScaling": "<p>Controls whether dynamic scaling by AWS Auto Scaling is disabled. When dynamic scaling is enabled, AWS Auto Scaling creates target tracking scaling policies based on the specified target tracking configurations. </p> <p>The default is enabled (<code>false</code>). </p>"
|
||||
}
|
||||
},
|
||||
"DisableScaleIn": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"TargetTrackingConfiguration$DisableScaleIn": "<p>Indicates whether scale in by the target tracking policy is disabled. If the value is <code>true</code>, scale in is disabled and the target tracking policy won't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the scalable resource. The default value is <code>false</code>.</p>"
|
||||
"TargetTrackingConfiguration$DisableScaleIn": "<p>Indicates whether scale in by the target tracking scaling policy is disabled. If the value is <code>true</code>, scale in is disabled and the target tracking scaling policy doesn't remove capacity from the scalable resource. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable resource. </p> <p>The default value is <code>false</code>.</p>"
|
||||
}
|
||||
},
|
||||
"ErrorMessage": {
|
||||
@@ -98,6 +125,22 @@
|
||||
"ValidationException$Message": null
|
||||
}
|
||||
},
|
||||
"ForecastDataType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetScalingPlanResourceForecastDataRequest$ForecastDataType": "<p>The type of forecast data to get.</p> <ul> <li> <p> <code>LoadForecast</code>: The load metric forecast. </p> </li> <li> <p> <code>CapacityForecast</code>: The capacity forecast. </p> </li> <li> <p> <code>ScheduledActionMinCapacity</code>: The minimum capacity for each scheduled scaling action. This data is calculated as the larger of two values: the capacity forecast or the minimum capacity in the scaling instruction.</p> </li> <li> <p> <code>ScheduledActionMaxCapacity</code>: The maximum capacity for each scheduled scaling action. The calculation used is determined by the predictive scaling maximum capacity behavior setting in the scaling instruction.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"GetScalingPlanResourceForecastDataRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetScalingPlanResourceForecastDataResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"InternalServiceException": {
|
||||
"base": "<p>The service encountered an internal error.</p>",
|
||||
"refs": {
|
||||
@@ -113,10 +156,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"LoadMetricType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PredefinedLoadMetricSpecification$PredefinedLoadMetricType": "<p>The metric type.</p>"
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeScalingPlanResourcesRequest$MaxResults": "<p>The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.</p>",
|
||||
"DescribeScalingPlanResourcesRequest$MaxResults": "<p>The maximum number of scalable resources to return. The value must be between 1 and 50. The default value is 50.</p>",
|
||||
"DescribeScalingPlansRequest$MaxResults": "<p>The maximum number of scalable resources to return. This value can be between 1 and 50. The default value is 50.</p>"
|
||||
}
|
||||
},
|
||||
@@ -141,37 +190,43 @@
|
||||
"MetricDimensions": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CustomizedScalingMetricSpecification$Dimensions": "<p>The dimensions of the metric.</p>"
|
||||
"CustomizedLoadMetricSpecification$Dimensions": "<p>The dimensions of the metric.</p> <p>Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized load metric specification.</p>",
|
||||
"CustomizedScalingMetricSpecification$Dimensions": "<p>The dimensions of the metric.</p> <p>Conditional: If you published your metric with dimensions, you must specify the same dimensions in your customized scaling metric specification.</p>"
|
||||
}
|
||||
},
|
||||
"MetricName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CustomizedLoadMetricSpecification$MetricName": "<p>The name of the metric.</p>",
|
||||
"CustomizedScalingMetricSpecification$MetricName": "<p>The name of the metric.</p>"
|
||||
}
|
||||
},
|
||||
"MetricNamespace": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CustomizedLoadMetricSpecification$Namespace": "<p>The namespace of the metric.</p>",
|
||||
"CustomizedScalingMetricSpecification$Namespace": "<p>The namespace of the metric.</p>"
|
||||
}
|
||||
},
|
||||
"MetricScale": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Datapoint$Value": "<p>The value of the data point.</p>",
|
||||
"TargetTrackingConfiguration$TargetValue": "<p>The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).</p>"
|
||||
}
|
||||
},
|
||||
"MetricStatistic": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CustomizedLoadMetricSpecification$Statistic": "<p>The statistic of the metric. Currently, the value must always be <code>Sum</code>. </p>",
|
||||
"CustomizedScalingMetricSpecification$Statistic": "<p>The statistic of the metric.</p>"
|
||||
}
|
||||
},
|
||||
"MetricUnit": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CustomizedScalingMetricSpecification$Unit": "<p>The unit of the metric.</p>"
|
||||
"CustomizedLoadMetricSpecification$Unit": "<p>The unit of the metric.</p>",
|
||||
"CustomizedScalingMetricSpecification$Unit": "<p>The unit of the metric. </p>"
|
||||
}
|
||||
},
|
||||
"NextToken": {
|
||||
@@ -200,41 +255,62 @@
|
||||
"ScalingPolicy$PolicyType": "<p>The type of scaling policy.</p>"
|
||||
}
|
||||
},
|
||||
"PredefinedScalingMetricSpecification": {
|
||||
"base": "<p>Represents a predefined metric for a target tracking policy.</p>",
|
||||
"PredefinedLoadMetricSpecification": {
|
||||
"base": "<p>Represents a predefined metric that can be used for predictive scaling. </p>",
|
||||
"refs": {
|
||||
"TargetTrackingConfiguration$PredefinedScalingMetricSpecification": "<p>A predefined metric.</p>"
|
||||
"ScalingInstruction$PredefinedLoadMetricSpecification": "<p>The predefined load metric to use for predictive scaling. This parameter or a <b>CustomizedLoadMetricSpecification</b> is required when configuring predictive scaling, and cannot be used otherwise. </p>"
|
||||
}
|
||||
},
|
||||
"PredefinedScalingMetricSpecification": {
|
||||
"base": "<p>Represents a predefined metric that can be used for dynamic scaling as part of a target tracking scaling policy.</p>",
|
||||
"refs": {
|
||||
"TargetTrackingConfiguration$PredefinedScalingMetricSpecification": "<p>A predefined metric. You can specify either a predefined metric or a customized metric.</p>"
|
||||
}
|
||||
},
|
||||
"PredictiveScalingMaxCapacityBehavior": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ScalingInstruction$PredictiveScalingMaxCapacityBehavior": "<p>Defines the behavior that should be applied if the forecast capacity approaches or exceeds the maximum capacity specified for the resource. The default value is <code>SetForecastCapacityToMaxCapacity</code>.</p> <p>The following are possible values:</p> <ul> <li> <p> <code>SetForecastCapacityToMaxCapacity</code> - AWS Auto Scaling cannot scale resource capacity higher than the maximum capacity. The maximum capacity is enforced as a hard limit. </p> </li> <li> <p> <code>SetMaxCapacityToForecastCapacity</code> - AWS Auto Scaling may scale resource capacity higher than the maximum capacity to equal but not exceed forecast capacity.</p> </li> <li> <p> <code>SetMaxCapacityAboveForecastCapacity</code> - AWS Auto Scaling may scale resource capacity higher than the maximum capacity by a specified buffer value. The intention is to give the target tracking scaling policy extra capacity if unexpected traffic occurs. </p> </li> </ul> <p>Only valid when configuring predictive scaling.</p>"
|
||||
}
|
||||
},
|
||||
"PredictiveScalingMode": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ScalingInstruction$PredictiveScalingMode": "<p>The predictive scaling mode. The default value is <code>ForecastAndScale</code>. Otherwise, AWS Auto Scaling forecasts capacity but does not create any scheduled scaling actions based on the capacity forecast. </p>"
|
||||
}
|
||||
},
|
||||
"ResourceCapacity": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ScalingInstruction$MinCapacity": "<p>The minimum value to scale to in response to a scale in event.</p>",
|
||||
"ScalingInstruction$MaxCapacity": "<p>The maximum value to scale to in response to a scale out event.</p>"
|
||||
"ScalingInstruction$MinCapacity": "<p>The minimum capacity of the resource. </p>",
|
||||
"ScalingInstruction$MaxCapacity": "<p>The maximum capacity of the resource. The exception to this upper limit is if you specify a non-default setting for <b>PredictiveScalingMaxCapacityBehavior</b>. </p>",
|
||||
"ScalingInstruction$PredictiveScalingMaxCapacityBuffer": "<p>The size of the capacity buffer to use when the forecast capacity is close to or exceeds the maximum capacity. The value is specified as a percentage relative to the forecast capacity. For example, if the buffer is 10, this means a 10 percent buffer, such that if the forecast capacity is 50, and the maximum capacity is 40, then the effective maximum capacity is 55.</p> <p>Only valid when configuring predictive scaling. Required if the <b>PredictiveScalingMaxCapacityBehavior</b> is set to <code>SetMaxCapacityAboveForecastCapacity</code>, and cannot be used otherwise.</p> <p>The range is 1-100.</p>"
|
||||
}
|
||||
},
|
||||
"ResourceIdMaxLen1600": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ScalingInstruction$ResourceId": "<p>The ID of the resource. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>Auto Scaling group - The resource type is <code>autoScalingGroup</code> and the unique identifier is the name of the Auto Scaling group. Example: <code>autoScalingGroup/my-asg</code>.</p> </li> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>",
|
||||
"ScalingPlanResource$ResourceId": "<p>The ID of the resource. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>Auto Scaling group - The resource type is <code>autoScalingGroup</code> and the unique identifier is the name of the Auto Scaling group. Example: <code>autoScalingGroup/my-asg</code>.</p> </li> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>"
|
||||
"ScalingInstruction$ResourceId": "<p>The ID of the resource. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>Auto Scaling group - The resource type is <code>autoScalingGroup</code> and the unique identifier is the name of the Auto Scaling group. Example: <code>autoScalingGroup/my-asg</code>.</p> </li> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>",
|
||||
"ScalingPlanResource$ResourceId": "<p>The ID of the resource. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>Auto Scaling group - The resource type is <code>autoScalingGroup</code> and the unique identifier is the name of the Auto Scaling group. Example: <code>autoScalingGroup/my-asg</code>.</p> </li> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"ResourceLabel": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PredefinedScalingMetricSpecification$ResourceLabel": "<p>Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is <code>ALBRequestCountPerTarget</code> and there is a target group attached to the Auto Scaling group, Spot Fleet request, or ECS service.</p> <p>The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:</p> <ul> <li> <p>app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN</p> </li> <li> <p>targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.</p> </li> </ul>"
|
||||
"PredefinedLoadMetricSpecification$ResourceLabel": "<p>Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is <code>ALBRequestCountPerTarget</code> and there is a target group for an Application Load Balancer attached to the Auto Scaling group.</p> <p>The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:</p> <ul> <li> <p>app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN.</p> </li> <li> <p>targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.</p> </li> </ul>",
|
||||
"PredefinedScalingMetricSpecification$ResourceLabel": "<p>Identifies the resource associated with the metric type. You can't specify a resource label unless the metric type is <code>ALBRequestCountPerTarget</code> and there is a target group for an Application Load Balancer attached to the Auto Scaling group, Spot Fleet request, or ECS service.</p> <p>The format is app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>, where:</p> <ul> <li> <p>app/<load-balancer-name>/<load-balancer-id> is the final portion of the load balancer ARN.</p> </li> <li> <p>targetgroup/<target-group-name>/<target-group-id> is the final portion of the target group ARN.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"ScalableDimension": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ScalingInstruction$ScalableDimension": "<p>The scalable dimension associated with the resource.</p> <ul> <li> <p> <code>autoscaling:autoScalingGroup:DesiredCapacity</code> - The desired capacity of an Auto Scaling group.</p> </li> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>",
|
||||
"ScalingPlanResource$ScalableDimension": "<p>The scalable dimension for the resource.</p> <ul> <li> <p> <code>autoscaling:autoScalingGroup:DesiredCapacity</code> - The desired capacity of an Auto Scaling group.</p> </li> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition.</p> </li> </ul>"
|
||||
"GetScalingPlanResourceForecastDataRequest$ScalableDimension": "<p>The scalable dimension for the resource.</p>",
|
||||
"ScalingInstruction$ScalableDimension": "<p>The scalable dimension associated with the resource.</p> <ul> <li> <p> <code>autoscaling:autoScalingGroup:DesiredCapacity</code> - The desired capacity of an Auto Scaling group.</p> </li> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> </ul>",
|
||||
"ScalingPlanResource$ScalableDimension": "<p>The scalable dimension for the resource.</p> <ul> <li> <p> <code>autoscaling:autoScalingGroup:DesiredCapacity</code> - The desired capacity of an Auto Scaling group.</p> </li> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot Fleet request.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>rds:cluster:ReadReplicaCount</code> - The count of Aurora Replicas in an Aurora DB cluster. Available for Aurora MySQL-compatible edition and Aurora PostgreSQL-compatible edition.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"ScalingInstruction": {
|
||||
"base": "<p>Specifies the scaling configuration for a scalable resource.</p>",
|
||||
"base": "<p>Describes a scaling instruction for a scalable resource.</p> <p>The scaling instruction is used in combination with a scaling plan, which is a set of instructions for configuring dynamic scaling and predictive scaling for the scalable resources in your application. Each scaling instruction applies to one resource.</p> <p>AWS Auto Scaling creates target tracking scaling policies based on the scaling instructions. Target tracking scaling policies adjust the capacity of your scalable resource as required to maintain resource utilization at the target value that you specified. </p> <p>AWS Auto Scaling also configures predictive scaling for your Amazon EC2 Auto Scaling groups using a subset of parameters, including the load metric, the scaling metric, the target value for the scaling metric, the predictive scaling mode (forecast and scale or forecast only), and the desired behavior when the forecast capacity exceeds the maximum capacity of the resource. With predictive scaling, AWS Auto Scaling generates forecasts with traffic predictions for the two days ahead and schedules scaling actions that proactively add and remove resource capacity to match the forecast. </p> <p>We recommend waiting a minimum of 24 hours after creating an Auto Scaling group to configure predictive scaling. At minimum, there must be 24 hours of historical data to generate a forecast.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/plans/userguide/auto-scaling-getting-started.html\">Getting Started with AWS Auto Scaling</a>.</p>",
|
||||
"refs": {
|
||||
"ScalingInstructions$member": null
|
||||
}
|
||||
@@ -243,13 +319,14 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateScalingPlanRequest$ScalingInstructions": "<p>The scaling instructions.</p>",
|
||||
"ScalingPlan$ScalingInstructions": "<p>The scaling instructions.</p>"
|
||||
"ScalingPlan$ScalingInstructions": "<p>The scaling instructions.</p>",
|
||||
"UpdateScalingPlanRequest$ScalingInstructions": "<p>The scaling instructions.</p>"
|
||||
}
|
||||
},
|
||||
"ScalingMetricType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PredefinedScalingMetricSpecification$PredefinedScalingMetricType": "<p>The metric type. The <code>ALBRequestCountPerTarget</code> metric type applies only to Auto Scaling groups, Sport Fleet requests, and ECS services.</p>"
|
||||
"PredefinedScalingMetricSpecification$PredefinedScalingMetricType": "<p>The metric type. The <code>ALBRequestCountPerTarget</code> metric type applies only to Auto Scaling groups, Spot Fleet requests, and ECS services.</p>"
|
||||
}
|
||||
},
|
||||
"ScalingPlan": {
|
||||
@@ -261,12 +338,14 @@
|
||||
"ScalingPlanName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateScalingPlanRequest$ScalingPlanName": "<p>The name of the scaling plan.</p>",
|
||||
"CreateScalingPlanRequest$ScalingPlanName": "<p>The name of the scaling plan. Names cannot contain vertical bars, colons, or forward slashes.</p>",
|
||||
"DeleteScalingPlanRequest$ScalingPlanName": "<p>The name of the scaling plan.</p>",
|
||||
"DescribeScalingPlanResourcesRequest$ScalingPlanName": "<p>The name of the scaling plan.</p>",
|
||||
"GetScalingPlanResourceForecastDataRequest$ScalingPlanName": "<p>The name of the scaling plan.</p>",
|
||||
"ScalingPlan$ScalingPlanName": "<p>The name of the scaling plan.</p>",
|
||||
"ScalingPlanNames$member": null,
|
||||
"ScalingPlanResource$ScalingPlanName": "<p>The name of the scaling plan.</p>"
|
||||
"ScalingPlanResource$ScalingPlanName": "<p>The name of the scaling plan.</p>",
|
||||
"UpdateScalingPlanRequest$ScalingPlanName": "<p>The name of the scaling plan.</p>"
|
||||
}
|
||||
},
|
||||
"ScalingPlanNames": {
|
||||
@@ -290,18 +369,20 @@
|
||||
"ScalingPlanStatusCode": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ScalingPlan$StatusCode": "<p>The status of the scaling plan.</p> <ul> <li> <p> <code>Active</code> - The scaling plan is active.</p> </li> <li> <p> <code>ActiveWithProblems</code> - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.</p> </li> <li> <p> <code>CreationInProgress</code> - The scaling plan is being created.</p> </li> <li> <p> <code>CreationFailed</code> - The scaling plan could not be created.</p> </li> <li> <p> <code>DeletionInProgress</code> - The scaling plan is being deleted.</p> </li> <li> <p> <code>DeletionFailed</code> - The scaling plan could not be deleted.</p> </li> </ul>"
|
||||
"ScalingPlan$StatusCode": "<p>The status of the scaling plan.</p> <ul> <li> <p> <code>Active</code> - The scaling plan is active.</p> </li> <li> <p> <code>ActiveWithProblems</code> - The scaling plan is active, but the scaling configuration for one or more resources could not be applied.</p> </li> <li> <p> <code>CreationInProgress</code> - The scaling plan is being created.</p> </li> <li> <p> <code>CreationFailed</code> - The scaling plan could not be created.</p> </li> <li> <p> <code>DeletionInProgress</code> - The scaling plan is being deleted.</p> </li> <li> <p> <code>DeletionFailed</code> - The scaling plan could not be deleted.</p> </li> <li> <p> <code>UpdateInProgress</code> - The scaling plan is being updated.</p> </li> <li> <p> <code>UpdateFailed</code> - The scaling plan could not be updated.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"ScalingPlanVersion": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateScalingPlanResponse$ScalingPlanVersion": "<p>The version of the scaling plan. This value is always 1.</p>",
|
||||
"DeleteScalingPlanRequest$ScalingPlanVersion": "<p>The version of the scaling plan.</p>",
|
||||
"DescribeScalingPlanResourcesRequest$ScalingPlanVersion": "<p>The version of the scaling plan.</p>",
|
||||
"DescribeScalingPlansRequest$ScalingPlanVersion": "<p>The version of the scaling plan. If you specify a scaling plan version, you must also specify a scaling plan name.</p>",
|
||||
"ScalingPlan$ScalingPlanVersion": "<p>The version of the scaling plan.</p>",
|
||||
"ScalingPlanResource$ScalingPlanVersion": "<p>The version of the scaling plan.</p>"
|
||||
"CreateScalingPlanResponse$ScalingPlanVersion": "<p>The version number of the scaling plan. This value is always 1.</p> <p>Currently, you cannot specify multiple scaling plan versions.</p>",
|
||||
"DeleteScalingPlanRequest$ScalingPlanVersion": "<p>The version number of the scaling plan.</p>",
|
||||
"DescribeScalingPlanResourcesRequest$ScalingPlanVersion": "<p>The version number of the scaling plan.</p>",
|
||||
"DescribeScalingPlansRequest$ScalingPlanVersion": "<p>The version number of the scaling plan. If you specify a scaling plan version, you must also specify a scaling plan name.</p>",
|
||||
"GetScalingPlanResourceForecastDataRequest$ScalingPlanVersion": "<p>The version number of the scaling plan.</p>",
|
||||
"ScalingPlan$ScalingPlanVersion": "<p>The version number of the scaling plan.</p>",
|
||||
"ScalingPlanResource$ScalingPlanVersion": "<p>The version number of the scaling plan.</p>",
|
||||
"UpdateScalingPlanRequest$ScalingPlanVersion": "<p>The version number of the scaling plan.</p>"
|
||||
}
|
||||
},
|
||||
"ScalingPlans": {
|
||||
@@ -322,36 +403,81 @@
|
||||
"ScalingPolicies$member": null
|
||||
}
|
||||
},
|
||||
"ScalingPolicyUpdateBehavior": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ScalingInstruction$ScalingPolicyUpdateBehavior": "<p>Controls whether a resource's externally created scaling policies are kept or replaced. </p> <p>The default value is <code>KeepExternalPolicies</code>. If the parameter is set to <code>ReplaceExternalPolicies</code>, any scaling policies that are external to AWS Auto Scaling are deleted and new target tracking scaling policies created. </p> <p>Only valid when configuring dynamic scaling. </p> <p>Condition: The number of existing policies to be replaced must be less than or equal to 50. If there are more than 50 policies to be replaced, AWS Auto Scaling keeps all existing policies and does not create new ones.</p>"
|
||||
}
|
||||
},
|
||||
"ScalingStatusCode": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ScalingPlanResource$ScalingStatusCode": "<p>The scaling status of the resource.</p> <ul> <li> <p> <code>Active</code> - The scaling configuration is active.</p> </li> <li> <p> <code>Inactive</code> - The scaling configuration is not active because the scaling plan is being created or the scaling configuration could not be applied. Check the status message for more information.</p> </li> <li> <p> <code>PartiallyActive</code> - The scaling configuration is partially active because the scaling plan is being created or deleted or the scaling configuration could not be fully applied. Check the status message for more information.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"ScheduledActionBufferTime": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ScalingInstruction$ScheduledActionBufferTime": "<p>The amount of time, in seconds, to buffer the run time of scheduled scaling actions when scaling out. For example, if the forecast says to add capacity at 10:00 AM, and the buffer time is 5 minutes, then the run time of the corresponding scheduled scaling action will be 9:55 AM. The intention is to give resources time to be provisioned. For example, it can take a few minutes to launch an EC2 instance. The actual amount of time required depends on several factors, such as the size of the instance and whether there are startup scripts to complete. </p> <p>The value must be less than the forecast interval duration of 3600 seconds (60 minutes). The default is 300 seconds. </p> <p>Only valid when configuring predictive scaling. </p>"
|
||||
}
|
||||
},
|
||||
"ServiceNamespace": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetScalingPlanResourceForecastDataRequest$ServiceNamespace": "<p>The namespace of the AWS service.</p>",
|
||||
"ScalingInstruction$ServiceNamespace": "<p>The namespace of the AWS service.</p>",
|
||||
"ScalingPlanResource$ServiceNamespace": "<p>The namespace of the AWS service.</p>"
|
||||
}
|
||||
},
|
||||
"TargetTrackingConfiguration": {
|
||||
"base": "<p>Represents a target tracking scaling policy.</p>",
|
||||
"TagFilter": {
|
||||
"base": "<p>Represents a tag.</p>",
|
||||
"refs": {
|
||||
"ScalingPolicy$TargetTrackingConfiguration": "<p>The target tracking scaling policy.</p>",
|
||||
"TagFilters$member": null
|
||||
}
|
||||
},
|
||||
"TagFilters": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ApplicationSource$TagFilters": "<p>A set of tags (up to 50).</p>"
|
||||
}
|
||||
},
|
||||
"TagValues": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"TagFilter$Values": "<p>The tag values (0 to 20).</p>"
|
||||
}
|
||||
},
|
||||
"TargetTrackingConfiguration": {
|
||||
"base": "<p>Describes a target tracking configuration to use with AWS Auto Scaling. Used with <a>ScalingInstruction</a> and <a>ScalingPolicy</a>.</p>",
|
||||
"refs": {
|
||||
"ScalingPolicy$TargetTrackingConfiguration": "<p>The target tracking scaling policy. Includes support for predefined or customized metrics.</p>",
|
||||
"TargetTrackingConfigurations$member": null
|
||||
}
|
||||
},
|
||||
"TargetTrackingConfigurations": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ScalingInstruction$TargetTrackingConfigurations": "<p>The target tracking scaling policies (up to 10).</p>"
|
||||
"ScalingInstruction$TargetTrackingConfigurations": "<p>The structure that defines new target tracking configurations (up to 10). Each of these structures includes a specific scaling metric and a target value for the metric, along with various parameters to use with dynamic scaling. </p> <p>With predictive scaling and dynamic scaling, the resource scales based on the target tracking configuration that provides the largest capacity for both scale in and scale out. </p> <p>Condition: The scaling metric must be unique across target tracking configurations.</p>"
|
||||
}
|
||||
},
|
||||
"TimestampType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ScalingPlan$CreationTime": "<p>The Unix timestamp when the scaling plan was created.</p>"
|
||||
"Datapoint$Timestamp": "<p>The time stamp for the data point in UTC format.</p>",
|
||||
"GetScalingPlanResourceForecastDataRequest$StartTime": "<p>The inclusive start time of the time range for the forecast data to get. The date and time can be at most 56 days before the current date and time. </p>",
|
||||
"GetScalingPlanResourceForecastDataRequest$EndTime": "<p>The exclusive end time of the time range for the forecast data to get. The maximum time duration between the start and end time is seven days. </p> <p>Although this parameter can accept a date and time that is more than two days in the future, the availability of forecast data has limits. AWS Auto Scaling only issues forecasts for periods of two days in advance.</p>",
|
||||
"ScalingPlan$StatusStartTime": "<p>The Unix time stamp when the scaling plan entered the current status.</p>",
|
||||
"ScalingPlan$CreationTime": "<p>The Unix time stamp when the scaling plan was created.</p>"
|
||||
}
|
||||
},
|
||||
"UpdateScalingPlanRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateScalingPlanResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ValidationException": {
|
||||
@@ -362,10 +488,23 @@
|
||||
"XmlString": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ApplicationSource$CloudFormationStackARN": "<p>The Amazon Resource Name (ARN) of a CloudFormation stack.</p>",
|
||||
"ApplicationSource$CloudFormationStackARN": "<p>The Amazon Resource Name (ARN) of a AWS CloudFormation stack.</p>",
|
||||
"GetScalingPlanResourceForecastDataRequest$ResourceId": "<p>The ID of the resource. This string consists of the resource type and unique identifier. </p> <ul> <li> <p>Auto Scaling group - The resource type is <code>autoScalingGroup</code> and the unique identifier is the name of the Auto Scaling group. Example: <code>autoScalingGroup/my-asg</code>.</p> </li> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot Fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot Fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> <li> <p>Aurora DB cluster - The resource type is <code>cluster</code> and the unique identifier is the cluster name. Example: <code>cluster:my-db-cluster</code>.</p> </li> </ul>",
|
||||
"ScalingPlan$StatusMessage": "<p>A simple message about the current status of the scaling plan.</p>",
|
||||
"ScalingPlanResource$ScalingStatusMessage": "<p>A simple message about the current scaling status of the resource.</p>"
|
||||
}
|
||||
},
|
||||
"XmlStringMaxLen128": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"TagFilter$Key": "<p>The tag key.</p>"
|
||||
}
|
||||
},
|
||||
"XmlStringMaxLen256": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"TagValues$member": null
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+143
@@ -5,6 +5,7 @@
|
||||
"endpointPrefix":"autoscaling",
|
||||
"protocol":"query",
|
||||
"serviceFullName":"Auto Scaling",
|
||||
"serviceId":"Auto Scaling",
|
||||
"signatureVersion":"v4",
|
||||
"uid":"autoscaling-2011-01-01",
|
||||
"xmlNamespace":"http://autoscaling.amazonaws.com/doc/2011-01-01/"
|
||||
@@ -54,6 +55,38 @@
|
||||
{"shape":"ServiceLinkedRoleFailure"}
|
||||
]
|
||||
},
|
||||
"BatchDeleteScheduledAction":{
|
||||
"name":"BatchDeleteScheduledAction",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"BatchDeleteScheduledActionType"},
|
||||
"output":{
|
||||
"shape":"BatchDeleteScheduledActionAnswer",
|
||||
"resultWrapper":"BatchDeleteScheduledActionResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"ResourceContentionFault"}
|
||||
]
|
||||
},
|
||||
"BatchPutScheduledUpdateGroupAction":{
|
||||
"name":"BatchPutScheduledUpdateGroupAction",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"BatchPutScheduledUpdateGroupActionType"},
|
||||
"output":{
|
||||
"shape":"BatchPutScheduledUpdateGroupActionAnswer",
|
||||
"resultWrapper":"BatchPutScheduledUpdateGroupActionResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"AlreadyExistsFault"},
|
||||
{"shape":"LimitExceededFault"},
|
||||
{"shape":"ResourceContentionFault"}
|
||||
]
|
||||
},
|
||||
"CompleteLifecycleAction":{
|
||||
"name":"CompleteLifecycleAction",
|
||||
"http":{
|
||||
@@ -886,6 +919,7 @@
|
||||
"AutoScalingGroupARN":{"shape":"ResourceName"},
|
||||
"LaunchConfigurationName":{"shape":"XmlStringMaxLen255"},
|
||||
"LaunchTemplate":{"shape":"LaunchTemplateSpecification"},
|
||||
"MixedInstancesPolicy":{"shape":"MixedInstancesPolicy"},
|
||||
"MinSize":{"shape":"AutoScalingGroupMinSize"},
|
||||
"MaxSize":{"shape":"AutoScalingGroupMaxSize"},
|
||||
"DesiredCapacity":{"shape":"AutoScalingGroupDesiredCapacity"},
|
||||
@@ -976,6 +1010,40 @@
|
||||
"member":{"shape":"XmlStringMaxLen255"},
|
||||
"min":1
|
||||
},
|
||||
"BatchDeleteScheduledActionAnswer":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"FailedScheduledActions":{"shape":"FailedScheduledUpdateGroupActionRequests"}
|
||||
}
|
||||
},
|
||||
"BatchDeleteScheduledActionType":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AutoScalingGroupName",
|
||||
"ScheduledActionNames"
|
||||
],
|
||||
"members":{
|
||||
"AutoScalingGroupName":{"shape":"ResourceName"},
|
||||
"ScheduledActionNames":{"shape":"ScheduledActionNames"}
|
||||
}
|
||||
},
|
||||
"BatchPutScheduledUpdateGroupActionAnswer":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"FailedScheduledUpdateGroupActions":{"shape":"FailedScheduledUpdateGroupActionRequests"}
|
||||
}
|
||||
},
|
||||
"BatchPutScheduledUpdateGroupActionType":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AutoScalingGroupName",
|
||||
"ScheduledUpdateGroupActions"
|
||||
],
|
||||
"members":{
|
||||
"AutoScalingGroupName":{"shape":"ResourceName"},
|
||||
"ScheduledUpdateGroupActions":{"shape":"ScheduledUpdateGroupActionRequests"}
|
||||
}
|
||||
},
|
||||
"BlockDeviceEbsDeleteOnTermination":{"type":"boolean"},
|
||||
"BlockDeviceEbsEncrypted":{"type":"boolean"},
|
||||
"BlockDeviceEbsIops":{
|
||||
@@ -1043,6 +1111,7 @@
|
||||
"AutoScalingGroupName":{"shape":"XmlStringMaxLen255"},
|
||||
"LaunchConfigurationName":{"shape":"ResourceName"},
|
||||
"LaunchTemplate":{"shape":"LaunchTemplateSpecification"},
|
||||
"MixedInstancesPolicy":{"shape":"MixedInstancesPolicy"},
|
||||
"InstanceId":{"shape":"XmlStringMaxLen19"},
|
||||
"MinSize":{"shape":"AutoScalingGroupMinSize"},
|
||||
"MaxSize":{"shape":"AutoScalingGroupMaxSize"},
|
||||
@@ -1455,6 +1524,19 @@
|
||||
"AutoScalingGroupName":{"shape":"ResourceName"}
|
||||
}
|
||||
},
|
||||
"FailedScheduledUpdateGroupActionRequest":{
|
||||
"type":"structure",
|
||||
"required":["ScheduledActionName"],
|
||||
"members":{
|
||||
"ScheduledActionName":{"shape":"XmlStringMaxLen255"},
|
||||
"ErrorCode":{"shape":"XmlStringMaxLen64"},
|
||||
"ErrorMessage":{"shape":"XmlString"}
|
||||
}
|
||||
},
|
||||
"FailedScheduledUpdateGroupActionRequests":{
|
||||
"type":"list",
|
||||
"member":{"shape":"FailedScheduledUpdateGroupActionRequest"}
|
||||
},
|
||||
"Filter":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1505,6 +1587,17 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"Instance"}
|
||||
},
|
||||
"InstancesDistribution":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"OnDemandAllocationStrategy":{"shape":"XmlString"},
|
||||
"OnDemandBaseCapacity":{"shape":"OnDemandBaseCapacity"},
|
||||
"OnDemandPercentageAboveBaseCapacity":{"shape":"OnDemandPercentageAboveBaseCapacity"},
|
||||
"SpotAllocationStrategy":{"shape":"XmlString"},
|
||||
"SpotInstancePools":{"shape":"SpotInstancePools"},
|
||||
"SpotMaxPrice":{"shape":"MixedInstanceSpotPrice"}
|
||||
}
|
||||
},
|
||||
"InvalidNextToken":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1578,12 +1671,25 @@
|
||||
"NextToken":{"shape":"XmlString"}
|
||||
}
|
||||
},
|
||||
"LaunchTemplate":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"LaunchTemplateSpecification":{"shape":"LaunchTemplateSpecification"},
|
||||
"Overrides":{"shape":"Overrides"}
|
||||
}
|
||||
},
|
||||
"LaunchTemplateName":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":3,
|
||||
"pattern":"[a-zA-Z0-9\\(\\)\\.-/_]+"
|
||||
},
|
||||
"LaunchTemplateOverrides":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"InstanceType":{"shape":"XmlStringMaxLen255"}
|
||||
}
|
||||
},
|
||||
"LaunchTemplateSpecification":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1770,6 +1876,18 @@
|
||||
"type":"integer",
|
||||
"deprecated":true
|
||||
},
|
||||
"MixedInstanceSpotPrice":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":0
|
||||
},
|
||||
"MixedInstancesPolicy":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"LaunchTemplate":{"shape":"LaunchTemplate"},
|
||||
"InstancesDistribution":{"shape":"InstancesDistribution"}
|
||||
}
|
||||
},
|
||||
"MonitoringEnabled":{"type":"boolean"},
|
||||
"NoDevice":{"type":"boolean"},
|
||||
"NotificationConfiguration":{
|
||||
@@ -1792,6 +1910,12 @@
|
||||
},
|
||||
"NumberOfAutoScalingGroups":{"type":"integer"},
|
||||
"NumberOfLaunchConfigurations":{"type":"integer"},
|
||||
"OnDemandBaseCapacity":{"type":"integer"},
|
||||
"OnDemandPercentageAboveBaseCapacity":{"type":"integer"},
|
||||
"Overrides":{
|
||||
"type":"list",
|
||||
"member":{"shape":"LaunchTemplateOverrides"}
|
||||
},
|
||||
"PoliciesType":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -2055,6 +2179,23 @@
|
||||
"DesiredCapacity":{"shape":"AutoScalingGroupDesiredCapacity"}
|
||||
}
|
||||
},
|
||||
"ScheduledUpdateGroupActionRequest":{
|
||||
"type":"structure",
|
||||
"required":["ScheduledActionName"],
|
||||
"members":{
|
||||
"ScheduledActionName":{"shape":"XmlStringMaxLen255"},
|
||||
"StartTime":{"shape":"TimestampType"},
|
||||
"EndTime":{"shape":"TimestampType"},
|
||||
"Recurrence":{"shape":"XmlStringMaxLen255"},
|
||||
"MinSize":{"shape":"AutoScalingGroupMinSize"},
|
||||
"MaxSize":{"shape":"AutoScalingGroupMaxSize"},
|
||||
"DesiredCapacity":{"shape":"AutoScalingGroupDesiredCapacity"}
|
||||
}
|
||||
},
|
||||
"ScheduledUpdateGroupActionRequests":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ScheduledUpdateGroupActionRequest"}
|
||||
},
|
||||
"ScheduledUpdateGroupActions":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ScheduledUpdateGroupAction"}
|
||||
@@ -2119,6 +2260,7 @@
|
||||
},
|
||||
"ShouldDecrementDesiredCapacity":{"type":"boolean"},
|
||||
"ShouldRespectGracePeriod":{"type":"boolean"},
|
||||
"SpotInstancePools":{"type":"integer"},
|
||||
"SpotPrice":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
@@ -2233,6 +2375,7 @@
|
||||
"AutoScalingGroupName":{"shape":"ResourceName"},
|
||||
"LaunchConfigurationName":{"shape":"ResourceName"},
|
||||
"LaunchTemplate":{"shape":"LaunchTemplateSpecification"},
|
||||
"MixedInstancesPolicy":{"shape":"MixedInstancesPolicy"},
|
||||
"MinSize":{"shape":"AutoScalingGroupMinSize"},
|
||||
"MaxSize":{"shape":"AutoScalingGroupMaxSize"},
|
||||
"DesiredCapacity":{"shape":"AutoScalingGroupDesiredCapacity"},
|
||||
|
||||
+308
-188
File diff suppressed because it is too large
Load Diff
+20
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"version": 1,
|
||||
"defaultRegion": "us-west-2",
|
||||
"testCases": [
|
||||
{
|
||||
"operationName": "DescribeScalingProcessTypes",
|
||||
"input": {},
|
||||
"errorExpectedFromService": false
|
||||
},
|
||||
{
|
||||
"operationName": "CreateLaunchConfiguration",
|
||||
"input": {
|
||||
"LaunchConfigurationName": "hello, world",
|
||||
"ImageId": "ami-12345678",
|
||||
"InstanceType": "m1.small"
|
||||
},
|
||||
"errorExpectedFromService": true
|
||||
}
|
||||
]
|
||||
}
|
||||
+2150
File diff suppressed because it is too large
Load Diff
+1196
File diff suppressed because it is too large
Load Diff
Generated
Vendored
+59
@@ -0,0 +1,59 @@
|
||||
{
|
||||
"pagination": {
|
||||
"ListBackupJobs": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListBackupPlanTemplates": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListBackupPlanVersions": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListBackupPlans": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListBackupSelections": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListBackupVaults": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListProtectedResources": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListRecoveryPointsByBackupVault": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListRecoveryPointsByResource": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListRestoreJobs": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListTags": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
}
|
||||
}
|
||||
}
|
||||
+126
-14
@@ -262,7 +262,8 @@
|
||||
"taskArn":{"shape":"String"},
|
||||
"exitCode":{"shape":"Integer"},
|
||||
"reason":{"shape":"String"},
|
||||
"logStreamName":{"shape":"String"}
|
||||
"logStreamName":{"shape":"String"},
|
||||
"networkInterfaces":{"shape":"NetworkInterfaceList"}
|
||||
}
|
||||
},
|
||||
"AttemptDetail":{
|
||||
@@ -381,7 +382,6 @@
|
||||
"maxvCpus",
|
||||
"instanceTypes",
|
||||
"subnets",
|
||||
"securityGroupIds",
|
||||
"instanceRole"
|
||||
],
|
||||
"members":{
|
||||
@@ -396,8 +396,10 @@
|
||||
"ec2KeyPair":{"shape":"String"},
|
||||
"instanceRole":{"shape":"String"},
|
||||
"tags":{"shape":"TagsMap"},
|
||||
"placementGroup":{"shape":"String"},
|
||||
"bidPercentage":{"shape":"Integer"},
|
||||
"spotIamFleetRole":{"shape":"String"}
|
||||
"spotIamFleetRole":{"shape":"String"},
|
||||
"launchTemplate":{"shape":"LaunchTemplateSpecification"}
|
||||
}
|
||||
},
|
||||
"ComputeResourceUpdate":{
|
||||
@@ -427,7 +429,10 @@
|
||||
"reason":{"shape":"String"},
|
||||
"containerInstanceArn":{"shape":"String"},
|
||||
"taskArn":{"shape":"String"},
|
||||
"logStreamName":{"shape":"String"}
|
||||
"logStreamName":{"shape":"String"},
|
||||
"instanceType":{"shape":"String"},
|
||||
"networkInterfaces":{"shape":"NetworkInterfaceList"},
|
||||
"resourceRequirements":{"shape":"ResourceRequirements"}
|
||||
}
|
||||
},
|
||||
"ContainerOverrides":{
|
||||
@@ -436,16 +441,13 @@
|
||||
"vcpus":{"shape":"Integer"},
|
||||
"memory":{"shape":"Integer"},
|
||||
"command":{"shape":"StringList"},
|
||||
"environment":{"shape":"EnvironmentVariables"}
|
||||
"instanceType":{"shape":"String"},
|
||||
"environment":{"shape":"EnvironmentVariables"},
|
||||
"resourceRequirements":{"shape":"ResourceRequirements"}
|
||||
}
|
||||
},
|
||||
"ContainerProperties":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"image",
|
||||
"vcpus",
|
||||
"memory"
|
||||
],
|
||||
"members":{
|
||||
"image":{"shape":"String"},
|
||||
"vcpus":{"shape":"Integer"},
|
||||
@@ -458,7 +460,9 @@
|
||||
"readonlyRootFilesystem":{"shape":"Boolean"},
|
||||
"privileged":{"shape":"Boolean"},
|
||||
"ulimits":{"shape":"Ulimits"},
|
||||
"user":{"shape":"String"}
|
||||
"user":{"shape":"String"},
|
||||
"instanceType":{"shape":"String"},
|
||||
"resourceRequirements":{"shape":"ResourceRequirements"}
|
||||
}
|
||||
},
|
||||
"ContainerSummary":{
|
||||
@@ -657,7 +661,8 @@
|
||||
"parameters":{"shape":"ParametersMap"},
|
||||
"retryStrategy":{"shape":"RetryStrategy"},
|
||||
"containerProperties":{"shape":"ContainerProperties"},
|
||||
"timeout":{"shape":"JobTimeout"}
|
||||
"timeout":{"shape":"JobTimeout"},
|
||||
"nodeProperties":{"shape":"NodeProperties"}
|
||||
}
|
||||
},
|
||||
"JobDefinitionList":{
|
||||
@@ -666,7 +671,10 @@
|
||||
},
|
||||
"JobDefinitionType":{
|
||||
"type":"string",
|
||||
"enum":["container"]
|
||||
"enum":[
|
||||
"container",
|
||||
"multinode"
|
||||
]
|
||||
},
|
||||
"JobDependency":{
|
||||
"type":"structure",
|
||||
@@ -704,6 +712,8 @@
|
||||
"jobDefinition":{"shape":"String"},
|
||||
"parameters":{"shape":"ParametersMap"},
|
||||
"container":{"shape":"ContainerDetail"},
|
||||
"nodeDetails":{"shape":"NodeDetails"},
|
||||
"nodeProperties":{"shape":"NodeProperties"},
|
||||
"arrayProperties":{"shape":"ArrayPropertiesDetail"},
|
||||
"timeout":{"shape":"JobTimeout"}
|
||||
}
|
||||
@@ -762,7 +772,8 @@
|
||||
"startedAt":{"shape":"Long"},
|
||||
"stoppedAt":{"shape":"Long"},
|
||||
"container":{"shape":"ContainerSummary"},
|
||||
"arrayProperties":{"shape":"ArrayPropertiesSummary"}
|
||||
"arrayProperties":{"shape":"ArrayPropertiesSummary"},
|
||||
"nodeProperties":{"shape":"NodePropertiesSummary"}
|
||||
}
|
||||
},
|
||||
"JobSummaryList":{
|
||||
@@ -782,11 +793,20 @@
|
||||
"value":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"LaunchTemplateSpecification":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"launchTemplateId":{"shape":"String"},
|
||||
"launchTemplateName":{"shape":"String"},
|
||||
"version":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"ListJobsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"jobQueue":{"shape":"String"},
|
||||
"arrayJobId":{"shape":"String"},
|
||||
"multiNodeJobId":{"shape":"String"},
|
||||
"jobStatus":{"shape":"JobStatus"},
|
||||
"maxResults":{"shape":"Integer"},
|
||||
"nextToken":{"shape":"String"}
|
||||
@@ -813,6 +833,77 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"MountPoint"}
|
||||
},
|
||||
"NetworkInterface":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"attachmentId":{"shape":"String"},
|
||||
"ipv6Address":{"shape":"String"},
|
||||
"privateIpv4Address":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"NetworkInterfaceList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"NetworkInterface"}
|
||||
},
|
||||
"NodeDetails":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"nodeIndex":{"shape":"Integer"},
|
||||
"isMainNode":{"shape":"Boolean"}
|
||||
}
|
||||
},
|
||||
"NodeOverrides":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"numNodes":{"shape":"Integer"},
|
||||
"nodePropertyOverrides":{"shape":"NodePropertyOverrides"}
|
||||
}
|
||||
},
|
||||
"NodeProperties":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"numNodes",
|
||||
"mainNode",
|
||||
"nodeRangeProperties"
|
||||
],
|
||||
"members":{
|
||||
"numNodes":{"shape":"Integer"},
|
||||
"mainNode":{"shape":"Integer"},
|
||||
"nodeRangeProperties":{"shape":"NodeRangeProperties"}
|
||||
}
|
||||
},
|
||||
"NodePropertiesSummary":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"isMainNode":{"shape":"Boolean"},
|
||||
"numNodes":{"shape":"Integer"},
|
||||
"nodeIndex":{"shape":"Integer"}
|
||||
}
|
||||
},
|
||||
"NodePropertyOverride":{
|
||||
"type":"structure",
|
||||
"required":["targetNodes"],
|
||||
"members":{
|
||||
"targetNodes":{"shape":"String"},
|
||||
"containerOverrides":{"shape":"ContainerOverrides"}
|
||||
}
|
||||
},
|
||||
"NodePropertyOverrides":{
|
||||
"type":"list",
|
||||
"member":{"shape":"NodePropertyOverride"}
|
||||
},
|
||||
"NodeRangeProperties":{
|
||||
"type":"list",
|
||||
"member":{"shape":"NodeRangeProperty"}
|
||||
},
|
||||
"NodeRangeProperty":{
|
||||
"type":"structure",
|
||||
"required":["targetNodes"],
|
||||
"members":{
|
||||
"targetNodes":{"shape":"String"},
|
||||
"container":{"shape":"ContainerProperties"}
|
||||
}
|
||||
},
|
||||
"ParametersMap":{
|
||||
"type":"map",
|
||||
"key":{"shape":"String"},
|
||||
@@ -829,6 +920,7 @@
|
||||
"type":{"shape":"JobDefinitionType"},
|
||||
"parameters":{"shape":"ParametersMap"},
|
||||
"containerProperties":{"shape":"ContainerProperties"},
|
||||
"nodeProperties":{"shape":"NodeProperties"},
|
||||
"retryStrategy":{"shape":"RetryStrategy"},
|
||||
"timeout":{"shape":"JobTimeout"}
|
||||
}
|
||||
@@ -846,6 +938,25 @@
|
||||
"revision":{"shape":"Integer"}
|
||||
}
|
||||
},
|
||||
"ResourceRequirement":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"value",
|
||||
"type"
|
||||
],
|
||||
"members":{
|
||||
"value":{"shape":"String"},
|
||||
"type":{"shape":"ResourceType"}
|
||||
}
|
||||
},
|
||||
"ResourceRequirements":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ResourceRequirement"}
|
||||
},
|
||||
"ResourceType":{
|
||||
"type":"string",
|
||||
"enum":["GPU"]
|
||||
},
|
||||
"RetryStrategy":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -881,6 +992,7 @@
|
||||
"jobDefinition":{"shape":"String"},
|
||||
"parameters":{"shape":"ParametersMap"},
|
||||
"containerOverrides":{"shape":"ContainerOverrides"},
|
||||
"nodeOverrides":{"shape":"NodeOverrides"},
|
||||
"retryStrategy":{"shape":"RetryStrategy"},
|
||||
"timeout":{"shape":"JobTimeout"}
|
||||
}
|
||||
|
||||
+160
-47
@@ -3,7 +3,7 @@
|
||||
"service": "<p>AWS Batch enables you to run batch computing workloads on the AWS Cloud. Batch computing is a common way for developers, scientists, and engineers to access large amounts of compute resources, and AWS Batch removes the undifferentiated heavy lifting of configuring and managing the required infrastructure. AWS Batch will be familiar to users of traditional batch computing software. This service can efficiently provision resources in response to jobs submitted in order to eliminate capacity constraints, reduce compute costs, and deliver results quickly.</p> <p>As a fully managed service, AWS Batch enables developers, scientists, and engineers to run batch computing workloads of any scale. AWS Batch automatically provisions compute resources and optimizes the workload distribution based on the quantity and scale of the workloads. With AWS Batch, there is no need to install or manage batch computing software, which allows you to focus on analyzing results and solving problems. AWS Batch reduces operational complexities, saves time, and reduces costs, which makes it easy for developers, scientists, and engineers to run their batch jobs in the AWS Cloud.</p>",
|
||||
"operations": {
|
||||
"CancelJob": "<p>Cancels a job in an AWS Batch job queue. Jobs that are in the <code>SUBMITTED</code>, <code>PENDING</code>, or <code>RUNNABLE</code> state are cancelled. Jobs that have progressed to <code>STARTING</code> or <code>RUNNING</code> are not cancelled (but the API operation still succeeds, even if no job is cancelled); these jobs must be terminated with the <a>TerminateJob</a> operation.</p>",
|
||||
"CreateComputeEnvironment": "<p>Creates an AWS Batch compute environment. You can create <code>MANAGED</code> or <code>UNMANAGED</code> compute environments.</p> <p>In a managed compute environment, AWS Batch manages the compute resources within the environment, based on the compute resources that you specify. Instances launched into a managed compute environment use a recent, approved version of the Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand Instances in your managed compute environment, or you can use Amazon EC2 Spot Instances that only launch when the Spot bid price is below a specified percentage of the On-Demand price.</p> <p>In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html\">Container Instance AMIs</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. After you have created your unmanaged compute environment, you can use the <a>DescribeComputeEnvironments</a> operation to find the Amazon ECS cluster that is associated with it and then manually launch your container instances into that Amazon ECS cluster. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html\">Launching an Amazon ECS Container Instance</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>",
|
||||
"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 capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html\">launch template</a> that you specify when you create the compute environment. You can choose to use Amazon EC2 On-Demand Instances or Spot Instances in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is below a specified percentage of the On-Demand price.</p> <note> <p>Multi-node parallel jobs are not supported on Spot Instances.</p> </note> <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=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html\">Container Instance AMIs</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. After you have created your unmanaged compute environment, you can use the <a>DescribeComputeEnvironments</a> operation to find the Amazon ECS cluster that is associated with it. Then, manually launch your container instances into that Amazon ECS cluster. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html\">Launching an Amazon ECS Container Instance</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>AWS Batch does not upgrade the AMIs in a compute environment after it is created (for example, when a newer version of the Amazon ECS-optimized AMI is available). You are responsible for the management of the guest operating system (including updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs:</p> <ol> <li> <p>Create a new compute environment with the new AMI.</p> </li> <li> <p>Add the compute environment to an existing job queue.</p> </li> <li> <p>Remove the old compute environment from your job queue.</p> </li> <li> <p>Delete the old compute environment.</p> </li> </ol> </note>",
|
||||
"CreateJobQueue": "<p>Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.</p> <p>You also set a priority to the job queue that determines the order in which the AWS Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.</p>",
|
||||
"DeleteComputeEnvironment": "<p>Deletes an AWS Batch compute environment.</p> <p>Before you can delete a compute environment, you must set its state to <code>DISABLED</code> with the <a>UpdateComputeEnvironment</a> API operation and disassociate it from any job queues with the <a>UpdateJobQueue</a> API operation.</p>",
|
||||
"DeleteJobQueue": "<p>Deletes the specified job queue. You must first disable submissions for a queue with the <a>UpdateJobQueue</a> operation. All jobs in the queue are terminated when you delete a job queue.</p> <p>It is not necessary to disassociate compute environments from a queue before submitting a <code>DeleteJobQueue</code> request. </p>",
|
||||
@@ -12,7 +12,7 @@
|
||||
"DescribeJobDefinitions": "<p>Describes a list of job definitions. You can specify a <code>status</code> (such as <code>ACTIVE</code>) to only return job definitions that match that status.</p>",
|
||||
"DescribeJobQueues": "<p>Describes one or more of your job queues.</p>",
|
||||
"DescribeJobs": "<p>Describes a list of AWS Batch jobs.</p>",
|
||||
"ListJobs": "<p>Returns a list of task jobs for a specified job queue. You can filter the results by job status with the <code>jobStatus</code> parameter. If you do not specify a status, only <code>RUNNING</code> jobs are returned.</p>",
|
||||
"ListJobs": "<p>Returns a list of AWS Batch jobs.</p> <p>You must specify only one of the following:</p> <ul> <li> <p>a job queue ID to return a list of jobs in that job queue</p> </li> <li> <p>a multi-node parallel job ID to return a list of that job's nodes</p> </li> <li> <p>an array job ID to return a list of that job's children</p> </li> </ul> <p>You can filter the results by job status with the <code>jobStatus</code> parameter. If you do not specify a status, only <code>RUNNING</code> jobs are returned.</p>",
|
||||
"RegisterJobDefinition": "<p>Registers an AWS Batch job definition. </p>",
|
||||
"SubmitJob": "<p>Submits an AWS Batch job from a job definition. Parameters specified during <a>SubmitJob</a> override parameters defined in the job definition. </p>",
|
||||
"TerminateJob": "<p>Terminates a job in a job queue. Jobs that are in the <code>STARTING</code> or <code>RUNNING</code> state are terminated, which causes them to transition to <code>FAILED</code>. Jobs that have not progressed to the <code>STARTING</code> state are cancelled.</p>",
|
||||
@@ -35,7 +35,7 @@
|
||||
"ArrayProperties": {
|
||||
"base": "<p>An object representing an AWS Batch array job.</p>",
|
||||
"refs": {
|
||||
"SubmitJobRequest$arrayProperties": "<p>The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see <a href=\"http://docs.aws.amazon.com/batch/latest/userguide/array_jobs.html\">Array Jobs</a> in the <i>AWS Batch User Guide</i>.</p>"
|
||||
"SubmitJobRequest$arrayProperties": "<p>The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/array_jobs.html\">Array Jobs</a> in the <i>AWS Batch User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"ArrayPropertiesDetail": {
|
||||
@@ -73,15 +73,17 @@
|
||||
"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>"
|
||||
"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/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/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/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/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>",
|
||||
"NodeDetails$isMainNode": "<p>Specifies whether the current node is the main node for a multi-node parallel job.</p>",
|
||||
"NodePropertiesSummary$isMainNode": "<p>Specifies whether the current node is the main node for a multi-node parallel job.</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>",
|
||||
"ComputeEnvironmentDetail$state": "<p>The state of the compute environment. The valid values are <code>ENABLED</code> or <code>DISABLED</code>. </p> <p>If the state is <code>ENABLED</code>, then the AWS Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.</p> <p>If the state is <code>DISABLED</code>, then the AWS Batch scheduler does not attempt to place jobs within the environment. Jobs in a <code>STARTING</code> or <code>RUNNING</code> state continue to progress normally. Managed compute environments in the <code>DISABLED</code> state do not scale out. However, they scale in to <code>minvCpus</code> value after instances become idle.</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>"
|
||||
}
|
||||
@@ -96,13 +98,13 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ComputeEnvironmentDetail$type": "<p>The type of the compute environment.</p>",
|
||||
"CreateComputeEnvironmentRequest$type": "<p>The type of the compute environment. </p>"
|
||||
"CreateComputeEnvironmentRequest$type": "<p>The type of the compute environment. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html\">Compute Environments</a> in the <i>AWS Batch User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"CRType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ComputeResource$type": "<p>The type of compute environment.</p>"
|
||||
"ComputeResource$type": "<p>The type of compute environment: EC2 or SPOT.</p>"
|
||||
}
|
||||
},
|
||||
"CancelJobRequest": {
|
||||
@@ -150,7 +152,7 @@
|
||||
"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>"
|
||||
"CreateComputeEnvironmentRequest$computeResources": "<p>Details of the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/compute_environments.html\">Compute Environments</a> in the <i>AWS Batch User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"ComputeResourceUpdate": {
|
||||
@@ -168,6 +170,7 @@
|
||||
"ContainerOverrides": {
|
||||
"base": "<p>The overrides that should be sent to a container.</p>",
|
||||
"refs": {
|
||||
"NodePropertyOverride$containerOverrides": "<p>The overrides that should be sent to a node range.</p>",
|
||||
"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>"
|
||||
}
|
||||
},
|
||||
@@ -175,7 +178,8 @@
|
||||
"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>"
|
||||
"NodeRangeProperty$container": "<p>The container details for the node range.</p>",
|
||||
"RegisterJobDefinitionRequest$containerProperties": "<p>An object with various properties specific to single-node container-based jobs. If the job definition's <code>type</code> parameter is <code>container</code>, then you must specify either <code>containerProperties</code> or <code>nodeProperties</code>.</p>"
|
||||
}
|
||||
},
|
||||
"ContainerSummary": {
|
||||
@@ -279,11 +283,11 @@
|
||||
"refs": {
|
||||
"ContainerDetail$environment": "<p>The environment variables to pass to a container.</p> <note> <p>Environment variables must not start with <code>AWS_BATCH</code>; this naming convention is reserved for variables that are set by the AWS Batch service.</p> </note>",
|
||||
"ContainerOverrides$environment": "<p>The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.</p> <note> <p>Environment variables must not start with <code>AWS_BATCH</code>; this naming convention is reserved for variables that are set by the AWS Batch service.</p> </note>",
|
||||
"ContainerProperties$environment": "<p>The environment variables to pass to a container. This parameter maps to <code>Env</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--env</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <important> <p>We do not recommend using plaintext environment variables for sensitive information, such as credential data.</p> </important> <note> <p>Environment variables must not start with <code>AWS_BATCH</code>; this naming convention is reserved for variables that are set by the AWS Batch service.</p> </note>"
|
||||
"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/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--env</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <important> <p>We do not recommend using plaintext environment variables for sensitive information, such as credential data.</p> </important> <note> <p>Environment variables must not start with <code>AWS_BATCH</code>; this naming convention is reserved for variables that are set by the AWS Batch service.</p> </note>"
|
||||
}
|
||||
},
|
||||
"Host": {
|
||||
"base": "<p>The contents of the <code>host</code> parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.</p>",
|
||||
"base": "<p>Determine whether your data volume persists on the host container instance and where it is stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data is not guaranteed to persist after the containers associated with it stop running.</p>",
|
||||
"refs": {
|
||||
"Volume$host": "<p>The contents of the <code>host</code> parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.</p>"
|
||||
}
|
||||
@@ -299,10 +303,10 @@
|
||||
"ArrayPropertiesSummary$index": "<p>The job index within the array that is associated with this job. This parameter is returned for children of array jobs.</p>",
|
||||
"AttemptContainerDetail$exitCode": "<p>The exit code for the job attempt. A non-zero exit code is considered a failure.</p>",
|
||||
"ComputeEnvironmentOrder$order": "<p>The order of the compute environment.</p>",
|
||||
"ComputeResource$minvCpus": "<p>The minimum number of EC2 vCPUs that an environment should maintain. </p>",
|
||||
"ComputeResource$minvCpus": "<p>The minimum number of EC2 vCPUs that an environment should maintain (even if the compute environment is <code>DISABLED</code>). </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>",
|
||||
"ComputeResource$bidPercentage": "<p>The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be below 20% of the current On-Demand price for that EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price.</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>",
|
||||
@@ -311,10 +315,10 @@
|
||||
"ContainerDetail$exitCode": "<p>The exit code to return upon completion.</p>",
|
||||
"ContainerOverrides$vcpus": "<p>The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.</p>",
|
||||
"ContainerOverrides$memory": "<p>The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.</p>",
|
||||
"ContainerProperties$vcpus": "<p>The number of vCPUs reserved for the container. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.</p>",
|
||||
"ContainerProperties$memory": "<p>The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. You must specify at least 4 MiB of memory for a job.</p> <note> <p>If you are trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see <a href=\"http://docs.aws.amazon.com/batch/latest/userguide/memory-management.html\">Memory Management</a> in the <i>AWS Batch User Guide</i>.</p> </note>",
|
||||
"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/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.</p>",
|
||||
"ContainerProperties$memory": "<p>The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. You must specify at least 4 MiB of memory for a job.</p> <note> <p>If you are trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html\">Memory Management</a> in the <i>AWS Batch User Guide</i>.</p> </note>",
|
||||
"ContainerSummary$exitCode": "<p>The exit code to return upon completion.</p>",
|
||||
"CreateJobQueueRequest$priority": "<p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the <code>priority</code> parameter) are evaluated first when associated with same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of <code>10</code> is given scheduling preference over a job queue with a priority value of <code>1</code>.</p>",
|
||||
"CreateJobQueueRequest$priority": "<p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the <code>priority</code> parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of <code>10</code> is given scheduling preference over a job queue with a priority value of <code>1</code>.</p>",
|
||||
"DescribeComputeEnvironmentsRequest$maxResults": "<p>The maximum number of cluster results returned by <code>DescribeComputeEnvironments</code> in paginated output. When this parameter is used, <code>DescribeComputeEnvironments</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeComputeEnvironments</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>DescribeComputeEnvironments</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
|
||||
"DescribeJobDefinitionsRequest$maxResults": "<p>The maximum number of results returned by <code>DescribeJobDefinitions</code> in paginated output. When this parameter is used, <code>DescribeJobDefinitions</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeJobDefinitions</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>DescribeJobDefinitions</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
|
||||
"DescribeJobQueuesRequest$maxResults": "<p>The maximum number of results returned by <code>DescribeJobQueues</code> in paginated output. When this parameter is used, <code>DescribeJobQueues</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeJobQueues</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>DescribeJobQueues</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
|
||||
@@ -322,11 +326,17 @@
|
||||
"JobQueueDetail$priority": "<p>The priority of the job queue. </p>",
|
||||
"JobTimeout$attemptDurationSeconds": "<p>The time duration in seconds (measured from the job attempt's <code>startedAt</code> timestamp) after which AWS Batch terminates your jobs if they have not finished.</p>",
|
||||
"ListJobsRequest$maxResults": "<p>The maximum number of results returned by <code>ListJobs</code> in paginated output. When this parameter is used, <code>ListJobs</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListJobs</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListJobs</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>",
|
||||
"NodeDetails$nodeIndex": "<p>The node index for the node. Node index numbering begins at zero. This index is also available on the node with the <code>AWS_BATCH_JOB_NODE_INDEX</code> environment variable.</p>",
|
||||
"NodeOverrides$numNodes": "<p>The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override:</p> <ul> <li> <p>There must be at least one node range in your job definition that has an open upper boundary (such as <code>:</code> or <code>n:</code>).</p> </li> <li> <p>The lower boundary of the node range specified in the job definition must be fewer than the number of nodes specified in the override.</p> </li> <li> <p>The main node index specified in the job definition must be fewer than the number of nodes specified in the override.</p> </li> </ul>",
|
||||
"NodeProperties$numNodes": "<p>The number of nodes associated with a multi-node parallel job.</p>",
|
||||
"NodeProperties$mainNode": "<p>Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes.</p>",
|
||||
"NodePropertiesSummary$numNodes": "<p>The number of nodes associated with a multi-node parallel job.</p>",
|
||||
"NodePropertiesSummary$nodeIndex": "<p>The node index for the node. Node index numbering begins at zero. This index is also available on the node with the <code>AWS_BATCH_JOB_NODE_INDEX</code> environment variable.</p>",
|
||||
"RegisterJobDefinitionResponse$revision": "<p>The revision of the job definition.</p>",
|
||||
"RetryStrategy$attempts": "<p>The number of times to move a job to the <code>RUNNABLE</code> status. You may specify between 1 and 10 attempts. If the value of <code>attempts</code> is greater than one, the job is retried if it fails until it has moved to <code>RUNNABLE</code> that many times.</p>",
|
||||
"RetryStrategy$attempts": "<p>The number of times to move a job to the <code>RUNNABLE</code> status. You may specify between 1 and 10 attempts. If the value of <code>attempts</code> is greater than one, the job is retried on failure the same number of attempts as the value.</p>",
|
||||
"Ulimit$hardLimit": "<p>The hard limit for the <code>ulimit</code> type.</p>",
|
||||
"Ulimit$softLimit": "<p>The soft limit for the <code>ulimit</code> type.</p>",
|
||||
"UpdateJobQueueRequest$priority": "<p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the <code>priority</code> parameter) are evaluated first when associated with same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of <code>10</code> is given scheduling preference over a job queue with a priority value of <code>1</code>.</p>"
|
||||
"UpdateJobQueueRequest$priority": "<p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the <code>priority</code> parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of <code>10</code> is given scheduling preference over a job queue with a priority value of <code>1</code>.</p>"
|
||||
}
|
||||
},
|
||||
"JQState": {
|
||||
@@ -371,7 +381,7 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"JobDetail$dependsOn": "<p>A list of job names or IDs on which this job depends.</p>",
|
||||
"SubmitJobRequest$dependsOn": "<p>A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a <code>SEQUENTIAL</code> type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an <code>N_TO_N</code> type dependency with a job ID for array jobs so that each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.</p>"
|
||||
"SubmitJobRequest$dependsOn": "<p>A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a <code>SEQUENTIAL</code> type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an <code>N_TO_N</code> type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.</p>"
|
||||
}
|
||||
},
|
||||
"JobDetail": {
|
||||
@@ -401,7 +411,7 @@
|
||||
"JobStatus": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"JobDetail$status": "<p>The current status for the job.</p>",
|
||||
"JobDetail$status": "<p>The current status for the job. </p> <note> <p>If your jobs do not progress to <code>STARTING</code>, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/troubleshooting.html#job_stuck_in_runnable\">Jobs Stuck in <code>RUNNABLE</code> Status</a> in the troubleshooting section of the <i>AWS Batch User Guide</i>.</p> </note>",
|
||||
"JobSummary$status": "<p>The current status for the job.</p>",
|
||||
"ListJobsRequest$jobStatus": "<p>The job status with which to filter jobs in the specified queue. If you do not specify a status, only <code>RUNNING</code> jobs are returned.</p>"
|
||||
}
|
||||
@@ -423,8 +433,8 @@
|
||||
"refs": {
|
||||
"JobDefinition$timeout": "<p>The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished.</p>",
|
||||
"JobDetail$timeout": "<p>The timeout configuration for the job. </p>",
|
||||
"RegisterJobDefinitionRequest$timeout": "<p>The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that is specified during a <a>SubmitJob</a> operation overrides the timeout configuration defined here. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html\">Job Timeouts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>",
|
||||
"SubmitJobRequest$timeout": "<p>The timeout configuration for this <a>SubmitJob</a> operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html\">Job Timeouts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
|
||||
"RegisterJobDefinitionRequest$timeout": "<p>The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that is specified during a <a>SubmitJob</a> operation overrides the timeout configuration defined here. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html\">Job Timeouts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>",
|
||||
"SubmitJobRequest$timeout": "<p>The timeout configuration for this <a>SubmitJob</a> operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html\">Job Timeouts</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"KeyValuePair": {
|
||||
@@ -433,6 +443,12 @@
|
||||
"EnvironmentVariables$member": null
|
||||
}
|
||||
},
|
||||
"LaunchTemplateSpecification": {
|
||||
"base": "<p>An object representing a launch template associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both. </p>",
|
||||
"refs": {
|
||||
"ComputeResource$launchTemplate": "<p>The launch template to use for your compute resources. Any other compute resource parameters that you specify in a <a>CreateComputeEnvironment</a> API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html\">Launch Template Support</a> in the <i>AWS Batch User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"ListJobsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -446,18 +462,18 @@
|
||||
"Long": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AttemptDetail$startedAt": "<p>The Unix time stamp (in seconds and milliseconds) for when the attempt was started (when the attempt transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>",
|
||||
"AttemptDetail$stoppedAt": "<p>The Unix time stamp (in seconds and milliseconds) for when the attempt was stopped (when the attempt transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>).</p>",
|
||||
"JobDetail$createdAt": "<p>The Unix time stamp (in seconds and milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the <code>SUBMITTED</code> state (at the time <a>SubmitJob</a> was called). For array child jobs, this is when the child job was spawned by its parent and entered the <code>PENDING</code> state.</p>",
|
||||
"JobDetail$startedAt": "<p>The Unix time stamp (in seconds and milliseconds) for when the job was started (when the job transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>",
|
||||
"JobDetail$stoppedAt": "<p>The Unix time stamp (in seconds and milliseconds) for when the job was stopped (when the job transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>).</p>",
|
||||
"JobSummary$createdAt": "<p>The Unix time stamp for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the <code>SUBMITTED</code> state (at the time <a>SubmitJob</a> was called). For array child jobs, this is when the child job was spawned by its parent and entered the <code>PENDING</code> state.</p>",
|
||||
"JobSummary$startedAt": "<p>The Unix time stamp for when the job was started (when the job transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>",
|
||||
"JobSummary$stoppedAt": "<p>The Unix time stamp for when the job was stopped (when the job transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>).</p>"
|
||||
"AttemptDetail$startedAt": "<p>The Unix timestamp (in seconds and milliseconds) for when the attempt was started (when the attempt transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>",
|
||||
"AttemptDetail$stoppedAt": "<p>The Unix timestamp (in seconds and milliseconds) for when the attempt was stopped (when the attempt transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>).</p>",
|
||||
"JobDetail$createdAt": "<p>The Unix timestamp (in seconds and milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the <code>SUBMITTED</code> state (at the time <a>SubmitJob</a> was called). For array child jobs, this is when the child job was spawned by its parent and entered the <code>PENDING</code> state.</p>",
|
||||
"JobDetail$startedAt": "<p>The Unix timestamp (in seconds and milliseconds) for when the job was started (when the job transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>",
|
||||
"JobDetail$stoppedAt": "<p>The Unix timestamp (in seconds and milliseconds) for when the job was stopped (when the job transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>).</p>",
|
||||
"JobSummary$createdAt": "<p>The Unix timestamp for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the <code>SUBMITTED</code> state (at the time <a>SubmitJob</a> was called). For array child jobs, this is when the child job was spawned by its parent and entered the <code>PENDING</code> state.</p>",
|
||||
"JobSummary$startedAt": "<p>The Unix timestamp for when the job was started (when the job transitioned from the <code>STARTING</code> state to the <code>RUNNING</code> state).</p>",
|
||||
"JobSummary$stoppedAt": "<p>The Unix timestamp for when the job was stopped (when the job transitioned from the <code>RUNNING</code> state to a terminal state, such as <code>SUCCEEDED</code> or <code>FAILED</code>).</p>"
|
||||
}
|
||||
},
|
||||
"MountPoint": {
|
||||
"base": "<p>Details on a Docker volume mount point that is used in a job's container properties.</p>",
|
||||
"base": "<p>Details on a Docker volume mount point that is used in a job's container properties. This parameter maps to <code>Volumes</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.19/#create-a-container\">Create a container</a> section of the Docker Remote API and the <code>--volume</code> option to docker run.</p>",
|
||||
"refs": {
|
||||
"MountPoints$member": null
|
||||
}
|
||||
@@ -466,13 +482,76 @@
|
||||
"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>"
|
||||
"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/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/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>"
|
||||
}
|
||||
},
|
||||
"NetworkInterface": {
|
||||
"base": "<p>An object representing the elastic network interface for a multi-node parallel job node.</p>",
|
||||
"refs": {
|
||||
"NetworkInterfaceList$member": null
|
||||
}
|
||||
},
|
||||
"NetworkInterfaceList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AttemptContainerDetail$networkInterfaces": "<p>The network interfaces associated with the job attempt.</p>",
|
||||
"ContainerDetail$networkInterfaces": "<p>The network interfaces associated with the job.</p>"
|
||||
}
|
||||
},
|
||||
"NodeDetails": {
|
||||
"base": "<p>An object representing the details of a multi-node parallel job node.</p>",
|
||||
"refs": {
|
||||
"JobDetail$nodeDetails": "<p>An object representing the details of a node that is associated with a multi-node parallel job.</p>"
|
||||
}
|
||||
},
|
||||
"NodeOverrides": {
|
||||
"base": "<p>Object representing any node overrides to a job definition that is used in a <a>SubmitJob</a> API operation.</p>",
|
||||
"refs": {
|
||||
"SubmitJobRequest$nodeOverrides": "<p>A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.</p>"
|
||||
}
|
||||
},
|
||||
"NodeProperties": {
|
||||
"base": "<p>An object representing the node properties of a multi-node parallel job.</p>",
|
||||
"refs": {
|
||||
"JobDefinition$nodeProperties": "<p>An object with various properties specific to multi-node parallel jobs.</p>",
|
||||
"JobDetail$nodeProperties": "<p>An object representing the node properties of a multi-node parallel job.</p>",
|
||||
"RegisterJobDefinitionRequest$nodeProperties": "<p>An object with various properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/multi-node-parallel-jobs.html\">Multi-node Parallel Jobs</a> in the <i>AWS Batch User Guide</i>. If the job definition's <code>type</code> parameter is <code>container</code>, then you must specify either <code>containerProperties</code> or <code>nodeProperties</code>.</p>"
|
||||
}
|
||||
},
|
||||
"NodePropertiesSummary": {
|
||||
"base": "<p>An object representing the properties of a node that is associated with a multi-node parallel job.</p>",
|
||||
"refs": {
|
||||
"JobSummary$nodeProperties": "<p>The node properties for a single node in a job summary list.</p>"
|
||||
}
|
||||
},
|
||||
"NodePropertyOverride": {
|
||||
"base": "<p>Object representing any node overrides to a job definition that is used in a <a>SubmitJob</a> API operation.</p>",
|
||||
"refs": {
|
||||
"NodePropertyOverrides$member": null
|
||||
}
|
||||
},
|
||||
"NodePropertyOverrides": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"NodeOverrides$nodePropertyOverrides": "<p>The node property overrides for the job.</p>"
|
||||
}
|
||||
},
|
||||
"NodeRangeProperties": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"NodeProperties$nodeRangeProperties": "<p>A list of node ranges and their properties associated with a multi-node parallel job.</p>"
|
||||
}
|
||||
},
|
||||
"NodeRangeProperty": {
|
||||
"base": "<p>An object representing the properties of the node range for a multi-node parallel job.</p>",
|
||||
"refs": {
|
||||
"NodeRangeProperties$member": null
|
||||
}
|
||||
},
|
||||
"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>",
|
||||
"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. For more information about specifying parameters, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/job_definition_parameters.html\">Job Definition Parameters</a> in the <i>AWS Batch User Guide</i>.</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>"
|
||||
@@ -488,6 +567,26 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ResourceRequirement": {
|
||||
"base": "<p>The type and amount of a resource to assign to a container. Currently, the only supported resource type is <code>GPU</code>.</p>",
|
||||
"refs": {
|
||||
"ResourceRequirements$member": null
|
||||
}
|
||||
},
|
||||
"ResourceRequirements": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ContainerDetail$resourceRequirements": "<p>The type and amount of a resource to assign to a container. Currently, the only supported resource is <code>GPU</code>.</p>",
|
||||
"ContainerOverrides$resourceRequirements": "<p>The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is <code>GPU</code>.</p>",
|
||||
"ContainerProperties$resourceRequirements": "<p>The type and amount of a resource to assign to a container. Currently, the only supported resource is <code>GPU</code>.</p>"
|
||||
}
|
||||
},
|
||||
"ResourceType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ResourceRequirement$type": "<p>The type of resource to assign to a container. Currently, the only supported resource type is <code>GPU</code>.</p>"
|
||||
}
|
||||
},
|
||||
"RetryStrategy": {
|
||||
"base": "<p>The retry strategy associated with a job.</p>",
|
||||
"refs": {
|
||||
@@ -522,8 +621,9 @@
|
||||
"ComputeEnvironmentOrder$computeEnvironment": "<p>The Amazon Resource Name (ARN) of the compute environment.</p>",
|
||||
"ComputeResource$imageId": "<p>The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.</p>",
|
||||
"ComputeResource$ec2KeyPair": "<p>The EC2 key pair that is used for instances launched in the compute environment.</p>",
|
||||
"ComputeResource$instanceRole": "<p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, <code>ecsInstanceRole</code> or <code>arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole</code>. For more information, see <a href=\"http://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html\">Amazon ECS Instance Role</a> in the <i>AWS Batch User Guide</i>.</p>",
|
||||
"ComputeResource$spotIamFleetRole": "<p>The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a <code>SPOT</code> compute environment.</p>",
|
||||
"ComputeResource$instanceRole": "<p>The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, <code> <i>ecsInstanceRole</i> </code> or <code>arn:aws:iam::<i><aws_account_id></i>:instance-profile/<i>ecsInstanceRole</i> </code>. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/instance_IAM_role.html\">Amazon ECS Instance Role</a> in the <i>AWS Batch User Guide</i>.</p>",
|
||||
"ComputeResource$placementGroup": "<p>The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html\">Placement Groups</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>",
|
||||
"ComputeResource$spotIamFleetRole": "<p>The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a <code>SPOT</code> compute environment. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/spot_fleet_IAM_role.html\">Amazon EC2 Spot Fleet Role</a> in the <i>AWS Batch User Guide</i>.</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>",
|
||||
@@ -531,9 +631,12 @@
|
||||
"ContainerDetail$containerInstanceArn": "<p>The Amazon Resource Name (ARN) of the container instance on which the container is running.</p>",
|
||||
"ContainerDetail$taskArn": "<p>The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job. Each container attempt receives a task ARN when they reach the <code>STARTING</code> status.</p>",
|
||||
"ContainerDetail$logStreamName": "<p>The name of the CloudWatch Logs log stream associated with the container. The log group for AWS Batch jobs is <code>/aws/batch/job</code>. Each container attempt receives a log stream name when they reach the <code>RUNNING</code> status.</p>",
|
||||
"ContainerProperties$image": "<p>The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with <code> <i>repository-url</i>/<i>image</i>:<i>tag</i> </code>. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to <code>Image</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>IMAGE</code> parameter of <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <ul> <li> <p>Images in Amazon ECR repositories use the full registry and repository URI (for example, <code>012345678910.dkr.ecr.<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>",
|
||||
"ContainerDetail$instanceType": "<p>The instance type of the underlying host infrastructure of a multi-node parallel job.</p>",
|
||||
"ContainerOverrides$instanceType": "<p>The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.</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/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/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>",
|
||||
"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/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/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>",
|
||||
"ContainerProperties$instanceType": "<p>The instance type to use for a multi-node parallel job. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.</p>",
|
||||
"ContainerSummary$reason": "<p>A short (255 max characters) human-readable string to provide additional details about a running or stopped container.</p>",
|
||||
"CreateComputeEnvironmentRequest$computeEnvironmentName": "<p>The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.</p>",
|
||||
"CreateComputeEnvironmentRequest$serviceRole": "<p>The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.</p> <p>If your specified role has a path other than <code>/</code>, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.</p> <note> <p>Depending on how you created your AWS Batch service role, its ARN may contain the <code>service-role</code> path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the <code>service-role</code> path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.</p> </note>",
|
||||
@@ -553,7 +656,7 @@
|
||||
"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>",
|
||||
"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 this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location 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>",
|
||||
@@ -572,17 +675,27 @@
|
||||
"JobSummary$statusReason": "<p>A short, human-readable string to provide additional details about the current status of the job.</p>",
|
||||
"KeyValuePair$name": "<p>The name of the key-value pair. For environment variables, this is the name of the environment variable.</p>",
|
||||
"KeyValuePair$value": "<p>The value of the key-value pair. For environment variables, this is the value of the environment variable.</p>",
|
||||
"LaunchTemplateSpecification$launchTemplateId": "<p>The ID of the launch template.</p>",
|
||||
"LaunchTemplateSpecification$launchTemplateName": "<p>The name of the launch template.</p>",
|
||||
"LaunchTemplateSpecification$version": "<p>The version number of the launch template.</p> <p>Default: The default version of the launch template.</p>",
|
||||
"ListJobsRequest$jobQueue": "<p>The name or full Amazon Resource Name (ARN) of the job queue with which to list jobs.</p>",
|
||||
"ListJobsRequest$arrayJobId": "<p>The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.</p>",
|
||||
"ListJobsRequest$multiNodeJobId": "<p>The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.</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>",
|
||||
"NetworkInterface$attachmentId": "<p>The attachment ID for the network interface.</p>",
|
||||
"NetworkInterface$ipv6Address": "<p>The private IPv6 address for the network interface.</p>",
|
||||
"NetworkInterface$privateIpv4Address": "<p>The private IPv4 address for the network interface.</p>",
|
||||
"NodePropertyOverride$targetNodes": "<p>The range of nodes, using node index values, with which to override. A range of <code>0:3</code> indicates nodes with index values of <code>0</code> through <code>3</code>. If the starting range value is omitted (<code>:n</code>), then <code>0</code> is used to start the range. If the ending range value is omitted (<code>n:</code>), then the highest possible node index is used to end the range.</p>",
|
||||
"NodeRangeProperty$targetNodes": "<p>The range of nodes, using node index values. A range of <code>0:3</code> indicates nodes with index values of <code>0</code> through <code>3</code>. If the starting range value is omitted (<code>:n</code>), then <code>0</code> is used to start the range. If the ending range value is omitted (<code>n:</code>), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes (0:n). You may nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties. </p>",
|
||||
"ParametersMap$key": null,
|
||||
"ParametersMap$value": null,
|
||||
"RegisterJobDefinitionRequest$jobDefinitionName": "<p>The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.</p>",
|
||||
"RegisterJobDefinitionResponse$jobDefinitionName": "<p>The name of the job definition.</p>",
|
||||
"RegisterJobDefinitionResponse$jobDefinitionArn": "<p>The Amazon Resource Name (ARN) of the job definition. </p>",
|
||||
"ResourceRequirement$value": "<p>The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on.</p>",
|
||||
"ServerException$message": null,
|
||||
"StringList$member": null,
|
||||
"SubmitJobRequest$jobName": "<p>The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. </p>",
|
||||
@@ -597,7 +710,7 @@
|
||||
"Ulimit$name": "<p>The <code>type</code> of the <code>ulimit</code>.</p>",
|
||||
"UpdateComputeEnvironmentRequest$computeEnvironment": "<p>The name or full Amazon Resource Name (ARN) of the compute environment to update.</p>",
|
||||
"UpdateComputeEnvironmentRequest$serviceRole": "<p>The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.</p> <p>If your specified role has a path other than <code>/</code>, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.</p> <note> <p>Depending on how you created your AWS Batch service role, its ARN may contain the <code>service-role</code> path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the <code>service-role</code> path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.</p> </note>",
|
||||
"UpdateComputeEnvironmentResponse$computeEnvironmentName": "<p>The name of compute environment.</p>",
|
||||
"UpdateComputeEnvironmentResponse$computeEnvironmentName": "<p>The name of the 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>",
|
||||
@@ -608,16 +721,16 @@
|
||||
"StringList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ComputeResource$instanceTypes": "<p>The instances types that may be launched. You can specify instance families to launch any instance type within those families (for example, <code>c4</code> or <code>p3</code>), or you can specify specific sizes within a family (such as <code>c4.8xlarge</code>). You can also choose <code>optimal</code> to pick instance types (from the latest C, M, and R instance families) on the fly that match the demand of your job queues.</p>",
|
||||
"ComputeResource$instanceTypes": "<p>The instances types that may be launched. You can specify instance families to launch any instance type within those families (for example, <code>c4</code> or <code>p3</code>), or you can specify specific sizes within a family (such as <code>c4.8xlarge</code>). You can also choose <code>optimal</code> to pick instance types (from the C, M, and R instance families) on the fly that match the demand of your job queues.</p>",
|
||||
"ComputeResource$subnets": "<p>The VPC subnets into which the compute resources are launched. </p>",
|
||||
"ComputeResource$securityGroupIds": "<p>The EC2 security group that is associated with instances launched in the compute environment. </p>",
|
||||
"ContainerDetail$command": "<p>The command that is passed to the container. </p>",
|
||||
"ContainerOverrides$command": "<p>The command to send to the container that overrides the default command from the Docker image or the job definition.</p>",
|
||||
"ContainerProperties$command": "<p>The command that is passed to the container. This parameter maps to <code>Cmd</code> in the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/reference/api/docker_remote_api_v1.23/\">Docker Remote API</a> and the <code>COMMAND</code> parameter to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. For more information, see <a href=\"https://docs.docker.com/engine/reference/builder/#cmd\">https://docs.docker.com/engine/reference/builder/#cmd</a>.</p>",
|
||||
"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/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/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>",
|
||||
"DescribeJobDefinitionsRequest$jobDefinitions": "<p>A 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>"
|
||||
"DescribeJobsRequest$jobs": "<p>A list of up to 100 job IDs.</p>"
|
||||
}
|
||||
},
|
||||
"SubmitJobRequest": {
|
||||
@@ -633,7 +746,7 @@
|
||||
"TagsMap": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ComputeResource$tags": "<p>Key-value pair tags to be applied to resources that are launched in the compute environment. </p>"
|
||||
"ComputeResource$tags": "<p>Key-value pair tags to be applied to resources that are launched in the compute environment. For AWS Batch, these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value—for example, { \"Name\": \"AWS Batch Instance - C4OnDemand\" }.</p>"
|
||||
}
|
||||
},
|
||||
"TerminateJobRequest": {
|
||||
@@ -656,7 +769,7 @@
|
||||
"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>"
|
||||
"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/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/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": {
|
||||
|
||||
+100
-9
@@ -7,6 +7,7 @@
|
||||
"protocol":"json",
|
||||
"serviceAbbreviation":"AWSBudgets",
|
||||
"serviceFullName":"AWS Budgets",
|
||||
"serviceId":"Budgets",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"AWSBudgetServiceGateway",
|
||||
"uid":"budgets-2016-10-20"
|
||||
@@ -115,6 +116,22 @@
|
||||
{"shape":"NotFoundException"}
|
||||
]
|
||||
},
|
||||
"DescribeBudgetPerformanceHistory":{
|
||||
"name":"DescribeBudgetPerformanceHistory",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeBudgetPerformanceHistoryRequest"},
|
||||
"output":{"shape":"DescribeBudgetPerformanceHistoryResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalErrorException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ExpiredNextTokenException"}
|
||||
]
|
||||
},
|
||||
"DescribeBudgets":{
|
||||
"name":"DescribeBudgets",
|
||||
"http":{
|
||||
@@ -212,7 +229,8 @@
|
||||
"AccountId":{
|
||||
"type":"string",
|
||||
"max":12,
|
||||
"min":12
|
||||
"min":12,
|
||||
"pattern":"\\d{12}"
|
||||
},
|
||||
"Budget":{
|
||||
"type":"structure",
|
||||
@@ -224,27 +242,54 @@
|
||||
"members":{
|
||||
"BudgetName":{"shape":"BudgetName"},
|
||||
"BudgetLimit":{"shape":"Spend"},
|
||||
"PlannedBudgetLimits":{"shape":"PlannedBudgetLimits"},
|
||||
"CostFilters":{"shape":"CostFilters"},
|
||||
"CostTypes":{"shape":"CostTypes"},
|
||||
"TimeUnit":{"shape":"TimeUnit"},
|
||||
"TimePeriod":{"shape":"TimePeriod"},
|
||||
"CalculatedSpend":{"shape":"CalculatedSpend"},
|
||||
"BudgetType":{"shape":"BudgetType"}
|
||||
"BudgetType":{"shape":"BudgetType"},
|
||||
"LastUpdatedTime":{"shape":"GenericTimestamp"}
|
||||
}
|
||||
},
|
||||
"BudgetName":{
|
||||
"type":"string",
|
||||
"max":100,
|
||||
"min":1,
|
||||
"pattern":"[^:\\\\]+"
|
||||
},
|
||||
"BudgetPerformanceHistory":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"BudgetName":{"shape":"BudgetName"},
|
||||
"BudgetType":{"shape":"BudgetType"},
|
||||
"CostFilters":{"shape":"CostFilters"},
|
||||
"CostTypes":{"shape":"CostTypes"},
|
||||
"TimeUnit":{"shape":"TimeUnit"},
|
||||
"BudgetedAndActualAmountsList":{"shape":"BudgetedAndActualAmountsList"}
|
||||
}
|
||||
},
|
||||
"BudgetType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"USAGE",
|
||||
"COST",
|
||||
"RI_UTILIZATION"
|
||||
"RI_UTILIZATION",
|
||||
"RI_COVERAGE"
|
||||
]
|
||||
},
|
||||
"BudgetedAndActualAmounts":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"BudgetedAmount":{"shape":"Spend"},
|
||||
"ActualAmount":{"shape":"Spend"},
|
||||
"TimePeriod":{"shape":"TimePeriod"}
|
||||
}
|
||||
},
|
||||
"BudgetedAndActualAmountsList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"BudgetedAndActualAmounts"}
|
||||
},
|
||||
"Budgets":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Budget"}
|
||||
@@ -404,6 +449,27 @@
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DescribeBudgetPerformanceHistoryRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AccountId",
|
||||
"BudgetName"
|
||||
],
|
||||
"members":{
|
||||
"AccountId":{"shape":"AccountId"},
|
||||
"BudgetName":{"shape":"BudgetName"},
|
||||
"TimePeriod":{"shape":"TimePeriod"},
|
||||
"MaxResults":{"shape":"MaxResults"},
|
||||
"NextToken":{"shape":"GenericString"}
|
||||
}
|
||||
},
|
||||
"DescribeBudgetPerformanceHistoryResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"BudgetPerformanceHistory":{"shape":"BudgetPerformanceHistory"},
|
||||
"NextToken":{"shape":"GenericString"}
|
||||
}
|
||||
},
|
||||
"DescribeBudgetRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -497,7 +563,12 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"GenericString":{"type":"string"},
|
||||
"GenericString":{
|
||||
"type":"string",
|
||||
"max":2147483647,
|
||||
"min":0,
|
||||
"pattern":".*"
|
||||
},
|
||||
"GenericTimestamp":{"type":"timestamp"},
|
||||
"InternalErrorException":{
|
||||
"type":"structure",
|
||||
@@ -544,13 +615,21 @@
|
||||
"NotificationType":{"shape":"NotificationType"},
|
||||
"ComparisonOperator":{"shape":"ComparisonOperator"},
|
||||
"Threshold":{"shape":"NotificationThreshold"},
|
||||
"ThresholdType":{"shape":"ThresholdType"}
|
||||
"ThresholdType":{"shape":"ThresholdType"},
|
||||
"NotificationState":{"shape":"NotificationState"}
|
||||
}
|
||||
},
|
||||
"NotificationState":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"OK",
|
||||
"ALARM"
|
||||
]
|
||||
},
|
||||
"NotificationThreshold":{
|
||||
"type":"double",
|
||||
"max":1000000000,
|
||||
"min":0.1
|
||||
"min":0
|
||||
},
|
||||
"NotificationType":{
|
||||
"type":"string",
|
||||
@@ -585,7 +664,14 @@
|
||||
},
|
||||
"NumericValue":{
|
||||
"type":"string",
|
||||
"pattern":"[0-9]*(\\.)?[0-9]+"
|
||||
"max":2147483647,
|
||||
"min":1,
|
||||
"pattern":"([0-9]*\\.)?[0-9]+"
|
||||
},
|
||||
"PlannedBudgetLimits":{
|
||||
"type":"map",
|
||||
"key":{"shape":"GenericString"},
|
||||
"value":{"shape":"Spend"}
|
||||
},
|
||||
"Spend":{
|
||||
"type":"structure",
|
||||
@@ -611,7 +697,10 @@
|
||||
},
|
||||
"SubscriberAddress":{
|
||||
"type":"string",
|
||||
"min":1
|
||||
"max":2147483647,
|
||||
"min":1,
|
||||
"pattern":"(?s).*",
|
||||
"sensitive":true
|
||||
},
|
||||
"Subscribers":{
|
||||
"type":"list",
|
||||
@@ -651,7 +740,9 @@
|
||||
},
|
||||
"UnitValue":{
|
||||
"type":"string",
|
||||
"min":1
|
||||
"max":2147483647,
|
||||
"min":1,
|
||||
"pattern":".*"
|
||||
},
|
||||
"UpdateBudgetRequest":{
|
||||
"type":"structure",
|
||||
|
||||
+132
-74
@@ -1,31 +1,33 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<p>Budgets enable you to plan your service usage, service costs, and your RI utilization. You can also track how close your plan is to your budgeted amount or to the free tier limits. Budgets provide you with a quick way to see your usage-to-date and current estimated charges from AWS and to see how much your predicted usage accrues in charges by the end of the month. Budgets also compare current estimates and charges to the amount that you indicated you want to use or spend and lets you see how much of your budget has been used. AWS updates your budget status several times a day. Budgets track your unblended costs, subscriptions, and refunds. You can create the following types of budgets:</p> <ul> <li> <p>Cost budgets allow you to say how much you want to spend on a service.</p> </li> <li> <p>Usage budgets allow you to say how many hours you want to use for one or more services.</p> </li> <li> <p>RI utilization budgets allow you to define a utilization threshold and receive alerts when RIs are tracking below that threshold.</p> </li> </ul> <p>You can create up to 20,000 budgets per AWS master account. Your first two budgets are free of charge. Each additional budget costs $0.02 per day. You can set up optional notifications that warn you if you exceed, or are forecasted to exceed, your budgeted amount. You can have notifications sent to an Amazon SNS topic, to an email address, or to both. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/budgets-sns-policy.html\">Creating an Amazon SNS Topic for Budget Notifications</a>. AWS Free Tier usage alerts via AWS Budgets are provided for you, and do not count toward your budget limits.</p> <p>Service Endpoint</p> <p>The AWS Budgets API provides the following endpoint:</p> <ul> <li> <p>https://budgets.us-east-1.amazonaws.com</p> </li> </ul>",
|
||||
"service": "<p>The AWS Budgets API enables you to use AWS Budgets to plan your service usage, service costs, and instance reservations. The API reference provides descriptions, syntax, and usage examples for each of the actions and data types for AWS Budgets. </p> <p>Budgets provide you with a way to see the following information:</p> <ul> <li> <p>How close your plan is to your budgeted amount or to the free tier limits</p> </li> <li> <p>Your usage-to-date, including how much you've used of your Reserved Instances (RIs)</p> </li> <li> <p>Your current estimated charges from AWS, and how much your predicted usage will accrue in charges by the end of the month</p> </li> <li> <p>How much of your budget has been used</p> </li> </ul> <p>AWS updates your budget status several times a day. Budgets track your unblended costs, subscriptions, refunds, and RIs. You can create the following types of budgets:</p> <ul> <li> <p> <b>Cost budgets</b> - Plan how much you want to spend on a service.</p> </li> <li> <p> <b>Usage budgets</b> - Plan how much you want to use one or more services.</p> </li> <li> <p> <b>RI utilization budgets</b> - Define a utilization threshold, and receive alerts when your RI usage falls below that threshold. This lets you see if your RIs are unused or under-utilized.</p> </li> <li> <p> <b>RI coverage budgets</b> - Define a coverage threshold, and receive alerts when the number of your instance hours that are covered by RIs fall below that threshold. This lets you see how much of your instance usage is covered by a reservation.</p> </li> </ul> <p>Service Endpoint</p> <p>The AWS Budgets API provides the following endpoint:</p> <ul> <li> <p>https://budgets.amazonaws.com</p> </li> </ul> <p>For information about costs that are associated with the AWS Budgets API, see <a href=\"https://aws.amazon.com/aws-cost-management/pricing/\">AWS Cost Management Pricing</a>.</p>",
|
||||
"operations": {
|
||||
"CreateBudget": "<p>Creates a budget and, if included, notifications and subscribers. </p>",
|
||||
"CreateBudget": "<p>Creates a budget and, if included, notifications and subscribers. </p> <important> <p>Only one of <code>BudgetLimit</code> or <code>PlannedBudgetLimits</code> can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_CreateBudget.html#API_CreateBudget_Examples\">Examples</a> section. </p> </important>",
|
||||
"CreateNotification": "<p>Creates a notification. You must create the budget before you create the associated notification.</p>",
|
||||
"CreateSubscriber": "<p>Creates a subscriber. You must create the associated budget and notification before you create the subscriber.</p>",
|
||||
"DeleteBudget": "<p>Deletes a budget. You can delete your budget at any time.</p> <p> <b>Deleting a budget also deletes the notifications and subscribers associated with that budget.</b> </p>",
|
||||
"DeleteNotification": "<p>Deletes a notification.</p> <p> <b>Deleting a notification also deletes the subscribers associated with the notification.</b> </p>",
|
||||
"DeleteSubscriber": "<p>Deletes a subscriber.</p> <p> <b>Deleting the last subscriber to a notification also deletes the notification.</b> </p>",
|
||||
"DescribeBudget": "<p>Describes a budget.</p>",
|
||||
"DescribeBudgets": "<p>Lists the budgets associated with an account.</p>",
|
||||
"DescribeNotificationsForBudget": "<p>Lists the notifications associated with a budget.</p>",
|
||||
"DescribeSubscribersForNotification": "<p>Lists the subscribers associated with a notification.</p>",
|
||||
"UpdateBudget": "<p>Updates a budget. You can change every part of a budget except for the <code>budgetName</code> and the <code>calculatedSpend</code>. When a budget is modified, the <code>calculatedSpend</code> drops to zero until AWS has new usage data to use for forecasting.</p>",
|
||||
"DeleteBudget": "<p>Deletes a budget. You can delete your budget at any time.</p> <important> <p>Deleting a budget also deletes the notifications and subscribers that are associated with that budget.</p> </important>",
|
||||
"DeleteNotification": "<p>Deletes a notification.</p> <important> <p>Deleting a notification also deletes the subscribers that are associated with the notification.</p> </important>",
|
||||
"DeleteSubscriber": "<p>Deletes a subscriber.</p> <important> <p>Deleting the last subscriber to a notification also deletes the notification.</p> </important>",
|
||||
"DescribeBudget": "<p>Describes a budget.</p> <important> <p>The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_DescribeBudget.html#API_DescribeBudget_Examples\">Examples</a> section. </p> </important>",
|
||||
"DescribeBudgetPerformanceHistory": "<p>Describes the history for <code>DAILY</code>, <code>MONTHLY</code>, and <code>QUARTERLY</code> budgets. Budget history isn't available for <code>ANNUAL</code> budgets.</p>",
|
||||
"DescribeBudgets": "<p>Lists the budgets that are associated with an account.</p> <important> <p>The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_DescribeBudgets.html#API_DescribeBudgets_Examples\">Examples</a> section. </p> </important>",
|
||||
"DescribeNotificationsForBudget": "<p>Lists the notifications that are associated with a budget.</p>",
|
||||
"DescribeSubscribersForNotification": "<p>Lists the subscribers that are associated with a notification.</p>",
|
||||
"UpdateBudget": "<p>Updates a budget. You can change every part of a budget except for the <code>budgetName</code> and the <code>calculatedSpend</code>. When you modify a budget, the <code>calculatedSpend</code> drops to zero until AWS has new usage data to use for forecasting.</p> <important> <p>Only one of <code>BudgetLimit</code> or <code>PlannedBudgetLimits</code> can be present in the syntax at one time. Use the syntax that matches your case. The Request Syntax section shows the <code>BudgetLimit</code> syntax. For <code>PlannedBudgetLimits</code>, see the <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_budgets_UpdateBudget.html#API_UpdateBudget_Examples\">Examples</a> section. </p> </important>",
|
||||
"UpdateNotification": "<p>Updates a notification.</p>",
|
||||
"UpdateSubscriber": "<p>Updates a subscriber.</p>"
|
||||
},
|
||||
"shapes": {
|
||||
"AccountId": {
|
||||
"base": "<p>The account ID of the customer. It should be a 12 digit number.</p>",
|
||||
"base": "<p>The account ID of the user. It should be a 12-digit number.</p>",
|
||||
"refs": {
|
||||
"CreateBudgetRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget.</p>",
|
||||
"CreateNotificationRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget that you want to create a notification for.</p>",
|
||||
"CreateSubscriberRequest$AccountId": "<p>The <code>accountId</code> associated with the budget that you want to create a subscriber for.</p>",
|
||||
"CreateSubscriberRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget that you want to create a subscriber for.</p>",
|
||||
"DeleteBudgetRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget that you want to delete.</p>",
|
||||
"DeleteNotificationRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget whose notification you want to delete.</p>",
|
||||
"DeleteSubscriberRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget whose subscriber you want to delete.</p>",
|
||||
"DescribeBudgetPerformanceHistoryRequest$AccountId": null,
|
||||
"DescribeBudgetRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget that you want a description of.</p>",
|
||||
"DescribeBudgetsRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budgets that you want descriptions of.</p>",
|
||||
"DescribeNotificationsForBudgetRequest$AccountId": "<p>The <code>accountId</code> that is associated with the budget whose notifications you want descriptions of.</p>",
|
||||
@@ -36,7 +38,7 @@
|
||||
}
|
||||
},
|
||||
"Budget": {
|
||||
"base": "<p>Represents the output of the <code>CreateBudget</code> operation. The content consists of the detailed metadata and data file information, and the current status of the <code>budget</code>.</p> <p>The ARN pattern for a budget is: <code>arn:aws:budgetservice::AccountId:budget/budgetName</code> </p>",
|
||||
"base": "<p>Represents the output of the <code>CreateBudget</code> operation. The content consists of the detailed metadata and data file information, and the current status of the <code>budget</code> object.</p> <p>This is the ARN pattern for a budget: </p> <p> <code>arn:aws:budgetservice::AccountId:budget/budgetName</code> </p>",
|
||||
"refs": {
|
||||
"Budgets$member": null,
|
||||
"CreateBudgetRequest$Budget": "<p>The budget object that you want to create.</p>",
|
||||
@@ -45,14 +47,16 @@
|
||||
}
|
||||
},
|
||||
"BudgetName": {
|
||||
"base": "<p> A string represents the budget name. No \":\" and \"\\\" character is allowed.</p>",
|
||||
"base": "<p> A string that represents the budget name. The \":\" and \"\\\" characters aren't allowed.</p>",
|
||||
"refs": {
|
||||
"Budget$BudgetName": "<p>The name of a budget. Unique within accounts. <code>:</code> and <code>\\</code> characters are not allowed in the <code>BudgetName</code>.</p>",
|
||||
"CreateNotificationRequest$BudgetName": "<p>The name of the budget that you want AWS to notified you about. Budget names must be unique within an account.</p>",
|
||||
"Budget$BudgetName": "<p>The name of a budget. The name must be unique within an account. The <code>:</code> and <code>\\</code> characters aren't allowed in <code>BudgetName</code>.</p>",
|
||||
"BudgetPerformanceHistory$BudgetName": null,
|
||||
"CreateNotificationRequest$BudgetName": "<p>The name of the budget that you want AWS to notify you about. Budget names must be unique within an account.</p>",
|
||||
"CreateSubscriberRequest$BudgetName": "<p>The name of the budget that you want to subscribe to. Budget names must be unique within an account.</p>",
|
||||
"DeleteBudgetRequest$BudgetName": "<p>The name of the budget that you want to delete.</p>",
|
||||
"DeleteNotificationRequest$BudgetName": "<p>The name of the budget whose notification you want to delete.</p>",
|
||||
"DeleteSubscriberRequest$BudgetName": "<p>The name of the budget whose subscriber you want to delete.</p>",
|
||||
"DescribeBudgetPerformanceHistoryRequest$BudgetName": null,
|
||||
"DescribeBudgetRequest$BudgetName": "<p>The name of the budget that you want a description of.</p>",
|
||||
"DescribeNotificationsForBudgetRequest$BudgetName": "<p>The name of the budget whose notifications you want descriptions of.</p>",
|
||||
"DescribeSubscribersForNotificationRequest$BudgetName": "<p>The name of the budget whose subscribers you want descriptions of.</p>",
|
||||
@@ -60,40 +64,61 @@
|
||||
"UpdateSubscriberRequest$BudgetName": "<p>The name of the budget whose subscriber you want to update.</p>"
|
||||
}
|
||||
},
|
||||
"BudgetType": {
|
||||
"base": "<p> The type of a budget. It should be COST, USAGE, or RI_UTILIZATION.</p>",
|
||||
"BudgetPerformanceHistory": {
|
||||
"base": "<p>A history of the state of a budget at the end of the budget's specified time period.</p>",
|
||||
"refs": {
|
||||
"Budget$BudgetType": "<p>Whether this budget tracks monetary costs, usage, or RI utilization.</p>"
|
||||
"DescribeBudgetPerformanceHistoryResponse$BudgetPerformanceHistory": "<p>The history of how often the budget has gone into an <code>ALARM</code> state.</p> <p>For <code>DAILY</code> budgets, the history saves the state of the budget for the last 60 days. For <code>MONTHLY</code> budgets, the history saves the state of the budget for the current month plus the last 12 months. For <code>QUARTERLY</code> budgets, the history saves the state of the budget for the last four quarters.</p>"
|
||||
}
|
||||
},
|
||||
"BudgetType": {
|
||||
"base": "<p> The type of a budget. It must be one of the following types: </p> <p> <code>COST</code>, <code>USAGE</code>, <code>RI_UTILIZATION</code>, or <code>RI_COVERAGE</code>.</p>",
|
||||
"refs": {
|
||||
"Budget$BudgetType": "<p>Whether this budget tracks costs, usage, RI utilization, or RI coverage.</p>",
|
||||
"BudgetPerformanceHistory$BudgetType": null
|
||||
}
|
||||
},
|
||||
"BudgetedAndActualAmounts": {
|
||||
"base": "<p>The amount of cost or usage that you created the budget for, compared to your actual costs or usage.</p>",
|
||||
"refs": {
|
||||
"BudgetedAndActualAmountsList$member": null
|
||||
}
|
||||
},
|
||||
"BudgetedAndActualAmountsList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BudgetPerformanceHistory$BudgetedAndActualAmountsList": "<p>A list of amounts of cost or usage that you created budgets for, compared to your actual costs or usage.</p>"
|
||||
}
|
||||
},
|
||||
"Budgets": {
|
||||
"base": "<p> A list of budgets</p>",
|
||||
"base": "<p> A list of budgets.</p>",
|
||||
"refs": {
|
||||
"DescribeBudgetsResponse$Budgets": "<p>A list of budgets.</p>"
|
||||
}
|
||||
},
|
||||
"CalculatedSpend": {
|
||||
"base": "<p>The spend objects associated with this budget. The <code>actualSpend</code> tracks how much you've used, cost, usage, or RI units, and the <code>forecastedSpend</code> tracks how much you are predicted to spend if your current usage remains steady.</p> <p>For example, if it is the 20th of the month and you have spent <code>50</code> dollars on Amazon EC2, your <code>actualSpend</code> is <code>50 USD</code>, and your <code>forecastedSpend</code> is <code>75 USD</code>.</p>",
|
||||
"base": "<p>The spend objects that are associated with this budget. The <code>actualSpend</code> tracks how much you've used, cost, usage, or RI units, and the <code>forecastedSpend</code> tracks how much you are predicted to spend if your current usage remains steady.</p> <p>For example, if it is the 20th of the month and you have spent <code>50</code> dollars on Amazon EC2, your <code>actualSpend</code> is <code>50 USD</code>, and your <code>forecastedSpend</code> is <code>75 USD</code>.</p>",
|
||||
"refs": {
|
||||
"Budget$CalculatedSpend": "<p>The actual and forecasted cost or usage being tracked by a budget.</p>"
|
||||
"Budget$CalculatedSpend": "<p>The actual and forecasted cost or usage that the budget tracks.</p>"
|
||||
}
|
||||
},
|
||||
"ComparisonOperator": {
|
||||
"base": "<p> The comparison operator of a notification. Currently we support less than, equal to and greater than.</p>",
|
||||
"base": "<p> The comparison operator of a notification. Currently the service supports the following operators:</p> <p> <code>GREATER_THAN</code>, <code>LESS_THAN</code>, <code>EQUAL_TO</code> </p>",
|
||||
"refs": {
|
||||
"Notification$ComparisonOperator": "<p>The comparison used for this notification.</p>"
|
||||
"Notification$ComparisonOperator": "<p>The comparison that is used for this notification.</p>"
|
||||
}
|
||||
},
|
||||
"CostFilters": {
|
||||
"base": "<p> A map that represents the cost filters applied to the budget.</p>",
|
||||
"base": "<p> A map that represents the cost filters that are applied to the budget.</p>",
|
||||
"refs": {
|
||||
"Budget$CostFilters": "<p>The cost filters applied to a budget, such as service or region.</p>"
|
||||
"Budget$CostFilters": "<p>The cost filters, such as service or tag, that are applied to a budget.</p> <p>AWS Budgets supports the following services as a filter for RI budgets:</p> <ul> <li> <p>Amazon Elastic Compute Cloud - Compute</p> </li> <li> <p>Amazon Redshift</p> </li> <li> <p>Amazon Relational Database Service</p> </li> <li> <p>Amazon ElastiCache</p> </li> <li> <p>Amazon Elasticsearch Service</p> </li> </ul>",
|
||||
"BudgetPerformanceHistory$CostFilters": "<p>The history of the cost filters for a budget during the specified time period.</p>"
|
||||
}
|
||||
},
|
||||
"CostTypes": {
|
||||
"base": "<p>The types of cost included in a budget, such as tax and subscriptions.</p>",
|
||||
"base": "<p>The types of cost that are included in a <code>COST</code> budget, such as tax and subscriptions.</p> <p> <code>USAGE</code>, <code>RI_UTILIZATION</code>, and <code>RI_COVERAGE</code> budgets do not have <code>CostTypes</code>.</p>",
|
||||
"refs": {
|
||||
"Budget$CostTypes": "<p>The types of costs included in this budget.</p>"
|
||||
"Budget$CostTypes": "<p>The types of costs that are included in this <code>COST</code> budget.</p> <p> <code>USAGE</code>, <code>RI_UTILIZATION</code>, and <code>RI_COVERAGE</code> budgets do not have <code>CostTypes</code>.</p>",
|
||||
"BudgetPerformanceHistory$CostTypes": "<p>The history of the cost types for a budget during the specified time period.</p>"
|
||||
}
|
||||
},
|
||||
"CreateBudgetRequest": {
|
||||
@@ -161,6 +186,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeBudgetPerformanceHistoryRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeBudgetPerformanceHistoryResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeBudgetRequest": {
|
||||
"base": "<p> Request of DescribeBudget </p>",
|
||||
"refs": {
|
||||
@@ -218,22 +253,26 @@
|
||||
}
|
||||
},
|
||||
"GenericString": {
|
||||
"base": "<p> A generic String.</p>",
|
||||
"base": "<p> A generic string.</p>",
|
||||
"refs": {
|
||||
"CostFilters$key": null,
|
||||
"DescribeBudgetsRequest$NextToken": "<p>The pagination token that indicates the next set of results to retrieve.</p>",
|
||||
"DescribeBudgetsResponse$NextToken": "<p>The pagination token that indicates the next set of results that you can retrieve.</p>",
|
||||
"DescribeNotificationsForBudgetRequest$NextToken": "<p>The pagination token that indicates the next set of results to retrieve.</p>",
|
||||
"DescribeNotificationsForBudgetResponse$NextToken": "<p>The pagination token that indicates the next set of results that you can retrieve.</p>",
|
||||
"DescribeSubscribersForNotificationRequest$NextToken": "<p>The pagination token that indicates the next set of results to retrieve.</p>",
|
||||
"DescribeSubscribersForNotificationResponse$NextToken": "<p>The pagination token that indicates the next set of results that you can retrieve.</p>",
|
||||
"DimensionValues$member": null
|
||||
"DescribeBudgetPerformanceHistoryRequest$NextToken": null,
|
||||
"DescribeBudgetPerformanceHistoryResponse$NextToken": null,
|
||||
"DescribeBudgetsRequest$NextToken": "<p>The pagination token that you include in your request to indicate the next set of results that you want to retrieve.</p>",
|
||||
"DescribeBudgetsResponse$NextToken": "<p>The pagination token in the service response that indicates the next set of results that you can retrieve.</p>",
|
||||
"DescribeNotificationsForBudgetRequest$NextToken": "<p>The pagination token that you include in your request to indicate the next set of results that you want to retrieve.</p>",
|
||||
"DescribeNotificationsForBudgetResponse$NextToken": "<p>The pagination token in the service response that indicates the next set of results that you can retrieve.</p>",
|
||||
"DescribeSubscribersForNotificationRequest$NextToken": "<p>The pagination token that you include in your request to indicate the next set of results that you want to retrieve.</p>",
|
||||
"DescribeSubscribersForNotificationResponse$NextToken": "<p>The pagination token in the service response that indicates the next set of results that you can retrieve.</p>",
|
||||
"DimensionValues$member": null,
|
||||
"PlannedBudgetLimits$key": null
|
||||
}
|
||||
},
|
||||
"GenericTimestamp": {
|
||||
"base": "<p> A generic timestamp. In Java it is transformed to a Date object.</p>",
|
||||
"base": "<p> A generic time stamp. In Java, it is transformed to a <code>Date</code> object.</p>",
|
||||
"refs": {
|
||||
"TimePeriod$Start": "<p>The start date for a budget. If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (i.e. DAILY, MONTHLY, QUARTERLY, ANNUALLY). For example, if you created your budget on January 24th 2018, chose <code>DAILY</code>, and didn't set a start date, AWS set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, AWS set your start date to <code>01/01/18 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API.</p> <p>You can change your start date with the <code>UpdateBudget</code> operation.</p>",
|
||||
"Budget$LastUpdatedTime": "<p>The last time that you updated this budget.</p>",
|
||||
"TimePeriod$Start": "<p>The start date for a budget. If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose <code>DAILY</code>, and didn't set a start date, AWS set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, AWS set your start date to <code>01/01/18 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API.</p> <p>You can change your start date with the <code>UpdateBudget</code> operation.</p>",
|
||||
"TimePeriod$End": "<p>The end date for a budget. If you didn't specify an end date, AWS set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API.</p> <p>After the end date, AWS deletes the budget and all associated notifications and subscribers. You can change your end date with the <code>UpdateBudget</code> operation.</p>"
|
||||
}
|
||||
},
|
||||
@@ -253,11 +292,12 @@
|
||||
}
|
||||
},
|
||||
"MaxResults": {
|
||||
"base": "<p> An integer to represent how many entries a paginated response contains. Maximum is set to 100.</p>",
|
||||
"base": "<p> An integer that represents how many entries a paginated response contains. The maximum is 100.</p>",
|
||||
"refs": {
|
||||
"DescribeBudgetsRequest$MaxResults": "<p>Optional integer. Specifies the maximum number of results to return in response.</p>",
|
||||
"DescribeNotificationsForBudgetRequest$MaxResults": "<p>Optional integer. Specifies the maximum number of results to return in response.</p>",
|
||||
"DescribeSubscribersForNotificationRequest$MaxResults": "<p>Optional integer. Specifies the maximum number of results to return in response.</p>"
|
||||
"DescribeBudgetPerformanceHistoryRequest$MaxResults": null,
|
||||
"DescribeBudgetsRequest$MaxResults": "<p>An optional integer that represents how many entries a paginated response contains. The maximum is 100.</p>",
|
||||
"DescribeNotificationsForBudgetRequest$MaxResults": "<p>An optional integer that represents how many entries a paginated response contains. The maximum is 100.</p>",
|
||||
"DescribeSubscribersForNotificationRequest$MaxResults": "<p>An optional integer that represents how many entries a paginated response contains. The maximum is 100.</p>"
|
||||
}
|
||||
},
|
||||
"NotFoundException": {
|
||||
@@ -266,48 +306,54 @@
|
||||
}
|
||||
},
|
||||
"Notification": {
|
||||
"base": "<p>A notification associated with a budget. A budget can have up to five notifications. </p> <p>Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to ten email subscribers, for a total of 11 subscribers.</p> <p>For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:</p> <ul> <li> <p>A notificationType of <code>ACTUAL</code> </p> </li> <li> <p>A comparisonOperator of <code>GREATER_THAN</code> </p> </li> <li> <p>A notification threshold of <code>80</code> </p> </li> </ul>",
|
||||
"base": "<p>A notification that is associated with a budget. A budget can have up to five notifications. </p> <p>Each notification must have at least one subscriber. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.</p> <p>For example, if you have a budget for 200 dollars and you want to be notified when you go over 160 dollars, create a notification with the following parameters:</p> <ul> <li> <p>A notificationType of <code>ACTUAL</code> </p> </li> <li> <p>A <code>thresholdType</code> of <code>PERCENTAGE</code> </p> </li> <li> <p>A <code>comparisonOperator</code> of <code>GREATER_THAN</code> </p> </li> <li> <p>A notification <code>threshold</code> of <code>80</code> </p> </li> </ul>",
|
||||
"refs": {
|
||||
"CreateNotificationRequest$Notification": "<p>The notification that you want to create.</p>",
|
||||
"CreateSubscriberRequest$Notification": "<p>The notification that you want to create a subscriber for.</p>",
|
||||
"DeleteNotificationRequest$Notification": "<p>The notification that you want to delete.</p>",
|
||||
"DeleteSubscriberRequest$Notification": "<p>The notification whose subscriber you want to delete.</p>",
|
||||
"DescribeSubscribersForNotificationRequest$Notification": "<p>The notification whose subscribers you want to list.</p>",
|
||||
"NotificationWithSubscribers$Notification": "<p>The notification associated with a budget.</p>",
|
||||
"NotificationWithSubscribers$Notification": "<p>The notification that is associated with a budget.</p>",
|
||||
"Notifications$member": null,
|
||||
"UpdateNotificationRequest$OldNotification": "<p>The previous notification associated with a budget.</p>",
|
||||
"UpdateNotificationRequest$OldNotification": "<p>The previous notification that is associated with a budget.</p>",
|
||||
"UpdateNotificationRequest$NewNotification": "<p>The updated notification to be associated with a budget.</p>",
|
||||
"UpdateSubscriberRequest$Notification": "<p>The notification whose subscriber you want to update.</p>"
|
||||
}
|
||||
},
|
||||
"NotificationThreshold": {
|
||||
"base": "<p> The threshold of a notification. It should be a number between 0 and 1,000,000,000.</p>",
|
||||
"NotificationState": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Notification$Threshold": "<p>The threshold associated with a notification. Thresholds are always a percentage.</p>"
|
||||
"Notification$NotificationState": "<p>Whether this notification is in alarm. If a budget notification is in the <code>ALARM</code> state, you have passed the set threshold for the budget.</p>"
|
||||
}
|
||||
},
|
||||
"NotificationThreshold": {
|
||||
"base": "<p> The threshold of a notification. It must be a number between 0 and 1,000,000,000.</p>",
|
||||
"refs": {
|
||||
"Notification$Threshold": "<p>The threshold that is associated with a notification. Thresholds are always a percentage.</p>"
|
||||
}
|
||||
},
|
||||
"NotificationType": {
|
||||
"base": "<p> The type of a notification. It should be ACTUAL or FORECASTED.</p>",
|
||||
"base": "<p> The type of a notification. It must be ACTUAL or FORECASTED.</p>",
|
||||
"refs": {
|
||||
"Notification$NotificationType": "<p>Whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much you are forecasted to spend (<code>FORECASTED</code>).</p>"
|
||||
"Notification$NotificationType": "<p>Whether the notification is for how much you have spent (<code>ACTUAL</code>) or for how much you're forecasted to spend (<code>FORECASTED</code>).</p>"
|
||||
}
|
||||
},
|
||||
"NotificationWithSubscribers": {
|
||||
"base": "<p>A notification with subscribers. A notification can have one SNS subscriber and up to ten email subscribers, for a total of 11 subscribers.</p>",
|
||||
"base": "<p>A notification with subscribers. A notification can have one SNS subscriber and up to 10 email subscribers, for a total of 11 subscribers.</p>",
|
||||
"refs": {
|
||||
"NotificationWithSubscribersList$member": null
|
||||
}
|
||||
},
|
||||
"NotificationWithSubscribersList": {
|
||||
"base": "<p> A list of Notifications, each with a list of subscribers.</p>",
|
||||
"base": "<p> A list of notifications, each with a list of subscribers.</p>",
|
||||
"refs": {
|
||||
"CreateBudgetRequest$NotificationsWithSubscribers": "<p>A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to ten email subscribers. If you include notifications and subscribers in your <code>CreateBudget</code> call, AWS creates the notifications and subscribers for you.</p>"
|
||||
"CreateBudgetRequest$NotificationsWithSubscribers": "<p>A notification that you want to associate with a budget. A budget can have up to five notifications, and each notification can have one SNS subscriber and up to 10 email subscribers. If you include notifications and subscribers in your <code>CreateBudget</code> call, AWS creates the notifications and subscribers for you.</p>"
|
||||
}
|
||||
},
|
||||
"Notifications": {
|
||||
"base": "<p> A list of notifications.</p>",
|
||||
"refs": {
|
||||
"DescribeNotificationsForBudgetResponse$Notifications": "<p>A list of notifications associated with a budget.</p>"
|
||||
"DescribeNotificationsForBudgetResponse$Notifications": "<p>A list of notifications that are associated with a budget.</p>"
|
||||
}
|
||||
},
|
||||
"NullableBoolean": {
|
||||
@@ -315,7 +361,7 @@
|
||||
"refs": {
|
||||
"CostTypes$IncludeTax": "<p>Specifies whether a budget includes taxes.</p> <p>The default value is <code>true</code>.</p>",
|
||||
"CostTypes$IncludeSubscription": "<p>Specifies whether a budget includes subscriptions.</p> <p>The default value is <code>true</code>.</p>",
|
||||
"CostTypes$UseBlended": "<p>Specifies whether a budget uses blended rate.</p> <p>The default value is <code>false</code>.</p>",
|
||||
"CostTypes$UseBlended": "<p>Specifies whether a budget uses a blended rate.</p> <p>The default value is <code>false</code>.</p>",
|
||||
"CostTypes$IncludeRefund": "<p>Specifies whether a budget includes refunds.</p> <p>The default value is <code>true</code>.</p>",
|
||||
"CostTypes$IncludeCredit": "<p>Specifies whether a budget includes credits.</p> <p>The default value is <code>true</code>.</p>",
|
||||
"CostTypes$IncludeUpfront": "<p>Specifies whether a budget includes upfront RI costs.</p> <p>The default value is <code>true</code>.</p>",
|
||||
@@ -327,40 +373,49 @@
|
||||
}
|
||||
},
|
||||
"NumericValue": {
|
||||
"base": "<p> A string to represent NumericValue.</p>",
|
||||
"base": "<p> A string that represents a numeric value.</p>",
|
||||
"refs": {
|
||||
"Spend$Amount": "<p>The cost or usage amount associated with a budget forecast, actual spend, or budget threshold.</p>"
|
||||
"Spend$Amount": "<p>The cost or usage amount that is associated with a budget forecast, actual spend, or budget threshold.</p>"
|
||||
}
|
||||
},
|
||||
"PlannedBudgetLimits": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Budget$PlannedBudgetLimits": "<p>A map containing multiple <code>BudgetLimit</code>, including current or future limits.</p> <p> <code>PlannedBudgetLimits</code> is available for cost or usage budget and supports monthly and quarterly <code>TimeUnit</code>. </p> <p>For monthly budgets, provide 12 months of <code>PlannedBudgetLimits</code> values. This must start from the current month and include the next 11 months. The <code>key</code> is the start of the month, <code>UTC</code> in epoch seconds. </p> <p>For quarterly budgets, provide 4 quarters of <code>PlannedBudgetLimits</code> value entries in standard calendar quarter increments. This must start from the current quarter and include the next 3 quarters. The <code>key</code> is the start of the quarter, <code>UTC</code> in epoch seconds. </p> <p>If the planned budget expires before 12 months for monthly or 4 quarters for quarterly, provide the <code>PlannedBudgetLimits</code> values only for the remaining periods.</p> <p>If the budget begins at a date in the future, provide <code>PlannedBudgetLimits</code> values from the start date of the budget. </p> <p>After all of the <code>BudgetLimit</code> values in <code>PlannedBudgetLimits</code> are used, the budget continues to use the last limit as the <code>BudgetLimit</code>. At that point, the planned budget provides the same experience as a fixed budget. </p> <p> <code>DescribeBudget</code> and <code>DescribeBudgets</code> response along with <code>PlannedBudgetLimits</code> will also contain <code>BudgetLimit</code> representing the current month or quarter limit present in <code>PlannedBudgetLimits</code>. This only applies to budgets created with <code>PlannedBudgetLimits</code>. Budgets created without <code>PlannedBudgetLimits</code> will only contain <code>BudgetLimit</code>, and no <code>PlannedBudgetLimits</code>.</p>"
|
||||
}
|
||||
},
|
||||
"Spend": {
|
||||
"base": "<p>The amount of cost or usage being measured for a budget.</p> <p>For example, a <code>Spend</code> for <code>3 GB</code> of S3 usage would have the following parameters:</p> <ul> <li> <p>An <code>Amount</code> of <code>3</code> </p> </li> <li> <p>A <code>unit</code> of <code>GB</code> </p> </li> </ul>",
|
||||
"base": "<p>The amount of cost or usage that is measured for a budget.</p> <p>For example, a <code>Spend</code> for <code>3 GB</code> of S3 usage would have the following parameters:</p> <ul> <li> <p>An <code>Amount</code> of <code>3</code> </p> </li> <li> <p>A <code>unit</code> of <code>GB</code> </p> </li> </ul>",
|
||||
"refs": {
|
||||
"Budget$BudgetLimit": "<p>The total amount of cost, usage, or RI utilization that you want to track with your budget.</p> <p> <code>BudgetLimit</code> is required for cost or usage budgets, but optional for RI utilization budgets. RI utilization budgets default to the only valid value for RI utilization budgets, which is <code>100</code>.</p>",
|
||||
"Budget$BudgetLimit": "<p>The total amount of cost, usage, RI utilization, or RI coverage that you want to track with your budget.</p> <p> <code>BudgetLimit</code> is required for cost or usage budgets, but optional for RI utilization or coverage budgets. RI utilization or coverage budgets default to <code>100</code>, which is the only valid value for RI utilization or coverage budgets. You can't use <code>BudgetLimit</code> with <code>PlannedBudgetLimits</code> for <code>CreateBudget</code> and <code>UpdateBudget</code> actions. </p>",
|
||||
"BudgetedAndActualAmounts$BudgetedAmount": "<p>The amount of cost or usage that you created the budget for.</p>",
|
||||
"BudgetedAndActualAmounts$ActualAmount": "<p>Your actual costs or usage for a budget period.</p>",
|
||||
"CalculatedSpend$ActualSpend": "<p>The amount of cost, usage, or RI units that you have used.</p>",
|
||||
"CalculatedSpend$ForecastedSpend": "<p>The amount of cost, usage, or RI units that you are forecasted to use.</p>"
|
||||
"CalculatedSpend$ForecastedSpend": "<p>The amount of cost, usage, or RI units that you are forecasted to use.</p>",
|
||||
"PlannedBudgetLimits$value": null
|
||||
}
|
||||
},
|
||||
"Subscriber": {
|
||||
"base": "<p>The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon Simple Notification Service topic or an email address.</p> <p>For example, an email subscriber would have the following parameters:</p> <ul> <li> <p>A <code>subscriptionType</code> of <code>EMAIL</code> </p> </li> <li> <p>An <code>address</code> of <code>example@example.com</code> </p> </li> </ul>",
|
||||
"base": "<p>The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.</p> <p>For example, an email subscriber would have the following parameters:</p> <ul> <li> <p>A <code>subscriptionType</code> of <code>EMAIL</code> </p> </li> <li> <p>An <code>address</code> of <code>example@example.com</code> </p> </li> </ul>",
|
||||
"refs": {
|
||||
"CreateSubscriberRequest$Subscriber": "<p>The subscriber that you want to associate with a budget notification.</p>",
|
||||
"DeleteSubscriberRequest$Subscriber": "<p>The subscriber that you want to delete.</p>",
|
||||
"Subscribers$member": null,
|
||||
"UpdateSubscriberRequest$OldSubscriber": "<p>The previous subscriber associated with a budget notification.</p>",
|
||||
"UpdateSubscriberRequest$NewSubscriber": "<p>The updated subscriber associated with a budget notification.</p>"
|
||||
"UpdateSubscriberRequest$OldSubscriber": "<p>The previous subscriber that is associated with a budget notification.</p>",
|
||||
"UpdateSubscriberRequest$NewSubscriber": "<p>The updated subscriber that is associated with a budget notification.</p>"
|
||||
}
|
||||
},
|
||||
"SubscriberAddress": {
|
||||
"base": "<p> String containing email or sns topic for the subscriber address.</p>",
|
||||
"base": "<p> A string that contains an email address or SNS topic for the subscriber's address.</p>",
|
||||
"refs": {
|
||||
"Subscriber$Address": "<p>The address that AWS sends budget notifications to, either an SNS topic or an email.</p>"
|
||||
"Subscriber$Address": "<p>The address that AWS sends budget notifications to, either an SNS topic or an email.</p> <p>AWS validates the address for a <code>CreateSubscriber</code> request with the <code>.*</code> regex.</p>"
|
||||
}
|
||||
},
|
||||
"Subscribers": {
|
||||
"base": "<p> A list of subscribers.</p>",
|
||||
"refs": {
|
||||
"CreateNotificationRequest$Subscribers": "<p>A list of subscribers that you want to associate with the notification. Each notification can have one SNS subscriber and up to ten email subscribers.</p>",
|
||||
"DescribeSubscribersForNotificationResponse$Subscribers": "<p>A list of subscribers associated with a notification.</p>",
|
||||
"CreateNotificationRequest$Subscribers": "<p>A list of subscribers that you want to associate with the notification. Each notification can have one SNS subscriber and up to 10 email subscribers.</p>",
|
||||
"DescribeSubscribersForNotificationResponse$Subscribers": "<p>A list of subscribers that are associated with a notification.</p>",
|
||||
"NotificationWithSubscribers$Subscribers": "<p>A list of subscribers who are subscribed to this notification.</p>"
|
||||
}
|
||||
},
|
||||
@@ -373,25 +428,28 @@
|
||||
"ThresholdType": {
|
||||
"base": "<p> The type of threshold for a notification. It can be PERCENTAGE or ABSOLUTE_VALUE.</p>",
|
||||
"refs": {
|
||||
"Notification$ThresholdType": "<p>The type of threshold for a notification. For <code>ACTUAL</code> thresholds, AWS notifies you when you go over the threshold, and for <code>FORECASTED</code> thresholds AWS notifies you when you are forecasted to go over the threshold.</p>"
|
||||
"Notification$ThresholdType": "<p>The type of threshold for a notification. For <code>ABSOLUTE_VALUE</code> thresholds, AWS notifies you when you go over or are forecasted to go over your total cost threshold. For <code>PERCENTAGE</code> thresholds, AWS notifies you when you go over or are forecasted to go over a certain percentage of your forecasted spend. For example, if you have a budget for 200 dollars and you have a <code>PERCENTAGE</code> threshold of 80%, AWS notifies you when you go over 160 dollars.</p>"
|
||||
}
|
||||
},
|
||||
"TimePeriod": {
|
||||
"base": "<p>The period of time covered by a budget. Has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date. </p>",
|
||||
"base": "<p>The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date. </p>",
|
||||
"refs": {
|
||||
"Budget$TimePeriod": "<p>The period of time covered by a budget. Has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date. </p> <p>If you created your budget and didn't specify a start date, AWS defaults to the start of your chosen time period (i.e. DAILY, MONTHLY, QUARTERLY, ANNUALLY). For example, if you created your budget on January 24th 2018, chose <code>DAILY</code>, and didn't set a start date, AWS set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, AWS set your start date to <code>01/01/18 00:00 UTC</code>. If you didn't specify an end date, AWS set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API. </p> <p>You can change either date with the <code>UpdateBudget</code> operation.</p> <p>After the end date, AWS deletes the budget and all associated notifications and subscribers.</p>"
|
||||
"Budget$TimePeriod": "<p>The period of time that is covered by a budget. The period has a start date and an end date. The start date must come before the end date. The end date must come before <code>06/15/87 00:00 UTC</code>. </p> <p>If you create your budget and don't specify a start date, AWS defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose <code>DAILY</code>, and didn't set a start date, AWS set your start date to <code>01/24/18 00:00 UTC</code>. If you chose <code>MONTHLY</code>, AWS set your start date to <code>01/01/18 00:00 UTC</code>. If you didn't specify an end date, AWS set your end date to <code>06/15/87 00:00 UTC</code>. The defaults are the same for the AWS Billing and Cost Management console and the API. </p> <p>You can change either date with the <code>UpdateBudget</code> operation.</p> <p>After the end date, AWS deletes the budget and all associated notifications and subscribers.</p>",
|
||||
"BudgetedAndActualAmounts$TimePeriod": "<p>The time period covered by this budget comparison.</p>",
|
||||
"DescribeBudgetPerformanceHistoryRequest$TimePeriod": "<p>Retrieves how often the budget went into an <code>ALARM</code> state for the specified time period.</p>"
|
||||
}
|
||||
},
|
||||
"TimeUnit": {
|
||||
"base": "<p> The time unit of the budget. e.g. MONTHLY, QUARTERLY, etc.</p>",
|
||||
"base": "<p> The time unit of the budget, such as MONTHLY or QUARTERLY.</p>",
|
||||
"refs": {
|
||||
"Budget$TimeUnit": "<p>The length of time until a budget resets the actual and forecasted spend.</p>"
|
||||
"Budget$TimeUnit": "<p>The length of time until a budget resets the actual and forecasted spend. <code>DAILY</code> is available only for <code>RI_UTILIZATION</code> and <code>RI_COVERAGE</code> budgets.</p>",
|
||||
"BudgetPerformanceHistory$TimeUnit": null
|
||||
}
|
||||
},
|
||||
"UnitValue": {
|
||||
"base": "<p> A string to represent budget spend unit. It should be not null and not empty.</p>",
|
||||
"base": "<p> A string that represents the spend unit of a budget. It can't be null or empty.</p>",
|
||||
"refs": {
|
||||
"Spend$Unit": "<p>The unit of measurement used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.</p>"
|
||||
"Spend$Unit": "<p>The unit of measurement that is used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.</p>"
|
||||
}
|
||||
},
|
||||
"UpdateBudgetRequest": {
|
||||
|
||||
+234
-11
@@ -26,7 +26,21 @@
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"BillExpirationException"},
|
||||
{"shape":"DataUnavailableException"},
|
||||
{"shape":"InvalidNextTokenException"}
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"RequestChangedException"}
|
||||
]
|
||||
},
|
||||
"GetCostForecast":{
|
||||
"name":"GetCostForecast",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetCostForecastRequest"},
|
||||
"output":{"shape":"GetCostForecastResponse"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"DataUnavailableException"}
|
||||
]
|
||||
},
|
||||
"GetDimensionValues":{
|
||||
@@ -40,7 +54,9 @@
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"BillExpirationException"},
|
||||
{"shape":"InvalidNextTokenException"}
|
||||
{"shape":"DataUnavailableException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"RequestChangedException"}
|
||||
]
|
||||
},
|
||||
"GetReservationCoverage":{
|
||||
@@ -96,15 +112,36 @@
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"BillExpirationException"},
|
||||
{"shape":"InvalidNextTokenException"}
|
||||
{"shape":"DataUnavailableException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"RequestChangedException"}
|
||||
]
|
||||
},
|
||||
"GetUsageForecast":{
|
||||
"name":"GetUsageForecast",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetUsageForecastRequest"},
|
||||
"output":{"shape":"GetUsageForecastResponse"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"DataUnavailableException"},
|
||||
{"shape":"UnresolvableUsageUnitException"}
|
||||
]
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AccountScope":{
|
||||
"type":"string",
|
||||
"enum":["PAYER"]
|
||||
"enum":[
|
||||
"PAYER",
|
||||
"LINKED"
|
||||
]
|
||||
},
|
||||
"AmortizedRecurringFee":{"type":"string"},
|
||||
"AmortizedUpfrontFee":{"type":"string"},
|
||||
"AttributeType":{"type":"string"},
|
||||
"AttributeValue":{"type":"string"},
|
||||
"Attributes":{
|
||||
@@ -129,7 +166,9 @@
|
||||
"Coverage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CoverageHours":{"shape":"CoverageHours"}
|
||||
"CoverageHours":{"shape":"CoverageHours"},
|
||||
"CoverageNormalizedUnits":{"shape":"CoverageNormalizedUnits"},
|
||||
"CoverageCost":{"shape":"CoverageCost"}
|
||||
}
|
||||
},
|
||||
"CoverageByTime":{
|
||||
@@ -140,6 +179,12 @@
|
||||
"Total":{"shape":"Coverage"}
|
||||
}
|
||||
},
|
||||
"CoverageCost":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"OnDemandCost":{"shape":"OnDemandCost"}
|
||||
}
|
||||
},
|
||||
"CoverageHours":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -150,6 +195,16 @@
|
||||
}
|
||||
},
|
||||
"CoverageHoursPercentage":{"type":"string"},
|
||||
"CoverageNormalizedUnits":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"OnDemandNormalizedUnits":{"shape":"OnDemandNormalizedUnits"},
|
||||
"ReservedNormalizedUnits":{"shape":"ReservedNormalizedUnits"},
|
||||
"TotalRunningNormalizedUnits":{"shape":"TotalRunningNormalizedUnits"},
|
||||
"CoverageNormalizedUnitsPercentage":{"shape":"CoverageNormalizedUnitsPercentage"}
|
||||
}
|
||||
},
|
||||
"CoverageNormalizedUnitsPercentage":{"type":"string"},
|
||||
"CoveragesByTime":{
|
||||
"type":"list",
|
||||
"member":{"shape":"CoverageByTime"}
|
||||
@@ -194,7 +249,9 @@
|
||||
"DEPLOYMENT_OPTION",
|
||||
"DATABASE_ENGINE",
|
||||
"CACHE_ENGINE",
|
||||
"INSTANCE_TYPE_FAMILY"
|
||||
"INSTANCE_TYPE_FAMILY",
|
||||
"BILLING_ENTITY",
|
||||
"RESERVATION_ID"
|
||||
]
|
||||
},
|
||||
"DimensionValues":{
|
||||
@@ -234,6 +291,27 @@
|
||||
"OfferingClass":{"shape":"OfferingClass"}
|
||||
}
|
||||
},
|
||||
"ESInstanceDetails":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"InstanceClass":{"shape":"GenericString"},
|
||||
"InstanceSize":{"shape":"GenericString"},
|
||||
"Region":{"shape":"GenericString"},
|
||||
"CurrentGeneration":{"shape":"GenericBoolean"},
|
||||
"SizeFlexEligible":{"shape":"GenericBoolean"}
|
||||
}
|
||||
},
|
||||
"ElastiCacheInstanceDetails":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Family":{"shape":"GenericString"},
|
||||
"NodeType":{"shape":"GenericString"},
|
||||
"Region":{"shape":"GenericString"},
|
||||
"ProductDescription":{"shape":"GenericString"},
|
||||
"CurrentGeneration":{"shape":"GenericBoolean"},
|
||||
"SizeFlexEligible":{"shape":"GenericBoolean"}
|
||||
}
|
||||
},
|
||||
"Entity":{"type":"string"},
|
||||
"ErrorMessage":{"type":"string"},
|
||||
"Estimated":{"type":"boolean"},
|
||||
@@ -251,10 +329,24 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"Expression"}
|
||||
},
|
||||
"ForecastResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TimePeriod":{"shape":"DateInterval"},
|
||||
"MeanValue":{"shape":"GenericString"},
|
||||
"PredictionIntervalLowerBound":{"shape":"GenericString"},
|
||||
"PredictionIntervalUpperBound":{"shape":"GenericString"}
|
||||
}
|
||||
},
|
||||
"ForecastResultsByTime":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ForecastResult"}
|
||||
},
|
||||
"GenericBoolean":{"type":"boolean"},
|
||||
"GenericString":{"type":"string"},
|
||||
"GetCostAndUsageRequest":{
|
||||
"type":"structure",
|
||||
"required":["TimePeriod"],
|
||||
"members":{
|
||||
"TimePeriod":{"shape":"DateInterval"},
|
||||
"Granularity":{"shape":"Granularity"},
|
||||
@@ -272,6 +364,28 @@
|
||||
"ResultsByTime":{"shape":"ResultsByTime"}
|
||||
}
|
||||
},
|
||||
"GetCostForecastRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"TimePeriod",
|
||||
"Metric",
|
||||
"Granularity"
|
||||
],
|
||||
"members":{
|
||||
"TimePeriod":{"shape":"DateInterval"},
|
||||
"Metric":{"shape":"Metric"},
|
||||
"Granularity":{"shape":"Granularity"},
|
||||
"Filter":{"shape":"Expression"},
|
||||
"PredictionIntervalLevel":{"shape":"PredictionIntervalLevel"}
|
||||
}
|
||||
},
|
||||
"GetCostForecastResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Total":{"shape":"MetricValue"},
|
||||
"ForecastResultsByTime":{"shape":"ForecastResultsByTime"}
|
||||
}
|
||||
},
|
||||
"GetDimensionValuesRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -308,6 +422,7 @@
|
||||
"GroupBy":{"shape":"GroupDefinitions"},
|
||||
"Granularity":{"shape":"Granularity"},
|
||||
"Filter":{"shape":"Expression"},
|
||||
"Metrics":{"shape":"MetricNames"},
|
||||
"NextPageToken":{"shape":"NextPageToken"}
|
||||
}
|
||||
},
|
||||
@@ -387,11 +502,34 @@
|
||||
"TotalSize":{"shape":"PageSize"}
|
||||
}
|
||||
},
|
||||
"GetUsageForecastRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"TimePeriod",
|
||||
"Metric",
|
||||
"Granularity"
|
||||
],
|
||||
"members":{
|
||||
"TimePeriod":{"shape":"DateInterval"},
|
||||
"Metric":{"shape":"Metric"},
|
||||
"Granularity":{"shape":"Granularity"},
|
||||
"Filter":{"shape":"Expression"},
|
||||
"PredictionIntervalLevel":{"shape":"PredictionIntervalLevel"}
|
||||
}
|
||||
},
|
||||
"GetUsageForecastResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Total":{"shape":"MetricValue"},
|
||||
"ForecastResultsByTime":{"shape":"ForecastResultsByTime"}
|
||||
}
|
||||
},
|
||||
"Granularity":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"DAILY",
|
||||
"MONTHLY"
|
||||
"MONTHLY",
|
||||
"HOURLY"
|
||||
]
|
||||
},
|
||||
"Group":{
|
||||
@@ -427,7 +565,11 @@
|
||||
"InstanceDetails":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"EC2InstanceDetails":{"shape":"EC2InstanceDetails"}
|
||||
"EC2InstanceDetails":{"shape":"EC2InstanceDetails"},
|
||||
"RDSInstanceDetails":{"shape":"RDSInstanceDetails"},
|
||||
"RedshiftInstanceDetails":{"shape":"RedshiftInstanceDetails"},
|
||||
"ElastiCacheInstanceDetails":{"shape":"ElastiCacheInstanceDetails"},
|
||||
"ESInstanceDetails":{"shape":"ESInstanceDetails"}
|
||||
}
|
||||
},
|
||||
"InvalidNextTokenException":{
|
||||
@@ -457,6 +599,18 @@
|
||||
"SIXTY_DAYS"
|
||||
]
|
||||
},
|
||||
"Metric":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"BLENDED_COST",
|
||||
"UNBLENDED_COST",
|
||||
"AMORTIZED_COST",
|
||||
"NET_UNBLENDED_COST",
|
||||
"NET_AMORTIZED_COST",
|
||||
"USAGE_QUANTITY",
|
||||
"NORMALIZED_USAGE_AMOUNT"
|
||||
]
|
||||
},
|
||||
"MetricAmount":{"type":"string"},
|
||||
"MetricName":{"type":"string"},
|
||||
"MetricNames":{
|
||||
@@ -476,6 +630,7 @@
|
||||
"key":{"shape":"MetricName"},
|
||||
"value":{"shape":"MetricValue"}
|
||||
},
|
||||
"NetRISavings":{"type":"string"},
|
||||
"NextPageToken":{"type":"string"},
|
||||
"NonNegativeInteger":{
|
||||
"type":"integer",
|
||||
@@ -488,24 +643,77 @@
|
||||
"CONVERTIBLE"
|
||||
]
|
||||
},
|
||||
"OnDemandCost":{"type":"string"},
|
||||
"OnDemandCostOfRIHoursUsed":{"type":"string"},
|
||||
"OnDemandHours":{"type":"string"},
|
||||
"OnDemandNormalizedUnits":{"type":"string"},
|
||||
"PageSize":{"type":"integer"},
|
||||
"PaymentOption":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"NO_UPFRONT",
|
||||
"PARTIAL_UPFRONT",
|
||||
"ALL_UPFRONT"
|
||||
"ALL_UPFRONT",
|
||||
"LIGHT_UTILIZATION",
|
||||
"MEDIUM_UTILIZATION",
|
||||
"HEAVY_UTILIZATION"
|
||||
]
|
||||
},
|
||||
"PredictionIntervalLevel":{
|
||||
"type":"integer",
|
||||
"max":99,
|
||||
"min":51
|
||||
},
|
||||
"PurchasedHours":{"type":"string"},
|
||||
"PurchasedUnits":{"type":"string"},
|
||||
"RDSInstanceDetails":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Family":{"shape":"GenericString"},
|
||||
"InstanceType":{"shape":"GenericString"},
|
||||
"Region":{"shape":"GenericString"},
|
||||
"DatabaseEngine":{"shape":"GenericString"},
|
||||
"DatabaseEdition":{"shape":"GenericString"},
|
||||
"DeploymentOption":{"shape":"GenericString"},
|
||||
"LicenseModel":{"shape":"GenericString"},
|
||||
"CurrentGeneration":{"shape":"GenericBoolean"},
|
||||
"SizeFlexEligible":{"shape":"GenericBoolean"}
|
||||
}
|
||||
},
|
||||
"RedshiftInstanceDetails":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Family":{"shape":"GenericString"},
|
||||
"NodeType":{"shape":"GenericString"},
|
||||
"Region":{"shape":"GenericString"},
|
||||
"CurrentGeneration":{"shape":"GenericBoolean"},
|
||||
"SizeFlexEligible":{"shape":"GenericBoolean"}
|
||||
}
|
||||
},
|
||||
"RequestChangedException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"ReservationAggregates":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"UtilizationPercentage":{"shape":"UtilizationPercentage"},
|
||||
"UtilizationPercentageInUnits":{"shape":"UtilizationPercentageInUnits"},
|
||||
"PurchasedHours":{"shape":"PurchasedHours"},
|
||||
"PurchasedUnits":{"shape":"PurchasedUnits"},
|
||||
"TotalActualHours":{"shape":"TotalActualHours"},
|
||||
"UnusedHours":{"shape":"UnusedHours"}
|
||||
"TotalActualUnits":{"shape":"TotalActualUnits"},
|
||||
"UnusedHours":{"shape":"UnusedHours"},
|
||||
"UnusedUnits":{"shape":"UnusedUnits"},
|
||||
"OnDemandCostOfRIHoursUsed":{"shape":"OnDemandCostOfRIHoursUsed"},
|
||||
"NetRISavings":{"shape":"NetRISavings"},
|
||||
"TotalPotentialRISavings":{"shape":"TotalPotentialRISavings"},
|
||||
"AmortizedUpfrontFee":{"shape":"AmortizedUpfrontFee"},
|
||||
"AmortizedRecurringFee":{"shape":"AmortizedRecurringFee"},
|
||||
"TotalAmortizedFee":{"shape":"TotalAmortizedFee"}
|
||||
}
|
||||
},
|
||||
"ReservationCoverageGroup":{
|
||||
@@ -536,6 +744,7 @@
|
||||
"ReservationPurchaseRecommendationDetail":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AccountId":{"shape":"GenericString"},
|
||||
"InstanceDetails":{"shape":"InstanceDetails"},
|
||||
"RecommendedNumberOfInstancesToPurchase":{"shape":"GenericString"},
|
||||
"RecommendedNormalizedUnitsToPurchase":{"shape":"GenericString"},
|
||||
@@ -593,6 +802,7 @@
|
||||
"member":{"shape":"ReservationUtilizationGroup"}
|
||||
},
|
||||
"ReservedHours":{"type":"string"},
|
||||
"ReservedNormalizedUnits":{"type":"string"},
|
||||
"ResultByTime":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -633,8 +843,20 @@
|
||||
]
|
||||
},
|
||||
"TotalActualHours":{"type":"string"},
|
||||
"TotalActualUnits":{"type":"string"},
|
||||
"TotalAmortizedFee":{"type":"string"},
|
||||
"TotalPotentialRISavings":{"type":"string"},
|
||||
"TotalRunningHours":{"type":"string"},
|
||||
"TotalRunningNormalizedUnits":{"type":"string"},
|
||||
"UnresolvableUsageUnitException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"UnusedHours":{"type":"string"},
|
||||
"UnusedUnits":{"type":"string"},
|
||||
"UtilizationByTime":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -644,6 +866,7 @@
|
||||
}
|
||||
},
|
||||
"UtilizationPercentage":{"type":"string"},
|
||||
"UtilizationPercentageInUnits":{"type":"string"},
|
||||
"UtilizationsByTime":{
|
||||
"type":"list",
|
||||
"member":{"shape":"UtilizationByTime"}
|
||||
@@ -655,7 +878,7 @@
|
||||
},
|
||||
"YearMonthDay":{
|
||||
"type":"string",
|
||||
"pattern":"\\d{4}-\\d{2}-\\d{2}"
|
||||
"pattern":"(\\d{4}-\\d{2}-\\d{2})(T\\d{2}:\\d{2}:\\d{2}Z)?"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+290
-64
@@ -1,22 +1,36 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<p>The Cost Explorer API allows you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for DynamoDB database tables in your production environment. </p> <p>Service Endpoint</p> <p>The Cost Explorer API provides the following endpoint:</p> <ul> <li> <p>https://ce.us-east-1.amazonaws.com</p> </li> </ul>",
|
||||
"service": "<p>The Cost Explorer API enables you to programmatically query your cost and usage data. You can query for aggregated data such as total monthly costs or total daily usage. You can also query for granular data, such as the number of daily write operations for Amazon DynamoDB database tables in your production environment. </p> <p>Service Endpoint</p> <p>The Cost Explorer API provides the following endpoint:</p> <ul> <li> <p> <code>https://ce.us-east-1.amazonaws.com</code> </p> </li> </ul> <p>For information about costs associated with the Cost Explorer API, see <a href=\"https://aws.amazon.com/aws-cost-management/pricing/\">AWS Cost Management Pricing</a>.</p>",
|
||||
"operations": {
|
||||
"GetCostAndUsage": "<p>Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as <code>BlendedCosts</code> or <code>UsageQuantity</code>, that you want the request to return. You can also filter and group your data by various dimensions, such as <code>SERVICE</code> or <code>AZ</code>, in a specific time range. For a complete list of valid dimensions, see the <code> <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html\">GetDimensionValues</a> </code> operation. Master accounts in an organization in AWS Organizations have access to all member accounts.</p>",
|
||||
"GetDimensionValues": "<p>Retrieves all available filter values for a specific filter over a period of time. You can search the dimension values for an arbitrary string. </p>",
|
||||
"GetReservationCoverage": "<p>Retrieves the reservation coverage for your account. This allows you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's master account can see the coverage of the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>TENANCY</p> </li> </ul> <p>To determine valid values for a dimension, use the <code>GetDimensionValues</code> operation. </p>",
|
||||
"GetReservationPurchaseRecommendation": "<p>Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.</p> <p>AWS generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After AWS has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings. </p> <p>For example, AWS automatically aggregates your EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for <code>c4.large</code>, because that is the smallest size instance in the c4 instance family.</p>",
|
||||
"GetReservationUtilization": "<p>You can retrieve the reservation utilization for your account. Master accounts in an organization in AWS Organizations have access to their associated member accounts. You can filter data by dimensions in a time period. You can use <code>GetDimensionValues</code> to determine the possible dimension values. Currently, you can group only by <code>SUBSCRIPTION_ID</code>. </p>",
|
||||
"GetTags": "<p>You can query for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string. </p>"
|
||||
"GetCostAndUsage": "<p>Retrieves cost and usage metrics for your account. You can specify which cost and usage-related metric, such as <code>BlendedCosts</code> or <code>UsageQuantity</code>, that you want the request to return. You can also filter and group your data by various dimensions, such as <code>SERVICE</code> or <code>AZ</code>, in a specific time range. For a complete list of valid dimensions, see the <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_GetDimensionValues.html\">GetDimensionValues</a> operation. Master accounts in an organization in AWS Organizations have access to all member accounts.</p>",
|
||||
"GetCostForecast": "<p>Retrieves a forecast for how much Amazon Web Services predicts that you will spend over the forecast time period that you select, based on your past costs. </p>",
|
||||
"GetDimensionValues": "<p>Retrieves all available filter values for a specified filter over a period of time. You can search the dimension values for an arbitrary string. </p>",
|
||||
"GetReservationCoverage": "<p>Retrieves the reservation coverage for your account. This enables you to see how much of your Amazon Elastic Compute Cloud, Amazon ElastiCache, Amazon Relational Database Service, or Amazon Redshift usage is covered by a reservation. An organization's master account can see the coverage of the associated member accounts. For any time period, you can filter data about reservation usage by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>TAG</p> </li> <li> <p>TENANCY</p> </li> </ul> <p>To determine valid values for a dimension, use the <code>GetDimensionValues</code> operation. </p>",
|
||||
"GetReservationPurchaseRecommendation": "<p>Gets recommendations for which reservations to purchase. These recommendations could help you reduce your costs. Reservations provide a discounted hourly rate (up to 75%) compared to On-Demand pricing.</p> <p>AWS generates your recommendations by identifying your On-Demand usage during a specific time period and collecting your usage into categories that are eligible for a reservation. After AWS has these categories, it simulates every combination of reservations in each category of usage to identify the best number of each type of RI to purchase to maximize your estimated savings. </p> <p>For example, AWS automatically aggregates your Amazon EC2 Linux, shared tenancy, and c4 family usage in the US West (Oregon) Region and recommends that you buy size-flexible regional reservations to apply to the c4 family usage. AWS recommends the smallest size instance in an instance family. This makes it easier to purchase a size-flexible RI. AWS also shows the equal number of normalized units so that you can purchase any instance size that you want. For this example, your RI recommendation would be for <code>c4.large</code> because that is the smallest size instance in the c4 instance family.</p>",
|
||||
"GetReservationUtilization": "<p>Retrieves the reservation utilization for your account. Master accounts in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use <code>GetDimensionValues</code> to determine the possible dimension values. Currently, you can group only by <code>SUBSCRIPTION_ID</code>. </p>",
|
||||
"GetTags": "<p>Queries for available tag keys and tag values for a specified period. You can search the tag values for an arbitrary string. </p>",
|
||||
"GetUsageForecast": "<p>Retrieves a forecast for how much Amazon Web Services predicts that you will use over the forecast time period that you select, based on your past usage. </p>"
|
||||
},
|
||||
"shapes": {
|
||||
"AccountScope": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetReservationPurchaseRecommendationRequest$AccountScope": "<p>The account scope that you want recommendations for. The only valid value is <code>Payer</code>. This means that AWS includes the master account and any member accounts when it calculates its recommendations.</p>",
|
||||
"GetReservationPurchaseRecommendationRequest$AccountScope": "<p>The account scope that you want recommendations for. <code>PAYER</code> means that AWS includes the master account and any member accounts when it calculates its recommendations. <code>LINKED</code> means that AWS includes only member accounts when it calculates its recommendations.</p> <p>Valid values are <code>PAYER</code> and <code>LINKED</code>.</p>",
|
||||
"ReservationPurchaseRecommendation$AccountScope": "<p>The account scope that AWS recommends that you purchase this instance for. For example, you can purchase this reservation for an entire organization in AWS Organizations.</p>"
|
||||
}
|
||||
},
|
||||
"AmortizedRecurringFee": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ReservationAggregates$AmortizedRecurringFee": "<p>The monthly cost of your reservation, amortized over the reservation period.</p>"
|
||||
}
|
||||
},
|
||||
"AmortizedUpfrontFee": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ReservationAggregates$AmortizedUpfrontFee": "<p>The upfront cost of your reservation, amortized over the reservation period.</p>"
|
||||
}
|
||||
},
|
||||
"AttributeType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -34,7 +48,7 @@
|
||||
"refs": {
|
||||
"DimensionValuesWithAttributes$Attributes": "<p>The attribute that applies to a specific <code>Dimension</code>.</p>",
|
||||
"ReservationCoverageGroup$Attributes": "<p>The attributes for this group of reservations.</p>",
|
||||
"ReservationUtilizationGroup$Attributes": "<p>The attributes for this group of RIs.</p>"
|
||||
"ReservationUtilizationGroup$Attributes": "<p>The attributes for this group of reservations.</p>"
|
||||
}
|
||||
},
|
||||
"BillExpirationException": {
|
||||
@@ -45,14 +59,14 @@
|
||||
"Context": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetDimensionValuesRequest$Context": "<p>The context for the call to <code>GetDimensionValues</code>. This can be <code>RESERVATIONS</code> or <code>COST_AND_USAGE</code>. The default value is <code>COST_AND_USAGE</code>. If the context is set to <code>RESERVATIONS</code>, the resulting dimension values can be used in the <code>GetReservationUtilization</code> operation. If the context is set to <code>COST_AND_USAGE</code> the resulting dimension values can be used in the <code>GetCostAndUsage</code> operation.</p> <p>If you set the context to <code>CostAndUsage</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>INSTANCE_TYPE - The type of instance. An example is an EC2 <code>m4.xlarge</code>.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>OPERATION - The action performed. Examples include <code>RunInstance</code> and <code>CreateBucket</code>.</p> </li> <li> <p>PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.</p> </li> <li> <p>SERVICE - The AWS service such as DynamoDB.</p> </li> <li> <p>USAGE_TYPE - The type of usage. An example is <code>DataTransfer-In-Bytes</code>. The response for the <code>GetDimensionValues</code> operation includes a unit attribute, examples of which include GB and Hrs.</p> </li> <li> <p>USAGE_TYPE_GROUP - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.</p> </li> <li> <p>RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.</p> </li> </ul> <p>If you set the context to <code>RESERVATIONS</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>INSTANCE_TYPE - The type of instance. An example is an EC2 <code>m4.xlarge</code>.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>PLATFORM - The specific combination of operating system, license model, and software on an instance. For example, a Windows instance with SQL Server Web and no license, or a Red Hat Enterprise Linux instance.</p> </li> <li> <p>REGION - The AWS Region.</p> </li> <li> <p>SCOPE - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.</p> </li> <li> <p>TENANCY - The tenancy of a resource. Examples are shared or dedicated.</p> </li> </ul>"
|
||||
"GetDimensionValuesRequest$Context": "<p>The context for the call to <code>GetDimensionValues</code>. This can be <code>RESERVATIONS</code> or <code>COST_AND_USAGE</code>. The default value is <code>COST_AND_USAGE</code>. If the context is set to <code>RESERVATIONS</code>, the resulting dimension values can be used in the <code>GetReservationUtilization</code> operation. If the context is set to <code>COST_AND_USAGE</code>, the resulting dimension values can be used in the <code>GetCostAndUsage</code> operation.</p> <p>If you set the context to <code>COST_AND_USAGE</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.</p> </li> <li> <p>INSTANCE_TYPE - The type of Amazon EC2 instance. An example is <code>m4.xlarge</code>.</p> </li> <li> <p>LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.</p> </li> <li> <p>OPERATION - The action performed. Examples include <code>RunInstance</code> and <code>CreateBucket</code>.</p> </li> <li> <p>PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.</p> </li> <li> <p>PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.</p> </li> <li> <p>SERVICE - The AWS service such as Amazon DynamoDB.</p> </li> <li> <p>USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the <code>GetDimensionValues</code> operation includes a unit attribute. Examples include GB and Hrs.</p> </li> <li> <p>USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.</p> </li> <li> <p>RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.</p> </li> </ul> <p>If you set the context to <code>RESERVATIONS</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.</p> </li> <li> <p>DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are <code>SingleAZ</code> and <code>MultiAZ</code>.</p> </li> <li> <p>INSTANCE_TYPE - The type of Amazon EC2 instance. An example is <code>m4.xlarge</code>.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.</p> </li> <li> <p>REGION - The AWS Region.</p> </li> <li> <p>SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.</p> </li> <li> <p>TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).</p> </li> <li> <p>TENANCY - The tenancy of a resource. Examples are shared or dedicated.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"Coverage": {
|
||||
"base": "<p>The amount of instance usage that a reservation covered.</p>",
|
||||
"refs": {
|
||||
"CoverageByTime$Total": "<p>The total reservation coverage, in hours.</p>",
|
||||
"GetReservationCoverageResponse$Total": "<p>The total amount of instance usage that is covered by a reservation.</p>",
|
||||
"GetReservationCoverageResponse$Total": "<p>The total amount of instance usage that a reservation covered.</p>",
|
||||
"ReservationCoverageGroup$Coverage": "<p>How much instance usage this group of reservations covered.</p>"
|
||||
}
|
||||
},
|
||||
@@ -62,16 +76,34 @@
|
||||
"CoveragesByTime$member": null
|
||||
}
|
||||
},
|
||||
"CoverageCost": {
|
||||
"base": "<p>How much it cost to run an instance.</p>",
|
||||
"refs": {
|
||||
"Coverage$CoverageCost": "<p>The amount of cost that the reservation covered.</p>"
|
||||
}
|
||||
},
|
||||
"CoverageHours": {
|
||||
"base": "<p>How long a running instance either used a reservation or was On-Demand.</p>",
|
||||
"refs": {
|
||||
"Coverage$CoverageHours": "<p>The amount of instance usage that a reservation covered, in hours.</p>"
|
||||
"Coverage$CoverageHours": "<p>The amount of instance usage that the reservation covered, in hours.</p>"
|
||||
}
|
||||
},
|
||||
"CoverageHoursPercentage": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CoverageHours$CoverageHoursPercentage": "<p>The percentage of instance hours that are covered by a reservation.</p>"
|
||||
"CoverageHours$CoverageHoursPercentage": "<p>The percentage of instance hours that a reservation covered.</p>"
|
||||
}
|
||||
},
|
||||
"CoverageNormalizedUnits": {
|
||||
"base": "<p>The amount of instance usage, in normalized units. Normalized units enable you to see your EC2 usage for multiple sizes of instances in a uniform way. For example, suppose you run an xlarge instance and a 2xlarge instance. If you run both instances for the same amount of time, the 2xlarge instance uses twice as much of your reservation as the xlarge instance, even though both instances show only one instance-hour. Using normalized units instead of instance-hours, the xlarge instance used 8 normalized units, and the 2xlarge instance used 16 normalized units.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html\">Modifying Reserved Instances</a> in the <i>Amazon Elastic Compute Cloud User Guide for Linux Instances</i>.</p>",
|
||||
"refs": {
|
||||
"Coverage$CoverageNormalizedUnits": "<p>The amount of instance usage that the reservation covered, in normalized units.</p>"
|
||||
}
|
||||
},
|
||||
"CoverageNormalizedUnitsPercentage": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CoverageNormalizedUnits$CoverageNormalizedUnitsPercentage": "<p>The percentage of your used instance normalized units that a reservation covers.</p>"
|
||||
}
|
||||
},
|
||||
"CoveragesByTime": {
|
||||
@@ -88,21 +120,24 @@
|
||||
"DateInterval": {
|
||||
"base": "<p>The time period that you want the usage and costs for. </p>",
|
||||
"refs": {
|
||||
"CoverageByTime$TimePeriod": "<p>The period over which this coverage was used.</p>",
|
||||
"CoverageByTime$TimePeriod": "<p>The period that this coverage was used over.</p>",
|
||||
"ForecastResult$TimePeriod": "<p>The period of time that the forecast covers.</p>",
|
||||
"GetCostAndUsageRequest$TimePeriod": "<p>Sets the start and end dates for retrieving AWS costs. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>.</p>",
|
||||
"GetCostForecastRequest$TimePeriod": "<p>The period of time that you want the forecast to cover.</p>",
|
||||
"GetDimensionValuesRequest$TimePeriod": "<p>The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>.</p>",
|
||||
"GetReservationCoverageRequest$TimePeriod": "<p>The start and end dates of the period for which you want to retrieve data about reservation coverage. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. </p>",
|
||||
"GetReservationUtilizationRequest$TimePeriod": "<p>Sets the start and end dates for retrieving reserve instance (RI) utilization. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. </p>",
|
||||
"GetReservationCoverageRequest$TimePeriod": "<p>The start and end dates of the period that you want to retrieve data about reservation coverage for. You can retrieve data for a maximum of 13 months: the last 12 months and the current month. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. </p>",
|
||||
"GetReservationUtilizationRequest$TimePeriod": "<p>Sets the start and end dates for retrieving RI utilization. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>. </p>",
|
||||
"GetTagsRequest$TimePeriod": "<p>The start and end dates for retrieving the dimension values. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>.</p>",
|
||||
"ResultByTime$TimePeriod": "<p>The time period covered by a result.</p>",
|
||||
"UtilizationByTime$TimePeriod": "<p>The period of time over which this utilization was used.</p>"
|
||||
"GetUsageForecastRequest$TimePeriod": "<p>The start and end dates of the period that you want to retrieve usage forecast for. The start date is inclusive, but the end date is exclusive. For example, if <code>start</code> is <code>2017-01-01</code> and <code>end</code> is <code>2017-05-01</code>, then the cost and usage data is retrieved from <code>2017-01-01</code> up to and including <code>2017-04-30</code> but not including <code>2017-05-01</code>.</p>",
|
||||
"ResultByTime$TimePeriod": "<p>The time period that the result covers.</p>",
|
||||
"UtilizationByTime$TimePeriod": "<p>The period of time that this utilization was used for.</p>"
|
||||
}
|
||||
},
|
||||
"Dimension": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DimensionValues$Key": "<p>The names of the metadata types that you can use to filter and group your results. For example, <code>AZ</code> returns a list of Availability Zones.</p>",
|
||||
"GetDimensionValuesRequest$Dimension": "<p>The name of the dimension. Each <code>Dimension</code> is available for different a <code>Context</code>. For more information, see <code>Context</code>.</p>"
|
||||
"GetDimensionValuesRequest$Dimension": "<p>The name of the dimension. Each <code>Dimension</code> is available for a different <code>Context</code>. For more information, see <code>Context</code>.</p>"
|
||||
}
|
||||
},
|
||||
"DimensionValues": {
|
||||
@@ -120,19 +155,31 @@
|
||||
"DimensionValuesWithAttributesList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetDimensionValuesResponse$DimensionValues": "<p>The filters that you used to filter your request. Some dimensions are available only for a specific context:</p> <p>If you set the context to <code>CostAndUsage</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>INSTANCE_TYPE - The type of instance. An example is an EC2 <code>m4.xlarge</code>.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>OPERATION - The action performed. Examples include <code>RunInstance</code> and <code>CreateBucket</code>.</p> </li> <li> <p>PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.</p> </li> <li> <p>SERVICE - The AWS service such as DynamoDB.</p> </li> <li> <p>USAGE_TYPE - The type of usage. An example is <code>DataTransfer-In-Bytes</code>. The response for the <code>GetDimensionValues</code> operation includes a unit attribute, examples of which include GB and Hrs.</p> </li> <li> <p>USAGE_TYPE_GROUP - The grouping of common usage types. An example is EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.</p> </li> <li> <p>RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.</p> </li> </ul> <p>If you set the context to <code>RESERVATIONS</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>INSTANCE_TYPE - The type of instance. An example is an EC2 <code>m4.xlarge</code>.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>PLATFORM - The specific combination of operating system, license model, and software on an instance. For example, a Windows instance with SQL Server Web and no license, or a Red Hat Enterprise Linux instance.</p> </li> <li> <p>REGION - The AWS Region.</p> </li> <li> <p>SCOPE - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.</p> </li> <li> <p>TENANCY - The tenancy of a resource. Examples are shared or dedicated.</p> </li> </ul>"
|
||||
"GetDimensionValuesResponse$DimensionValues": "<p>The filters that you used to filter your request. Some dimensions are available only for a specific context.</p> <p>If you set the context to <code>COST_AND_USAGE</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>DATABASE_ENGINE - The Amazon Relational Database Service database. Examples are Aurora or MySQL.</p> </li> <li> <p>INSTANCE_TYPE - The type of Amazon EC2 instance. An example is <code>m4.xlarge</code>.</p> </li> <li> <p>LEGAL_ENTITY_NAME - The name of the organization that sells you AWS services, such as Amazon Web Services.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>OPERATING_SYSTEM - The operating system. Examples are Windows or Linux.</p> </li> <li> <p>OPERATION - The action performed. Examples include <code>RunInstance</code> and <code>CreateBucket</code>.</p> </li> <li> <p>PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.</p> </li> <li> <p>PURCHASE_TYPE - The reservation type of the purchase to which this usage is related. Examples include On-Demand Instances and Standard Reserved Instances.</p> </li> <li> <p>SERVICE - The AWS service such as Amazon DynamoDB.</p> </li> <li> <p>USAGE_TYPE - The type of usage. An example is DataTransfer-In-Bytes. The response for the <code>GetDimensionValues</code> operation includes a unit attribute. Examples include GB and Hrs.</p> </li> <li> <p>USAGE_TYPE_GROUP - The grouping of common usage types. An example is Amazon EC2: CloudWatch – Alarms. The response for this operation includes a unit attribute.</p> </li> <li> <p>RECORD_TYPE - The different types of charges such as RI fees, usage costs, tax refunds, and credits.</p> </li> </ul> <p>If you set the context to <code>RESERVATIONS</code>, you can use the following dimensions for searching:</p> <ul> <li> <p>AZ - The Availability Zone. An example is <code>us-east-1a</code>.</p> </li> <li> <p>CACHE_ENGINE - The Amazon ElastiCache operating system. Examples are Windows or Linux.</p> </li> <li> <p>DEPLOYMENT_OPTION - The scope of Amazon Relational Database Service deployments. Valid values are <code>SingleAZ</code> and <code>MultiAZ</code>.</p> </li> <li> <p>INSTANCE_TYPE - The type of Amazon EC2 instance. An example is <code>m4.xlarge</code>.</p> </li> <li> <p>LINKED_ACCOUNT - The description in the attribute map that includes the full name of the member account. The value field contains the AWS ID of the member account.</p> </li> <li> <p>PLATFORM - The Amazon EC2 operating system. Examples are Windows or Linux.</p> </li> <li> <p>REGION - The AWS Region.</p> </li> <li> <p>SCOPE (Utilization only) - The scope of a Reserved Instance (RI). Values are regional or a single Availability Zone.</p> </li> <li> <p>TAG (Coverage only) - The tags that are associated with a Reserved Instance (RI).</p> </li> <li> <p>TENANCY - The tenancy of a resource. Examples are shared or dedicated.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"EC2InstanceDetails": {
|
||||
"base": "<p>Details about the EC2 instances that AWS recommends that you purchase.</p>",
|
||||
"base": "<p>Details about the Amazon EC2 instances that AWS recommends that you purchase.</p>",
|
||||
"refs": {
|
||||
"InstanceDetails$EC2InstanceDetails": "<p>The EC2 instances that AWS recommends that you purchase.</p>"
|
||||
"InstanceDetails$EC2InstanceDetails": "<p>The Amazon EC2 instances that AWS recommends that you purchase.</p>"
|
||||
}
|
||||
},
|
||||
"EC2Specification": {
|
||||
"base": "<p>The EC2 hardware specifications that you want AWS to provide recommendations for.</p>",
|
||||
"base": "<p>The Amazon EC2 hardware specifications that you want AWS to provide recommendations for.</p>",
|
||||
"refs": {
|
||||
"ServiceSpecification$EC2Specification": "<p>The EC2 hardware specifications that you want AWS to provide recommendations for.</p>"
|
||||
"ServiceSpecification$EC2Specification": "<p>The Amazon EC2 hardware specifications that you want AWS to provide recommendations for.</p>"
|
||||
}
|
||||
},
|
||||
"ESInstanceDetails": {
|
||||
"base": "<p>Details about the Amazon ES instances that AWS recommends that you purchase.</p>",
|
||||
"refs": {
|
||||
"InstanceDetails$ESInstanceDetails": "<p>The Amazon ES instances that AWS recommends that you purchase.</p>"
|
||||
}
|
||||
},
|
||||
"ElastiCacheInstanceDetails": {
|
||||
"base": "<p>Details about the Amazon ElastiCache instances that AWS recommends that you purchase.</p>",
|
||||
"refs": {
|
||||
"InstanceDetails$ElastiCacheInstanceDetails": "<p>The ElastiCache instances that AWS recommends that you purchase.</p>"
|
||||
}
|
||||
},
|
||||
"Entity": {
|
||||
@@ -147,23 +194,27 @@
|
||||
"BillExpirationException$Message": null,
|
||||
"DataUnavailableException$Message": null,
|
||||
"InvalidNextTokenException$Message": null,
|
||||
"LimitExceededException$Message": null
|
||||
"LimitExceededException$Message": null,
|
||||
"RequestChangedException$Message": null,
|
||||
"UnresolvableUsageUnitException$Message": null
|
||||
}
|
||||
},
|
||||
"Estimated": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ResultByTime$Estimated": "<p>Whether this result is estimated.</p>"
|
||||
"ResultByTime$Estimated": "<p>Whether the result is estimated.</p>"
|
||||
}
|
||||
},
|
||||
"Expression": {
|
||||
"base": "<p>Use <code>Expression</code> to filter by cost or by usage. There are two patterns: </p> <ul> <li> <p>Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for <code>INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large</code>. The <code>Expression</code> for that looks like this:</p> <p> <code>{ \"Dimensions\": { \"Key\": \"INSTANCE_TYPE\", \"Values\": [ \"m4.xlarge\", “c4.large” ] } }</code> </p> <p>The list of dimension values are OR'd together to retrieve cost or usage data. You can create <code>Expression</code> and <code>DimensionValues</code> objects using either <code>with*</code> methods or <code>set*</code> methods in multiple lines. </p> </li> <li> <p>Compound dimension values with logical operations - You can use multiple <code>Expression</code> types and the logical operators <code>AND/OR/NOT</code> to create a list of one or more <code>Expression</code> objects. This allows you to filter on more advanced options. For example, you can filter on <code>((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)</code>. The <code>Expression</code> for that looks like this:</p> <p> <code>{ \"And\": [ {\"Or\": [ {\"Dimensions\": { \"Key\": \"INSTANCE_TYPE\", \"Values\": [ \"m4.x.large\", \"c4.large\" ] }}, {\"Tag\": { \"Key\": \"TagName\", \"Values\": [\"Value1\"] } } ]}, {\"Not\": {\"dimensions\": { \"Key\": \"USAGE_TYPE\", \"Values\": [\"DataTransfer\"] }}} ] } </code> </p> <note> <p>Because each <code>Expression</code> can have only one operator, the service returns an error if more than one is specified. The following example shows an <code>Expression</code> object that creates an error.</p> </note> <p> <code> { \"And\": [ ... ], \"DimensionValues\": { \"Dimension\": \"USAGE_TYPE\", \"Values\": [ \"DataTransfer\" ] } } </code> </p> </li> </ul>",
|
||||
"base": "<p>Use <code>Expression</code> to filter by cost or by usage. There are two patterns: </p> <ul> <li> <p>Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for <code>INSTANCE_TYPE==m4.xlarge OR INSTANCE_TYPE==c4.large</code>. The <code>Expression</code> for that looks like this:</p> <p> <code>{ \"Dimensions\": { \"Key\": \"INSTANCE_TYPE\", \"Values\": [ \"m4.xlarge\", “c4.large” ] } }</code> </p> <p>The list of dimension values are OR'd together to retrieve cost or usage data. You can create <code>Expression</code> and <code>DimensionValues</code> objects using either <code>with*</code> methods or <code>set*</code> methods in multiple lines. </p> </li> <li> <p>Compound dimension values with logical operations - You can use multiple <code>Expression</code> types and the logical operators <code>AND/OR/NOT</code> to create a list of one or more <code>Expression</code> objects. This allows you to filter on more advanced options. For example, you can filter on <code>((INSTANCE_TYPE == m4.large OR INSTANCE_TYPE == m3.large) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer)</code>. The <code>Expression</code> for that looks like this:</p> <p> <code>{ \"And\": [ {\"Or\": [ {\"Dimensions\": { \"Key\": \"INSTANCE_TYPE\", \"Values\": [ \"m4.x.large\", \"c4.large\" ] }}, {\"Tags\": { \"Key\": \"TagName\", \"Values\": [\"Value1\"] } } ]}, {\"Not\": {\"Dimensions\": { \"Key\": \"USAGE_TYPE\", \"Values\": [\"DataTransfer\"] }}} ] } </code> </p> <note> <p>Because each <code>Expression</code> can have only one operator, the service returns an error if more than one is specified. The following example shows an <code>Expression</code> object that creates an error.</p> </note> <p> <code> { \"And\": [ ... ], \"DimensionValues\": { \"Dimension\": \"USAGE_TYPE\", \"Values\": [ \"DataTransfer\" ] } } </code> </p> </li> </ul>",
|
||||
"refs": {
|
||||
"Expression$Not": "<p>Return results that don't match a <code>Dimension</code> object.</p>",
|
||||
"Expressions$member": null,
|
||||
"GetCostAndUsageRequest$Filter": "<p>Filters AWS costs by different dimensions. For example, you can specify <code>SERVICE</code> and <code>LINKED_ACCOUNT</code> and get the costs that are associated with that account's usage of that service. You can nest <code>Expression</code> objects to define any combination of dimension filters. For more information, see <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a>. </p>",
|
||||
"GetReservationCoverageRequest$Filter": "<p>Filters utilization data by dimensions. You can filter by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>TENANCY</p> </li> </ul> <p> <code>GetReservationCoverage</code> uses the same <code> <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> </code> object as the other operations, but only <code>AND</code> is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.</p>",
|
||||
"GetReservationUtilizationRequest$Filter": "<p>Filters utilization data by using different dimensions. <code>GetReservationUtilization</code> uses the same <code> <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> </code> object as the other operations, but only <code>AND</code> is supported among each dimension, and nesting is supported to only one level deep. If there are multiple values for a dimension, they are OR'd together.</p>"
|
||||
"GetCostForecastRequest$Filter": "<p>The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.</p>",
|
||||
"GetReservationCoverageRequest$Filter": "<p>Filters utilization data by dimensions. You can filter by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>TAG</p> </li> <li> <p>TENANCY</p> </li> </ul> <p> <code>GetReservationCoverage</code> uses the same <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> object as the other operations, but only <code>AND</code> is supported among each dimension. You can nest only one level deep. If there are multiple values for a dimension, they are OR'd together.</p> <p>If you don't provide a <code>SERVICE</code> filter, Cost Explorer defaults to EC2.</p>",
|
||||
"GetReservationUtilizationRequest$Filter": "<p>Filters utilization data by dimensions. You can filter by the following dimensions:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>SERVICE</p> </li> <li> <p>SCOPE</p> </li> <li> <p>TENANCY</p> </li> </ul> <p> <code>GetReservationUtilization</code> uses the same <a href=\"http://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> object as the other operations, but only <code>AND</code> is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR'd together.</p>",
|
||||
"GetUsageForecastRequest$Filter": "<p>The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.</p>"
|
||||
}
|
||||
},
|
||||
"Expressions": {
|
||||
@@ -173,11 +224,32 @@
|
||||
"Expression$And": "<p>Return results that match both <code>Dimension</code> objects.</p>"
|
||||
}
|
||||
},
|
||||
"ForecastResult": {
|
||||
"base": "<p>The forecast created for your query.</p>",
|
||||
"refs": {
|
||||
"ForecastResultsByTime$member": null
|
||||
}
|
||||
},
|
||||
"ForecastResultsByTime": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetCostForecastResponse$ForecastResultsByTime": "<p>The forecasts for your query, in order. For <code>DAILY</code> forecasts, this is a list of days. For <code>MONTHLY</code> forecasts, this is a list of months.</p>",
|
||||
"GetUsageForecastResponse$ForecastResultsByTime": "<p>The forecasts for your query, in order. For <code>DAILY</code> forecasts, this is a list of days. For <code>MONTHLY</code> forecasts, this is a list of months.</p>"
|
||||
}
|
||||
},
|
||||
"GenericBoolean": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"EC2InstanceDetails$CurrentGeneration": "<p>Whether the recommendation is for a current generation instance. </p>",
|
||||
"EC2InstanceDetails$SizeFlexEligible": "<p>Whether the recommended reservation is size flexible.</p>"
|
||||
"EC2InstanceDetails$CurrentGeneration": "<p>Whether the recommendation is for a current-generation instance. </p>",
|
||||
"EC2InstanceDetails$SizeFlexEligible": "<p>Whether the recommended reservation is size flexible.</p>",
|
||||
"ESInstanceDetails$CurrentGeneration": "<p>Whether the recommendation is for a current-generation instance.</p>",
|
||||
"ESInstanceDetails$SizeFlexEligible": "<p>Whether the recommended reservation is size flexible.</p>",
|
||||
"ElastiCacheInstanceDetails$CurrentGeneration": "<p>Whether the recommendation is for a current generation instance.</p>",
|
||||
"ElastiCacheInstanceDetails$SizeFlexEligible": "<p>Whether the recommended reservation is size flexible.</p>",
|
||||
"RDSInstanceDetails$CurrentGeneration": "<p>Whether the recommendation is for a current-generation instance. </p>",
|
||||
"RDSInstanceDetails$SizeFlexEligible": "<p>Whether the recommended reservation is size flexible.</p>",
|
||||
"RedshiftInstanceDetails$CurrentGeneration": "<p>Whether the recommendation is for a current-generation instance.</p>",
|
||||
"RedshiftInstanceDetails$SizeFlexEligible": "<p>Whether the recommended reservation is size flexible.</p>"
|
||||
}
|
||||
},
|
||||
"GenericString": {
|
||||
@@ -189,12 +261,33 @@
|
||||
"EC2InstanceDetails$AvailabilityZone": "<p>The Availability Zone of the recommended reservation.</p>",
|
||||
"EC2InstanceDetails$Platform": "<p>The platform of the recommended reservation. The platform is the specific combination of operating system, license model, and software on an instance.</p>",
|
||||
"EC2InstanceDetails$Tenancy": "<p>Whether the recommended reservation is dedicated or shared.</p>",
|
||||
"ESInstanceDetails$InstanceClass": "<p>The class of instance that AWS recommends.</p>",
|
||||
"ESInstanceDetails$InstanceSize": "<p>The size of instance that AWS recommends.</p>",
|
||||
"ESInstanceDetails$Region": "<p>The AWS Region of the recommended reservation.</p>",
|
||||
"ElastiCacheInstanceDetails$Family": "<p>The instance family of the recommended reservation.</p>",
|
||||
"ElastiCacheInstanceDetails$NodeType": "<p>The type of node that AWS recommends.</p>",
|
||||
"ElastiCacheInstanceDetails$Region": "<p>The AWS Region of the recommended reservation.</p>",
|
||||
"ElastiCacheInstanceDetails$ProductDescription": "<p>The description of the recommended reservation.</p>",
|
||||
"ForecastResult$MeanValue": "<p>The mean value of the forecast.</p>",
|
||||
"ForecastResult$PredictionIntervalLowerBound": "<p>The lower limit for the prediction interval. </p>",
|
||||
"ForecastResult$PredictionIntervalUpperBound": "<p>The upper limit for the prediction interval. </p>",
|
||||
"GetReservationPurchaseRecommendationRequest$AccountId": "<p>The account ID that is associated with the recommendation. </p>",
|
||||
"GetReservationPurchaseRecommendationRequest$Service": "<p>The specific service that you want recommendations for.</p>",
|
||||
"RDSInstanceDetails$Family": "<p>The instance family of the recommended reservation.</p>",
|
||||
"RDSInstanceDetails$InstanceType": "<p>The type of instance that AWS recommends.</p>",
|
||||
"RDSInstanceDetails$Region": "<p>The AWS Region of the recommended reservation.</p>",
|
||||
"RDSInstanceDetails$DatabaseEngine": "<p>The database engine that the recommended reservation supports.</p>",
|
||||
"RDSInstanceDetails$DatabaseEdition": "<p>The database edition that the recommended reservation supports.</p>",
|
||||
"RDSInstanceDetails$DeploymentOption": "<p>Whether the recommendation is for a reservation in a single Availability Zone or a reservation with a backup in a second Availability Zone.</p>",
|
||||
"RDSInstanceDetails$LicenseModel": "<p>The license model that the recommended reservation supports.</p>",
|
||||
"RedshiftInstanceDetails$Family": "<p>The instance family of the recommended reservation.</p>",
|
||||
"RedshiftInstanceDetails$NodeType": "<p>The type of node that AWS recommends.</p>",
|
||||
"RedshiftInstanceDetails$Region": "<p>The AWS Region of the recommended reservation.</p>",
|
||||
"ReservationPurchaseRecommendationDetail$AccountId": "<p>The account that this RI recommendation is for.</p>",
|
||||
"ReservationPurchaseRecommendationDetail$RecommendedNumberOfInstancesToPurchase": "<p>The number of instances that AWS recommends that you purchase.</p>",
|
||||
"ReservationPurchaseRecommendationDetail$RecommendedNormalizedUnitsToPurchase": "<p>The number of normalized units that AWS recommends that you purchase.</p>",
|
||||
"ReservationPurchaseRecommendationDetail$MinimumNumberOfInstancesUsedPerHour": "<p>The minimum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
|
||||
"ReservationPurchaseRecommendationDetail$MinimumNormalizedUnitsUsedPerHour": "<p>The minimum number of hours that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
|
||||
"ReservationPurchaseRecommendationDetail$MinimumNormalizedUnitsUsedPerHour": "<p>The minimum number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
|
||||
"ReservationPurchaseRecommendationDetail$MaximumNumberOfInstancesUsedPerHour": "<p>The maximum number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
|
||||
"ReservationPurchaseRecommendationDetail$MaximumNormalizedUnitsUsedPerHour": "<p>The maximum number of normalized units that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
|
||||
"ReservationPurchaseRecommendationDetail$AverageNumberOfInstancesUsedPerHour": "<p>The average number of instances that you used in an hour during the historical period. AWS uses this to calculate your recommended reservation purchases.</p>",
|
||||
@@ -205,7 +298,7 @@
|
||||
"ReservationPurchaseRecommendationDetail$EstimatedMonthlySavingsAmount": "<p>How much AWS estimates that this specific recommendation could save you in a month.</p>",
|
||||
"ReservationPurchaseRecommendationDetail$EstimatedMonthlySavingsPercentage": "<p>How much AWS estimates that this specific recommendation could save you in a month, as a percentage of your overall costs.</p>",
|
||||
"ReservationPurchaseRecommendationDetail$EstimatedMonthlyOnDemandCost": "<p>How much AWS estimates that you spend on On-Demand Instances in a month.</p>",
|
||||
"ReservationPurchaseRecommendationDetail$EstimatedReservationCostForLookbackPeriod": "<p>How much AWS estimates that you spent on Reserved Instances during the specified historical period.</p>",
|
||||
"ReservationPurchaseRecommendationDetail$EstimatedReservationCostForLookbackPeriod": "<p>How much AWS estimates that you would have spent for all usage during the specified historical period if you had had a reservation.</p>",
|
||||
"ReservationPurchaseRecommendationDetail$UpfrontCost": "<p>How much purchasing this instance costs you upfront.</p>",
|
||||
"ReservationPurchaseRecommendationDetail$RecurringStandardMonthlyCost": "<p>How much purchasing this instance costs you on a monthly basis.</p>",
|
||||
"ReservationPurchaseRecommendationMetadata$RecommendationId": "<p>The ID for this specific recommendation.</p>",
|
||||
@@ -225,6 +318,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetCostForecastRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetCostForecastResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetDimensionValuesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -236,7 +339,7 @@
|
||||
}
|
||||
},
|
||||
"GetReservationCoverageRequest": {
|
||||
"base": "<p>You can use the following request parameters to query for how much of your instance usage is covered by a reservation.</p>",
|
||||
"base": "<p>You can use the following request parameters to query for how much of your instance usage a reservation covered.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -275,22 +378,34 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetUsageForecastRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetUsageForecastResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Granularity": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetCostAndUsageRequest$Granularity": "<p>Sets the AWS cost granularity to <code>MONTHLY</code> or <code>DAILY</code>. If <code>Granularity</code> isn't set, the response object doesn't include the <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>. </p>",
|
||||
"GetReservationCoverageRequest$Granularity": "<p>The granularity of the AWS cost data for the reservation. Valid values are <code>MONTHLY</code> and <code>DAILY</code>.</p> <p>If <code>GroupBy</code> is set, <code>Granularity</code> can't be set. If <code>Granularity</code> isn't set, the response object doesn't include the <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>.</p>",
|
||||
"GetReservationUtilizationRequest$Granularity": "<p>If <code>GroupBy</code> is set, <code>Granularity</code> can't be set. If <code>Granularity</code> isn't set, the response object doesn't include the <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>. If both <code>GroupBy</code> and <code>Granularity</code> aren't set, <code>GetReservationUtilization</code> defaults to <code>DAILY</code>.</p>"
|
||||
"GetCostAndUsageRequest$Granularity": "<p>Sets the AWS cost granularity to <code>MONTHLY</code> or <code>DAILY</code>. If <code>Granularity</code> isn't set, the response object doesn't include the <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>. </p> <p>The <code>GetCostAndUsageRequest</code> operation supports only <code>DAILY</code> and <code>MONTHLY</code> granularities.</p>",
|
||||
"GetCostForecastRequest$Granularity": "<p>How granular you want the forecast to be. You can get 3 months of <code>DAILY</code> forecasts or 12 months of <code>MONTHLY</code> forecasts.</p> <p>The <code>GetCostForecast</code> operation supports only <code>DAILY</code> and <code>MONTHLY</code> granularities.</p>",
|
||||
"GetReservationCoverageRequest$Granularity": "<p>The granularity of the AWS cost data for the reservation. Valid values are <code>MONTHLY</code> and <code>DAILY</code>.</p> <p>If <code>GroupBy</code> is set, <code>Granularity</code> can't be set. If <code>Granularity</code> isn't set, the response object doesn't include <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>.</p> <p>The <code>GetReservationCoverage</code> operation supports only <code>DAILY</code> and <code>MONTHLY</code> granularities.</p>",
|
||||
"GetReservationUtilizationRequest$Granularity": "<p>If <code>GroupBy</code> is set, <code>Granularity</code> can't be set. If <code>Granularity</code> isn't set, the response object doesn't include <code>Granularity</code>, either <code>MONTHLY</code> or <code>DAILY</code>. If both <code>GroupBy</code> and <code>Granularity</code> aren't set, <code>GetReservationUtilization</code> defaults to <code>DAILY</code>.</p> <p>The <code>GetReservationUtilization</code> operation supports only <code>DAILY</code> and <code>MONTHLY</code> granularities.</p>",
|
||||
"GetUsageForecastRequest$Granularity": "<p>How granular you want the forecast to be. You can get 3 months of <code>DAILY</code> forecasts or 12 months of <code>MONTHLY</code> forecasts.</p> <p>The <code>GetUsageForecast</code> operation supports only <code>DAILY</code> and <code>MONTHLY</code> granularities.</p>"
|
||||
}
|
||||
},
|
||||
"Group": {
|
||||
"base": "<p>One level of grouped data within the results.</p>",
|
||||
"base": "<p>One level of grouped data in the results.</p>",
|
||||
"refs": {
|
||||
"Groups$member": null
|
||||
}
|
||||
},
|
||||
"GroupDefinition": {
|
||||
"base": "<p>Represents a group when you specify a group by criteria, or in the response to a query with a specific grouping.</p>",
|
||||
"base": "<p>Represents a group when you specify a group by criteria or in the response to a query with a specific grouping.</p>",
|
||||
"refs": {
|
||||
"GroupDefinitions$member": null
|
||||
}
|
||||
@@ -312,14 +427,14 @@
|
||||
"refs": {
|
||||
"GetCostAndUsageRequest$GroupBy": "<p>You can group AWS costs using up to two different groups, either dimensions, tag keys, or both.</p> <p>When you group by tag key, you get all tag values, including empty strings.</p> <p>Valid values are <code>AZ</code>, <code>INSTANCE_TYPE</code>, <code>LEGAL_ENTITY_NAME</code>, <code>LINKED_ACCOUNT</code>, <code>OPERATION</code>, <code>PLATFORM</code>, <code>PURCHASE_TYPE</code>, <code>SERVICE</code>, <code>TAGS</code>, <code>TENANCY</code>, and <code>USAGE_TYPE</code>.</p>",
|
||||
"GetCostAndUsageResponse$GroupDefinitions": "<p>The groups that are specified by the <code>Filter</code> or <code>GroupBy</code> parameters in the request.</p>",
|
||||
"GetReservationCoverageRequest$GroupBy": "<p>You can group the data by the following attributes:</p> <ul> <li> <p>AZ</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>TENANCY</p> </li> </ul>",
|
||||
"GetReservationCoverageRequest$GroupBy": "<p>You can group the data by the following attributes:</p> <ul> <li> <p>AZ</p> </li> <li> <p>CACHE_ENGINE</p> </li> <li> <p>DATABASE_ENGINE</p> </li> <li> <p>DEPLOYMENT_OPTION</p> </li> <li> <p>INSTANCE_TYPE</p> </li> <li> <p>LINKED_ACCOUNT</p> </li> <li> <p>OPERATING_SYSTEM</p> </li> <li> <p>PLATFORM</p> </li> <li> <p>REGION</p> </li> <li> <p>TENANCY</p> </li> </ul>",
|
||||
"GetReservationUtilizationRequest$GroupBy": "<p>Groups only by <code>SUBSCRIPTION_ID</code>. Metadata is included.</p>"
|
||||
}
|
||||
},
|
||||
"Groups": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ResultByTime$Groups": "<p>The groups that are included in this time period.</p>"
|
||||
"ResultByTime$Groups": "<p>The groups that this time period includes.</p>"
|
||||
}
|
||||
},
|
||||
"InstanceDetails": {
|
||||
@@ -354,7 +469,14 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetReservationPurchaseRecommendationRequest$LookbackPeriodInDays": "<p>The number of previous days that you want AWS to consider when it calculates your recommendations.</p>",
|
||||
"ReservationPurchaseRecommendation$LookbackPeriodInDays": "<p>How many days of previous usage that AWS takes into consideration when making this recommendation.</p>"
|
||||
"ReservationPurchaseRecommendation$LookbackPeriodInDays": "<p>How many days of previous usage that AWS considers when making this recommendation.</p>"
|
||||
}
|
||||
},
|
||||
"Metric": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetCostForecastRequest$Metric": "<p>Which metric Cost Explorer uses to create your forecast. For more information about blended and unblended rates, see <a href=\"https://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/\">Why does the \"blended\" annotation appear on some line items in my bill?</a>. </p> <p>Valid values for a <code>GetCostForecast</code> call are the following:</p> <ul> <li> <p>AMORTIZED_COST</p> </li> <li> <p>BLENDED_COST</p> </li> <li> <p>NET_AMORTIZED_COST</p> </li> <li> <p>NET_UNBLENDED_COST</p> </li> <li> <p>UNBLENDED_COST</p> </li> </ul>",
|
||||
"GetUsageForecastRequest$Metric": "<p>Which metric Cost Explorer uses to create your forecast.</p> <p>Valid values for a <code>GetUsageForecast</code> call are the following:</p> <ul> <li> <p>USAGE_QUANTITY</p> </li> <li> <p>NORMALIZED_USAGE_AMOUNT</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"MetricAmount": {
|
||||
@@ -373,7 +495,8 @@
|
||||
"MetricNames": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetCostAndUsageRequest$Metrics": "<p>Which metrics are returned in the query. For more information about blended and unblended rates, see <a href=\"https://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/\">Why does the \"blended\" annotation appear on some line items in my bill?</a>. </p> <p>Valid values are <code>BlendedCost</code>, <code>UnblendedCost</code>, and <code>UsageQuantity</code>.</p> <note> <p>If you return the <code>UsageQuantity</code> metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate <code>usageQuantity</code> across all of EC2, the results aren't meaningful because EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful <code>UsageQuantity</code> metrics, filter by <code>UsageType</code> or <code>UsageTypeGroups</code>. </p> </note> <p> <code>Metrics</code> is required for <code>GetCostAndUsage</code> requests.</p>"
|
||||
"GetCostAndUsageRequest$Metrics": "<p>Which metrics are returned in the query. For more information about blended and unblended rates, see <a href=\"https://aws.amazon.com/premiumsupport/knowledge-center/blended-rates-intro/\">Why does the \"blended\" annotation appear on some line items in my bill?</a>. </p> <p>Valid values are <code>AmortizedCost</code>, <code>BlendedCost</code>, <code>NetAmortizedCost</code>, <code>NetUnblendedCost</code>, <code>NormalizedUsageAmount</code>, <code>UnblendedCost</code>, and <code>UsageQuantity</code>. </p> <note> <p>If you return the <code>UsageQuantity</code> metric, the service aggregates all usage numbers without taking into account the units. For example, if you aggregate <code>usageQuantity</code> across all of Amazon EC2, the results aren't meaningful because Amazon EC2 compute hours and data transfer are measured in different units (for example, hours vs. GB). To get more meaningful <code>UsageQuantity</code> metrics, filter by <code>UsageType</code> or <code>UsageTypeGroups</code>. </p> </note> <p> <code>Metrics</code> is required for <code>GetCostAndUsage</code> requests.</p>",
|
||||
"GetReservationCoverageRequest$Metrics": "<p>The measurement that you want your reservation coverage reported in.</p> <p>Valid values are <code>Hour</code>, <code>Unit</code>, and <code>Cost</code>. You can use multiple values in a request.</p>"
|
||||
}
|
||||
},
|
||||
"MetricUnit": {
|
||||
@@ -385,6 +508,8 @@
|
||||
"MetricValue": {
|
||||
"base": "<p>The aggregated value for a metric.</p>",
|
||||
"refs": {
|
||||
"GetCostForecastResponse$Total": "<p>How much you are forecasted to spend over the forecast period, in <code>USD</code>.</p>",
|
||||
"GetUsageForecastResponse$Total": "<p>How much you're forecasted to use over the forecast period.</p>",
|
||||
"Metrics$value": null
|
||||
}
|
||||
},
|
||||
@@ -395,6 +520,12 @@
|
||||
"ResultByTime$Total": "<p>The total amount of cost or usage accrued during the time period.</p>"
|
||||
}
|
||||
},
|
||||
"NetRISavings": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ReservationAggregates$NetRISavings": "<p>How much you saved due to purchasing and utilizing reservation. AWS calculates this by subtracting <code>TotalAmortizedFee</code> from <code>OnDemandCostOfRIHoursUsed</code>.</p>"
|
||||
}
|
||||
},
|
||||
"NextPageToken": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -424,10 +555,28 @@
|
||||
"EC2Specification$OfferingClass": "<p>Whether you want a recommendation for standard or convertible reservations.</p>"
|
||||
}
|
||||
},
|
||||
"OnDemandCost": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CoverageCost$OnDemandCost": "<p>How much an On-Demand instance cost.</p>"
|
||||
}
|
||||
},
|
||||
"OnDemandCostOfRIHoursUsed": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ReservationAggregates$OnDemandCostOfRIHoursUsed": "<p>How much your reservation would cost if charged On-Demand rates.</p>"
|
||||
}
|
||||
},
|
||||
"OnDemandHours": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CoverageHours$OnDemandHours": "<p>The number of instance running hours that are covered by On-Demand Instances.</p>"
|
||||
"CoverageHours$OnDemandHours": "<p>The number of instance running hours that On-Demand Instances covered.</p>"
|
||||
}
|
||||
},
|
||||
"OnDemandNormalizedUnits": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CoverageNormalizedUnits$OnDemandNormalizedUnits": "<p>The number of normalized units that are covered by On-Demand Instances instead of a reservation.</p>"
|
||||
}
|
||||
},
|
||||
"PageSize": {
|
||||
@@ -446,18 +595,48 @@
|
||||
"ReservationPurchaseRecommendation$PaymentOption": "<p>The payment option for the reservation. For example, <code>AllUpfront</code> or <code>NoUpfront</code>.</p>"
|
||||
}
|
||||
},
|
||||
"PredictionIntervalLevel": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetCostForecastRequest$PredictionIntervalLevel": "<p>Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.</p>",
|
||||
"GetUsageForecastRequest$PredictionIntervalLevel": "<p>Cost Explorer always returns the mean forecast as a single point. You can request a prediction interval around the mean by specifying a confidence level. The higher the confidence level, the more confident Cost Explorer is about the actual value falling in the prediction interval. Higher confidence levels result in wider prediction intervals.</p>"
|
||||
}
|
||||
},
|
||||
"PurchasedHours": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ReservationAggregates$PurchasedHours": "<p>How many RI hours that you purchased.</p>"
|
||||
"ReservationAggregates$PurchasedHours": "<p>How many reservation hours that you purchased.</p>"
|
||||
}
|
||||
},
|
||||
"PurchasedUnits": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ReservationAggregates$PurchasedUnits": "<p>How many Amazon EC2 reservation hours that you purchased, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.</p>"
|
||||
}
|
||||
},
|
||||
"RDSInstanceDetails": {
|
||||
"base": "<p>Details about the Amazon RDS instances that AWS recommends that you purchase.</p>",
|
||||
"refs": {
|
||||
"InstanceDetails$RDSInstanceDetails": "<p>The Amazon RDS instances that AWS recommends that you purchase.</p>"
|
||||
}
|
||||
},
|
||||
"RedshiftInstanceDetails": {
|
||||
"base": "<p>Details about the Amazon Redshift instances that AWS recommends that you purchase.</p>",
|
||||
"refs": {
|
||||
"InstanceDetails$RedshiftInstanceDetails": "<p>The Amazon Redshift instances that AWS recommends that you purchase.</p>"
|
||||
}
|
||||
},
|
||||
"RequestChangedException": {
|
||||
"base": "<p>Your request parameters changed between pages. Try again with the old parameters or without a pagination token.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ReservationAggregates": {
|
||||
"base": "<p>The aggregated numbers for your RI usage.</p>",
|
||||
"base": "<p>The aggregated numbers for your reservation usage.</p>",
|
||||
"refs": {
|
||||
"GetReservationUtilizationResponse$Total": "<p>The total amount of time that you utilized your RIs.</p>",
|
||||
"ReservationUtilizationGroup$Utilization": "<p>How much you used this group of RIs.</p>",
|
||||
"UtilizationByTime$Total": "<p>The total number of RI hours that were used.</p>"
|
||||
"GetReservationUtilizationResponse$Total": "<p>The total amount of time that you used your RIs.</p>",
|
||||
"ReservationUtilizationGroup$Utilization": "<p>How much you used this group of reservations.</p>",
|
||||
"UtilizationByTime$Total": "<p>The total number of reservation hours that were used.</p>"
|
||||
}
|
||||
},
|
||||
"ReservationCoverageGroup": {
|
||||
@@ -469,19 +648,19 @@
|
||||
"ReservationCoverageGroups": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CoverageByTime$Groups": "<p>The groups of instances that are covered by a reservation.</p>"
|
||||
"CoverageByTime$Groups": "<p>The groups of instances that the reservation covered.</p>"
|
||||
}
|
||||
},
|
||||
"ReservationGroupKey": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ReservationUtilizationGroup$Key": "<p>The key for a specific RI attribute.</p>"
|
||||
"ReservationUtilizationGroup$Key": "<p>The key for a specific reservation attribute.</p>"
|
||||
}
|
||||
},
|
||||
"ReservationGroupValue": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ReservationUtilizationGroup$Value": "<p>The value of a specific RI attribute.</p>"
|
||||
"ReservationUtilizationGroup$Value": "<p>The value of a specific reservation attribute.</p>"
|
||||
}
|
||||
},
|
||||
"ReservationPurchaseRecommendation": {
|
||||
@@ -509,7 +688,7 @@
|
||||
}
|
||||
},
|
||||
"ReservationPurchaseRecommendationSummary": {
|
||||
"base": "<p>A summary about this recommendation, such as the currency code, the amount that AWS estimates you could save, and the total amount of reservation to purchase.</p>",
|
||||
"base": "<p>A summary about this recommendation, such as the currency code, the amount that AWS estimates that you could save, and the total amount of reservation to purchase.</p>",
|
||||
"refs": {
|
||||
"ReservationPurchaseRecommendation$RecommendationSummary": "<p>A summary about the recommended purchase.</p>"
|
||||
}
|
||||
@@ -521,7 +700,7 @@
|
||||
}
|
||||
},
|
||||
"ReservationUtilizationGroup": {
|
||||
"base": "<p>A group of RIs that share a set of attributes.</p>",
|
||||
"base": "<p>A group of reservations that share a set of attributes.</p>",
|
||||
"refs": {
|
||||
"ReservationUtilizationGroups$member": null
|
||||
}
|
||||
@@ -529,13 +708,19 @@
|
||||
"ReservationUtilizationGroups": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"UtilizationByTime$Groups": "<p>The groups that are included in this utilization result.</p>"
|
||||
"UtilizationByTime$Groups": "<p>The groups that this utilization result uses.</p>"
|
||||
}
|
||||
},
|
||||
"ReservedHours": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CoverageHours$ReservedHours": "<p>The number of instance running hours that are covered by reservations.</p>"
|
||||
"CoverageHours$ReservedHours": "<p>The number of instance running hours that reservations covered.</p>"
|
||||
}
|
||||
},
|
||||
"ReservedNormalizedUnits": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CoverageNormalizedUnits$ReservedNormalizedUnits": "<p>The number of normalized units that a reservation covers.</p>"
|
||||
}
|
||||
},
|
||||
"ResultByTime": {
|
||||
@@ -560,7 +745,7 @@
|
||||
"ServiceSpecification": {
|
||||
"base": "<p>Hardware specifications for the service that you want recommendations for.</p>",
|
||||
"refs": {
|
||||
"GetReservationPurchaseRecommendationRequest$ServiceSpecification": "<p>The specific service, such as EC2, that you want recommendations for.</p>",
|
||||
"GetReservationPurchaseRecommendationRequest$ServiceSpecification": "<p>The hardware specifications for the service instances that you want recommendations for, such as standard or convertible Amazon EC2 instances.</p>",
|
||||
"ReservationPurchaseRecommendation$ServiceSpecification": "<p>Hardware specifications for the service that you want recommendations for.</p>"
|
||||
}
|
||||
},
|
||||
@@ -568,7 +753,7 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetTagsRequest$TagKey": "<p>The key of the tag that you want to return values for.</p>",
|
||||
"TagValues$Key": "<p>The key for a tag.</p>"
|
||||
"TagValues$Key": "<p>The key for the tag.</p>"
|
||||
}
|
||||
},
|
||||
"TagList": {
|
||||
@@ -593,7 +778,25 @@
|
||||
"TotalActualHours": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ReservationAggregates$TotalActualHours": "<p>The total number of RI hours that you used.</p>"
|
||||
"ReservationAggregates$TotalActualHours": "<p>The total number of reservation hours that you used.</p>"
|
||||
}
|
||||
},
|
||||
"TotalActualUnits": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ReservationAggregates$TotalActualUnits": "<p>The total number of Amazon EC2 reservation hours that you used, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.</p>"
|
||||
}
|
||||
},
|
||||
"TotalAmortizedFee": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ReservationAggregates$TotalAmortizedFee": "<p>The total cost of your reservation, amortized over the reservation period.</p>"
|
||||
}
|
||||
},
|
||||
"TotalPotentialRISavings": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ReservationAggregates$TotalPotentialRISavings": "<p>How much you could save if you use your entire reservation.</p>"
|
||||
}
|
||||
},
|
||||
"TotalRunningHours": {
|
||||
@@ -602,10 +805,27 @@
|
||||
"CoverageHours$TotalRunningHours": "<p>The total instance usage, in hours.</p>"
|
||||
}
|
||||
},
|
||||
"TotalRunningNormalizedUnits": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CoverageNormalizedUnits$TotalRunningNormalizedUnits": "<p>The total number of normalized units that you used.</p>"
|
||||
}
|
||||
},
|
||||
"UnresolvableUsageUnitException": {
|
||||
"base": "<p>Cost Explorer was unable to identify the usage unit. Provide <code>UsageType/UsageTypeGroup</code> filter selections that contain matching units, for example: <code>hours</code>.(</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UnusedHours": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ReservationAggregates$UnusedHours": "<p>The number of RI hours that you didn't use.</p>"
|
||||
"ReservationAggregates$UnusedHours": "<p>The number of reservation hours that you didn't use.</p>"
|
||||
}
|
||||
},
|
||||
"UnusedUnits": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ReservationAggregates$UnusedUnits": "<p>The number of Amazon EC2 reservation hours that you didn't use, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.</p>"
|
||||
}
|
||||
},
|
||||
"UtilizationByTime": {
|
||||
@@ -617,13 +837,19 @@
|
||||
"UtilizationPercentage": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ReservationAggregates$UtilizationPercentage": "<p>The percentage of RI time that you used.</p>"
|
||||
"ReservationAggregates$UtilizationPercentage": "<p>The percentage of reservation time that you used.</p>"
|
||||
}
|
||||
},
|
||||
"UtilizationPercentageInUnits": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ReservationAggregates$UtilizationPercentageInUnits": "<p>The percentage of Amazon EC2 reservation time that you used, converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.</p>"
|
||||
}
|
||||
},
|
||||
"UtilizationsByTime": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetReservationUtilizationResponse$UtilizationsByTime": "<p>The amount of time that you utilized your RIs.</p>"
|
||||
"GetReservationUtilizationResponse$UtilizationsByTime": "<p>The amount of time that you used your RIs.</p>"
|
||||
}
|
||||
},
|
||||
"Value": {
|
||||
@@ -636,8 +862,8 @@
|
||||
"Values": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DimensionValues$Values": "<p>The metadata values that you can use to filter and group your results. You can use <code>GetDimensionValues</code> to find specific values.</p>",
|
||||
"TagValues$Values": "<p>The specific value of a tag.</p>"
|
||||
"DimensionValues$Values": "<p>The metadata values that you can use to filter and group your results. You can use <code>GetDimensionValues</code> to find specific values.</p> <p>Valid values for the <code>SERVICE</code> dimension are <code>Amazon Elastic Compute Cloud - Compute</code>, <code>Amazon Elasticsearch Service</code>, <code>Amazon ElastiCache</code>, <code>Amazon Redshift</code>, and <code>Amazon Relational Database Service</code>.</p>",
|
||||
"TagValues$Values": "<p>The specific value of the tag.</p>"
|
||||
}
|
||||
},
|
||||
"YearMonthDay": {
|
||||
|
||||
+2902
File diff suppressed because it is too large
Load Diff
+1369
File diff suppressed because it is too large
Load Diff
Generated
Vendored
+29
@@ -0,0 +1,29 @@
|
||||
{
|
||||
"pagination": {
|
||||
"ListAccounts": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListPhoneNumberOrders": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListPhoneNumbers": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListUsers": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListVoiceConnectors": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
}
|
||||
}
|
||||
}
|
||||
+22
-3
@@ -6,6 +6,7 @@
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceFullName":"AWS Cloud9",
|
||||
"serviceId":"Cloud9",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"AWSCloud9WorkspaceManagementService",
|
||||
"uid":"cloud9-2017-09-23"
|
||||
@@ -347,12 +348,14 @@
|
||||
"description":{"shape":"EnvironmentDescription"},
|
||||
"type":{"shape":"EnvironmentType"},
|
||||
"arn":{"shape":"String"},
|
||||
"ownerArn":{"shape":"String"}
|
||||
"ownerArn":{"shape":"String"},
|
||||
"lifecycle":{"shape":"EnvironmentLifecycle"}
|
||||
}
|
||||
},
|
||||
"EnvironmentDescription":{
|
||||
"type":"string",
|
||||
"max":200
|
||||
"max":200,
|
||||
"sensitive":true
|
||||
},
|
||||
"EnvironmentId":{
|
||||
"type":"string",
|
||||
@@ -362,6 +365,22 @@
|
||||
"type":"list",
|
||||
"member":{"shape":"EnvironmentId"}
|
||||
},
|
||||
"EnvironmentLifecycle":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"status":{"shape":"EnvironmentLifecycleStatus"},
|
||||
"reason":{"shape":"String"},
|
||||
"failureResource":{"shape":"String"}
|
||||
}
|
||||
},
|
||||
"EnvironmentLifecycleStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"CREATED",
|
||||
"DELETING",
|
||||
"DELETE_FAILED"
|
||||
]
|
||||
},
|
||||
"EnvironmentList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Environment"}
|
||||
@@ -522,7 +541,7 @@
|
||||
},
|
||||
"UserArn":{
|
||||
"type":"string",
|
||||
"pattern":"arn:aws:(iam|sts)::\\d+:\\S+"
|
||||
"pattern":"arn:aws:(iam|sts)::\\d+:(root|user|federated-user|assumed-role)\\/?\\S*"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
+14
@@ -149,6 +149,18 @@
|
||||
"ListEnvironmentsResult$environmentIds": "<p>The list of environment identifiers.</p>"
|
||||
}
|
||||
},
|
||||
"EnvironmentLifecycle": {
|
||||
"base": "<p>Information about the current creation or deletion lifecycle state of an AWS Cloud9 development environment.</p>",
|
||||
"refs": {
|
||||
"Environment$lifecycle": "<p>The state of the environment in its creation or deletion lifecycle.</p>"
|
||||
}
|
||||
},
|
||||
"EnvironmentLifecycleStatus": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"EnvironmentLifecycle$status": "<p>The current creation or deletion lifecycle state of the environment.</p> <ul> <li> <p> <code>CREATED</code>: The environment was successfully created.</p> </li> <li> <p> <code>DELETE_FAILED</code>: The environment failed to delete.</p> </li> <li> <p> <code>DELETING</code>: The environment is in the process of being deleted.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"EnvironmentList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -260,6 +272,8 @@
|
||||
"DescribeEnvironmentStatusResult$message": "<p>Any informational message about the status of the environment.</p>",
|
||||
"Environment$arn": "<p>The Amazon Resource Name (ARN) of the environment.</p>",
|
||||
"Environment$ownerArn": "<p>The Amazon Resource Name (ARN) of the environment owner.</p>",
|
||||
"EnvironmentLifecycle$reason": "<p>Any informational message about the lifecycle state of the environment.</p>",
|
||||
"EnvironmentLifecycle$failureResource": "<p>If the environment failed to delete, the Amazon Resource Name (ARN) of the related AWS resource.</p>",
|
||||
"EnvironmentMember$userId": "<p>The user ID in AWS Identity and Access Management (AWS IAM) of the environment member.</p>",
|
||||
"ListEnvironmentsRequest$nextToken": "<p>During a previous call, if there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a <i>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.</p>",
|
||||
"ListEnvironmentsResult$nextToken": "<p>If there are more than 25 items in the list, only the first 25 items are returned, along with a unique string called a <i>next token</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call.</p>"
|
||||
|
||||
Generated
Vendored
+237
-16
@@ -1,13 +1,14 @@
|
||||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"apiVersion":"2016-05-10",
|
||||
"apiVersion":"2017-01-11",
|
||||
"endpointPrefix":"clouddirectory",
|
||||
"protocol":"rest-json",
|
||||
"serviceFullName":"Amazon CloudDirectory",
|
||||
"serviceId":"CloudDirectory",
|
||||
"signatureVersion":"v4",
|
||||
"signingName":"clouddirectory",
|
||||
"uid":"clouddirectory-2016-05-10"
|
||||
"uid":"clouddirectory-2017-01-11"
|
||||
},
|
||||
"operations":{
|
||||
"AddFacetToObject":{
|
||||
@@ -47,6 +48,7 @@
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"SchemaAlreadyExistsException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidAttachmentException"}
|
||||
]
|
||||
@@ -596,6 +598,27 @@
|
||||
{"shape":"FacetNotFoundException"}
|
||||
]
|
||||
},
|
||||
"GetLinkAttributes":{
|
||||
"name":"GetLinkAttributes",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/attributes/get",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"GetLinkAttributesRequest"},
|
||||
"output":{"shape":"GetLinkAttributesResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"DirectoryNotEnabledException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"FacetValidationException"}
|
||||
]
|
||||
},
|
||||
"GetObjectAttributes":{
|
||||
"name":"GetObjectAttributes",
|
||||
"http":{
|
||||
@@ -843,6 +866,24 @@
|
||||
{"shape":"NotIndexException"}
|
||||
]
|
||||
},
|
||||
"ListManagedSchemaArns":{
|
||||
"name":"ListManagedSchemaArns",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/amazonclouddirectory/2017-01-11/schema/managed",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"ListManagedSchemaArnsRequest"},
|
||||
"output":{"shape":"ListManagedSchemaArnsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidNextTokenException"}
|
||||
]
|
||||
},
|
||||
"ListObjectAttributes":{
|
||||
"name":"ListObjectAttributes",
|
||||
"http":{
|
||||
@@ -1215,11 +1256,33 @@
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"InvalidFacetUpdateException"},
|
||||
{"shape":"FacetValidationException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"FacetNotFoundException"},
|
||||
{"shape":"InvalidRuleException"}
|
||||
]
|
||||
},
|
||||
"UpdateLinkAttributes":{
|
||||
"name":"UpdateLinkAttributes",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/attributes/update",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"UpdateLinkAttributesRequest"},
|
||||
"output":{"shape":"UpdateLinkAttributesResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"DirectoryNotEnabledException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"FacetValidationException"}
|
||||
]
|
||||
},
|
||||
"UpdateObjectAttributes":{
|
||||
"name":"UpdateObjectAttributes",
|
||||
"http":{
|
||||
@@ -1238,6 +1301,7 @@
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"DirectoryNotEnabledException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"LinkNameAlreadyInUseException"},
|
||||
{"shape":"FacetValidationException"}
|
||||
]
|
||||
},
|
||||
@@ -1300,7 +1364,8 @@
|
||||
{"shape":"IncompatibleSchemaException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidAttachmentException"}
|
||||
{"shape":"InvalidAttachmentException"},
|
||||
{"shape":"SchemaAlreadyExistsException"}
|
||||
]
|
||||
},
|
||||
"UpgradePublishedSchema":{
|
||||
@@ -1515,9 +1580,9 @@
|
||||
},
|
||||
"AttributeName":{
|
||||
"type":"string",
|
||||
"max":64,
|
||||
"max":230,
|
||||
"min":1,
|
||||
"pattern":"^[a-zA-Z0-9._-]*$"
|
||||
"pattern":"^[a-zA-Z0-9._:-]*$"
|
||||
},
|
||||
"AttributeNameAndValue":{
|
||||
"type":"structure",
|
||||
@@ -1744,6 +1809,23 @@
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"BatchGetLinkAttributes":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"TypedLinkSpecifier",
|
||||
"AttributeNames"
|
||||
],
|
||||
"members":{
|
||||
"TypedLinkSpecifier":{"shape":"TypedLinkSpecifier"},
|
||||
"AttributeNames":{"shape":"AttributeNameList"}
|
||||
}
|
||||
},
|
||||
"BatchGetLinkAttributesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Attributes":{"shape":"AttributeKeyAndValueList"}
|
||||
}
|
||||
},
|
||||
"BatchGetObjectAttributes":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -1877,6 +1959,22 @@
|
||||
"NextToken":{"shape":"NextToken"}
|
||||
}
|
||||
},
|
||||
"BatchListObjectParents":{
|
||||
"type":"structure",
|
||||
"required":["ObjectReference"],
|
||||
"members":{
|
||||
"ObjectReference":{"shape":"ObjectReference"},
|
||||
"NextToken":{"shape":"NextToken"},
|
||||
"MaxResults":{"shape":"NumberResults"}
|
||||
}
|
||||
},
|
||||
"BatchListObjectParentsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ParentLinks":{"shape":"ObjectIdentifierAndLinkNameList"},
|
||||
"NextToken":{"shape":"NextToken"}
|
||||
}
|
||||
},
|
||||
"BatchListObjectPolicies":{
|
||||
"type":"structure",
|
||||
"required":["ObjectReference"],
|
||||
@@ -1978,12 +2076,14 @@
|
||||
"ListObjectParentPaths":{"shape":"BatchListObjectParentPaths"},
|
||||
"GetObjectInformation":{"shape":"BatchGetObjectInformation"},
|
||||
"GetObjectAttributes":{"shape":"BatchGetObjectAttributes"},
|
||||
"ListObjectParents":{"shape":"BatchListObjectParents"},
|
||||
"ListObjectPolicies":{"shape":"BatchListObjectPolicies"},
|
||||
"ListPolicyAttachments":{"shape":"BatchListPolicyAttachments"},
|
||||
"LookupPolicy":{"shape":"BatchLookupPolicy"},
|
||||
"ListIndex":{"shape":"BatchListIndex"},
|
||||
"ListOutgoingTypedLinks":{"shape":"BatchListOutgoingTypedLinks"},
|
||||
"ListIncomingTypedLinks":{"shape":"BatchListIncomingTypedLinks"}
|
||||
"ListIncomingTypedLinks":{"shape":"BatchListIncomingTypedLinks"},
|
||||
"GetLinkAttributes":{"shape":"BatchGetLinkAttributes"}
|
||||
}
|
||||
},
|
||||
"BatchReadOperationList":{
|
||||
@@ -2041,7 +2141,9 @@
|
||||
"LookupPolicy":{"shape":"BatchLookupPolicyResponse"},
|
||||
"ListIndex":{"shape":"BatchListIndexResponse"},
|
||||
"ListOutgoingTypedLinks":{"shape":"BatchListOutgoingTypedLinksResponse"},
|
||||
"ListIncomingTypedLinks":{"shape":"BatchListIncomingTypedLinksResponse"}
|
||||
"ListIncomingTypedLinks":{"shape":"BatchListIncomingTypedLinksResponse"},
|
||||
"GetLinkAttributes":{"shape":"BatchGetLinkAttributesResponse"},
|
||||
"ListObjectParents":{"shape":"BatchListObjectParentsResponse"}
|
||||
}
|
||||
},
|
||||
"BatchReferenceName":{"type":"string"},
|
||||
@@ -2061,6 +2163,22 @@
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"BatchUpdateLinkAttributes":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"TypedLinkSpecifier",
|
||||
"AttributeUpdates"
|
||||
],
|
||||
"members":{
|
||||
"TypedLinkSpecifier":{"shape":"TypedLinkSpecifier"},
|
||||
"AttributeUpdates":{"shape":"LinkAttributeUpdateList"}
|
||||
}
|
||||
},
|
||||
"BatchUpdateLinkAttributesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"BatchUpdateObjectAttributes":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -2126,7 +2244,8 @@
|
||||
"AttachToIndex":{"shape":"BatchAttachToIndex"},
|
||||
"DetachFromIndex":{"shape":"BatchDetachFromIndex"},
|
||||
"AttachTypedLink":{"shape":"BatchAttachTypedLink"},
|
||||
"DetachTypedLink":{"shape":"BatchDetachTypedLink"}
|
||||
"DetachTypedLink":{"shape":"BatchDetachTypedLink"},
|
||||
"UpdateLinkAttributes":{"shape":"BatchUpdateLinkAttributes"}
|
||||
}
|
||||
},
|
||||
"BatchWriteOperationList":{
|
||||
@@ -2149,7 +2268,8 @@
|
||||
"AttachToIndex":{"shape":"BatchAttachToIndexResponse"},
|
||||
"DetachFromIndex":{"shape":"BatchDetachFromIndexResponse"},
|
||||
"AttachTypedLink":{"shape":"BatchAttachTypedLinkResponse"},
|
||||
"DetachTypedLink":{"shape":"BatchDetachTypedLinkResponse"}
|
||||
"DetachTypedLink":{"shape":"BatchDetachTypedLinkResponse"},
|
||||
"UpdateLinkAttributes":{"shape":"BatchUpdateLinkAttributesResponse"}
|
||||
}
|
||||
},
|
||||
"BatchWriteOperationResponseList":{
|
||||
@@ -2229,8 +2349,7 @@
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"SchemaArn",
|
||||
"Name",
|
||||
"ObjectType"
|
||||
"Name"
|
||||
],
|
||||
"members":{
|
||||
"SchemaArn":{
|
||||
@@ -2240,7 +2359,8 @@
|
||||
},
|
||||
"Name":{"shape":"FacetName"},
|
||||
"Attributes":{"shape":"FacetAttributeList"},
|
||||
"ObjectType":{"shape":"ObjectType"}
|
||||
"ObjectType":{"shape":"ObjectType"},
|
||||
"FacetStyle":{"shape":"FacetStyle"}
|
||||
}
|
||||
},
|
||||
"CreateFacetResponse":{
|
||||
@@ -2611,7 +2731,8 @@
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Name":{"shape":"FacetName"},
|
||||
"ObjectType":{"shape":"ObjectType"}
|
||||
"ObjectType":{"shape":"ObjectType"},
|
||||
"FacetStyle":{"shape":"FacetStyle"}
|
||||
}
|
||||
},
|
||||
"FacetAlreadyExistsException":{
|
||||
@@ -2664,7 +2785,8 @@
|
||||
"BINARY",
|
||||
"BOOLEAN",
|
||||
"NUMBER",
|
||||
"DATETIME"
|
||||
"DATETIME",
|
||||
"VARIANT"
|
||||
]
|
||||
},
|
||||
"FacetAttributeUpdate":{
|
||||
@@ -2704,6 +2826,13 @@
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"FacetStyle":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"STATIC",
|
||||
"DYNAMIC"
|
||||
]
|
||||
},
|
||||
"FacetValidationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -2764,6 +2893,30 @@
|
||||
"Facet":{"shape":"Facet"}
|
||||
}
|
||||
},
|
||||
"GetLinkAttributesRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DirectoryArn",
|
||||
"TypedLinkSpecifier",
|
||||
"AttributeNames"
|
||||
],
|
||||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"TypedLinkSpecifier":{"shape":"TypedLinkSpecifier"},
|
||||
"AttributeNames":{"shape":"AttributeNameList"},
|
||||
"ConsistencyLevel":{"shape":"ConsistencyLevel"}
|
||||
}
|
||||
},
|
||||
"GetLinkAttributesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Attributes":{"shape":"AttributeKeyAndValueList"}
|
||||
}
|
||||
},
|
||||
"GetObjectAttributesRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -2959,6 +3112,24 @@
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"LinkAttributeAction":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AttributeActionType":{"shape":"UpdateActionType"},
|
||||
"AttributeUpdateValue":{"shape":"TypedAttributeValue"}
|
||||
}
|
||||
},
|
||||
"LinkAttributeUpdate":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AttributeKey":{"shape":"AttributeKey"},
|
||||
"AttributeAction":{"shape":"LinkAttributeAction"}
|
||||
}
|
||||
},
|
||||
"LinkAttributeUpdateList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"LinkAttributeUpdate"}
|
||||
},
|
||||
"LinkName":{
|
||||
"type":"string",
|
||||
"max":64,
|
||||
@@ -3155,6 +3326,21 @@
|
||||
"NextToken":{"shape":"NextToken"}
|
||||
}
|
||||
},
|
||||
"ListManagedSchemaArnsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SchemaArn":{"shape":"Arn"},
|
||||
"NextToken":{"shape":"NextToken"},
|
||||
"MaxResults":{"shape":"NumberResults"}
|
||||
}
|
||||
},
|
||||
"ListManagedSchemaArnsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SchemaArns":{"shape":"Arns"},
|
||||
"NextToken":{"shape":"NextToken"}
|
||||
}
|
||||
},
|
||||
"ListObjectAttributesRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -3257,14 +3443,16 @@
|
||||
"shape":"ConsistencyLevel",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-consistency-level"
|
||||
}
|
||||
},
|
||||
"IncludeAllLinksToEachParent":{"shape":"Bool"}
|
||||
}
|
||||
},
|
||||
"ListObjectParentsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Parents":{"shape":"ObjectIdentifierToLinkNameMap"},
|
||||
"NextToken":{"shape":"NextToken"}
|
||||
"NextToken":{"shape":"NextToken"},
|
||||
"ParentLinks":{"shape":"ObjectIdentifierAndLinkNameList"}
|
||||
}
|
||||
},
|
||||
"ListObjectPoliciesRequest":{
|
||||
@@ -3519,6 +3707,17 @@
|
||||
"member":{"shape":"ObjectAttributeUpdate"}
|
||||
},
|
||||
"ObjectIdentifier":{"type":"string"},
|
||||
"ObjectIdentifierAndLinkNameList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ObjectIdentifierAndLinkNameTuple"}
|
||||
},
|
||||
"ObjectIdentifierAndLinkNameTuple":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ObjectIdentifier":{"shape":"ObjectIdentifier"},
|
||||
"LinkName":{"shape":"LinkName"}
|
||||
}
|
||||
},
|
||||
"ObjectIdentifierList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ObjectIdentifier"}
|
||||
@@ -3975,6 +4174,28 @@
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"UpdateLinkAttributesRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DirectoryArn",
|
||||
"TypedLinkSpecifier",
|
||||
"AttributeUpdates"
|
||||
],
|
||||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"TypedLinkSpecifier":{"shape":"TypedLinkSpecifier"},
|
||||
"AttributeUpdates":{"shape":"LinkAttributeUpdateList"}
|
||||
}
|
||||
},
|
||||
"UpdateLinkAttributesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"UpdateObjectAttributesRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
Generated
Vendored
+188
-54
@@ -1,68 +1,71 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<fullname>Amazon Cloud Directory</fullname> <p>Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see <a href=\"https://aws.amazon.com/directoryservice/\">AWS Directory Service</a> and the <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html\">AWS Directory Service Administration Guide</a>.</p>",
|
||||
"service": "<fullname>Amazon Cloud Directory</fullname> <p>Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about Cloud Directory features, see <a href=\"https://aws.amazon.com/directoryservice/\">AWS Directory Service</a> and the <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/what_is_cloud_directory.html\">Amazon Cloud Directory Developer Guide</a>.</p>",
|
||||
"operations": {
|
||||
"AddFacetToObject": "<p>Adds a new <a>Facet</a> to an object. An object can have more than one facet applied on it.</p>",
|
||||
"ApplySchema": "<p>Copies the input published schema, at the specified version, into the <a>Directory</a> with the same name and version as that of the published schema.</p>",
|
||||
"AttachObject": "<p>Attaches an existing object to another object. An object can be accessed in two ways:</p> <ol> <li> <p>Using the path</p> </li> <li> <p>Using <code>ObjectIdentifier</code> </p> </li> </ol>",
|
||||
"AttachPolicy": "<p>Attaches a policy object to a regular object. An object can have a limited number of attached policies.</p>",
|
||||
"AttachToIndex": "<p>Attaches the specified object to the specified index.</p>",
|
||||
"AttachTypedLink": "<p>Attaches a typed link to a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
|
||||
"AttachTypedLink": "<p>Attaches a typed link to a specified source and target object. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>",
|
||||
"BatchRead": "<p>Performs all the read operations in a batch. </p>",
|
||||
"BatchWrite": "<p>Performs all the write operations in a batch. Either all the operations succeed or none.</p>",
|
||||
"CreateDirectory": "<p>Creates a <a>Directory</a> by copying the published schema into the directory. A directory cannot be created without a schema.</p>",
|
||||
"CreateDirectory": "<p>Creates a <a>Directory</a> by copying the published schema into the directory. A directory cannot be created without a schema.</p> <p>You can also quickly create a directory using a managed schema, called the <code>QuickStartSchema</code>. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_managed.html\">Managed Schema</a> in the <i>Amazon Cloud Directory Developer Guide</i>.</p>",
|
||||
"CreateFacet": "<p>Creates a new <a>Facet</a> in a schema. Facet creation is allowed only in development or applied schemas.</p>",
|
||||
"CreateIndex": "<p>Creates an index object. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_indexing.html\">Indexing</a> for more information.</p>",
|
||||
"CreateIndex": "<p>Creates an index object. See <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.html\">Indexing and search</a> for more information.</p>",
|
||||
"CreateObject": "<p>Creates an object in a <a>Directory</a>. Additionally attaches the object to a parent, if a parent reference and <code>LinkName</code> is specified. An object is simply a collection of <a>Facet</a> attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet. </p>",
|
||||
"CreateSchema": "<p>Creates a new schema in a development state. A schema can exist in three phases:</p> <ul> <li> <p> <i>Development:</i> This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.</p> </li> <li> <p> <i>Published:</i> Published schemas are immutable and have a version associated with them.</p> </li> <li> <p> <i>Applied:</i> Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories. </p> </li> </ul>",
|
||||
"CreateTypedLinkFacet": "<p>Creates a <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
|
||||
"CreateTypedLinkFacet": "<p>Creates a <a>TypedLinkFacet</a>. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>",
|
||||
"DeleteDirectory": "<p>Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.</p>",
|
||||
"DeleteFacet": "<p>Deletes a given <a>Facet</a>. All attributes and <a>Rule</a>s that are associated with the facet will be deleted. Only development schema facets are allowed deletion.</p>",
|
||||
"DeleteObject": "<p>Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted.</p>",
|
||||
"DeleteObject": "<p>Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html\">Amazon Cloud Directory Limits</a>.</p>",
|
||||
"DeleteSchema": "<p>Deletes a given schema. Schemas in a development and published state can only be deleted. </p>",
|
||||
"DeleteTypedLinkFacet": "<p>Deletes a <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
|
||||
"DeleteTypedLinkFacet": "<p>Deletes a <a>TypedLinkFacet</a>. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>",
|
||||
"DetachFromIndex": "<p>Detaches the specified object from the specified index.</p>",
|
||||
"DetachObject": "<p>Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.</p>",
|
||||
"DetachPolicy": "<p>Detaches a policy from an object.</p>",
|
||||
"DetachTypedLink": "<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
|
||||
"DetachTypedLink": "<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>",
|
||||
"DisableDirectory": "<p>Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.</p>",
|
||||
"EnableDirectory": "<p>Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.</p>",
|
||||
"GetAppliedSchemaVersion": "<p>Returns current applied schema version ARN, including the minor version in use.</p>",
|
||||
"GetDirectory": "<p>Retrieves metadata about a directory.</p>",
|
||||
"GetFacet": "<p>Gets details of the <a>Facet</a>, such as facet name, attributes, <a>Rule</a>s, or <code>ObjectType</code>. You can call this on all kinds of schema facets -- published, development, or applied.</p>",
|
||||
"GetLinkAttributes": "<p>Retrieves attributes that are associated with a typed link.</p>",
|
||||
"GetObjectAttributes": "<p>Retrieves attributes within a facet that are associated with an object.</p>",
|
||||
"GetObjectInformation": "<p>Retrieves metadata about an object.</p>",
|
||||
"GetSchemaAsJson": "<p>Retrieves a JSON representation of the schema. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_schemas.html#jsonformat\">JSON Schema Format</a> for more information.</p>",
|
||||
"GetTypedLinkFacetInformation": "<p>Returns the identity attribute order for a specific <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
|
||||
"GetSchemaAsJson": "<p>Retrieves a JSON representation of the schema. See <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_jsonformat.html#schemas_json\">JSON Schema Format</a> for more information.</p>",
|
||||
"GetTypedLinkFacetInformation": "<p>Returns the identity attribute order for a specific <a>TypedLinkFacet</a>. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>",
|
||||
"ListAppliedSchemaArns": "<p>Lists schema major versions applied to a directory. If <code>SchemaArn</code> is provided, lists the minor version.</p>",
|
||||
"ListAttachedIndices": "<p>Lists indices attached to the specified object.</p>",
|
||||
"ListDevelopmentSchemaArns": "<p>Retrieves each Amazon Resource Name (ARN) of schemas in the development state.</p>",
|
||||
"ListDirectories": "<p>Lists directories created within an account.</p>",
|
||||
"ListFacetAttributes": "<p>Retrieves attributes attached to the facet.</p>",
|
||||
"ListFacetNames": "<p>Retrieves the names of facets that exist in a schema.</p>",
|
||||
"ListIncomingTypedLinks": "<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
|
||||
"ListIncomingTypedLinks": "<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>",
|
||||
"ListIndex": "<p>Lists objects attached to the specified index.</p>",
|
||||
"ListManagedSchemaArns": "<p>Lists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.</p>",
|
||||
"ListObjectAttributes": "<p>Lists all attributes that are associated with an object. </p>",
|
||||
"ListObjectChildren": "<p>Returns a paginated list of child objects that are associated with a given object.</p>",
|
||||
"ListObjectParentPaths": "<p>Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#dirstructure\">Directory Structure</a>.</p> <p>Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined <code>MaxResults</code>, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to the directory root are ignored from the target object.</p>",
|
||||
"ListObjectParentPaths": "<p>Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html\">Directory Structure</a>.</p> <p>Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined <code>MaxResults</code>, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to the directory root are ignored from the target object.</p>",
|
||||
"ListObjectParents": "<p>Lists parent objects that are associated with a given object in pagination fashion.</p>",
|
||||
"ListObjectPolicies": "<p>Returns policies attached to an object in pagination fashion.</p>",
|
||||
"ListOutgoingTypedLinks": "<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
|
||||
"ListOutgoingTypedLinks": "<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>",
|
||||
"ListPolicyAttachments": "<p>Returns all of the <code>ObjectIdentifiers</code> to which a given policy is attached.</p>",
|
||||
"ListPublishedSchemaArns": "<p>Lists the major version families of each published schema. If a major version ARN is provided as <code>SchemaArn</code>, the minor version revisions in that family are listed instead.</p>",
|
||||
"ListTagsForResource": "<p>Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.</p>",
|
||||
"ListTypedLinkFacetAttributes": "<p>Returns a paginated list of all attribute definitions for a particular <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
|
||||
"ListTypedLinkFacetNames": "<p>Returns a paginated list of <code>TypedLink</code> facet names for a particular schema. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
|
||||
"LookupPolicy": "<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code> for such objects. If policies are present, it returns <code>ObjectIdentifier</code>, <code>policyId</code>, and <code>policyType</code>. Paths that don't lead to the root from the target object are ignored. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>",
|
||||
"ListTypedLinkFacetAttributes": "<p>Returns a paginated list of all attribute definitions for a particular <a>TypedLinkFacet</a>. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>",
|
||||
"ListTypedLinkFacetNames": "<p>Returns a paginated list of <code>TypedLink</code> facet names for a particular schema. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>",
|
||||
"LookupPolicy": "<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code> for such objects. If policies are present, it returns <code>ObjectIdentifier</code>, <code>policyId</code>, and <code>policyType</code>. Paths that don't lead to the root from the target object are ignored. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies\">Policies</a>.</p>",
|
||||
"PublishSchema": "<p>Publishes a development schema with a major version and a recommended minor version.</p>",
|
||||
"PutSchemaFromJson": "<p>Allows a schema to be updated using JSON upload. Only available for development schemas. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_schemas.html#jsonformat\">JSON Schema Format</a> for more information.</p>",
|
||||
"PutSchemaFromJson": "<p>Allows a schema to be updated using JSON upload. Only available for development schemas. See <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_jsonformat.html#schemas_json\">JSON Schema Format</a> for more information.</p>",
|
||||
"RemoveFacetFromObject": "<p>Removes the specified facet from the specified object.</p>",
|
||||
"TagResource": "<p>An API operation for adding tags to a resource.</p>",
|
||||
"UntagResource": "<p>An API operation for removing tags from a resource.</p>",
|
||||
"UpdateFacet": "<p>Does the following:</p> <ol> <li> <p>Adds new <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> <li> <p>Updates existing <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> <li> <p>Deletes existing <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> </ol>",
|
||||
"UpdateLinkAttributes": "<p>Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its <code>IdentityAttributeOrder</code>.</p>",
|
||||
"UpdateObjectAttributes": "<p>Updates a given object's attributes.</p>",
|
||||
"UpdateSchema": "<p>Updates the schema name with a new name. Only development schema names can be updated.</p>",
|
||||
"UpdateTypedLinkFacet": "<p>Updates a <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
|
||||
"UpdateTypedLinkFacet": "<p>Updates a <a>TypedLinkFacet</a>. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>",
|
||||
"UpgradeAppliedSchema": "<p>Upgrades a single directory in-place using the <code>PublishedSchemaArn</code> with schema updates found in <code>MinorVersion</code>. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory.</p>",
|
||||
"UpgradePublishedSchema": "<p>Upgrades a published schema under a new minor version revision using the current contents of <code>DevelopmentSchemaArn</code>.</p>"
|
||||
},
|
||||
@@ -133,6 +136,7 @@
|
||||
"GetAppliedSchemaVersionRequest$SchemaArn": "<p>The ARN of the applied schema.</p>",
|
||||
"GetAppliedSchemaVersionResponse$AppliedSchemaArn": "<p>Current applied schema ARN, including the minor version in use if one was provided.</p>",
|
||||
"GetFacetRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) that is associated with the <a>Facet</a>. For more information, see <a>arns</a>.</p>",
|
||||
"GetLinkAttributesRequest$DirectoryArn": "<p>The Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more information, see <a>arns</a> or <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>",
|
||||
"GetObjectAttributesRequest$DirectoryArn": "<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides.</p>",
|
||||
"GetObjectInformationRequest$DirectoryArn": "<p>The ARN of the directory being retrieved.</p>",
|
||||
"GetSchemaAsJsonRequest$SchemaArn": "<p>The ARN of the schema to retrieve.</p>",
|
||||
@@ -144,6 +148,7 @@
|
||||
"ListFacetNamesRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) to retrieve facet names from.</p>",
|
||||
"ListIncomingTypedLinksRequest$DirectoryArn": "<p>The Amazon Resource Name (ARN) of the directory where you want to list the typed links.</p>",
|
||||
"ListIndexRequest$DirectoryArn": "<p>The ARN of the directory that the index exists in.</p>",
|
||||
"ListManagedSchemaArnsRequest$SchemaArn": "<p>The response for ListManagedSchemaArns. When this parameter is used, all minor version ARNs for a major version are listed.</p>",
|
||||
"ListObjectAttributesRequest$DirectoryArn": "<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
|
||||
"ListObjectChildrenRequest$DirectoryArn": "<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
|
||||
"ListObjectParentPathsRequest$DirectoryArn": "<p>The ARN of the directory to which the parent path applies.</p>",
|
||||
@@ -161,11 +166,12 @@
|
||||
"PutSchemaFromJsonRequest$SchemaArn": "<p>The ARN of the schema to update.</p>",
|
||||
"PutSchemaFromJsonResponse$Arn": "<p>The ARN of the schema to update.</p>",
|
||||
"RemoveFacetFromObjectRequest$DirectoryArn": "<p>The ARN of the directory in which the object resides.</p>",
|
||||
"SchemaFacet$SchemaArn": "<p>The ARN of the schema that contains the facet with no minor component. See <a>arns</a> and <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/inplaceschemaupgrade.html\">In-Place Schema Upgrade</a> for a description of when to provide minor versions.</p>",
|
||||
"SchemaFacet$SchemaArn": "<p>The ARN of the schema that contains the facet with no minor component. See <a>arns</a> and <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_inplaceschemaupgrade.html\">In-Place Schema Upgrade</a> for a description of when to provide minor versions.</p>",
|
||||
"TagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.</p>",
|
||||
"TypedLinkSchemaAndFacetName$SchemaArn": "<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
|
||||
"UntagResourceRequest$ResourceArn": "<p>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.</p>",
|
||||
"UpdateFacetRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) that is associated with the <a>Facet</a>. For more information, see <a>arns</a>.</p>",
|
||||
"UpdateLinkAttributesRequest$DirectoryArn": "<p>The Amazon Resource Name (ARN) that is associated with the Directory where the updated typed link resides. For more information, see <a>arns</a> or <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>",
|
||||
"UpdateObjectAttributesRequest$DirectoryArn": "<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
|
||||
"UpdateSchemaRequest$SchemaArn": "<p>The Amazon Resource Name (ARN) of the development schema. For more information, see <a>arns</a>.</p>",
|
||||
"UpdateSchemaResponse$SchemaArn": "<p>The ARN that is associated with the updated schema. For more information, see <a>arns</a>.</p>",
|
||||
@@ -184,6 +190,7 @@
|
||||
"refs": {
|
||||
"ListAppliedSchemaArnsResponse$SchemaArns": "<p>The ARNs of schemas that are applied to the directory.</p>",
|
||||
"ListDevelopmentSchemaArnsResponse$SchemaArns": "<p>The ARNs of retrieved development schemas.</p>",
|
||||
"ListManagedSchemaArnsResponse$SchemaArns": "<p>The ARNs for all AWS managed schemas.</p>",
|
||||
"ListPublishedSchemaArnsResponse$SchemaArns": "<p>The ARNs of published schemas.</p>"
|
||||
}
|
||||
},
|
||||
@@ -232,6 +239,7 @@
|
||||
"refs": {
|
||||
"AttributeKeyAndValue$Key": "<p>The key of the attribute.</p>",
|
||||
"AttributeKeyList$member": null,
|
||||
"LinkAttributeUpdate$AttributeKey": "<p>The key of the attribute being updated.</p>",
|
||||
"ObjectAttributeRange$AttributeKey": "<p>The key of the attribute that the attribute range covers.</p>",
|
||||
"ObjectAttributeUpdate$ObjectAttributeKey": "<p>The key of the attribute being updated.</p>"
|
||||
}
|
||||
@@ -248,9 +256,11 @@
|
||||
"AddFacetToObjectRequest$ObjectAttributeList": "<p>Attributes on the facet that you are adding to the object.</p>",
|
||||
"BatchAddFacetToObject$ObjectAttributeList": "<p>The attributes to set on the object.</p>",
|
||||
"BatchCreateObject$ObjectAttributeList": "<p>An attribute map, which contains an attribute ARN as the key and attribute value as the map value.</p>",
|
||||
"BatchGetLinkAttributesResponse$Attributes": "<p>The attributes that are associated with the typed link.</p>",
|
||||
"BatchGetObjectAttributesResponse$Attributes": "<p>The attribute values that are associated with an object.</p>",
|
||||
"BatchListObjectAttributesResponse$Attributes": "<p>The attributes map that is associated with the object. <code>AttributeArn</code> is the key; attribute value is the value.</p>",
|
||||
"CreateObjectRequest$ObjectAttributeList": "<p>The attribute map whose attribute ARN contains the key and attribute value as the map value.</p>",
|
||||
"GetLinkAttributesResponse$Attributes": "<p>The attributes that are associated with the typed link.</p>",
|
||||
"GetObjectAttributesResponse$Attributes": "<p>The attributes that are associated with the object.</p>",
|
||||
"IndexAttachment$IndexedAttributes": "<p>The indexed attribute values.</p>",
|
||||
"ListObjectAttributesResponse$Attributes": "<p>Attributes map that is associated with the object. <code>AttributeArn</code> is the key, and attribute value is the value.</p>"
|
||||
@@ -270,7 +280,7 @@
|
||||
"AttributeNameAndValue$AttributeName": "<p>The attribute name of the typed link.</p>",
|
||||
"AttributeNameList$member": null,
|
||||
"FacetAttribute$Name": "<p>The name of the facet attribute.</p>",
|
||||
"FacetAttributeReference$TargetAttributeName": "<p>The target attribute name that is associated with the facet reference. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>",
|
||||
"FacetAttributeReference$TargetAttributeName": "<p>The target attribute name that is associated with the facet reference. See <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html\">Attribute References</a> for more information.</p>",
|
||||
"TypedLinkAttributeDefinition$Name": "<p>The unique name of the typed link attribute.</p>",
|
||||
"TypedLinkAttributeRange$AttributeName": "<p>The unique name of the typed link attribute.</p>"
|
||||
}
|
||||
@@ -292,11 +302,13 @@
|
||||
"AttributeNameList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchGetLinkAttributes$AttributeNames": "<p>A list of attribute names whose values will be retrieved.</p>",
|
||||
"BatchGetObjectAttributes$AttributeNames": "<p>List of attribute names whose values will be retrieved.</p>",
|
||||
"GetLinkAttributesRequest$AttributeNames": "<p>A list of attribute names whose values will be retrieved.</p>",
|
||||
"GetObjectAttributesRequest$AttributeNames": "<p>List of attribute names whose values will be retrieved.</p>",
|
||||
"GetTypedLinkFacetInformationResponse$IdentityAttributeOrder": "<p>The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>",
|
||||
"GetTypedLinkFacetInformationResponse$IdentityAttributeOrder": "<p>The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>",
|
||||
"TypedLinkFacet$IdentityAttributeOrder": "<p>The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See <a>ListOutgoingTypedLinks</a> and <a>ListIncomingTypedLinks</a> for details.</p>",
|
||||
"UpdateTypedLinkFacetRequest$IdentityAttributeOrder": "<p>The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to a typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
"UpdateTypedLinkFacetRequest$IdentityAttributeOrder": "<p>The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to a typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>"
|
||||
}
|
||||
},
|
||||
"BatchAddFacetToObject": {
|
||||
@@ -350,25 +362,25 @@
|
||||
"BatchAttachTypedLink": {
|
||||
"base": "<p>Attaches a typed link to a specified source and target object inside a <a>BatchRead</a> operation. For more information, see <a>AttachTypedLink</a> and <a>BatchReadRequest$Operations</a>.</p>",
|
||||
"refs": {
|
||||
"BatchWriteOperation$AttachTypedLink": "<p>Attaches a typed link to a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
"BatchWriteOperation$AttachTypedLink": "<p>Attaches a typed link to a specified source and target object. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>"
|
||||
}
|
||||
},
|
||||
"BatchAttachTypedLinkResponse": {
|
||||
"base": "<p>Represents the output of a <a>AttachTypedLink</a> response operation.</p>",
|
||||
"refs": {
|
||||
"BatchWriteOperationResponse$AttachTypedLink": "<p>Attaches a typed link to a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
"BatchWriteOperationResponse$AttachTypedLink": "<p>Attaches a typed link to a specified source and target object. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>"
|
||||
}
|
||||
},
|
||||
"BatchCreateIndex": {
|
||||
"base": "<p>Creates an index object inside of a <a>BatchRead</a> operation. For more information, see <a>CreateIndex</a> and <a>BatchReadRequest$Operations</a>.</p>",
|
||||
"refs": {
|
||||
"BatchWriteOperation$CreateIndex": "<p>Creates an index object. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_indexing.html\">Indexing</a> for more information.</p>"
|
||||
"BatchWriteOperation$CreateIndex": "<p>Creates an index object. See <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.htm\">Indexing and search</a> for more information.</p>"
|
||||
}
|
||||
},
|
||||
"BatchCreateIndexResponse": {
|
||||
"base": "<p>Represents the output of a <a>CreateIndex</a> response operation.</p>",
|
||||
"refs": {
|
||||
"BatchWriteOperationResponse$CreateIndex": "<p>Creates an index object. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_indexing.html\">Indexing</a> for more information.</p>"
|
||||
"BatchWriteOperationResponse$CreateIndex": "<p>Creates an index object. See <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.htm\">Indexing and search</a> for more information.</p>"
|
||||
}
|
||||
},
|
||||
"BatchCreateObject": {
|
||||
@@ -434,13 +446,25 @@
|
||||
"BatchDetachTypedLink": {
|
||||
"base": "<p>Detaches a typed link from a specified source and target object inside a <a>BatchRead</a> operation. For more information, see <a>DetachTypedLink</a> and <a>BatchReadRequest$Operations</a>.</p>",
|
||||
"refs": {
|
||||
"BatchWriteOperation$DetachTypedLink": "<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
"BatchWriteOperation$DetachTypedLink": "<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>"
|
||||
}
|
||||
},
|
||||
"BatchDetachTypedLinkResponse": {
|
||||
"base": "<p>Represents the output of a <a>DetachTypedLink</a> response operation.</p>",
|
||||
"refs": {
|
||||
"BatchWriteOperationResponse$DetachTypedLink": "<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
"BatchWriteOperationResponse$DetachTypedLink": "<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>"
|
||||
}
|
||||
},
|
||||
"BatchGetLinkAttributes": {
|
||||
"base": "<p>Retrieves attributes that are associated with a typed link inside a <a>BatchRead</a> operation. For more information, see <a>GetLinkAttributes</a> and <a>BatchReadRequest$Operations</a>.</p>",
|
||||
"refs": {
|
||||
"BatchReadOperation$GetLinkAttributes": "<p>Retrieves attributes that are associated with a typed link.</p>"
|
||||
}
|
||||
},
|
||||
"BatchGetLinkAttributesResponse": {
|
||||
"base": "<p>Represents the output of a <a>GetLinkAttributes</a> response operation.</p>",
|
||||
"refs": {
|
||||
"BatchReadSuccessfulResponse$GetLinkAttributes": "<p>The list of attributes to retrieve from the typed link.</p>"
|
||||
}
|
||||
},
|
||||
"BatchGetObjectAttributes": {
|
||||
@@ -482,13 +506,13 @@
|
||||
"BatchListIncomingTypedLinks": {
|
||||
"base": "<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object inside a <a>BatchRead</a> operation. For more information, see <a>ListIncomingTypedLinks</a> and <a>BatchReadRequest$Operations</a>.</p>",
|
||||
"refs": {
|
||||
"BatchReadOperation$ListIncomingTypedLinks": "<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
"BatchReadOperation$ListIncomingTypedLinks": "<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>"
|
||||
}
|
||||
},
|
||||
"BatchListIncomingTypedLinksResponse": {
|
||||
"base": "<p>Represents the output of a <a>ListIncomingTypedLinks</a> response operation.</p>",
|
||||
"refs": {
|
||||
"BatchReadSuccessfulResponse$ListIncomingTypedLinks": "<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
"BatchReadSuccessfulResponse$ListIncomingTypedLinks": "<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>"
|
||||
}
|
||||
},
|
||||
"BatchListIndex": {
|
||||
@@ -530,13 +554,25 @@
|
||||
"BatchListObjectParentPaths": {
|
||||
"base": "<p>Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects inside a <a>BatchRead</a> operation. For more information, see <a>ListObjectParentPaths</a> and <a>BatchReadRequest$Operations</a>.</p>",
|
||||
"refs": {
|
||||
"BatchReadOperation$ListObjectParentPaths": "<p>Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#dirstructure\">Directory Structure</a>.</p>"
|
||||
"BatchReadOperation$ListObjectParentPaths": "<p>Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html\">Directory Structure</a>.</p>"
|
||||
}
|
||||
},
|
||||
"BatchListObjectParentPathsResponse": {
|
||||
"base": "<p>Represents the output of a <a>ListObjectParentPaths</a> response operation.</p>",
|
||||
"refs": {
|
||||
"BatchReadSuccessfulResponse$ListObjectParentPaths": "<p>Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#dirstructure\">Directory Structure</a>.</p>"
|
||||
"BatchReadSuccessfulResponse$ListObjectParentPaths": "<p>Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html\">Directory Structure</a>.</p>"
|
||||
}
|
||||
},
|
||||
"BatchListObjectParents": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchReadOperation$ListObjectParents": null
|
||||
}
|
||||
},
|
||||
"BatchListObjectParentsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchReadSuccessfulResponse$ListObjectParents": null
|
||||
}
|
||||
},
|
||||
"BatchListObjectPolicies": {
|
||||
@@ -554,13 +590,13 @@
|
||||
"BatchListOutgoingTypedLinks": {
|
||||
"base": "<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object inside a <a>BatchRead</a> operation. For more information, see <a>ListOutgoingTypedLinks</a> and <a>BatchReadRequest$Operations</a>.</p>",
|
||||
"refs": {
|
||||
"BatchReadOperation$ListOutgoingTypedLinks": "<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
"BatchReadOperation$ListOutgoingTypedLinks": "<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>"
|
||||
}
|
||||
},
|
||||
"BatchListOutgoingTypedLinksResponse": {
|
||||
"base": "<p>Represents the output of a <a>ListOutgoingTypedLinks</a> response operation.</p>",
|
||||
"refs": {
|
||||
"BatchReadSuccessfulResponse$ListOutgoingTypedLinks": "<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
"BatchReadSuccessfulResponse$ListOutgoingTypedLinks": "<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.</p>"
|
||||
}
|
||||
},
|
||||
"BatchListPolicyAttachments": {
|
||||
@@ -578,13 +614,13 @@
|
||||
"BatchLookupPolicy": {
|
||||
"base": "<p>Lists all policies from the root of the Directory to the object specified inside a <a>BatchRead</a> operation. For more information, see <a>LookupPolicy</a> and <a>BatchReadRequest$Operations</a>.</p>",
|
||||
"refs": {
|
||||
"BatchReadOperation$LookupPolicy": "<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code> for such objects. If policies are present, it returns <code>ObjectIdentifier</code>, <code>policyId</code>, and <code>policyType</code>. Paths that don't lead to the root from the target object are ignored. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
|
||||
"BatchReadOperation$LookupPolicy": "<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code> for such objects. If policies are present, it returns <code>ObjectIdentifier</code>, <code>policyId</code>, and <code>policyType</code>. Paths that don't lead to the root from the target object are ignored. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies\">Policies</a>.</p>"
|
||||
}
|
||||
},
|
||||
"BatchLookupPolicyResponse": {
|
||||
"base": "<p>Represents the output of a <a>LookupPolicy</a> response operation.</p>",
|
||||
"refs": {
|
||||
"BatchReadSuccessfulResponse$LookupPolicy": "<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code> for such objects. If policies are present, it returns <code>ObjectIdentifier</code>, <code>policyId</code>, and <code>policyType</code>. Paths that don't lead to the root from the target object are ignored. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
|
||||
"BatchReadSuccessfulResponse$LookupPolicy": "<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code> for such objects. If policies are present, it returns <code>ObjectIdentifier</code>, <code>policyId</code>, and <code>policyType</code>. Paths that don't lead to the root from the target object are ignored. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies\">Policies</a>.</p>"
|
||||
}
|
||||
},
|
||||
"BatchOperationIndex": {
|
||||
@@ -648,9 +684,9 @@
|
||||
"BatchReferenceName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchCreateIndex$BatchReferenceName": "<p>The batch reference name. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches\">Batches</a> for more information.</p>",
|
||||
"BatchCreateObject$BatchReferenceName": "<p>The batch reference name. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches\">Batches</a> for more information.</p>",
|
||||
"BatchDetachObject$BatchReferenceName": "<p>The batch reference name. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches\">Batches</a> for more information.</p>"
|
||||
"BatchCreateIndex$BatchReferenceName": "<p>The batch reference name. See <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html\">Transaction Support</a> for more information.</p>",
|
||||
"BatchCreateObject$BatchReferenceName": "<p>The batch reference name. See <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html\">Transaction Support</a> for more information.</p>",
|
||||
"BatchDetachObject$BatchReferenceName": "<p>The batch reference name. See <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html\">Transaction Support</a> for more information.</p>"
|
||||
}
|
||||
},
|
||||
"BatchRemoveFacetFromObject": {
|
||||
@@ -665,6 +701,18 @@
|
||||
"BatchWriteOperationResponse$RemoveFacetFromObject": "<p>The result of a batch remove facet from object operation.</p>"
|
||||
}
|
||||
},
|
||||
"BatchUpdateLinkAttributes": {
|
||||
"base": "<p>Updates a given typed link’s attributes inside a <a>BatchRead</a> operation. Attributes to be updated must not contribute to the typed link’s identity, as defined by its <code>IdentityAttributeOrder</code>. For more information, see <a>UpdateLinkAttributes</a> and <a>BatchReadRequest$Operations</a>.</p>",
|
||||
"refs": {
|
||||
"BatchWriteOperation$UpdateLinkAttributes": "<p>Updates a given object's attributes.</p>"
|
||||
}
|
||||
},
|
||||
"BatchUpdateLinkAttributesResponse": {
|
||||
"base": "<p>Represents the output of a <a>UpdateLinkAttributes</a> response operation.</p>",
|
||||
"refs": {
|
||||
"BatchWriteOperationResponse$UpdateLinkAttributes": "<p>Represents the output of a <code>BatchWrite</code> response operation.</p>"
|
||||
}
|
||||
},
|
||||
"BatchUpdateObjectAttributes": {
|
||||
"base": "<p>Represents the output of a <code>BatchUpdate</code> operation. </p>",
|
||||
"refs": {
|
||||
@@ -734,6 +782,7 @@
|
||||
"BatchCreateIndex$IsUnique": "<p>Indicates whether the attribute that is being indexed has unique values or not.</p>",
|
||||
"CreateIndexRequest$IsUnique": "<p>Indicates whether the attribute that is being indexed has unique values or not.</p>",
|
||||
"FacetAttributeDefinition$IsImmutable": "<p>Whether the attribute is mutable or not.</p>",
|
||||
"ListObjectParentsRequest$IncludeAllLinksToEachParent": "<p>When set to True, returns all <a>ListObjectParentsResponse$ParentLinks</a>. There could be multiple links between a parent-child pair.</p>",
|
||||
"TypedLinkAttributeDefinition$IsImmutable": "<p>Whether the attribute is mutable or not.</p>",
|
||||
"UpgradeAppliedSchemaRequest$DryRun": "<p>Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.</p>",
|
||||
"UpgradePublishedSchemaRequest$DryRun": "<p>Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.</p>"
|
||||
@@ -754,6 +803,7 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchReadRequest$ConsistencyLevel": "<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
|
||||
"GetLinkAttributesRequest$ConsistencyLevel": "<p>The consistency level at which to retrieve the attributes on a typed link.</p>",
|
||||
"GetObjectAttributesRequest$ConsistencyLevel": "<p>The consistency level at which to retrieve the attributes on an object.</p>",
|
||||
"GetObjectInformationRequest$ConsistencyLevel": "<p>The consistency level at which to retrieve the object information.</p>",
|
||||
"ListAttachedIndicesRequest$ConsistencyLevel": "<p>The consistency level to use for this operation.</p>",
|
||||
@@ -1042,7 +1092,7 @@
|
||||
}
|
||||
},
|
||||
"Facet": {
|
||||
"base": "<p>A structure that contains <code>Name</code>, <code>ARN</code>, <code>Attributes</code>, <code> <a>Rule</a>s</code>, and <code>ObjectTypes</code>. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/whatarefacets.html\">Facets</a> for more information.</p>",
|
||||
"base": "<p>A structure that contains <code>Name</code>, <code>ARN</code>, <code>Attributes</code>, <code> <a>Rule</a>s</code>, and <code>ObjectTypes</code>. See <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_whatarefacets.html\">Facets</a> for more information.</p>",
|
||||
"refs": {
|
||||
"GetFacetResponse$Facet": "<p>The <a>Facet</a> structure that is associated with the facet.</p>"
|
||||
}
|
||||
@@ -1060,9 +1110,9 @@
|
||||
}
|
||||
},
|
||||
"FacetAttributeDefinition": {
|
||||
"base": "<p>A facet attribute definition. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>",
|
||||
"base": "<p>A facet attribute definition. See <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html\">Attribute References</a> for more information.</p>",
|
||||
"refs": {
|
||||
"FacetAttribute$AttributeDefinition": "<p>A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
|
||||
"FacetAttribute$AttributeDefinition": "<p>A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html\">Attribute References</a> for more information.</p>"
|
||||
}
|
||||
},
|
||||
"FacetAttributeList": {
|
||||
@@ -1075,7 +1125,7 @@
|
||||
"FacetAttributeReference": {
|
||||
"base": "<p>The facet attribute reference that specifies the attribute definition that contains the attribute facet name and attribute name.</p>",
|
||||
"refs": {
|
||||
"FacetAttribute$AttributeReference": "<p>An attribute reference that is associated with the attribute. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
|
||||
"FacetAttribute$AttributeReference": "<p>An attribute reference that is associated with the attribute. See <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html\">Attribute References</a> for more information.</p>"
|
||||
}
|
||||
},
|
||||
"FacetAttributeType": {
|
||||
@@ -1109,7 +1159,7 @@
|
||||
"CreateFacetRequest$Name": "<p>The name of the <a>Facet</a>, which is unique for a given schema.</p>",
|
||||
"DeleteFacetRequest$Name": "<p>The name of the facet to delete.</p>",
|
||||
"Facet$Name": "<p>The name of the <a>Facet</a>.</p>",
|
||||
"FacetAttributeReference$TargetFacetName": "<p>The target facet name that is associated with the facet reference. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>",
|
||||
"FacetAttributeReference$TargetFacetName": "<p>The target facet name that is associated with the facet reference. See <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html\">Attribute References</a> for more information.</p>",
|
||||
"FacetNameList$member": null,
|
||||
"GetFacetRequest$Name": "<p>The name of the facet to retrieve.</p>",
|
||||
"ListFacetAttributesRequest$Name": "<p>The name of the facet whose attributes will be retrieved.</p>",
|
||||
@@ -1128,6 +1178,13 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"FacetStyle": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateFacetRequest$FacetStyle": "<p>There are two different styles that you can define on any given facet, <code>Static</code> and <code>Dynamic</code>. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.</p>",
|
||||
"Facet$FacetStyle": "<p>There are two different styles that you can define on any given facet, <code>Static</code> and <code>Dynamic</code>. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.</p>"
|
||||
}
|
||||
},
|
||||
"FacetValidationException": {
|
||||
"base": "<p>The <a>Facet</a> that you provided was not well formed or could not be validated with the schema.</p>",
|
||||
"refs": {
|
||||
@@ -1163,6 +1220,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetLinkAttributesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetLinkAttributesResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"GetObjectAttributesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -1239,7 +1306,7 @@
|
||||
}
|
||||
},
|
||||
"InvalidAttachmentException": {
|
||||
"base": "<p>Indicates that an attempt to attach an object with the same link name or to apply a schema with the same name has occurred. Rename the link or the schema and then try again.</p>",
|
||||
"base": "<p>Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
@@ -1269,10 +1336,29 @@
|
||||
}
|
||||
},
|
||||
"LimitExceededException": {
|
||||
"base": "<p>Indicates that limits are exceeded. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html\">Limits</a> for more information.</p>",
|
||||
"base": "<p>Indicates that limits are exceeded. See <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html\">Limits</a> for more information.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"LinkAttributeAction": {
|
||||
"base": "<p>The action to take on a typed link attribute value. Updates are only supported for attributes which don’t contribute to link identity.</p>",
|
||||
"refs": {
|
||||
"LinkAttributeUpdate$AttributeAction": "<p>The action to perform as part of the attribute update.</p>"
|
||||
}
|
||||
},
|
||||
"LinkAttributeUpdate": {
|
||||
"base": "<p>Structure that contains attribute update information.</p>",
|
||||
"refs": {
|
||||
"LinkAttributeUpdateList$member": null
|
||||
}
|
||||
},
|
||||
"LinkAttributeUpdateList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchUpdateLinkAttributes$AttributeUpdates": "<p>The attributes update structure.</p>",
|
||||
"UpdateLinkAttributesRequest$AttributeUpdates": "<p>The attributes update structure.</p>"
|
||||
}
|
||||
},
|
||||
"LinkName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -1285,6 +1371,7 @@
|
||||
"CreateObjectRequest$LinkName": "<p>The name of link that is used to attach this object to a parent.</p>",
|
||||
"DetachObjectRequest$LinkName": "<p>The link name associated with the object that needs to be detached.</p>",
|
||||
"LinkNameToObjectIdentifierMap$key": null,
|
||||
"ObjectIdentifierAndLinkNameTuple$LinkName": "<p>The name of the link between the parent and the child object.</p>",
|
||||
"ObjectIdentifierToLinkNameMap$value": null
|
||||
}
|
||||
},
|
||||
@@ -1380,6 +1467,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListManagedSchemaArnsRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListManagedSchemaArnsResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ListObjectAttributesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -1515,6 +1612,8 @@
|
||||
"BatchListObjectChildrenResponse$NextToken": "<p>The pagination token.</p>",
|
||||
"BatchListObjectParentPaths$NextToken": "<p>The pagination token.</p>",
|
||||
"BatchListObjectParentPathsResponse$NextToken": "<p>The pagination token.</p>",
|
||||
"BatchListObjectParents$NextToken": null,
|
||||
"BatchListObjectParentsResponse$NextToken": null,
|
||||
"BatchListObjectPolicies$NextToken": "<p>The pagination token.</p>",
|
||||
"BatchListObjectPoliciesResponse$NextToken": "<p>The pagination token.</p>",
|
||||
"BatchListOutgoingTypedLinks$NextToken": "<p>The pagination token.</p>",
|
||||
@@ -1539,6 +1638,8 @@
|
||||
"ListIncomingTypedLinksResponse$NextToken": "<p>The pagination token.</p>",
|
||||
"ListIndexRequest$NextToken": "<p>The pagination token.</p>",
|
||||
"ListIndexResponse$NextToken": "<p>The pagination token.</p>",
|
||||
"ListManagedSchemaArnsRequest$NextToken": "<p>The pagination token.</p>",
|
||||
"ListManagedSchemaArnsResponse$NextToken": "<p>The pagination token.</p>",
|
||||
"ListObjectAttributesRequest$NextToken": "<p>The pagination token.</p>",
|
||||
"ListObjectAttributesResponse$NextToken": "<p>The pagination token.</p>",
|
||||
"ListObjectChildrenRequest$NextToken": "<p>The pagination token.</p>",
|
||||
@@ -1595,6 +1696,7 @@
|
||||
"BatchListObjectAttributes$MaxResults": "<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>",
|
||||
"BatchListObjectChildren$MaxResults": "<p>Maximum number of items to be retrieved in a single call. This is an approximate number.</p>",
|
||||
"BatchListObjectParentPaths$MaxResults": "<p>The maximum number of results to retrieve.</p>",
|
||||
"BatchListObjectParents$MaxResults": null,
|
||||
"BatchListObjectPolicies$MaxResults": "<p>The maximum number of results to retrieve.</p>",
|
||||
"BatchListOutgoingTypedLinks$MaxResults": "<p>The maximum number of results to retrieve.</p>",
|
||||
"BatchListPolicyAttachments$MaxResults": "<p>The maximum number of results to retrieve.</p>",
|
||||
@@ -1606,7 +1708,8 @@
|
||||
"ListFacetAttributesRequest$MaxResults": "<p>The maximum number of results to retrieve.</p>",
|
||||
"ListFacetNamesRequest$MaxResults": "<p>The maximum number of results to retrieve.</p>",
|
||||
"ListIncomingTypedLinksRequest$MaxResults": "<p>The maximum number of results to retrieve.</p>",
|
||||
"ListIndexRequest$MaxResults": "<p>The maximum number of objects in a single page to retrieve from the index during a request. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html#limits_cd\">AWS Directory Service Limits</a>.</p>",
|
||||
"ListIndexRequest$MaxResults": "<p>The maximum number of objects in a single page to retrieve from the index during a request. For more information, see <a href=\"http://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html\">Amazon Cloud Directory Limits</a>.</p>",
|
||||
"ListManagedSchemaArnsRequest$MaxResults": "<p>The maximum number of results to retrieve.</p>",
|
||||
"ListObjectAttributesRequest$MaxResults": "<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>",
|
||||
"ListObjectChildrenRequest$MaxResults": "<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>",
|
||||
"ListObjectParentPathsRequest$MaxResults": "<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>",
|
||||
@@ -1678,6 +1781,7 @@
|
||||
"GetObjectInformationResponse$ObjectIdentifier": "<p>The <code>ObjectIdentifier</code> of the specified object.</p>",
|
||||
"IndexAttachment$ObjectIdentifier": "<p>In response to <a>ListIndex</a>, the <code>ObjectIdentifier</code> of the object attached to the index. In response to <a>ListAttachedIndices</a>, the <code>ObjectIdentifier</code> of the index attached to the object. This field will always contain the <code>ObjectIdentifier</code> of the object on the opposite side of the attachment specified in the query.</p>",
|
||||
"LinkNameToObjectIdentifierMap$value": null,
|
||||
"ObjectIdentifierAndLinkNameTuple$ObjectIdentifier": "<p>The ID that is associated with the object.</p>",
|
||||
"ObjectIdentifierList$member": null,
|
||||
"ObjectIdentifierToLinkNameMap$key": null,
|
||||
"PolicyAttachment$PolicyId": "<p>The ID of <code>PolicyAttachment</code>.</p>",
|
||||
@@ -1685,6 +1789,19 @@
|
||||
"UpdateObjectAttributesResponse$ObjectIdentifier": "<p>The <code>ObjectIdentifier</code> of the updated object.</p>"
|
||||
}
|
||||
},
|
||||
"ObjectIdentifierAndLinkNameList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchListObjectParentsResponse$ParentLinks": null,
|
||||
"ListObjectParentsResponse$ParentLinks": "<p>Returns a list of parent reference and LinkName Tuples.</p>"
|
||||
}
|
||||
},
|
||||
"ObjectIdentifierAndLinkNameTuple": {
|
||||
"base": "<p>A pair of ObjectIdentifier and LinkName.</p>",
|
||||
"refs": {
|
||||
"ObjectIdentifierAndLinkNameList$member": null
|
||||
}
|
||||
},
|
||||
"ObjectIdentifierList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -1743,6 +1860,7 @@
|
||||
"BatchListObjectAttributes$ObjectReference": "<p>Reference of the object whose attributes need to be listed.</p>",
|
||||
"BatchListObjectChildren$ObjectReference": "<p>Reference of the object for which child objects are being listed.</p>",
|
||||
"BatchListObjectParentPaths$ObjectReference": "<p>The reference that identifies the object whose attributes will be listed.</p>",
|
||||
"BatchListObjectParents$ObjectReference": null,
|
||||
"BatchListObjectPolicies$ObjectReference": "<p>The reference that identifies the object whose attributes will be listed.</p>",
|
||||
"BatchListOutgoingTypedLinks$ObjectReference": "<p>The reference that identifies the object whose attributes will be listed.</p>",
|
||||
"BatchListPolicyAttachments$PolicyReference": "<p>The reference that identifies the policy object.</p>",
|
||||
@@ -1779,7 +1897,7 @@
|
||||
"ObjectType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateFacetRequest$ObjectType": "<p>Specifies whether a given object created from this facet is of type node, leaf node, policy or index.</p> <ul> <li> <p>Node: Can have multiple children but one parent.</p> </li> </ul> <ul> <li> <p>Leaf node: Cannot have children but can have multiple parents.</p> </li> </ul> <ul> <li> <p>Policy: Allows you to store a policy document and policy type. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p> </li> </ul> <ul> <li> <p>Index: Can be created with the Index API.</p> </li> </ul>",
|
||||
"CreateFacetRequest$ObjectType": "<p>Specifies whether a given object created from this facet is of type node, leaf node, policy or index.</p> <ul> <li> <p>Node: Can have multiple children but one parent.</p> </li> </ul> <ul> <li> <p>Leaf node: Cannot have children but can have multiple parents.</p> </li> </ul> <ul> <li> <p>Policy: Allows you to store a policy document and policy type. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies\">Policies</a>.</p> </li> </ul> <ul> <li> <p>Index: Can be created with the Index API.</p> </li> </ul>",
|
||||
"Facet$ObjectType": "<p>The object type that is associated with the facet. See <a>CreateFacetRequest$ObjectType</a> for more details.</p>",
|
||||
"UpdateFacetRequest$ObjectType": "<p>The object type that is associated with the facet. See <a>CreateFacetRequest$ObjectType</a> for more details.</p>"
|
||||
}
|
||||
@@ -1805,7 +1923,7 @@
|
||||
}
|
||||
},
|
||||
"PolicyAttachment": {
|
||||
"base": "<p>Contains the <code>PolicyType</code>, <code>PolicyId</code>, and the <code>ObjectIdentifier</code> to which it is attached. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>",
|
||||
"base": "<p>Contains the <code>PolicyType</code>, <code>PolicyId</code>, and the <code>ObjectIdentifier</code> to which it is attached. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies\">Policies</a>.</p>",
|
||||
"refs": {
|
||||
"PolicyAttachmentList$member": null
|
||||
}
|
||||
@@ -1825,8 +1943,8 @@
|
||||
"PolicyToPathList": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"BatchLookupPolicyResponse$PolicyToPathList": "<p>Provides list of path to policies. Policies contain <code>PolicyId</code>, <code>ObjectIdentifier</code>, and <code>PolicyType</code>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>",
|
||||
"LookupPolicyResponse$PolicyToPathList": "<p>Provides list of path to policies. Policies contain <code>PolicyId</code>, <code>ObjectIdentifier</code>, and <code>PolicyType</code>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
|
||||
"BatchLookupPolicyResponse$PolicyToPathList": "<p>Provides list of path to policies. Policies contain <code>PolicyId</code>, <code>ObjectIdentifier</code>, and <code>PolicyType</code>. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies\">Policies</a>.</p>",
|
||||
"LookupPolicyResponse$PolicyToPathList": "<p>Provides list of path to policies. Policies contain <code>PolicyId</code>, <code>ObjectIdentifier</code>, and <code>PolicyType</code>. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies\">Policies</a>.</p>"
|
||||
}
|
||||
},
|
||||
"PolicyType": {
|
||||
@@ -1984,7 +2102,7 @@
|
||||
"SelectorObjectReference": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ObjectReference$Selector": "<p>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#accessingobjects\">Accessing Objects</a>. You can identify an object in one of the following ways:</p> <ul> <li> <p> <i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier</p> </li> <li> <p> <i>/some/path</i> - Identifies the object based on path</p> </li> <li> <p> <i>#SomeBatchReference</i> - Identifies the object in a batch call</p> </li> </ul>"
|
||||
"ObjectReference$Selector": "<p>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html\">Access Objects</a>. You can identify an object in one of the following ways:</p> <ul> <li> <p> <i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier</p> </li> <li> <p> <i>/some/path</i> - Identifies the object based on path</p> </li> <li> <p> <i>#SomeBatchReference</i> - Identifies the object in a batch call</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"StillContainsLinksException": {
|
||||
@@ -2052,6 +2170,7 @@
|
||||
"AttributeKeyAndValue$Value": "<p>The value of the attribute.</p>",
|
||||
"AttributeNameAndValue$Value": "<p>The value for the typed link.</p>",
|
||||
"FacetAttributeDefinition$DefaultValue": "<p>The default value of the attribute (if configured).</p>",
|
||||
"LinkAttributeAction$AttributeUpdateValue": "<p>The value that you want to update to.</p>",
|
||||
"ObjectAttributeAction$ObjectAttributeUpdateValue": "<p>The value that you want to update to.</p>",
|
||||
"TypedAttributeValueRange$StartValue": "<p>The value to start the range at.</p>",
|
||||
"TypedAttributeValueRange$EndValue": "<p>The attribute value to terminate the range at.</p>",
|
||||
@@ -2059,7 +2178,7 @@
|
||||
}
|
||||
},
|
||||
"TypedAttributeValueRange": {
|
||||
"base": "<p>A range of attribute values. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#rangefilters\">Range Filters</a>.</p>",
|
||||
"base": "<p>A range of attribute values. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_range_filters.html\">Range Filters</a>.</p>",
|
||||
"refs": {
|
||||
"ObjectAttributeRange$Range": "<p>The range of attribute values being selected.</p>",
|
||||
"TypedLinkAttributeRange$Range": "<p>The range of attribute values that are being selected.</p>"
|
||||
@@ -2148,8 +2267,12 @@
|
||||
"AttachTypedLinkResponse$TypedLinkSpecifier": "<p>Returns a typed link specifier as output.</p>",
|
||||
"BatchAttachTypedLinkResponse$TypedLinkSpecifier": "<p>Returns a typed link specifier as output.</p>",
|
||||
"BatchDetachTypedLink$TypedLinkSpecifier": "<p>Used to accept a typed link specifier as input.</p>",
|
||||
"BatchGetLinkAttributes$TypedLinkSpecifier": "<p>Allows a typed link specifier to be accepted as input.</p>",
|
||||
"BatchUpdateLinkAttributes$TypedLinkSpecifier": "<p>Allows a typed link specifier to be accepted as input.</p>",
|
||||
"DetachTypedLinkRequest$TypedLinkSpecifier": "<p>Used to accept a typed link specifier as input.</p>",
|
||||
"TypedLinkSpecifierList$member": null
|
||||
"GetLinkAttributesRequest$TypedLinkSpecifier": "<p>Allows a typed link specifier to be accepted as input.</p>",
|
||||
"TypedLinkSpecifierList$member": null,
|
||||
"UpdateLinkAttributesRequest$TypedLinkSpecifier": "<p>Allows a typed link specifier to be accepted as input.</p>"
|
||||
}
|
||||
},
|
||||
"TypedLinkSpecifierList": {
|
||||
@@ -2180,6 +2303,7 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"FacetAttributeUpdate$Action": "<p>The action to perform when updating the attribute.</p>",
|
||||
"LinkAttributeAction$AttributeActionType": "<p>A type that can be either <code>UPDATE_OR_CREATE</code> or <code>DELETE</code>.</p>",
|
||||
"ObjectAttributeAction$ObjectAttributeActionType": "<p>A type that can be either <code>Update</code> or <code>Delete</code>.</p>",
|
||||
"TypedLinkFacetAttributeUpdate$Action": "<p>The action to perform when updating the attribute.</p>"
|
||||
}
|
||||
@@ -2194,6 +2318,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateLinkAttributesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateLinkAttributesResponse": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"UpdateObjectAttributesRequest": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
Generated
Vendored
+5
@@ -35,6 +35,11 @@
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListManagedSchemaArns": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults"
|
||||
},
|
||||
"ListObjectAttributes": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
Generated
Vendored
+313
-10
@@ -197,6 +197,18 @@
|
||||
{"shape":"ChangeSetNotFoundException"}
|
||||
]
|
||||
},
|
||||
"DescribeStackDriftDetectionStatus":{
|
||||
"name":"DescribeStackDriftDetectionStatus",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeStackDriftDetectionStatusInput"},
|
||||
"output":{
|
||||
"shape":"DescribeStackDriftDetectionStatusOutput",
|
||||
"resultWrapper":"DescribeStackDriftDetectionStatusResult"
|
||||
}
|
||||
},
|
||||
"DescribeStackEvents":{
|
||||
"name":"DescribeStackEvents",
|
||||
"http":{
|
||||
@@ -237,6 +249,18 @@
|
||||
"resultWrapper":"DescribeStackResourceResult"
|
||||
}
|
||||
},
|
||||
"DescribeStackResourceDrifts":{
|
||||
"name":"DescribeStackResourceDrifts",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeStackResourceDriftsInput"},
|
||||
"output":{
|
||||
"shape":"DescribeStackResourceDriftsOutput",
|
||||
"resultWrapper":"DescribeStackResourceDriftsResult"
|
||||
}
|
||||
},
|
||||
"DescribeStackResources":{
|
||||
"name":"DescribeStackResources",
|
||||
"http":{
|
||||
@@ -292,6 +316,30 @@
|
||||
"resultWrapper":"DescribeStacksResult"
|
||||
}
|
||||
},
|
||||
"DetectStackDrift":{
|
||||
"name":"DetectStackDrift",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DetectStackDriftInput"},
|
||||
"output":{
|
||||
"shape":"DetectStackDriftOutput",
|
||||
"resultWrapper":"DetectStackDriftResult"
|
||||
}
|
||||
},
|
||||
"DetectStackResourceDrift":{
|
||||
"name":"DetectStackResourceDrift",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DetectStackResourceDriftInput"},
|
||||
"output":{
|
||||
"shape":"DetectStackResourceDriftOutput",
|
||||
"resultWrapper":"DetectStackResourceDriftResult"
|
||||
}
|
||||
},
|
||||
"EstimateTemplateCost":{
|
||||
"name":"EstimateTemplateCost",
|
||||
"http":{
|
||||
@@ -567,7 +615,8 @@
|
||||
{"shape":"OperationInProgressException"},
|
||||
{"shape":"OperationIdAlreadyExistsException"},
|
||||
{"shape":"StaleRequestException"},
|
||||
{"shape":"InvalidOperationException"}
|
||||
{"shape":"InvalidOperationException"},
|
||||
{"shape":"StackInstanceNotFoundException"}
|
||||
]
|
||||
},
|
||||
"UpdateTerminationProtection":{
|
||||
@@ -648,6 +697,16 @@
|
||||
"exception":true
|
||||
},
|
||||
"Arn":{"type":"string"},
|
||||
"BoxedInteger":{
|
||||
"type":"integer",
|
||||
"box":true
|
||||
},
|
||||
"BoxedMaxResults":{
|
||||
"type":"integer",
|
||||
"box":true,
|
||||
"max":100,
|
||||
"min":1
|
||||
},
|
||||
"CancelUpdateStackInput":{
|
||||
"type":"structure",
|
||||
"required":["StackName"],
|
||||
@@ -665,7 +724,8 @@
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"CAPABILITY_IAM",
|
||||
"CAPABILITY_NAMED_IAM"
|
||||
"CAPABILITY_NAMED_IAM",
|
||||
"CAPABILITY_AUTO_EXPAND"
|
||||
]
|
||||
},
|
||||
"CausingEntity":{"type":"string"},
|
||||
@@ -889,6 +949,7 @@
|
||||
"Capabilities":{"shape":"Capabilities"},
|
||||
"Tags":{"shape":"Tags"},
|
||||
"AdministrationRoleARN":{"shape":"RoleARN"},
|
||||
"ExecutionRoleName":{"shape":"ExecutionRoleName"},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"idempotencyToken":true
|
||||
@@ -1018,6 +1079,31 @@
|
||||
"NextToken":{"shape":"NextToken"}
|
||||
}
|
||||
},
|
||||
"DescribeStackDriftDetectionStatusInput":{
|
||||
"type":"structure",
|
||||
"required":["StackDriftDetectionId"],
|
||||
"members":{
|
||||
"StackDriftDetectionId":{"shape":"StackDriftDetectionId"}
|
||||
}
|
||||
},
|
||||
"DescribeStackDriftDetectionStatusOutput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"StackId",
|
||||
"StackDriftDetectionId",
|
||||
"DetectionStatus",
|
||||
"Timestamp"
|
||||
],
|
||||
"members":{
|
||||
"StackId":{"shape":"StackId"},
|
||||
"StackDriftDetectionId":{"shape":"StackDriftDetectionId"},
|
||||
"StackDriftStatus":{"shape":"StackDriftStatus"},
|
||||
"DetectionStatus":{"shape":"StackDriftDetectionStatus"},
|
||||
"DetectionStatusReason":{"shape":"StackDriftDetectionStatusReason"},
|
||||
"DriftedStackResourceCount":{"shape":"BoxedInteger"},
|
||||
"Timestamp":{"shape":"Timestamp"}
|
||||
}
|
||||
},
|
||||
"DescribeStackEventsInput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
@@ -1051,6 +1137,24 @@
|
||||
"StackInstance":{"shape":"StackInstance"}
|
||||
}
|
||||
},
|
||||
"DescribeStackResourceDriftsInput":{
|
||||
"type":"structure",
|
||||
"required":["StackName"],
|
||||
"members":{
|
||||
"StackName":{"shape":"StackNameOrId"},
|
||||
"StackResourceDriftStatusFilters":{"shape":"StackResourceDriftStatusFilters"},
|
||||
"NextToken":{"shape":"NextToken"},
|
||||
"MaxResults":{"shape":"BoxedMaxResults"}
|
||||
}
|
||||
},
|
||||
"DescribeStackResourceDriftsOutput":{
|
||||
"type":"structure",
|
||||
"required":["StackResourceDrifts"],
|
||||
"members":{
|
||||
"StackResourceDrifts":{"shape":"StackResourceDrifts"},
|
||||
"NextToken":{"shape":"NextToken"}
|
||||
}
|
||||
},
|
||||
"DescribeStackResourceInput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -1131,6 +1235,47 @@
|
||||
"max":1024,
|
||||
"min":1
|
||||
},
|
||||
"DetectStackDriftInput":{
|
||||
"type":"structure",
|
||||
"required":["StackName"],
|
||||
"members":{
|
||||
"StackName":{"shape":"StackNameOrId"},
|
||||
"LogicalResourceIds":{"shape":"LogicalResourceIds"}
|
||||
}
|
||||
},
|
||||
"DetectStackDriftOutput":{
|
||||
"type":"structure",
|
||||
"required":["StackDriftDetectionId"],
|
||||
"members":{
|
||||
"StackDriftDetectionId":{"shape":"StackDriftDetectionId"}
|
||||
}
|
||||
},
|
||||
"DetectStackResourceDriftInput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"StackName",
|
||||
"LogicalResourceId"
|
||||
],
|
||||
"members":{
|
||||
"StackName":{"shape":"StackNameOrId"},
|
||||
"LogicalResourceId":{"shape":"LogicalResourceId"}
|
||||
}
|
||||
},
|
||||
"DetectStackResourceDriftOutput":{
|
||||
"type":"structure",
|
||||
"required":["StackResourceDrift"],
|
||||
"members":{
|
||||
"StackResourceDrift":{"shape":"StackResourceDrift"}
|
||||
}
|
||||
},
|
||||
"DifferenceType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ADD",
|
||||
"REMOVE",
|
||||
"NOT_EQUAL"
|
||||
]
|
||||
},
|
||||
"DisableRollback":{"type":"boolean"},
|
||||
"EnableTerminationProtection":{"type":"boolean"},
|
||||
"EstimateTemplateCostInput":{
|
||||
@@ -1169,6 +1314,12 @@
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"ExecutionRoleName":{
|
||||
"type":"string",
|
||||
"max":64,
|
||||
"min":1,
|
||||
"pattern":"[a-zA-Z_0-9+=,.@-]+"
|
||||
},
|
||||
"ExecutionStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
@@ -1290,6 +1441,7 @@
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"Key":{"type":"string"},
|
||||
"LastUpdatedTime":{"type":"timestamp"},
|
||||
"LimitExceededException":{
|
||||
"type":"structure",
|
||||
@@ -1446,6 +1598,12 @@
|
||||
}
|
||||
},
|
||||
"LogicalResourceId":{"type":"string"},
|
||||
"LogicalResourceIds":{
|
||||
"type":"list",
|
||||
"member":{"shape":"LogicalResourceId"},
|
||||
"max":200,
|
||||
"min":1
|
||||
},
|
||||
"MaxConcurrentCount":{
|
||||
"type":"integer",
|
||||
"min":1
|
||||
@@ -1583,7 +1741,45 @@
|
||||
"member":{"shape":"Parameter"}
|
||||
},
|
||||
"PhysicalResourceId":{"type":"string"},
|
||||
"PhysicalResourceIdContext":{
|
||||
"type":"list",
|
||||
"member":{"shape":"PhysicalResourceIdContextKeyValuePair"},
|
||||
"max":5
|
||||
},
|
||||
"PhysicalResourceIdContextKeyValuePair":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Key",
|
||||
"Value"
|
||||
],
|
||||
"members":{
|
||||
"Key":{"shape":"Key"},
|
||||
"Value":{"shape":"Value"}
|
||||
}
|
||||
},
|
||||
"Properties":{"type":"string"},
|
||||
"PropertyDifference":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"PropertyPath",
|
||||
"ExpectedValue",
|
||||
"ActualValue",
|
||||
"DifferenceType"
|
||||
],
|
||||
"members":{
|
||||
"PropertyPath":{"shape":"PropertyPath"},
|
||||
"ExpectedValue":{"shape":"PropertyValue"},
|
||||
"ActualValue":{"shape":"PropertyValue"},
|
||||
"DifferenceType":{"shape":"DifferenceType"}
|
||||
}
|
||||
},
|
||||
"PropertyDifferences":{
|
||||
"type":"list",
|
||||
"member":{"shape":"PropertyDifference"}
|
||||
},
|
||||
"PropertyName":{"type":"string"},
|
||||
"PropertyPath":{"type":"string"},
|
||||
"PropertyValue":{"type":"string"},
|
||||
"Reason":{"type":"string"},
|
||||
"Region":{"type":"string"},
|
||||
"RegionList":{
|
||||
@@ -1786,9 +1982,49 @@
|
||||
"Tags":{"shape":"Tags"},
|
||||
"EnableTerminationProtection":{"shape":"EnableTerminationProtection"},
|
||||
"ParentId":{"shape":"StackId"},
|
||||
"RootId":{"shape":"StackId"}
|
||||
"RootId":{"shape":"StackId"},
|
||||
"DriftInformation":{"shape":"StackDriftInformation"}
|
||||
}
|
||||
},
|
||||
"StackDriftDetectionId":{
|
||||
"type":"string",
|
||||
"max":36,
|
||||
"min":1
|
||||
},
|
||||
"StackDriftDetectionStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"DETECTION_IN_PROGRESS",
|
||||
"DETECTION_FAILED",
|
||||
"DETECTION_COMPLETE"
|
||||
]
|
||||
},
|
||||
"StackDriftDetectionStatusReason":{"type":"string"},
|
||||
"StackDriftInformation":{
|
||||
"type":"structure",
|
||||
"required":["StackDriftStatus"],
|
||||
"members":{
|
||||
"StackDriftStatus":{"shape":"StackDriftStatus"},
|
||||
"LastCheckTimestamp":{"shape":"Timestamp"}
|
||||
}
|
||||
},
|
||||
"StackDriftInformationSummary":{
|
||||
"type":"structure",
|
||||
"required":["StackDriftStatus"],
|
||||
"members":{
|
||||
"StackDriftStatus":{"shape":"StackDriftStatus"},
|
||||
"LastCheckTimestamp":{"shape":"Timestamp"}
|
||||
}
|
||||
},
|
||||
"StackDriftStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"DRIFTED",
|
||||
"IN_SYNC",
|
||||
"UNKNOWN",
|
||||
"NOT_CHECKED"
|
||||
]
|
||||
},
|
||||
"StackEvent":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
@@ -1905,7 +2141,8 @@
|
||||
"Timestamp":{"shape":"Timestamp"},
|
||||
"ResourceStatus":{"shape":"ResourceStatus"},
|
||||
"ResourceStatusReason":{"shape":"ResourceStatusReason"},
|
||||
"Description":{"shape":"Description"}
|
||||
"Description":{"shape":"Description"},
|
||||
"DriftInformation":{"shape":"StackResourceDriftInformation"}
|
||||
}
|
||||
},
|
||||
"StackResourceDetail":{
|
||||
@@ -1926,9 +2163,67 @@
|
||||
"ResourceStatus":{"shape":"ResourceStatus"},
|
||||
"ResourceStatusReason":{"shape":"ResourceStatusReason"},
|
||||
"Description":{"shape":"Description"},
|
||||
"Metadata":{"shape":"Metadata"}
|
||||
"Metadata":{"shape":"Metadata"},
|
||||
"DriftInformation":{"shape":"StackResourceDriftInformation"}
|
||||
}
|
||||
},
|
||||
"StackResourceDrift":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"StackId",
|
||||
"LogicalResourceId",
|
||||
"ResourceType",
|
||||
"StackResourceDriftStatus",
|
||||
"Timestamp"
|
||||
],
|
||||
"members":{
|
||||
"StackId":{"shape":"StackId"},
|
||||
"LogicalResourceId":{"shape":"LogicalResourceId"},
|
||||
"PhysicalResourceId":{"shape":"PhysicalResourceId"},
|
||||
"PhysicalResourceIdContext":{"shape":"PhysicalResourceIdContext"},
|
||||
"ResourceType":{"shape":"ResourceType"},
|
||||
"ExpectedProperties":{"shape":"Properties"},
|
||||
"ActualProperties":{"shape":"Properties"},
|
||||
"PropertyDifferences":{"shape":"PropertyDifferences"},
|
||||
"StackResourceDriftStatus":{"shape":"StackResourceDriftStatus"},
|
||||
"Timestamp":{"shape":"Timestamp"}
|
||||
}
|
||||
},
|
||||
"StackResourceDriftInformation":{
|
||||
"type":"structure",
|
||||
"required":["StackResourceDriftStatus"],
|
||||
"members":{
|
||||
"StackResourceDriftStatus":{"shape":"StackResourceDriftStatus"},
|
||||
"LastCheckTimestamp":{"shape":"Timestamp"}
|
||||
}
|
||||
},
|
||||
"StackResourceDriftInformationSummary":{
|
||||
"type":"structure",
|
||||
"required":["StackResourceDriftStatus"],
|
||||
"members":{
|
||||
"StackResourceDriftStatus":{"shape":"StackResourceDriftStatus"},
|
||||
"LastCheckTimestamp":{"shape":"Timestamp"}
|
||||
}
|
||||
},
|
||||
"StackResourceDriftStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"IN_SYNC",
|
||||
"MODIFIED",
|
||||
"DELETED",
|
||||
"NOT_CHECKED"
|
||||
]
|
||||
},
|
||||
"StackResourceDriftStatusFilters":{
|
||||
"type":"list",
|
||||
"member":{"shape":"StackResourceDriftStatus"},
|
||||
"max":4,
|
||||
"min":1
|
||||
},
|
||||
"StackResourceDrifts":{
|
||||
"type":"list",
|
||||
"member":{"shape":"StackResourceDrift"}
|
||||
},
|
||||
"StackResourceSummaries":{
|
||||
"type":"list",
|
||||
"member":{"shape":"StackResourceSummary"}
|
||||
@@ -1947,7 +2242,8 @@
|
||||
"ResourceType":{"shape":"ResourceType"},
|
||||
"LastUpdatedTimestamp":{"shape":"Timestamp"},
|
||||
"ResourceStatus":{"shape":"ResourceStatus"},
|
||||
"ResourceStatusReason":{"shape":"ResourceStatusReason"}
|
||||
"ResourceStatusReason":{"shape":"ResourceStatusReason"},
|
||||
"DriftInformation":{"shape":"StackResourceDriftInformationSummary"}
|
||||
}
|
||||
},
|
||||
"StackResources":{
|
||||
@@ -1966,7 +2262,8 @@
|
||||
"Capabilities":{"shape":"Capabilities"},
|
||||
"Tags":{"shape":"Tags"},
|
||||
"StackSetARN":{"shape":"StackSetARN"},
|
||||
"AdministrationRoleARN":{"shape":"RoleARN"}
|
||||
"AdministrationRoleARN":{"shape":"RoleARN"},
|
||||
"ExecutionRoleName":{"shape":"ExecutionRoleName"}
|
||||
}
|
||||
},
|
||||
"StackSetARN":{"type":"string"},
|
||||
@@ -2008,6 +2305,7 @@
|
||||
"OperationPreferences":{"shape":"StackSetOperationPreferences"},
|
||||
"RetainStacks":{"shape":"RetainStacksNullable"},
|
||||
"AdministrationRoleARN":{"shape":"RoleARN"},
|
||||
"ExecutionRoleName":{"shape":"ExecutionRoleName"},
|
||||
"CreationTimestamp":{"shape":"Timestamp"},
|
||||
"EndTimestamp":{"shape":"Timestamp"}
|
||||
}
|
||||
@@ -2146,7 +2444,8 @@
|
||||
"StackStatus":{"shape":"StackStatus"},
|
||||
"StackStatusReason":{"shape":"StackStatusReason"},
|
||||
"ParentId":{"shape":"StackId"},
|
||||
"RootId":{"shape":"StackId"}
|
||||
"RootId":{"shape":"StackId"},
|
||||
"DriftInformation":{"shape":"StackDriftInformationSummary"}
|
||||
}
|
||||
},
|
||||
"Stacks":{
|
||||
@@ -2292,7 +2591,7 @@
|
||||
"Regions"
|
||||
],
|
||||
"members":{
|
||||
"StackSetName":{"shape":"StackSetName"},
|
||||
"StackSetName":{"shape":"StackSetNameOrId"},
|
||||
"Accounts":{"shape":"AccountList"},
|
||||
"Regions":{"shape":"RegionList"},
|
||||
"ParameterOverrides":{"shape":"Parameters"},
|
||||
@@ -2329,10 +2628,13 @@
|
||||
"Tags":{"shape":"Tags"},
|
||||
"OperationPreferences":{"shape":"StackSetOperationPreferences"},
|
||||
"AdministrationRoleARN":{"shape":"RoleARN"},
|
||||
"ExecutionRoleName":{"shape":"ExecutionRoleName"},
|
||||
"OperationId":{
|
||||
"shape":"ClientRequestToken",
|
||||
"idempotencyToken":true
|
||||
}
|
||||
},
|
||||
"Accounts":{"shape":"AccountList"},
|
||||
"Regions":{"shape":"RegionList"}
|
||||
}
|
||||
},
|
||||
"UpdateStackSetOutput":{
|
||||
@@ -2378,6 +2680,7 @@
|
||||
"DeclaredTransforms":{"shape":"TransformsList"}
|
||||
}
|
||||
},
|
||||
"Value":{"type":"string"},
|
||||
"Version":{"type":"string"}
|
||||
}
|
||||
}
|
||||
|
||||
Generated
Vendored
+305
-71
@@ -1,9 +1,9 @@
|
||||
{
|
||||
"version": "2.0",
|
||||
"service": "<fullname>AWS CloudFormation</fullname> <p>AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly scalable, cost-effective applications without creating or configuring the underlying AWS infrastructure.</p> <p>With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.</p> <p>For more information about AWS CloudFormation, see the <a href=\"http://aws.amazon.com/cloudformation/\">AWS CloudFormation Product Page</a>.</p> <p>Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at <a href=\"http://docs.aws.amazon.com/\">docs.aws.amazon.com</a>.</p>",
|
||||
"service": "<fullname>AWS CloudFormation</fullname> <p>AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly scalable, cost-effective applications without creating or configuring the underlying AWS infrastructure.</p> <p>With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.</p> <p>For more information about AWS CloudFormation, see the <a href=\"http://aws.amazon.com/cloudformation/\">AWS CloudFormation Product Page</a>.</p> <p>Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at <a href=\"https://docs.aws.amazon.com/\">docs.aws.amazon.com</a>.</p>",
|
||||
"operations": {
|
||||
"CancelUpdateStack": "<p>Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.</p> <note> <p>You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.</p> </note>",
|
||||
"ContinueUpdateRollback": "<p>For a specified stack that is in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of the failure, you can manually <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed\"> fix the error</a> and continue the rollback. By continuing the rollback, you can return your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and then try to update the stack again.</p> <p>A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.</p>",
|
||||
"ContinueUpdateRollback": "<p>For a specified stack that is in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of the failure, you can manually <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed\"> fix the error</a> and continue the rollback. By continuing the rollback, you can return your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and then try to update the stack again.</p> <p>A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.</p>",
|
||||
"CreateChangeSet": "<p>Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that AWS CloudFormation will create. If you create a change set for an existing stack, AWS CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources AWS CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.</p> <p>To create a change set for a stack that doesn't exist, for the <code>ChangeSetType</code> parameter, specify <code>CREATE</code>. To create a change set for an existing stack, specify <code>UPDATE</code> for the <code>ChangeSetType</code> parameter. After the <code>CreateChangeSet</code> call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the <a>DescribeChangeSet</a> action.</p> <p>When you are satisfied with the changes the change set will make, execute the change set by using the <a>ExecuteChangeSet</a> action. AWS CloudFormation doesn't make changes until you execute the change set.</p>",
|
||||
"CreateStack": "<p>Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the <a>DescribeStacks</a> API.</p>",
|
||||
"CreateStackInstances": "<p>Creates stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. <code>Accounts</code> and <code>Regions</code> are required parameters—you must specify at least one account and one region. </p>",
|
||||
@@ -12,23 +12,27 @@
|
||||
"DeleteStack": "<p>Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the <a>DescribeStacks</a> API if the deletion has been completed successfully.</p>",
|
||||
"DeleteStackInstances": "<p>Deletes stack instances for the specified accounts, in the specified regions. </p>",
|
||||
"DeleteStackSet": "<p>Deletes a stack set. Before you can delete a stack set, all of its member stack instances must be deleted. For more information about how to do this, see <a>DeleteStackInstances</a>. </p>",
|
||||
"DescribeAccountLimits": "<p>Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account.</p>",
|
||||
"DescribeChangeSet": "<p>Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html\">Updating Stacks Using Change Sets</a> in the AWS CloudFormation User Guide.</p>",
|
||||
"DescribeStackEvents": "<p>Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html\">Stacks</a> in the AWS CloudFormation User Guide.</p> <note> <p>You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).</p> </note>",
|
||||
"DescribeAccountLimits": "<p>Retrieves your account's AWS CloudFormation limits, such as the maximum number of stacks that you can create in your account. For more information about account limits, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html\">AWS CloudFormation Limits</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
|
||||
"DescribeChangeSet": "<p>Returns the inputs for the change set and a list of changes that AWS CloudFormation will make if you execute the change set. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-changesets.html\">Updating Stacks Using Change Sets</a> in the AWS CloudFormation User Guide.</p>",
|
||||
"DescribeStackDriftDetectionStatus": "<p>Returns information about a stack drift detection operation. A stack drift detection operation detects whether a stack's actual configuration differs, or has <i>drifted</i>, from it's expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted. For more information on stack and resource drift, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html\">Detecting Unregulated Configuration Changes to Stacks and Resources</a>.</p> <p>Use <a>DetectStackDrift</a> to initiate a stack drift detection operation. <code>DetectStackDrift</code> returns a <code>StackDriftDetectionId</code> you can use to monitor the progress of the operation using <code>DescribeStackDriftDetectionStatus</code>. Once the drift detection operation has completed, use <a>DescribeStackResourceDrifts</a> to return drift information about the stack and its resources.</p>",
|
||||
"DescribeStackEvents": "<p>Returns all stack related events for a specified stack in reverse chronological order. For more information about a stack's event history, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-stack.html\">Stacks</a> in the AWS CloudFormation User Guide.</p> <note> <p>You can list events for stacks that have failed to create or have been deleted by specifying the unique stack identifier (stack ID).</p> </note>",
|
||||
"DescribeStackInstance": "<p>Returns the stack instance that's associated with the specified stack set, AWS account, and region.</p> <p>For a list of stack instances that are associated with a specific stack set, use <a>ListStackInstances</a>.</p>",
|
||||
"DescribeStackResource": "<p>Returns a description of the specified resource in the specified stack.</p> <p>For deleted stacks, DescribeStackResource returns resource information for up to 90 days after the stack has been deleted.</p>",
|
||||
"DescribeStackResources": "<p>Returns AWS resource descriptions for running and deleted stacks. If <code>StackName</code> is specified, all the associated resources that are part of the stack are returned. If <code>PhysicalResourceId</code> is specified, the associated resources of the stack that the resource belongs to are returned.</p> <note> <p>Only the first 100 resources will be returned. If your stack has more resources than this, you should use <code>ListStackResources</code> instead.</p> </note> <p>For deleted stacks, <code>DescribeStackResources</code> returns resource information for up to 90 days after the stack has been deleted.</p> <p>You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but not both. In addition, you can specify <code>LogicalResourceId</code> to filter the returned result. For more information about resources, the <code>LogicalResourceId</code> and <code>PhysicalResourceId</code>, go to the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/\">AWS CloudFormation User Guide</a>.</p> <note> <p>A <code>ValidationError</code> is returned if you specify both <code>StackName</code> and <code>PhysicalResourceId</code> in the same request.</p> </note>",
|
||||
"DescribeStackResourceDrifts": "<p>Returns drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where AWS CloudFormation detects configuration drift.</p> <p>For a given stack, there will be one <code>StackResourceDrift</code> for each stack resource that has been checked for drift. Resources that have not yet been checked for drift are not included. Resources that do not currently support drift detection are not checked, and so not included. For a list of resources that support drift detection, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html\">Resources that Support Drift Detection</a>.</p> <p>Use <a>DetectStackResourceDrift</a> to detect drift on individual resources, or <a>DetectStackDrift</a> to detect drift on all supported resources for a given stack.</p>",
|
||||
"DescribeStackResources": "<p>Returns AWS resource descriptions for running and deleted stacks. If <code>StackName</code> is specified, all the associated resources that are part of the stack are returned. If <code>PhysicalResourceId</code> is specified, the associated resources of the stack that the resource belongs to are returned.</p> <note> <p>Only the first 100 resources will be returned. If your stack has more resources than this, you should use <code>ListStackResources</code> instead.</p> </note> <p>For deleted stacks, <code>DescribeStackResources</code> returns resource information for up to 90 days after the stack has been deleted.</p> <p>You must specify either <code>StackName</code> or <code>PhysicalResourceId</code>, but not both. In addition, you can specify <code>LogicalResourceId</code> to filter the returned result. For more information about resources, the <code>LogicalResourceId</code> and <code>PhysicalResourceId</code>, go to the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/\">AWS CloudFormation User Guide</a>.</p> <note> <p>A <code>ValidationError</code> is returned if you specify both <code>StackName</code> and <code>PhysicalResourceId</code> in the same request.</p> </note>",
|
||||
"DescribeStackSet": "<p>Returns the description of the specified stack set. </p>",
|
||||
"DescribeStackSetOperation": "<p>Returns the description of the specified stack set operation. </p>",
|
||||
"DescribeStacks": "<p>Returns the description for the specified stack; if no stack name was specified, then it returns the description for all the stacks created.</p> <note> <p>If the stack does not exist, an <code>AmazonCloudFormationException</code> is returned.</p> </note>",
|
||||
"DetectStackDrift": "<p>Detects whether a stack's actual configuration differs, or has <i>drifted</i>, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For each resource in the stack that supports drift detection, AWS CloudFormation compares the actual configuration of the resource with its expected template configuration. Only resource properties explicitly defined in the stack template are checked for drift. A stack is considered to have drifted if one or more of its resources differ from their expected template configurations. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html\">Detecting Unregulated Configuration Changes to Stacks and Resources</a>.</p> <p>Use <code>DetectStackDrift</code> to detect drift on all supported resources for a given stack, or <a>DetectStackResourceDrift</a> to detect drift on individual resources.</p> <p>For a list of stack resources that currently support drift detection, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html\">Resources that Support Drift Detection</a>.</p> <p> <code>DetectStackDrift</code> can take up to several minutes, depending on the number of resources contained within the stack. Use <a>DescribeStackDriftDetectionStatus</a> to monitor the progress of a detect stack drift operation. Once the drift detection operation has completed, use <a>DescribeStackResourceDrifts</a> to return drift information about the stack and its resources.</p> <p>When detecting drift on a stack, AWS CloudFormation does not detect drift on any nested stacks belonging to that stack. Perform <code>DetectStackDrift</code> directly on the nested stack itself.</p>",
|
||||
"DetectStackResourceDrift": "<p>Returns information about whether a resource's actual configuration differs, or has <i>drifted</i>, from it's expected configuration, as defined in the stack template and any values specified as template parameters. This information includes actual and expected property values for resources in which AWS CloudFormation detects drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information about stack and resource drift, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html\">Detecting Unregulated Configuration Changes to Stacks and Resources</a>.</p> <p>Use <code>DetectStackResourceDrift</code> to detect drift on individual resources, or <a>DetectStackDrift</a> to detect drift on all resources in a given stack that support drift detection.</p> <p>Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html\">Resources that Support Drift Detection</a>.</p>",
|
||||
"EstimateTemplateCost": "<p>Returns the estimated monthly cost of a template. The return value is an AWS Simple Monthly Calculator URL with a query string that describes the resources required to run the template.</p>",
|
||||
"ExecuteChangeSet": "<p>Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the <a>DescribeStacks</a> action to view the status of the update.</p> <p>When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.</p> <p>If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.</p>",
|
||||
"GetStackPolicy": "<p>Returns the stack policy for a specified stack. If a stack doesn't have a policy, a null value is returned.</p>",
|
||||
"GetTemplate": "<p>Returns the template body for a specified stack. You can get the template for running or deleted stacks.</p> <p>For deleted stacks, GetTemplate returns the template for up to 90 days after the stack has been deleted.</p> <note> <p> If the template does not exist, a <code>ValidationError</code> is returned. </p> </note>",
|
||||
"GetTemplateSummary": "<p>Returns information about a new or existing template. The <code>GetTemplateSummary</code> action is useful for viewing parameter information, such as default parameter values and parameter types, before you create or update a stack or stack set.</p> <p>You can use the <code>GetTemplateSummary</code> action when you submit a template, or you can get template information for a stack set, or a running or deleted stack.</p> <p>For deleted stacks, <code>GetTemplateSummary</code> returns the template information for up to 90 days after the stack has been deleted. If the template does not exist, a <code>ValidationError</code> is returned.</p>",
|
||||
"ListChangeSets": "<p>Returns the ID and status of each active change set for a stack. For example, AWS CloudFormation lists change sets that are in the <code>CREATE_IN_PROGRESS</code> or <code>CREATE_PENDING</code> state.</p>",
|
||||
"ListExports": "<p>Lists all exported output values in the account and region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html\"> <code>Fn::ImportValue</code> </a> function. </p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html\"> AWS CloudFormation Export Stack Output Values</a>.</p>",
|
||||
"ListImports": "<p>Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see <a>ListExports</a>. </p> <p>For more information about importing an exported output value, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html\"> <code>Fn::ImportValue</code> </a> function. </p>",
|
||||
"ListExports": "<p>Lists all exported output values in the account and region in which you call this action. Use this action to see the exported output values that you can import into other stacks. To import values, use the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html\"> <code>Fn::ImportValue</code> </a> function. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-exports.html\"> AWS CloudFormation Export Stack Output Values</a>.</p>",
|
||||
"ListImports": "<p>Lists all stacks that are importing an exported output value. To modify or remove an exported output value, first use this action to see which stacks are using it. To see the exported output values in your account, see <a>ListExports</a>. </p> <p>For more information about importing an exported output value, see the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-importvalue.html\"> <code>Fn::ImportValue</code> </a> function. </p>",
|
||||
"ListStackInstances": "<p>Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or region.</p>",
|
||||
"ListStackResources": "<p>Returns descriptions of all resources of the specified stack.</p> <p>For deleted stacks, ListStackResources returns resource information for up to 90 days after the stack has been deleted.</p>",
|
||||
"ListStackSetOperationResults": "<p>Returns summary information about the results of a stack set operation. </p>",
|
||||
@@ -38,10 +42,10 @@
|
||||
"SetStackPolicy": "<p>Sets a stack policy for a specified stack.</p>",
|
||||
"SignalResource": "<p>Sends a signal to the specified resource with a success or failure status. You can use the SignalResource API in conjunction with a creation policy or update policy. AWS CloudFormation doesn't proceed with a stack creation or update until resources receive the required number of signals or the timeout period is exceeded. The SignalResource API is useful in cases where you want to send signals from anywhere other than an Amazon EC2 instance.</p>",
|
||||
"StopStackSetOperation": "<p>Stops an in-progress operation on a stack set and its associated stack instances. </p>",
|
||||
"UpdateStack": "<p>Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the <a>DescribeStacks</a> action.</p> <p>To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action.</p> <p>For more information about creating an update template, updating a stack, and monitoring the progress of the update, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html\">Updating a Stack</a>.</p>",
|
||||
"UpdateStackInstances": "<p>Updates the parameter values for stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. </p> <p>You can only update stack instances in regions and accounts where they already exist; to create additional stack instances, use <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html\">CreateStackInstances</a>. </p> <p>During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value.</p> <p>You can only update the parameter <i>values</i> that are specified in the stack set; to add or delete a parameter itself, use <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using <code>UpdateStackInstances</code>.</p>",
|
||||
"UpdateStackSet": "<p>Updates the stack set and <i>all</i> associated stack instances.</p> <p>Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent <a>CreateStackInstances</a> calls on the specified stack set use the updated stack set.</p>",
|
||||
"UpdateTerminationProtection": "<p>Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html\">Protecting a Stack From Being Deleted</a> in the <i>AWS CloudFormation User Guide</i>.</p> <p> For <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html\">nested stacks</a>, termination protection is set on the root stack and cannot be changed directly on the nested stack.</p>",
|
||||
"UpdateStack": "<p>Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the <a>DescribeStacks</a> action.</p> <p>To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action.</p> <p>For more information about creating an update template, updating a stack, and monitoring the progress of the update, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html\">Updating a Stack</a>.</p>",
|
||||
"UpdateStackInstances": "<p>Updates the parameter values for stack instances for the specified accounts, within the specified regions. A stack instance refers to a stack in a specific account and region. </p> <p>You can only update stack instances in regions and accounts where they already exist; to create additional stack instances, use <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CreateStackInstances.html\">CreateStackInstances</a>. </p> <p>During stack set updates, any parameters overridden for a stack instance are not updated, but retain their overridden value.</p> <p>You can only update the parameter <i>values</i> that are specified in the stack set; to add or delete a parameter itself, use <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using <code>UpdateStackInstances</code>.</p>",
|
||||
"UpdateStackSet": "<p>Updates the stack set, and associated stack instances in the specified accounts and regions.</p> <p>Even if the stack set operation created by updating the stack set fails (completely or partially, below or above a specified failure tolerance), the stack set is updated with your changes. Subsequent <a>CreateStackInstances</a> calls on the specified stack set use the updated stack set.</p>",
|
||||
"UpdateTerminationProtection": "<p>Updates termination protection for the specified stack. If a user attempts to delete a stack with termination protection enabled, the operation fails and the stack remains unchanged. For more information, see <a href=\"AWSCloudFormation/latest/UserGuide/using-cfn-protect-stacks.html\">Protecting a Stack From Being Deleted</a> in the <i>AWS CloudFormation User Guide</i>.</p> <p> For <a href=\"AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html\">nested stacks</a>, termination protection is set on the root stack and cannot be changed directly on the nested stack.</p>",
|
||||
"ValidateTemplate": "<p>Validates a specified template. AWS CloudFormation first checks if the template is valid JSON. If it isn't, AWS CloudFormation checks if the template is valid YAML. If both these checks fail, AWS CloudFormation returns a template validation error.</p>"
|
||||
},
|
||||
"shapes": {
|
||||
@@ -57,7 +61,7 @@
|
||||
}
|
||||
},
|
||||
"AccountGateResult": {
|
||||
"base": "<p>Structure that contains the results of the account gate function which AWS CloudFormation invokes, if present, before proceeding with a stack set operation in an account and region.</p> <p>For each account and region, AWS CloudFormation lets you specify a Lamdba function that encapsulates any requirements that must be met before CloudFormation can proceed with a stack set operation in that account and region. CloudFormation invokes the function each time a stack set operation is requested for that account and region; if the function returns <code>FAILED</code>, CloudFormation cancels the operation in that account and region, and sets the stack set operation result status for that account and region to <code>FAILED</code>. </p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-account-gating.html\">Configuring a target account gate</a>.</p>",
|
||||
"base": "<p>Structure that contains the results of the account gate function which AWS CloudFormation invokes, if present, before proceeding with a stack set operation in an account and region.</p> <p>For each account and region, AWS CloudFormation lets you specify a Lamdba function that encapsulates any requirements that must be met before CloudFormation can proceed with a stack set operation in that account and region. CloudFormation invokes the function each time a stack set operation is requested for that account and region; if the function returns <code>FAILED</code>, CloudFormation cancels the operation in that account and region, and sets the stack set operation result status for that account and region to <code>FAILED</code>. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-account-gating.html\">Configuring a target account gate</a>.</p>",
|
||||
"refs": {
|
||||
"StackSetOperationResultSummary$AccountGateResult": "<p>The results of the account gate function AWS CloudFormation invokes, if present, before proceeding with stack set operations in an account</p>"
|
||||
}
|
||||
@@ -75,7 +79,7 @@
|
||||
}
|
||||
},
|
||||
"AccountLimit": {
|
||||
"base": "<p>The AccountLimit data type.</p>",
|
||||
"base": "<p>The AccountLimit data type. For more information about account limits, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html\">AWS CloudFormation Limits</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
|
||||
"refs": {
|
||||
"AccountLimitList$member": null
|
||||
}
|
||||
@@ -91,7 +95,8 @@
|
||||
"refs": {
|
||||
"CreateStackInstancesInput$Accounts": "<p>The names of one or more AWS accounts that you want to create stack instances in the specified region(s) for.</p>",
|
||||
"DeleteStackInstancesInput$Accounts": "<p>The names of the AWS accounts that you want to delete stack instances for.</p>",
|
||||
"UpdateStackInstancesInput$Accounts": "<p>The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.</p>"
|
||||
"UpdateStackInstancesInput$Accounts": "<p>The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.</p>",
|
||||
"UpdateStackSetInput$Accounts": "<p>The accounts in which to update associated stack instances. If you specify accounts, you must also specify the regions in which to update stack set instances.</p> <p>To update <i>all</i> the stack instances associated with this stack set, do not specify the <code>Accounts</code> or <code>Regions</code> properties.</p> <p>If the stack set update includes changes to the template (that is, if the <code>TemplateBody</code> or <code>TemplateURL</code> properties are specified), or the <code>Parameters</code> property, AWS CloudFormation marks all stack instances with a status of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status. </p>"
|
||||
}
|
||||
},
|
||||
"AllowedValue": {
|
||||
@@ -117,6 +122,18 @@
|
||||
"RollbackTrigger$Arn": "<p>The Amazon Resource Name (ARN) of the rollback trigger.</p> <p>If a specified trigger is missing, the entire stack operation fails and is rolled back. </p>"
|
||||
}
|
||||
},
|
||||
"BoxedInteger": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeStackDriftDetectionStatusOutput$DriftedStackResourceCount": "<p>Total number of stack resources that have drifted. This is NULL until the drift detection operation reaches a status of <code>DETECTION_COMPLETE</code>. This value will be 0 for stacks whose drift status is <code>IN_SYNC</code>.</p>"
|
||||
}
|
||||
},
|
||||
"BoxedMaxResults": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeStackResourceDriftsInput$MaxResults": "<p>The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>"
|
||||
}
|
||||
},
|
||||
"CancelUpdateStackInput": {
|
||||
"base": "<p>The input for the <a>CancelUpdateStack</a> action.</p>",
|
||||
"refs": {
|
||||
@@ -125,16 +142,16 @@
|
||||
"Capabilities": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateChangeSetInput$Capabilities": "<p>A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.</p> <p>The only valid values are <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>. The following resources require you to specify this parameter: <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html\"> AWS::IAM::AccessKey</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html\"> AWS::IAM::Group</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\"> AWS::IAM::InstanceProfile</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html\"> AWS::IAM::Policy</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html\"> AWS::IAM::User</a>, and <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html\"> AWS::IAM::UserToGroupAddition</a>. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <p>If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify <code>CAPABILITY_NAMED_IAM</code>. If you don't specify this parameter, this action returns an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p>",
|
||||
"CreateStackInput$Capabilities": "<p>A list of values that you must specify before AWS CloudFormation can create certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.</p> <p>The only valid values are <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>. The following resources require you to specify this parameter: <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html\"> AWS::IAM::AccessKey</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html\"> AWS::IAM::Group</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\"> AWS::IAM::InstanceProfile</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html\"> AWS::IAM::Policy</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html\"> AWS::IAM::User</a>, and <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html\"> AWS::IAM::UserToGroupAddition</a>. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <p>If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify <code>CAPABILITY_NAMED_IAM</code>. If you don't specify this parameter, this action returns an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p>",
|
||||
"CreateStackSetInput$Capabilities": "<p>A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge their capabilities by specifying this parameter.</p> <p>The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: </p> <ul> <li> <p>AWS::IAM::AccessKey</p> </li> <li> <p>AWS::IAM::Group</p> </li> <li> <p>AWS::IAM::InstanceProfile</p> </li> <li> <p>AWS::IAM::Policy</p> </li> <li> <p>AWS::IAM::Role</p> </li> <li> <p>AWS::IAM::User</p> </li> <li> <p>AWS::IAM::UserToGroupAddition</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions that are associated with them and edit their permissions if necessary.</p> <p>If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates.</a> </p>",
|
||||
"CreateChangeSetInput$Capabilities": "<p>In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability. </p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>. </p> </li> <li> <p>If you don't specify either of these capabilities, AWS CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html\"> AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html\"> AWS::IAM::Group</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\"> AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html\"> AWS::IAM::Policy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html\"> AWS::IAM::User</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html\"> AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html\">AWS::Include</a> and <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html\">AWS::Serverless</a> transforms, which are macros hosted by AWS CloudFormation.</p> <note> <p>This capacity does not apply to creating change sets, and specifying it when creating change sets has no effect.</p> <p>Also, change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros <i>and</i> nested stacks, you must create or update the stack directly from the template using the <a>CreateStack</a> or <a>UpdateStack</a> action, and specifying this capability.</p> </note> <p>For more information on macros, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html\">Using AWS CloudFormation Macros to Perform Custom Processing on Templates</a>.</p> </li> </ul>",
|
||||
"CreateStackInput$Capabilities": "<p>In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to create the stack.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability. </p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>. </p> </li> <li> <p>If you don't specify either of these capabilities, AWS CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html\"> AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html\"> AWS::IAM::Group</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\"> AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html\"> AWS::IAM::Policy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html\"> AWS::IAM::User</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html\"> AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually creating the stack. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html\">AWS::Include</a> and <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html\">AWS::Serverless</a> transforms, which are macros hosted by AWS CloudFormation.</p> <p>Change sets do not currently support nested stacks. If you want to create a stack from a stack template that contains macros <i>and</i> nested stacks, you must create the stack directly from the template using this capability.</p> <important> <p>You should only create stacks directly from a stack template that contains macros if you know what processing the macro performs.</p> <p>Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.</p> </important> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html\">Using AWS CloudFormation Macros to Perform Custom Processing on Templates</a>.</p> </li> </ul>",
|
||||
"CreateStackSetInput$Capabilities": "<p>In some cases, you must explicity acknowledge that your stack set template contains certain capabilities in order for AWS CloudFormation to create the stack set and related stack instances.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge this by specifying one of these capabilities.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability. </p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>. </p> </li> <li> <p>If you don't specify either of these capabilities, AWS CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html\"> AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html\"> AWS::IAM::Group</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\"> AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html\"> AWS::IAM::Policy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html\"> AWS::IAM::User</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html\"> AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>Some templates contain macros. If your stack template contains one or more macros, and you choose to create a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html\">Using AWS CloudFormation Macros to Perform Custom Processing on Templates</a>.</p> <note> <p>Stack sets do not currently support macros in stack templates. (This includes the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html\">AWS::Include</a> and <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html\">AWS::Serverless</a> transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.</p> </note> </li> </ul>",
|
||||
"DescribeChangeSetOutput$Capabilities": "<p>If you execute the change set, the list of capabilities that were explicitly acknowledged when the change set was created.</p>",
|
||||
"GetTemplateSummaryOutput$Capabilities": "<p>The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the <a>CreateStack</a> or <a>UpdateStack</a> actions with your template; otherwise, those actions return an InsufficientCapabilities error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p>",
|
||||
"GetTemplateSummaryOutput$Capabilities": "<p>The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the <a>CreateStack</a> or <a>UpdateStack</a> actions with your template; otherwise, those actions return an InsufficientCapabilities error.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p>",
|
||||
"Stack$Capabilities": "<p>The capabilities allowed in the stack.</p>",
|
||||
"StackSet$Capabilities": "<p>The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates.</a> </p>",
|
||||
"UpdateStackInput$Capabilities": "<p>A list of values that you must specify before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter.</p> <p>The only valid values are <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code>. The following resources require you to specify this parameter: <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html\"> AWS::IAM::AccessKey</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html\"> AWS::IAM::Group</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\"> AWS::IAM::InstanceProfile</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html\"> AWS::IAM::Policy</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a>, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html\"> AWS::IAM::User</a>, and <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html\"> AWS::IAM::UserToGroupAddition</a>. If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <p>If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify <code>CAPABILITY_NAMED_IAM</code>. If you don't specify this parameter, this action returns an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p>",
|
||||
"UpdateStackSetInput$Capabilities": "<p>A list of values that you must specify before AWS CloudFormation can create certain stack sets. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For those stack sets, you must explicitly acknowledge their capabilities by specifying this parameter.</p> <p>The only valid values are CAPABILITY_IAM and CAPABILITY_NAMED_IAM. The following resources require you to specify this parameter: </p> <ul> <li> <p>AWS::IAM::AccessKey</p> </li> <li> <p>AWS::IAM::Group</p> </li> <li> <p>AWS::IAM::InstanceProfile</p> </li> <li> <p>AWS::IAM::Policy</p> </li> <li> <p>AWS::IAM::Role</p> </li> <li> <p>AWS::IAM::User</p> </li> <li> <p>AWS::IAM::UserToGroupAddition</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions that are associated with them and edit their permissions if necessary.</p> <p>If you have IAM resources, you can specify either capability. If you have IAM resources with custom names, you must specify CAPABILITY_NAMED_IAM. If you don't specify this parameter, this action returns an <code>InsufficientCapabilities</code> error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates.</a> </p>",
|
||||
"ValidateTemplateOutput$Capabilities": "<p>The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the <a>CreateStack</a> or <a>UpdateStack</a> actions with your template; otherwise, those actions return an InsufficientCapabilities error.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p>"
|
||||
"StackSet$Capabilities": "<p>The capabilities that are allowed in the stack set. Some stack set templates might include resources that can affect permissions in your AWS account—for example, by creating new AWS Identity and Access Management (IAM) users. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates.</a> </p>",
|
||||
"UpdateStackInput$Capabilities": "<p>In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge this by specifying one of these capabilities.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability. </p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>. </p> </li> <li> <p>If you don't specify either of these capabilities, AWS CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html\"> AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html\"> AWS::IAM::Group</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\"> AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html\"> AWS::IAM::Policy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html\"> AWS::IAM::User</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html\"> AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>Some template contain macros. Macros perform custom processing on templates; this can include simple actions like find-and-replace operations, all the way to extensive transformations of entire templates. Because of this, users typically create a change set from the processed template, so that they can review the changes resulting from the macros before actually updating the stack. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. This includes the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html\">AWS::Include</a> and <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html\">AWS::Serverless</a> transforms, which are macros hosted by AWS CloudFormation.</p> <p>Change sets do not currently support nested stacks. If you want to update a stack from a stack template that contains macros <i>and</i> nested stacks, you must update the stack directly from the template using this capability.</p> <important> <p>You should only update stacks directly from a stack template that contains macros if you know what processing the macro performs.</p> <p>Each macro relies on an underlying Lambda service function for processing stack templates. Be aware that the Lambda function owner can update the function operation without AWS CloudFormation being notified.</p> </important> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html\">Using AWS CloudFormation Macros to Perform Custom Processing on Templates</a>.</p> </li> </ul>",
|
||||
"UpdateStackSetInput$Capabilities": "<p>In some cases, you must explicity acknowledge that your stack template contains certain capabilities in order for AWS CloudFormation to update the stack set and its associated stack instances.</p> <ul> <li> <p> <code>CAPABILITY_IAM</code> and <code>CAPABILITY_NAMED_IAM</code> </p> <p>Some stack templates might include resources that can affect permissions in your AWS account; for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks sets, you must explicitly acknowledge this by specifying one of these capabilities.</p> <p>The following IAM resources require you to specify either the <code>CAPABILITY_IAM</code> or <code>CAPABILITY_NAMED_IAM</code> capability.</p> <ul> <li> <p>If you have IAM resources, you can specify either capability. </p> </li> <li> <p>If you have IAM resources with custom names, you <i>must</i> specify <code>CAPABILITY_NAMED_IAM</code>. </p> </li> <li> <p>If you don't specify either of these capabilities, AWS CloudFormation returns an <code>InsufficientCapabilities</code> error.</p> </li> </ul> <p>If your stack template contains these resources, we recommend that you review all permissions associated with them and edit their permissions if necessary.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-accesskey.html\"> AWS::IAM::AccessKey</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-group.html\"> AWS::IAM::Group</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-instanceprofile.html\"> AWS::IAM::InstanceProfile</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-policy.html\"> AWS::IAM::Policy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-role.html\"> AWS::IAM::Role</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user.html\"> AWS::IAM::User</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-addusertogroup.html\"> AWS::IAM::UserToGroupAddition</a> </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p> </li> <li> <p> <code>CAPABILITY_AUTO_EXPAND</code> </p> <p>Some templates contain macros. If your stack template contains one or more macros, and you choose to update a stack directly from the processed template, without first reviewing the resulting changes in a change set, you must acknowledge this capability. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-macros.html\">Using AWS CloudFormation Macros to Perform Custom Processing on Templates</a>.</p> <important> <p>Stack sets do not currently support macros in stack templates. (This includes the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/create-reusable-transform-function-snippets-and-add-to-your-template-with-aws-include-transform.html\">AWS::Include</a> and <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/transform-aws-serverless.html\">AWS::Serverless</a> transforms, which are macros hosted by AWS CloudFormation.) Even if you specify this capability, if you include a macro in your template the stack set operation will fail.</p> </important> </li> </ul>",
|
||||
"ValidateTemplateOutput$Capabilities": "<p>The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the <a>CreateStack</a> or <a>UpdateStack</a> actions with your template; otherwise, those actions return an InsufficientCapabilities error.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#capabilities\">Acknowledging IAM Resources in AWS CloudFormation Templates</a>.</p>"
|
||||
}
|
||||
},
|
||||
"CapabilitiesReason": {
|
||||
@@ -228,7 +245,7 @@
|
||||
"ChangeSetType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateChangeSetInput$ChangeSetType": "<p>The type of change set operation. To create a change set for a new stack, specify <code>CREATE</code>. To create a change set for an existing stack, specify <code>UPDATE</code>.</p> <p>If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no template or resources. The stack will be in the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995\"> <code>REVIEW_IN_PROGRESS</code> </a> state until you execute the change set.</p> <p>By default, AWS CloudFormation specifies <code>UPDATE</code>. You can't use the <code>UPDATE</code> type to create a change set for a new stack or the <code>CREATE</code> type to create a change set for an existing stack.</p>"
|
||||
"CreateChangeSetInput$ChangeSetType": "<p>The type of change set operation. To create a change set for a new stack, specify <code>CREATE</code>. To create a change set for an existing stack, specify <code>UPDATE</code>.</p> <p>If you create a change set for a new stack, AWS Cloudformation creates a stack with a unique stack ID, but no template or resources. The stack will be in the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-describing-stacks.html#d0e11995\"> <code>REVIEW_IN_PROGRESS</code> </a> state until you execute the change set.</p> <p>By default, AWS CloudFormation specifies <code>UPDATE</code>. You can't use the <code>UPDATE</code> type to create a change set for a new stack or the <code>CREATE</code> type to create a change set for an existing stack.</p>"
|
||||
}
|
||||
},
|
||||
"ChangeSource": {
|
||||
@@ -407,6 +424,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeStackDriftDetectionStatusInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeStackDriftDetectionStatusOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeStackEventsInput": {
|
||||
"base": "<p>The input for <a>DescribeStackEvents</a> action.</p>",
|
||||
"refs": {
|
||||
@@ -427,6 +454,16 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeStackResourceDriftsInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeStackResourceDriftsOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DescribeStackResourceInput": {
|
||||
"base": "<p>The input for <a>DescribeStackResource</a> action.</p>",
|
||||
"refs": {
|
||||
@@ -497,6 +534,32 @@
|
||||
"ValidateTemplateOutput$Description": "<p>The description found within the template.</p>"
|
||||
}
|
||||
},
|
||||
"DetectStackDriftInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DetectStackDriftOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DetectStackResourceDriftInput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DetectStackResourceDriftOutput": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"DifferenceType": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PropertyDifference$DifferenceType": "<p>The type of property difference.</p> <ul> <li> <p> <code>ADD</code>: A value has been added to a resource property that is an array or list data type.</p> </li> <li> <p> <code>REMOVE</code>: The property has been removed from the current resource configuration.</p> </li> <li> <p> <code>NOT_EQUAL</code>: The current property value differs from its expected value (as defined in the stack template and any values specified as template parameters).</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"DisableRollback": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -544,6 +607,15 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"ExecutionRoleName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateStackSetInput$ExecutionRoleName": "<p>The name of the IAM execution role to use to create the stack set. If you do not specify an execution role, AWS CloudFormation uses the <code>AWSCloudFormationStackSetExecutionRole</code> role for the stack set operation.</p> <p>Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets. </p>",
|
||||
"StackSet$ExecutionRoleName": "<p>The name of the IAM execution role used to create or update the stack set. </p> <p>Use customized execution roles to control which stack resources users and groups can include in their stack sets. </p>",
|
||||
"StackSetOperation$ExecutionRoleName": "<p>The name of the IAM execution role used to create or update the stack set.</p> <p>Use customized execution roles to control which stack resources users and groups can include in their stack sets. </p>",
|
||||
"UpdateStackSetInput$ExecutionRoleName": "<p>The name of the IAM execution role to use to update the stack set. If you do not specify an execution role, AWS CloudFormation uses the <code>AWSCloudFormationStackSetExecutionRole</code> role for the stack set operation.</p> <p>Specify an IAM role only if you are using customized execution roles to control which stack resources users and groups can include in their stack sets. </p> <p> If you specify a customized execution role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized execution role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.</p>"
|
||||
}
|
||||
},
|
||||
"ExecutionStatus": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -640,6 +712,12 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Key": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PhysicalResourceIdContextKeyValuePair$Key": "<p>The resource context key.</p>"
|
||||
}
|
||||
},
|
||||
"LastUpdatedTime": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -648,14 +726,14 @@
|
||||
}
|
||||
},
|
||||
"LimitExceededException": {
|
||||
"base": "<p>The quota for the resource has already been reached.</p> <p>For information on stack set limitations, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-limitations.html\">Limitations of StackSets</a>.</p>",
|
||||
"base": "<p>The quota for the resource has already been reached.</p> <p>For information on resource and stack limitations, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cloudformation-limits.html\">Limits</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"LimitName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"AccountLimit$Name": "<p>The name of the account limit. Currently, the only account limit is <code>StackLimit</code>.</p>"
|
||||
"AccountLimit$Name": "<p>The name of the account limit.</p>"
|
||||
}
|
||||
},
|
||||
"LimitValue": {
|
||||
@@ -759,15 +837,24 @@
|
||||
"refs": {
|
||||
"DescribeStackResourceInput$LogicalResourceId": "<p>The logical name of the resource as specified in the template.</p> <p>Default: There is no default value.</p>",
|
||||
"DescribeStackResourcesInput$LogicalResourceId": "<p>The logical name of the resource as specified in the template.</p> <p>Default: There is no default value.</p>",
|
||||
"DetectStackResourceDriftInput$LogicalResourceId": "<p>The logical name of the resource for which to return drift information.</p>",
|
||||
"LogicalResourceIds$member": null,
|
||||
"ResourceChange$LogicalResourceId": "<p>The resource's logical ID, which is defined in the stack's template.</p>",
|
||||
"RetainResources$member": null,
|
||||
"SignalResourceInput$LogicalResourceId": "<p>The logical ID of the resource that you want to signal. The logical ID is the name of the resource that given in the template.</p>",
|
||||
"StackEvent$LogicalResourceId": "<p>The logical name of the resource specified in the template.</p>",
|
||||
"StackResource$LogicalResourceId": "<p>The logical name of the resource specified in the template.</p>",
|
||||
"StackResourceDetail$LogicalResourceId": "<p>The logical name of the resource specified in the template.</p>",
|
||||
"StackResourceDrift$LogicalResourceId": "<p>The logical name of the resource specified in the template.</p>",
|
||||
"StackResourceSummary$LogicalResourceId": "<p>The logical name of the resource specified in the template.</p>"
|
||||
}
|
||||
},
|
||||
"LogicalResourceIds": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DetectStackDriftInput$LogicalResourceIds": "<p>The logical names of any resources you want to use as filters.</p>"
|
||||
}
|
||||
},
|
||||
"MaxConcurrentCount": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -793,13 +880,13 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetTemplateSummaryOutput$Metadata": "<p>The value that is defined for the <code>Metadata</code> property of the template.</p>",
|
||||
"StackResourceDetail$Metadata": "<p>The content of the <code>Metadata</code> attribute declared for the resource. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html\">Metadata Attribute</a> in the AWS CloudFormation User Guide.</p>"
|
||||
"StackResourceDetail$Metadata": "<p>The content of the <code>Metadata</code> attribute declared for the resource. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-metadata.html\">Metadata Attribute</a> in the AWS CloudFormation User Guide.</p>"
|
||||
}
|
||||
},
|
||||
"MonitoringTimeInMinutes": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"RollbackConfiguration$MonitoringTimeInMinutes": "<p>The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.</p> <p>The default is 0 minutes.</p> <p>If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html\">CancelUpdateStack</a>, for example) as necessary.</p> <p>If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.</p>"
|
||||
"RollbackConfiguration$MonitoringTimeInMinutes": "<p>The amount of time, in minutes, during which CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources.</p> <p>The default is 0 minutes.</p> <p>If you specify a monitoring period but do not specify any rollback triggers, CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_CancelUpdateStack.html\">CancelUpdateStack</a>, for example) as necessary.</p> <p>If you specify 0 for this parameter, CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes.</p>"
|
||||
}
|
||||
},
|
||||
"NameAlreadyExistsException": {
|
||||
@@ -816,6 +903,8 @@
|
||||
"DescribeChangeSetOutput$NextToken": "<p>If the output exceeds 1 MB, a string that identifies the next page of changes. If there is no additional page, this value is null.</p>",
|
||||
"DescribeStackEventsInput$NextToken": "<p>A string that identifies the next page of events that you want to retrieve.</p>",
|
||||
"DescribeStackEventsOutput$NextToken": "<p>If the output exceeds 1 MB in size, a string that identifies the next page of events. If no additional page exists, this value is null.</p>",
|
||||
"DescribeStackResourceDriftsInput$NextToken": "<p>A string that identifies the next page of stack resource drift results.</p>",
|
||||
"DescribeStackResourceDriftsOutput$NextToken": "<p>If the request doesn't return all of the remaining results, <code>NextToken</code> is set to a token. To retrieve the next set of results, call <code>DescribeStackResourceDrifts</code> again and assign that token to the request object's <code>NextToken</code> parameter. If the request returns all results, <code>NextToken</code> is set to <code>null</code>.</p>",
|
||||
"DescribeStacksInput$NextToken": "<p>A string that identifies the next page of stacks that you want to retrieve.</p>",
|
||||
"DescribeStacksOutput$NextToken": "<p>If the output exceeds 1 MB in size, a string that identifies the next page of stacks. If no additional page exists, this value is null.</p>",
|
||||
"ListChangeSetsInput$NextToken": "<p>A string (provided by the <a>ListChangeSets</a> response output) that identifies the next page of change sets that you want to retrieve.</p>",
|
||||
@@ -948,7 +1037,7 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"Parameter$ParameterValue": "<p>The input value associated with the parameter.</p>",
|
||||
"Parameter$ResolvedValue": "<p>Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types\"> <code>SSM</code> parameter types</a> in the template.</p>",
|
||||
"Parameter$ResolvedValue": "<p>Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/parameters-section-structure.html#aws-ssm-parameter-types\"> <code>SSM</code> parameter types</a> in the template.</p>",
|
||||
"ParameterDeclaration$DefaultValue": "<p>The default value of the parameter.</p>",
|
||||
"TemplateParameter$DefaultValue": "<p>The default value associated with the parameter.</p>"
|
||||
}
|
||||
@@ -956,17 +1045,17 @@
|
||||
"Parameters": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateChangeSetInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters for the change set. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>",
|
||||
"CreateStackInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>",
|
||||
"CreateStackInstancesInput$ParameterOverrides": "<p>A list of stack set parameters whose values you want to override in the selected stack instances.</p> <p>Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance operations:</p> <ul> <li> <p>To override the current value for a parameter, include the parameter and specify its value.</p> </li> <li> <p>To leave a parameter set to its present value, you can do one of the following:</p> <ul> <li> <p>Do not include the parameter in the list.</p> </li> <li> <p>Include the parameter and specify <code>UsePreviousValue</code> as <code>true</code>. (You cannot specify both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p> </li> </ul> </li> <li> <p>To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.</p> </li> <li> <p>To leave all parameters set to their present values, do not specify this property at all.</p> </li> </ul> <p>During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.</p> <p>You can only override the parameter <i>values</i> that are specified in the stack set; to add or delete a parameter itself, use <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update the stack set template.</p>",
|
||||
"CreateChangeSetInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters for the change set. For more information, see the <a>Parameter</a> data type.</p>",
|
||||
"CreateStackInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information, see the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>",
|
||||
"CreateStackInstancesInput$ParameterOverrides": "<p>A list of stack set parameters whose values you want to override in the selected stack instances.</p> <p>Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance operations:</p> <ul> <li> <p>To override the current value for a parameter, include the parameter and specify its value.</p> </li> <li> <p>To leave a parameter set to its present value, you can do one of the following:</p> <ul> <li> <p>Do not include the parameter in the list.</p> </li> <li> <p>Include the parameter and specify <code>UsePreviousValue</code> as <code>true</code>. (You cannot specify both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p> </li> </ul> </li> <li> <p>To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.</p> </li> <li> <p>To leave all parameters set to their present values, do not specify this property at all.</p> </li> </ul> <p>During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.</p> <p>You can only override the parameter <i>values</i> that are specified in the stack set; to add or delete a parameter itself, use <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update the stack set template.</p>",
|
||||
"CreateStackSetInput$Parameters": "<p>The input parameters for the stack set template. </p>",
|
||||
"DescribeChangeSetOutput$Parameters": "<p>A list of <code>Parameter</code> structures that describes the input parameters and their values used to create the change set. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>",
|
||||
"DescribeChangeSetOutput$Parameters": "<p>A list of <code>Parameter</code> structures that describes the input parameters and their values used to create the change set. For more information, see the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>",
|
||||
"EstimateTemplateCostInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters.</p>",
|
||||
"Stack$Parameters": "<p>A list of <code>Parameter</code> structures.</p>",
|
||||
"StackInstance$ParameterOverrides": "<p>A list of parameters from the stack set template whose values have been overridden in this stack instance.</p>",
|
||||
"StackSet$Parameters": "<p>A list of input parameters for a stack set.</p>",
|
||||
"UpdateStackInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information, see the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>",
|
||||
"UpdateStackInstancesInput$ParameterOverrides": "<p> A list of input parameters whose values you want to update for the specified stack instances. </p> <p>Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance update operations:</p> <ul> <li> <p>To override the current value for a parameter, include the parameter and specify its value.</p> </li> <li> <p>To leave a parameter set to its present value, you can do one of the following:</p> <ul> <li> <p>Do not include the parameter in the list.</p> </li> <li> <p>Include the parameter and specify <code>UsePreviousValue</code> as <code>true</code>. (You cannot specify both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p> </li> </ul> </li> <li> <p>To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.</p> </li> <li> <p>To leave all parameters set to their present values, do not specify this property at all.</p> </li> </ul> <p>During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.</p> <p>You can only override the parameter <i>values</i> that are specified in the stack set; to add or delete a parameter itself, use <code>UpdateStackSet</code> to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using <code>UpdateStackInstances</code>.</p>",
|
||||
"UpdateStackInput$Parameters": "<p>A list of <code>Parameter</code> structures that specify input parameters for the stack. For more information, see the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_Parameter.html\">Parameter</a> data type.</p>",
|
||||
"UpdateStackInstancesInput$ParameterOverrides": "<p> A list of input parameters whose values you want to update for the specified stack instances. </p> <p>Any overridden parameter values will be applied to all stack instances in the specified accounts and regions. When specifying parameters and their values, be aware of how AWS CloudFormation sets parameter values during stack instance update operations:</p> <ul> <li> <p>To override the current value for a parameter, include the parameter and specify its value.</p> </li> <li> <p>To leave a parameter set to its present value, you can do one of the following:</p> <ul> <li> <p>Do not include the parameter in the list.</p> </li> <li> <p>Include the parameter and specify <code>UsePreviousValue</code> as <code>true</code>. (You cannot specify both a value and set <code>UsePreviousValue</code> to <code>true</code>.)</p> </li> </ul> </li> <li> <p>To set all overridden parameter back to the values specified in the stack set, specify a parameter list but do not include any parameters.</p> </li> <li> <p>To leave all parameters set to their present values, do not specify this property at all.</p> </li> </ul> <p>During stack set updates, any parameter values overridden for a stack instance are not updated, but retain their overridden value.</p> <p>You can only override the parameter <i>values</i> that are specified in the stack set; to add or delete a parameter itself, use <code>UpdateStackSet</code> to update the stack set template. If you add a parameter to a template, before you can override the parameter value specified in the stack set you must first use <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_UpdateStackSet.html\">UpdateStackSet</a> to update all stack instances with the updated template and parameter value specified in the stack set. Once a stack instance has been updated with the new parameter, you can then override the parameter value using <code>UpdateStackInstances</code>.</p>",
|
||||
"UpdateStackSetInput$Parameters": "<p>A list of input parameters for the stack set template. </p>"
|
||||
}
|
||||
},
|
||||
@@ -978,15 +1067,60 @@
|
||||
"StackEvent$PhysicalResourceId": "<p>The name or unique identifier associated with the physical instance of the resource.</p>",
|
||||
"StackResource$PhysicalResourceId": "<p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.</p>",
|
||||
"StackResourceDetail$PhysicalResourceId": "<p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation.</p>",
|
||||
"StackResourceDrift$PhysicalResourceId": "<p>The name or unique identifier that corresponds to a physical instance ID of a resource supported by AWS CloudFormation. </p>",
|
||||
"StackResourceSummary$PhysicalResourceId": "<p>The name or unique identifier that corresponds to a physical instance ID of the resource.</p>"
|
||||
}
|
||||
},
|
||||
"PhysicalResourceIdContext": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StackResourceDrift$PhysicalResourceIdContext": "<p>Context information that enables AWS CloudFormation to uniquely identify a resource. AWS CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs are not enough to uniquely identify that resource. Each context key-value pair specifies a unique resource that contains the targeted resource.</p>"
|
||||
}
|
||||
},
|
||||
"PhysicalResourceIdContextKeyValuePair": {
|
||||
"base": "<p>Context information that enables AWS CloudFormation to uniquely identify a resource. AWS CloudFormation uses context key-value pairs in cases where a resource's logical and physical IDs are not enough to uniquely identify that resource. Each context key-value pair specifies a resource that contains the targeted resource.</p>",
|
||||
"refs": {
|
||||
"PhysicalResourceIdContext$member": null
|
||||
}
|
||||
},
|
||||
"Properties": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StackResourceDrift$ExpectedProperties": "<p>A JSON structure containing the expected property values of the stack resource, as defined in the stack template and any values specified as template parameters. </p> <p>For resources whose <code>StackResourceDriftStatus</code> is <code>DELETED</code>, this structure will not be present. </p>",
|
||||
"StackResourceDrift$ActualProperties": "<p>A JSON structure containing the actual property values of the stack resource.</p> <p>For resources whose <code>StackResourceDriftStatus</code> is <code>DELETED</code>, this structure will not be present. </p>"
|
||||
}
|
||||
},
|
||||
"PropertyDifference": {
|
||||
"base": "<p>Information about a resource property whose actual value differs from its expected value, as defined in the stack template and any values specified as template parameters. These will be present only for resources whose <code>StackResourceDriftStatus</code> is <code>MODIFIED</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html\">Detecting Unregulated Configuration Changes to Stacks and Resources</a>.</p>",
|
||||
"refs": {
|
||||
"PropertyDifferences$member": null
|
||||
}
|
||||
},
|
||||
"PropertyDifferences": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StackResourceDrift$PropertyDifferences": "<p>A collection of the resource properties whose actual values differ from their expected values. These will be present only for resources whose <code>StackResourceDriftStatus</code> is <code>MODIFIED</code>. </p>"
|
||||
}
|
||||
},
|
||||
"PropertyName": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ResourceTargetDefinition$Name": "<p>If the <code>Attribute</code> value is <code>Properties</code>, the name of the property. For all other attributes, the value is null.</p>"
|
||||
}
|
||||
},
|
||||
"PropertyPath": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PropertyDifference$PropertyPath": "<p>The fully-qualified path to the resource property.</p>"
|
||||
}
|
||||
},
|
||||
"PropertyValue": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PropertyDifference$ExpectedValue": "<p>The expected property value of the resource property, as defined in the stack template and any values specified as template parameters.</p>",
|
||||
"PropertyDifference$ActualValue": "<p>The actual property value of the resource property.</p>"
|
||||
}
|
||||
},
|
||||
"Reason": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -1012,7 +1146,8 @@
|
||||
"CreateStackInstancesInput$Regions": "<p>The names of one or more regions where you want to create stack instances using the specified AWS account(s). </p>",
|
||||
"DeleteStackInstancesInput$Regions": "<p>The regions where you want to delete stack set instances. </p>",
|
||||
"StackSetOperationPreferences$RegionOrder": "<p>The order of the regions in where you want to perform the stack operation.</p>",
|
||||
"UpdateStackInstancesInput$Regions": "<p>The names of one or more regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.</p>"
|
||||
"UpdateStackInstancesInput$Regions": "<p>The names of one or more regions in which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and regions.</p>",
|
||||
"UpdateStackSetInput$Regions": "<p>The regions in which to update associated stack instances. If you specify regions, you must also specify accounts in which to update stack set instances.</p> <p>To update <i>all</i> the stack instances associated with this stack set, do not specify the <code>Accounts</code> or <code>Regions</code> properties.</p> <p>If the stack set update includes changes to the template (that is, if the <code>TemplateBody</code> or <code>TemplateURL</code> properties are specified), or the <code>Parameters</code> property, AWS CloudFormation marks all stack instances with a status of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and regions, while leaving all other stack instances with their existing stack instance status. </p>"
|
||||
}
|
||||
},
|
||||
"Replacement": {
|
||||
@@ -1024,7 +1159,7 @@
|
||||
"RequiresRecreation": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ResourceTargetDefinition$RequiresRecreation": "<p>If the <code>Attribute</code> value is <code>Properties</code>, indicates whether a change to this property causes the resource to be recreated. The value can be <code>Never</code>, <code>Always</code>, or <code>Conditionally</code>. To determine the conditions for a <code>Conditionally</code> recreation, see the update behavior for that <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\">property</a> in the AWS CloudFormation User Guide.</p>"
|
||||
"ResourceTargetDefinition$RequiresRecreation": "<p>If the <code>Attribute</code> value is <code>Properties</code>, indicates whether a change to this property causes the resource to be recreated. The value can be <code>Never</code>, <code>Always</code>, or <code>Conditionally</code>. To determine the conditions for a <code>Conditionally</code> recreation, see the update behavior for that <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\">property</a> in the AWS CloudFormation User Guide.</p>"
|
||||
}
|
||||
},
|
||||
"ResourceAttribute": {
|
||||
@@ -1105,25 +1240,26 @@
|
||||
"refs": {
|
||||
"ResourceChange$ResourceType": "<p>The type of AWS CloudFormation resource, such as <code>AWS::S3::Bucket</code>.</p>",
|
||||
"ResourceTypes$member": null,
|
||||
"StackEvent$ResourceType": "<p>Type of resource. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\"> AWS Resource Types Reference</a> in the AWS CloudFormation User Guide.)</p>",
|
||||
"StackResource$ResourceType": "<p>Type of resource. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\"> AWS Resource Types Reference</a> in the AWS CloudFormation User Guide.)</p>",
|
||||
"StackResourceDetail$ResourceType": "<p>Type of resource. ((For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\"> AWS Resource Types Reference</a> in the AWS CloudFormation User Guide.)</p>",
|
||||
"StackResourceSummary$ResourceType": "<p>Type of resource. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\"> AWS Resource Types Reference</a> in the AWS CloudFormation User Guide.)</p>"
|
||||
"StackEvent$ResourceType": "<p>Type of resource. (For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\"> AWS Resource Types Reference</a> in the AWS CloudFormation User Guide.)</p>",
|
||||
"StackResource$ResourceType": "<p>Type of resource. (For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\"> AWS Resource Types Reference</a> in the AWS CloudFormation User Guide.)</p>",
|
||||
"StackResourceDetail$ResourceType": "<p>Type of resource. ((For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\"> AWS Resource Types Reference</a> in the AWS CloudFormation User Guide.)</p>",
|
||||
"StackResourceDrift$ResourceType": "<p>The type of the resource.</p>",
|
||||
"StackResourceSummary$ResourceType": "<p>Type of resource. (For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html\"> AWS Resource Types Reference</a> in the AWS CloudFormation User Guide.)</p>"
|
||||
}
|
||||
},
|
||||
"ResourceTypes": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateChangeSetInput$ResourceTypes": "<p>The template resource types that you have permissions to work with if you execute this change set, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>.</p> <p>If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html\">Controlling Access with AWS Identity and Access Management</a> in the AWS CloudFormation User Guide.</p>",
|
||||
"CreateStackInput$ResourceTypes": "<p>The template resource types that you have permissions to work with for this create stack action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>. Use the following syntax to describe template resource types: <code>AWS::*</code> (for all AWS resource), <code>Custom::*</code> (for all custom resources), <code>Custom::<i>logical_ID</i> </code> (for a specific custom resource), <code>AWS::<i>service_name</i>::*</code> (for all resources of a particular AWS service), and <code>AWS::<i>service_name</i>::<i>resource_logical_ID</i> </code> (for a specific AWS resource).</p> <p>If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html\">Controlling Access with AWS Identity and Access Management</a>.</p>",
|
||||
"CreateChangeSetInput$ResourceTypes": "<p>The template resource types that you have permissions to work with if you execute this change set, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>.</p> <p>If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html\">Controlling Access with AWS Identity and Access Management</a> in the AWS CloudFormation User Guide.</p>",
|
||||
"CreateStackInput$ResourceTypes": "<p>The template resource types that you have permissions to work with for this create stack action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>. Use the following syntax to describe template resource types: <code>AWS::*</code> (for all AWS resource), <code>Custom::*</code> (for all custom resources), <code>Custom::<i>logical_ID</i> </code> (for a specific custom resource), <code>AWS::<i>service_name</i>::*</code> (for all resources of a particular AWS service), and <code>AWS::<i>service_name</i>::<i>resource_logical_ID</i> </code> (for a specific AWS resource).</p> <p>If the list of resource types doesn't include a resource that you're creating, the stack creation fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html\">Controlling Access with AWS Identity and Access Management</a>.</p>",
|
||||
"GetTemplateSummaryOutput$ResourceTypes": "<p>A list of all the template resource types that are defined in the template, such as <code>AWS::EC2::Instance</code>, <code>AWS::Dynamo::Table</code>, and <code>Custom::MyCustomInstance</code>.</p>",
|
||||
"UpdateStackInput$ResourceTypes": "<p>The template resource types that you have permissions to work with for this update stack action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>.</p> <p>If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html\">Controlling Access with AWS Identity and Access Management</a>.</p>"
|
||||
"UpdateStackInput$ResourceTypes": "<p>The template resource types that you have permissions to work with for this update stack action, such as <code>AWS::EC2::Instance</code>, <code>AWS::EC2::*</code>, or <code>Custom::MyCustomInstance</code>.</p> <p>If the list of resource types doesn't include a resource that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. AWS Identity and Access Management (IAM) uses this parameter for AWS CloudFormation-specific condition keys in IAM policies. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html\">Controlling Access with AWS Identity and Access Management</a>.</p>"
|
||||
}
|
||||
},
|
||||
"ResourcesToSkip": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"ContinueUpdateRollbackInput$ResourcesToSkip": "<p>A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the <code>UPDATE_FAILED</code> state because a rollback failed. You can't specify resources that are in the <code>UPDATE_FAILED</code> state for other reasons, for example, because an update was cancelled. To check why a resource update failed, use the <a>DescribeStackResources</a> action, and view the resource status reason. </p> <important> <p>Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We recommend that you <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed\"> troubleshoot</a> resources before skipping them. AWS CloudFormation sets the status of the specified resources to <code>UPDATE_COMPLETE</code> and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable. </p> </important> <p>Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources. </p> <p>To skip resources that are part of nested stacks, use the following format: <code>NestedStackName.ResourceLogicalID</code>. If you want to specify the logical ID of a stack resource (<code>Type: AWS::CloudFormation::Stack</code>) in the <code>ResourcesToSkip</code> list, then its corresponding embedded stack must be in one of the following states: <code>DELETE_IN_PROGRESS</code>, <code>DELETE_COMPLETE</code>, or <code>DELETE_FAILED</code>. </p> <note> <p>Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html#nested-stacks\">Using ResourcesToSkip to recover a nested stacks hierarchy</a>. </p> </note>"
|
||||
"ContinueUpdateRollbackInput$ResourcesToSkip": "<p>A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the <code>UPDATE_FAILED</code> state because a rollback failed. You can't specify resources that are in the <code>UPDATE_FAILED</code> state for other reasons, for example, because an update was cancelled. To check why a resource update failed, use the <a>DescribeStackResources</a> action, and view the resource status reason. </p> <important> <p>Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We recommend that you <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed\"> troubleshoot</a> resources before skipping them. AWS CloudFormation sets the status of the specified resources to <code>UPDATE_COMPLETE</code> and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable. </p> </important> <p>Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources. </p> <p>To skip resources that are part of nested stacks, use the following format: <code>NestedStackName.ResourceLogicalID</code>. If you want to specify the logical ID of a stack resource (<code>Type: AWS::CloudFormation::Stack</code>) in the <code>ResourcesToSkip</code> list, then its corresponding embedded stack must be in one of the following states: <code>DELETE_IN_PROGRESS</code>, <code>DELETE_COMPLETE</code>, or <code>DELETE_FAILED</code>. </p> <note> <p>Don't confuse a child stack's name with its corresponding logical ID defined in the parent stack. For an example of a continue update rollback operation with nested stacks, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html#nested-stacks\">Using ResourcesToSkip to recover a nested stacks hierarchy</a>. </p> </note>"
|
||||
}
|
||||
},
|
||||
"RetainResources": {
|
||||
@@ -1135,7 +1271,7 @@
|
||||
"RetainStacks": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DeleteStackInstancesInput$RetainStacks": "<p>Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options\">Stack set operation options</a>.</p>"
|
||||
"DeleteStackInstancesInput$RetainStacks": "<p>Removes the stack instances from the specified stack set, but doesn't delete the stacks. You can't reassociate a retained stack or add an existing, saved stack to a new stack set.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options\">Stack set operation options</a>.</p>"
|
||||
}
|
||||
},
|
||||
"RetainStacksNullable": {
|
||||
@@ -1150,13 +1286,13 @@
|
||||
"ContinueUpdateRollbackInput$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to roll back the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>",
|
||||
"CreateChangeSetInput$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>",
|
||||
"CreateStackInput$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to create the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>",
|
||||
"CreateStackSetInput$AdministrationRoleARN": "<p>The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. </p> <p>Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Define Permissions for Multiple Administrators</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
|
||||
"CreateStackSetInput$AdministrationRoleARN": "<p>The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. </p> <p>Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Prerequisites: Granting Permissions for Stack Set Operations</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
|
||||
"DeleteStackInput$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>",
|
||||
"Stack$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that is associated with the stack. During a stack operation, AWS CloudFormation uses this role's credentials to make calls on your behalf.</p>",
|
||||
"StackSet$AdministrationRoleARN": "<p>The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.</p> <p>Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Define Permissions for Multiple Administrators</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
|
||||
"StackSet$AdministrationRoleARN": "<p>The Amazon Resource Number (ARN) of the IAM role used to create or update the stack set.</p> <p>Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Prerequisites: Granting Permissions for Stack Set Operations</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
|
||||
"StackSetOperation$AdministrationRoleARN": "<p>The Amazon Resource Number (ARN) of the IAM role used to perform this stack set operation. </p> <p>Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Define Permissions for Multiple Administrators</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
|
||||
"UpdateStackInput$RoleARN": "<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to update the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation always uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>",
|
||||
"UpdateStackSetInput$AdministrationRoleARN": "<p>The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.</p> <p>Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Define Permissions for Multiple Administrators</a> in the <i>AWS CloudFormation User Guide</i>.</p> <p> If you specify a customized administrator role, AWS CloudFormation uses that role to update the stack. If you do not specify a customized administrator role, AWS CloudFormation performs the update using the role previously associated with the stack set, so long as you have permissions to perform operations on the stack set.</p>"
|
||||
"UpdateStackSetInput$AdministrationRoleARN": "<p>The Amazon Resource Number (ARN) of the IAM role to use to update this stack set.</p> <p>Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html\">Granting Permissions for Stack Set Operations</a> in the <i>AWS CloudFormation User Guide</i>.</p> <p>If you specified a customized administrator role when you created the stack set, you must specify a customized administrator role, even if it is the same customized administrator role used with this stack set previously.</p>"
|
||||
}
|
||||
},
|
||||
"RollbackConfiguration": {
|
||||
@@ -1203,6 +1339,46 @@
|
||||
"Stacks$member": null
|
||||
}
|
||||
},
|
||||
"StackDriftDetectionId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeStackDriftDetectionStatusInput$StackDriftDetectionId": "<p>The ID of the drift detection results of this operation. </p> <p>AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results AWS CloudFormation retains for any given stack, and for how long, may vary. </p>",
|
||||
"DescribeStackDriftDetectionStatusOutput$StackDriftDetectionId": "<p>The ID of the drift detection results of this operation. </p> <p>AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of reports AWS CloudFormation retains for any given stack, and for how long, may vary.</p>",
|
||||
"DetectStackDriftOutput$StackDriftDetectionId": "<p>The ID of the drift detection results of this operation. </p> <p>AWS CloudFormation generates new results, with a new drift detection ID, each time this operation is run. However, the number of drift results AWS CloudFormation retains for any given stack, and for how long, may vary. </p>"
|
||||
}
|
||||
},
|
||||
"StackDriftDetectionStatus": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeStackDriftDetectionStatusOutput$DetectionStatus": "<p>The status of the stack drift detection operation.</p> <ul> <li> <p> <code>DETECTION_COMPLETE</code>: The stack drift detection operation has successfully completed for all resources in the stack that support drift detection. (Resources that do not currently support stack detection remain unchecked.)</p> <p>If you specified logical resource IDs for AWS CloudFormation to use as a filter for the stack drift detection operation, only the resources with those logical IDs are checked for drift.</p> </li> <li> <p> <code>DETECTION_FAILED</code>: The stack drift detection operation has failed for at least one resource in the stack. Results will be available for resources on which AWS CloudFormation successfully completed drift detection.</p> </li> <li> <p> <code>DETECTION_IN_PROGRESS</code>: The stack drift detection operation is currently in progress.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"StackDriftDetectionStatusReason": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeStackDriftDetectionStatusOutput$DetectionStatusReason": "<p>The reason the stack drift detection operation has its current status.</p>"
|
||||
}
|
||||
},
|
||||
"StackDriftInformation": {
|
||||
"base": "<p>Contains information about whether the stack's actual configuration differs, or has <i>drifted</i>, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted.</p>",
|
||||
"refs": {
|
||||
"Stack$DriftInformation": "<p>Information on whether a stack's actual configuration differs, or has <i>drifted</i>, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html\">Detecting Unregulated Configuration Changes to Stacks and Resources</a>.</p>"
|
||||
}
|
||||
},
|
||||
"StackDriftInformationSummary": {
|
||||
"base": "<p>Contains information about whether the stack's actual configuration differs, or has <i>drifted</i>, from its expected configuration, as defined in the stack template and any values specified as template parameters. A stack is considered to have drifted if one or more of its resources have drifted.</p>",
|
||||
"refs": {
|
||||
"StackSummary$DriftInformation": "<p>Summarizes information on whether a stack's actual configuration differs, or has <i>drifted</i>, from it's expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html\">Detecting Unregulated Configuration Changes to Stacks and Resources</a>.</p>"
|
||||
}
|
||||
},
|
||||
"StackDriftStatus": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeStackDriftDetectionStatusOutput$StackDriftStatus": "<p>Status of the stack's actual configuration compared to its expected configuration. </p> <ul> <li> <p> <code>DRIFTED</code>: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.</p> </li> <li> <p> <code>NOT_CHECKED</code>: AWS CloudFormation has not checked if the stack differs from its expected template configuration.</p> </li> <li> <p> <code>IN_SYNC</code>: The stack's actual configuration matches its expected template configuration.</p> </li> <li> <p> <code>UNKNOWN</code>: This value is reserved for future use.</p> </li> </ul>",
|
||||
"StackDriftInformation$StackDriftStatus": "<p>Status of the stack's actual configuration compared to its expected template configuration. </p> <ul> <li> <p> <code>DRIFTED</code>: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.</p> </li> <li> <p> <code>NOT_CHECKED</code>: AWS CloudFormation has not checked if the stack differs from its expected template configuration.</p> </li> <li> <p> <code>IN_SYNC</code>: The stack's actual configuration matches its expected template configuration.</p> </li> <li> <p> <code>UNKNOWN</code>: This value is reserved for future use.</p> </li> </ul>",
|
||||
"StackDriftInformationSummary$StackDriftStatus": "<p>Status of the stack's actual configuration compared to its expected template configuration. </p> <ul> <li> <p> <code>DRIFTED</code>: The stack differs from its expected template configuration. A stack is considered to have drifted if one or more of its resources have drifted.</p> </li> <li> <p> <code>NOT_CHECKED</code>: AWS CloudFormation has not checked if the stack differs from its expected template configuration.</p> </li> <li> <p> <code>IN_SYNC</code>: The stack's actual configuration matches its expected template configuration.</p> </li> <li> <p> <code>UNKNOWN</code>: This value is reserved for future use.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"StackEvent": {
|
||||
"base": "<p>The StackEvent data type.</p>",
|
||||
"refs": {
|
||||
@@ -1222,6 +1398,7 @@
|
||||
"CreateChangeSetOutput$StackId": "<p>The unique ID of the stack.</p>",
|
||||
"CreateStackOutput$StackId": "<p>Unique identifier of the stack.</p>",
|
||||
"DescribeChangeSetOutput$StackId": "<p>The ARN of the stack that is associated with the change set.</p>",
|
||||
"DescribeStackDriftDetectionStatusOutput$StackId": "<p>The ID of the stack.</p>",
|
||||
"Export$ExportingStackId": "<p>The stack that contains the exported output name and value.</p>",
|
||||
"Stack$StackId": "<p>Unique identifier of the stack.</p>",
|
||||
"Stack$ParentId": "<p>For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html\">Working with Nested Stacks</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
|
||||
@@ -1231,6 +1408,7 @@
|
||||
"StackInstanceSummary$StackId": "<p>The ID of the stack instance.</p>",
|
||||
"StackResource$StackId": "<p>Unique identifier of the stack.</p>",
|
||||
"StackResourceDetail$StackId": "<p>Unique identifier of the stack.</p>",
|
||||
"StackResourceDrift$StackId": "<p>The ID of the stack.</p>",
|
||||
"StackSummary$StackId": "<p>Unique stack identifier.</p>",
|
||||
"StackSummary$ParentId": "<p>For nested stacks--stacks created as resources for another stack--the stack ID of the direct parent of this stack. For the first level of nested stacks, the root stack is also the parent stack.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html\">Working with Nested Stacks</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
|
||||
"StackSummary$RootId": "<p>For nested stacks--stacks created as resources for another stack--the stack ID of the the top-level stack to which the nested stack ultimately belongs.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-nested-stacks.html\">Working with Nested Stacks</a> in the <i>AWS CloudFormation User Guide</i>.</p>",
|
||||
@@ -1300,6 +1478,9 @@
|
||||
"CreateChangeSetInput$StackName": "<p>The name or the unique ID of the stack for which you are creating a change set. AWS CloudFormation generates the change set by comparing this stack's information with the information that you submit, such as a modified template or different parameter input values.</p>",
|
||||
"DeleteChangeSetInput$StackName": "<p>If you specified the name of a change set to delete, specify the stack name or ID (ARN) that is associated with it.</p>",
|
||||
"DescribeChangeSetInput$StackName": "<p>If you specified the name of a change set, specify the stack name or ID (ARN) of the change set you want to describe.</p>",
|
||||
"DescribeStackResourceDriftsInput$StackName": "<p>The name of the stack for which you want drift information.</p>",
|
||||
"DetectStackDriftInput$StackName": "<p>The name of the stack for which you want to detect drift. </p>",
|
||||
"DetectStackResourceDriftInput$StackName": "<p>The name of the stack to which the resource belongs.</p>",
|
||||
"ExecuteChangeSetInput$StackName": "<p>If you specified the name of a change set, specify the stack name or ID (ARN) that is associated with the change set you want to execute.</p>",
|
||||
"GetTemplateSummaryInput$StackName": "<p>The name or the stack ID that is associated with the stack, which are not always interchangeable. For running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the unique stack ID.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>",
|
||||
"ListChangeSetsInput$StackName": "<p>The name or the Amazon Resource Name (ARN) of the stack for which you want to list change sets.</p>",
|
||||
@@ -1310,9 +1491,9 @@
|
||||
"StackPolicyBody": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateStackInput$StackPolicyBody": "<p>Structure containing the stack policy body. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html\"> Prevent Updates to Stack Resources</a> in the <i>AWS CloudFormation User Guide</i>. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>",
|
||||
"GetStackPolicyOutput$StackPolicyBody": "<p>Structure containing the stack policy body. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html\"> Prevent Updates to Stack Resources</a> in the AWS CloudFormation User Guide.)</p>",
|
||||
"SetStackPolicyInput$StackPolicyBody": "<p>Structure containing the stack policy body. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html\"> Prevent Updates to Stack Resources</a> in the AWS CloudFormation User Guide. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>",
|
||||
"CreateStackInput$StackPolicyBody": "<p>Structure containing the stack policy body. For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html\"> Prevent Updates to Stack Resources</a> in the <i>AWS CloudFormation User Guide</i>. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>",
|
||||
"GetStackPolicyOutput$StackPolicyBody": "<p>Structure containing the stack policy body. (For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html\"> Prevent Updates to Stack Resources</a> in the AWS CloudFormation User Guide.)</p>",
|
||||
"SetStackPolicyInput$StackPolicyBody": "<p>Structure containing the stack policy body. For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html\"> Prevent Updates to Stack Resources</a> in the AWS CloudFormation User Guide. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p>",
|
||||
"UpdateStackInput$StackPolicyBody": "<p>Structure containing a new stack policy body. You can specify either the <code>StackPolicyBody</code> or the <code>StackPolicyURL</code> parameter, but not both.</p> <p>You might update the stack policy, for example, in order to protect a new resource that you created during a stack update. If you do not specify a stack policy, the current policy that is associated with the stack is unchanged.</p>"
|
||||
}
|
||||
},
|
||||
@@ -1348,6 +1529,47 @@
|
||||
"DescribeStackResourceOutput$StackResourceDetail": "<p>A <code>StackResourceDetail</code> structure containing the description of the specified resource in the specified stack.</p>"
|
||||
}
|
||||
},
|
||||
"StackResourceDrift": {
|
||||
"base": "<p>Contains the drift information for a resource that has been checked for drift. This includes actual and expected property values for resources in which AWS CloudFormation has detected drift. Only resource properties explicitly defined in the stack template are checked for drift. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html\">Detecting Unregulated Configuration Changes to Stacks and Resources</a>.</p> <p>Resources that do not currently support drift detection cannot be checked. For a list of resources that support drift detection, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html\">Resources that Support Drift Detection</a>.</p> <p>Use <a>DetectStackResourceDrift</a> to detect drift on individual resources, or <a>DetectStackDrift</a> to detect drift on all resources in a given stack that support drift detection.</p>",
|
||||
"refs": {
|
||||
"DetectStackResourceDriftOutput$StackResourceDrift": "<p>Information about whether the resource's actual configuration has drifted from its expected template configuration, including actual and expected property values and any differences detected.</p>",
|
||||
"StackResourceDrifts$member": null
|
||||
}
|
||||
},
|
||||
"StackResourceDriftInformation": {
|
||||
"base": "<p>Contains information about whether the resource's actual configuration differs, or has <i>drifted</i>, from its expected configuration.</p>",
|
||||
"refs": {
|
||||
"StackResource$DriftInformation": "<p>Information about whether the resource's actual configuration differs, or has <i>drifted</i>, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html\">Detecting Unregulated Configuration Changes to Stacks and Resources</a>.</p>",
|
||||
"StackResourceDetail$DriftInformation": "<p>Information about whether the resource's actual configuration differs, or has <i>drifted</i>, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html\">Detecting Unregulated Configuration Changes to Stacks and Resources</a>.</p>"
|
||||
}
|
||||
},
|
||||
"StackResourceDriftInformationSummary": {
|
||||
"base": "<p>Summarizes information about whether the resource's actual configuration differs, or has <i>drifted</i>, from its expected configuration.</p>",
|
||||
"refs": {
|
||||
"StackResourceSummary$DriftInformation": "<p>Information about whether the resource's actual configuration differs, or has <i>drifted</i>, from its expected configuration, as defined in the stack template and any values specified as template parameters. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html\">Detecting Unregulated Configuration Changes to Stacks and Resources</a>.</p>"
|
||||
}
|
||||
},
|
||||
"StackResourceDriftStatus": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"StackResourceDrift$StackResourceDriftStatus": "<p>Status of the resource's actual configuration compared to its expected configuration</p> <ul> <li> <p> <code>DELETED</code>: The resource differs from its expected template configuration because the resource has been deleted.</p> </li> <li> <p> <code>MODIFIED</code>: One or more resource properties differ from their expected values (as defined in the stack template and any values specified as template parameters).</p> </li> <li> <p> <code>IN_SYNC</code>: The resources's actual configuration matches its expected template configuration.</p> </li> <li> <p> <code>NOT_CHECKED</code>: AWS CloudFormation does not currently return this value.</p> </li> </ul>",
|
||||
"StackResourceDriftInformation$StackResourceDriftStatus": "<p>Status of the resource's actual configuration compared to its expected configuration</p> <ul> <li> <p> <code>DELETED</code>: The resource differs from its expected configuration in that it has been deleted.</p> </li> <li> <p> <code>MODIFIED</code>: The resource differs from its expected configuration.</p> </li> <li> <p> <code>NOT_CHECKED</code>: AWS CloudFormation has not checked if the resource differs from its expected configuration.</p> <p>Any resources that do not currently support drift detection have a status of <code>NOT_CHECKED</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html\">Resources that Support Drift Detection</a>. </p> </li> <li> <p> <code>IN_SYNC</code>: The resources's actual configuration matches its expected configuration.</p> </li> </ul>",
|
||||
"StackResourceDriftInformationSummary$StackResourceDriftStatus": "<p>Status of the resource's actual configuration compared to its expected configuration</p> <ul> <li> <p> <code>DELETED</code>: The resource differs from its expected configuration in that it has been deleted.</p> </li> <li> <p> <code>MODIFIED</code>: The resource differs from its expected configuration.</p> </li> <li> <p> <code>NOT_CHECKED</code>: AWS CloudFormation has not checked if the resource differs from its expected configuration.</p> <p>Any resources that do not currently support drift detection have a status of <code>NOT_CHECKED</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html\">Resources that Support Drift Detection</a>. If you performed an <a>ContinueUpdateRollback</a> operation on a stack, any resources included in <code>ResourcesToSkip</code> will also have a status of <code>NOT_CHECKED</code>. For more information on skipping resources during rollback operations, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-continueupdaterollback.html\">Continue Rolling Back an Update</a> in the AWS CloudFormation User Guide.</p> </li> <li> <p> <code>IN_SYNC</code>: The resources's actual configuration matches its expected configuration.</p> </li> </ul>",
|
||||
"StackResourceDriftStatusFilters$member": null
|
||||
}
|
||||
},
|
||||
"StackResourceDriftStatusFilters": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeStackResourceDriftsInput$StackResourceDriftStatusFilters": "<p>The resource drift status values to use as filters for the resource drift results returned.</p> <ul> <li> <p> <code>DELETED</code>: The resource differs from its expected template configuration in that the resource has been deleted.</p> </li> <li> <p> <code>MODIFIED</code>: One or more resource properties differ from their expected template values.</p> </li> <li> <p> <code>IN_SYNC</code>: The resources's actual configuration matches its expected template configuration.</p> </li> <li> <p> <code>NOT_CHECKED</code>: AWS CloudFormation does not currently return this value.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"StackResourceDrifts": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeStackResourceDriftsOutput$StackResourceDrifts": "<p>Drift information for the resources that have been checked for drift in the specified stack. This includes actual and expected configuration values for resources where AWS CloudFormation detects drift.</p> <p>For a given stack, there will be one <code>StackResourceDrift</code> for each stack resource that has been checked for drift. Resources that have not yet been checked for drift are not included. Resources that do not currently support drift detection are not checked, and so not included. For a list of resources that support drift detection, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift-resource-list.html\">Resources that Support Drift Detection</a>.</p>"
|
||||
}
|
||||
},
|
||||
"StackResourceSummaries": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
@@ -1405,14 +1627,14 @@
|
||||
"StackSet$StackSetName": "<p>The name that's associated with the stack set.</p>",
|
||||
"StackSetSummary$StackSetName": "<p>The name of the stack set.</p>",
|
||||
"StopStackSetOperationInput$StackSetName": "<p>The name or unique ID of the stack set that you want to stop the operation for.</p>",
|
||||
"UpdateStackInstancesInput$StackSetName": "<p>The name or unique ID of the stack set associated with the stack instances.</p>",
|
||||
"UpdateStackSetInput$StackSetName": "<p>The name or unique ID of the stack set that you want to update.</p>"
|
||||
}
|
||||
},
|
||||
"StackSetNameOrId": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"GetTemplateSummaryInput$StackSetName": "<p>The name or unique ID of the stack set from which the stack was created.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>"
|
||||
"GetTemplateSummaryInput$StackSetName": "<p>The name or unique ID of the stack set from which the stack was created.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>",
|
||||
"UpdateStackInstancesInput$StackSetName": "<p>The name or unique ID of the stack set associated with the stack instances.</p>"
|
||||
}
|
||||
},
|
||||
"StackSetNotEmptyException": {
|
||||
@@ -1439,7 +1661,7 @@
|
||||
}
|
||||
},
|
||||
"StackSetOperationPreferences": {
|
||||
"base": "<p>The user-specified preferences for how AWS CloudFormation performs a stack set operation. </p> <p>For more information on maximum concurrent accounts and failure tolerance, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options\">Stack set operation options</a>.</p>",
|
||||
"base": "<p>The user-specified preferences for how AWS CloudFormation performs a stack set operation. </p> <p>For more information on maximum concurrent accounts and failure tolerance, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-ops-options\">Stack set operation options</a>.</p>",
|
||||
"refs": {
|
||||
"CreateStackInstancesInput$OperationPreferences": "<p>Preferences for how AWS CloudFormation performs this stack set operation.</p>",
|
||||
"DeleteStackInstancesInput$OperationPreferences": "<p>Preferences for how AWS CloudFormation performs this stack set operation.</p>",
|
||||
@@ -1600,15 +1822,15 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateChangeSetInput$TemplateBody": "<p>A structure that contains the body of the revised template, with a minimum length of 1 byte and a maximum length of 51,200 bytes. AWS CloudFormation generates the change set by comparing this template with the template of the stack that you specified.</p> <p>Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>.</p>",
|
||||
"CreateStackInput$TemplateBody": "<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>",
|
||||
"CreateStackSetInput$TemplateBody": "<p>The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.</p>",
|
||||
"EstimateTemplateCostInput$TemplateBody": "<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.)</p> <p>Conditional: You must pass <code>TemplateBody</code> or <code>TemplateURL</code>. If both are passed, only <code>TemplateBody</code> is used.</p>",
|
||||
"GetTemplateOutput$TemplateBody": "<p>Structure containing the template body. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.)</p> <p>AWS CloudFormation returns the same template that was used when the stack was created.</p>",
|
||||
"GetTemplateSummaryInput$TemplateBody": "<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>",
|
||||
"CreateStackInput$TemplateBody": "<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>",
|
||||
"CreateStackSetInput$TemplateBody": "<p>The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.</p>",
|
||||
"EstimateTemplateCostInput$TemplateBody": "<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.)</p> <p>Conditional: You must pass <code>TemplateBody</code> or <code>TemplateURL</code>. If both are passed, only <code>TemplateBody</code> is used.</p>",
|
||||
"GetTemplateOutput$TemplateBody": "<p>Structure containing the template body. (For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.)</p> <p>AWS CloudFormation returns the same template that was used when the stack was created.</p>",
|
||||
"GetTemplateSummaryInput$TemplateBody": "<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information about templates, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>",
|
||||
"StackSet$TemplateBody": "<p>The structure that contains the body of the template that was used to create or update the stack set.</p>",
|
||||
"UpdateStackInput$TemplateBody": "<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.)</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>, <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>",
|
||||
"UpdateStackSetInput$TemplateBody": "<p>The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true.</p>",
|
||||
"ValidateTemplateInput$TemplateBody": "<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>"
|
||||
"UpdateStackInput$TemplateBody": "<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.)</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>, <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>",
|
||||
"UpdateStackSetInput$TemplateBody": "<p>The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true.</p>",
|
||||
"ValidateTemplateInput$TemplateBody": "<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>"
|
||||
}
|
||||
},
|
||||
"TemplateDescription": {
|
||||
@@ -1640,13 +1862,13 @@
|
||||
"base": null,
|
||||
"refs": {
|
||||
"CreateChangeSetInput$TemplateURL": "<p>The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.</p> <p>Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>.</p>",
|
||||
"CreateStackInput$TemplateURL": "<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>",
|
||||
"CreateStackSetInput$TemplateURL": "<p>The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.</p>",
|
||||
"EstimateTemplateCostInput$TemplateURL": "<p>Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>",
|
||||
"GetTemplateSummaryInput$TemplateURL": "<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>",
|
||||
"UpdateStackInput$TemplateURL": "<p>Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>, <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>",
|
||||
"UpdateStackSetInput$TemplateURL": "<p>The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true. </p>",
|
||||
"ValidateTemplateInput$TemplateURL": "<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>"
|
||||
"CreateStackInput$TemplateURL": "<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>",
|
||||
"CreateStackSetInput$TemplateURL": "<p>The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.</p>",
|
||||
"EstimateTemplateCostInput$TemplateURL": "<p>Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>",
|
||||
"GetTemplateSummaryInput$TemplateURL": "<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>",
|
||||
"UpdateStackInput$TemplateURL": "<p>Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>, <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>",
|
||||
"UpdateStackSetInput$TemplateURL": "<p>The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true. </p>",
|
||||
"ValidateTemplateInput$TemplateURL": "<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>"
|
||||
}
|
||||
},
|
||||
"TimeoutMinutes": {
|
||||
@@ -1659,9 +1881,15 @@
|
||||
"Timestamp": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"DescribeStackDriftDetectionStatusOutput$Timestamp": "<p>Time at which the stack drift detection operation was initiated.</p>",
|
||||
"StackDriftInformation$LastCheckTimestamp": "<p>Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.</p>",
|
||||
"StackDriftInformationSummary$LastCheckTimestamp": "<p>Most recent time when a drift detection operation was initiated on the stack, or any of its individual resources that support drift detection.</p>",
|
||||
"StackEvent$Timestamp": "<p>Time the status was updated.</p>",
|
||||
"StackResource$Timestamp": "<p>Time the status was updated.</p>",
|
||||
"StackResourceDetail$LastUpdatedTimestamp": "<p>Time the status was updated.</p>",
|
||||
"StackResourceDrift$Timestamp": "<p>Time at which AWS CloudFormation performed drift detection on the stack resource.</p>",
|
||||
"StackResourceDriftInformation$LastCheckTimestamp": "<p>When AWS CloudFormation last checked if the resource had drifted from its expected configuration.</p>",
|
||||
"StackResourceDriftInformationSummary$LastCheckTimestamp": "<p>When AWS CloudFormation last checked if the resource had drifted from its expected configuration.</p>",
|
||||
"StackResourceSummary$LastUpdatedTimestamp": "<p>Time the status was updated.</p>",
|
||||
"StackSetOperation$CreationTimestamp": "<p>The time at which the operation was initiated. Note that the creation times for the stack set operation might differ from the creation time of the individual stacks themselves. This is because AWS CloudFormation needs to perform preparatory work for the operation, such as dispatching the work to the requested regions, before actually creating the first stacks.</p>",
|
||||
"StackSetOperation$EndTimestamp": "<p>The time at which the stack set operation ended, across all accounts and regions specified. Note that this doesn't necessarily mean that the stack set operation was successful, or even attempted, in each account or region.</p>",
|
||||
@@ -1690,7 +1918,7 @@
|
||||
"Type": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"RollbackTrigger$Type": "<p>The resource type of the rollback trigger. Currently, <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html\">AWS::CloudWatch::Alarm</a> is the only supported resource type.</p>"
|
||||
"RollbackTrigger$Type": "<p>The resource type of the rollback trigger. Currently, <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cw-alarm.html\">AWS::CloudWatch::Alarm</a> is the only supported resource type.</p>"
|
||||
}
|
||||
},
|
||||
"UpdateStackInput": {
|
||||
@@ -1763,6 +1991,12 @@
|
||||
"refs": {
|
||||
}
|
||||
},
|
||||
"Value": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
"PhysicalResourceIdContextKeyValuePair$Value": "<p>The resource context value.</p>"
|
||||
}
|
||||
},
|
||||
"Version": {
|
||||
"base": null,
|
||||
"refs": {
|
||||
|
||||
Generated
Vendored
+5
@@ -5,6 +5,11 @@
|
||||
"output_token": "NextToken",
|
||||
"result_key": "StackEvents"
|
||||
},
|
||||
"DescribeStackResourceDrifts": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken"
|
||||
},
|
||||
"DescribeStackResources": {
|
||||
"result_key": "StackResources"
|
||||
},
|
||||
|
||||
-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
@@ -1,32 +0,0 @@
|
||||
{
|
||||
"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
@@ -1,47 +0,0 @@
|
||||
{
|
||||
"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
@@ -1,32 +0,0 @@
|
||||
{
|
||||
"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
@@ -1,47 +0,0 @@
|
||||
{
|
||||
"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
-32
@@ -1,32 +0,0 @@
|
||||
{
|
||||
"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
@@ -1,47 +0,0 @@
|
||||
{
|
||||
"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
-32
@@ -1,32 +0,0 @@
|
||||
{
|
||||
"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
@@ -1,47 +0,0 @@
|
||||
{
|
||||
"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
-32
@@ -1,32 +0,0 @@
|
||||
{
|
||||
"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"
|
||||
}
|
||||
}
|
||||
}
|
||||
-2548
File diff suppressed because it is too large
Load Diff
-1355
File diff suppressed because it is too large
Load Diff
Generated
Vendored
-32
@@ -1,32 +0,0 @@
|
||||
{
|
||||
"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
@@ -1,47 +0,0 @@
|
||||
{
|
||||
"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"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
-2586
File diff suppressed because it is too large
Load Diff
-1381
File diff suppressed because it is too large
Load Diff
Generated
Vendored
-32
@@ -1,32 +0,0 @@
|
||||
{
|
||||
"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
@@ -1,47 +0,0 @@
|
||||
{
|
||||
"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"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
-2596
File diff suppressed because it is too large
Load Diff
-1388
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user