dprevot/python-botocore
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

New upstream version 1.8.40+repack

Browse source
This commit is contained in:
TANIGUCHI Takaki 2018-02-11 17:52:35 +09:00
parent ede794960c
commit 5c030d6f87
59 changed files with 3058 additions and 623 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
PKG-INFO
View file

@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: botocore
Version: 1.8.36
Version: 1.8.40
Summary: Low-level, data-driven core of boto 3.
Home-page: https://github.com/boto/botocore
Author: Amazon Web Services

2
botocore.egg-info/PKG-INFO
View file

@ -1,6 +1,6 @@
Metadata-Version: 1.1
Name: botocore
Version: 1.8.36
Version: 1.8.40
Summary: Low-level, data-driven core of boto 3.
Home-page: https://github.com/boto/botocore
Author: Amazon Web Services

2
botocore.egg-info/SOURCES.txt
View file

@ -55,6 +55,7 @@ botocore/data/application-autoscaling/2016-02-06/service-2.json
botocore/data/appstream/2016-12-01/examples-1.json
botocore/data/appstream/2016-12-01/paginators-1.json
botocore/data/appstream/2016-12-01/service-2.json
botocore/data/appstream/2016-12-01/waiters-2.json
botocore/data/appsync/2017-07-25/paginators-1.json
botocore/data/appsync/2017-07-25/service-2.json
botocore/data/athena/2017-05-18/paginators-1.json
@ -253,6 +254,7 @@ botocore/data/elb/2012-06-01/waiters-2.json
botocore/data/elbv2/2015-12-01/examples-1.json
botocore/data/elbv2/2015-12-01/paginators-1.json
botocore/data/elbv2/2015-12-01/service-2.json
botocore/data/elbv2/2015-12-01/waiters-2.json
botocore/data/emr/2009-03-31/examples-1.json
botocore/data/emr/2009-03-31/paginators-1.json
botocore/data/emr/2009-03-31/service-2.json

2
botocore/__init__.py
View file

@ -16,7 +16,7 @@ import os
import re
import logging
__version__ = '1.8.36'
__version__ = '1.8.40'
class NullHandler(logging.Handler):

9
botocore/data/_retry.json
View file

@ -24,6 +24,14 @@
}
}
},
"request_throttled_exception": {
"applies_when": {
"response": {
"service_error_code": "RequestThrottledException",
"http_status_code": 400
}
}
},
"too_many_requests": {
"applies_when": {
"response": {
@ -89,6 +97,7 @@
"limit_exceeded": {"$ref": "limit_exceeded"},
"throttling_exception": {"$ref": "throttling_exception"},
"throttled_exception": {"$ref": "throttled_exception"},
"request_throttled_exception": {"$ref": "request_throttled_exception"},
"throttling": {"$ref": "throttling"},
"too_many_requests": {"$ref": "too_many_requests"}
}

8
botocore/data/acm/2015-12-08/service-2.json
View file

@ -68,7 +68,7 @@
{"shape":"RequestInProgressException"},
{"shape":"InvalidArnException"}
],
"documentation":"<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 ertificate, 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>"
"documentation":"<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":{
"name":"ImportCertificate",
@ -82,7 +82,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-services.html\">Integrated Services</a>. </p> <note> <p>ACM does not provide <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html\">managed renewal</a> for certificates that you import.</p> </note> <p>For more information about importing certificates into ACM, including the differences between certificates that you import and those that ACM provides, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>. </p> <p>In general, you can import almost any valid certificate. However, services integrated with ACM allow only certificate types they support to be associated with their resources. The following guidelines are also important:</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 must not exceed 1000 characters.</p> </li> <li> <p>To import a new certificate, omit the <code>CertificateArn</code> field. Include this field only when you want to replace a previously imported certificate.</p> </li> <li> <p>When you import a certificate by using the CLI or one of the SDKs, you must specify the certificate, certificate chain, and private key parameters as file names preceded by <code>file://</code>. For example, you can specify a certificate saved in the <code>C:\\temp</code> folder as <code>C:\\temp\\certificate_to_import.pem</code>. If you are making an HTTP or HTTPS Query request, include these parameters 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>"
"documentation":"<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/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=\"http://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=\"http://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 or one of the SDKs, you must specify the certificate, the certificate chain, and the private key by their file names preceded by <code>file://</code>. For example, you can specify a certificate saved in the <code>C:\\temp</code> folder as <code>file://C:\\temp\\certificate_to_import.pem</code>. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. </p> </li> </ul> <p>This operation returns the <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>"
},
"ListCertificates":{
"name":"ListCertificates",
@ -680,7 +680,7 @@
},
"Includes":{
"shape":"Filters",
"documentation":"<p>Filter the certificate list by one or more of the following values. For more information, see the <a>Filters</a> structure.</p> <ul> <li> <p>extendedKeyUsage</p> </li> <li> <p>keyUsage</p> </li> <li> <p>keyTypes</p> </li> </ul>"
"documentation":"<p>Filter the certificate list. For more information, see the <a>Filters</a> structure.</p>"
},
"NextToken":{
"shape":"NextToken",
@ -811,7 +811,7 @@
},
"DomainValidationOptions":{
"shape":"DomainValidationOptionList",
"documentation":"<p>The domain name that you want ACM to use to send you emails so taht your can validate domain ownership.</p>"
"documentation":"<p>The domain name that you want ACM to use to send you emails so that you can validate domain ownership.</p>"
}
}
},

0
botocore/data/apigateway/2015-07-09/examples-1.json Executable file → Normal file
View file

44
botocore/data/appstream/2016-12-01/service-2.json
View file

@ -218,7 +218,7 @@
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Describes the specified directory configurations.</p>"
"documentation":"<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":{
"name":"DescribeFleets",
@ -341,7 +341,7 @@
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<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\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
"documentation":"<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>"
},
"StartFleet":{
"name":"StartFleet",
@ -416,7 +416,7 @@
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<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\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
"documentation":"<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":{
"name":"UntagResource",
@ -429,7 +429,7 @@
"errors":[
{"shape":"ResourceNotFoundException"}
],
"documentation":"<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\">Tagging Your Resources</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p>"
"documentation":"<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":{
"name":"UpdateDirectoryConfig",
@ -819,6 +819,10 @@
"StorageConnectors":{
"shape":"StorageConnectorList",
"documentation":"<p>The storage connectors to enable.</p>"
},
"RedirectURL":{
"shape":"RedirectURL",
"documentation":"<p>The URL the user is redirected to after the streaming session ends.</p>"
}
}
},
@ -983,7 +987,7 @@
"members":{
"DirectoryConfigs":{
"shape":"DirectoryConfigList",
"documentation":"<p>Information about the directory configurations.</p>"
"documentation":"<p>Information about the 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>"
},
"NextToken":{
"shape":"String",
@ -1733,6 +1737,10 @@
"type":"string",
"enum":["WINDOWS"]
},
"RedirectURL":{
"type":"string",
"max":1000
},
"ResourceAlreadyExistsException":{
"type":"structure",
"members":{
@ -1895,6 +1903,10 @@
"shape":"StorageConnectorList",
"documentation":"<p>The storage connectors to enable.</p>"
},
"RedirectURL":{
"shape":"RedirectURL",
"documentation":"<p>The URL the user is redirected to after the streaming session ends.</p>"
},
"StackErrors":{
"shape":"StackErrors",
"documentation":"<p>The errors for the stack.</p>"
@ -1902,6 +1914,17 @@
},
"documentation":"<p>Describes a stack.</p>"
},
"StackAttribute":{
"type":"string",
"enum":[
"STORAGE_CONNECTORS",
"REDIRECT_URL"
]
},
"StackAttributes":{
"type":"list",
"member":{"shape":"StackAttribute"}
},
"StackError":{
"type":"structure",
"members":{
@ -2236,7 +2259,16 @@
},
"DeleteStorageConnectors":{
"shape":"Boolean",
"documentation":"<p>Deletes the storage connectors currently enabled for the stack.</p>"
"documentation":"<p>Deletes the storage connectors currently enabled for the stack.</p>",
"deprecated":true
},
"RedirectURL":{
"shape":"RedirectURL",
"documentation":"<p>The URL the user is redirected to after the streaming session ends.</p>"
},
"AttributesToDelete":{
"shape":"StackAttributes",
"documentation":"<p>The stack attributes to delete.</p>"
}
}
},

55
botocore/data/appstream/2016-12-01/waiters-2.json Normal file
View file

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

0
botocore/data/budgets/2016-10-20/examples-1.json Executable file → Normal file
View file

550
botocore/data/budgets/2016-10-20/service-2.json
View file

@ -26,7 +26,7 @@
{"shape":"CreationLimitExceededException"},
{"shape":"DuplicateRecordException"}
],
"documentation":"Create a new budget"
"documentation":"<p>Creates a budget and, if included, notifications and subscribers. </p>"
},
"CreateNotification":{
"name":"CreateNotification",
@ -43,7 +43,7 @@
{"shape":"CreationLimitExceededException"},
{"shape":"DuplicateRecordException"}
],
"documentation":"Create a new Notification with subscribers for a budget"
"documentation":"<p>Creates a notification. You must create the budget before you create the associated notification.</p>"
},
"CreateSubscriber":{
"name":"CreateSubscriber",
@ -60,7 +60,7 @@
{"shape":"DuplicateRecordException"},
{"shape":"NotFoundException"}
],
"documentation":"Create a new Subscriber for a notification"
"documentation":"<p>Creates a subscriber. You must create the associated budget and notification before you create the subscriber.</p>"
},
"DeleteBudget":{
"name":"DeleteBudget",
@ -75,7 +75,7 @@
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"}
],
"documentation":"Delete a budget and related notifications"
"documentation":"<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":{
"name":"DeleteNotification",
@ -90,7 +90,7 @@
{"shape":"InternalErrorException"},
{"shape":"NotFoundException"}
],
"documentation":"Delete a notification and related subscribers"
"documentation":"<p>Deletes a notification.</p> <p> <b>Deleting a notification also deletes the subscribers associated with the notification.</b> </p>"
},
"DeleteSubscriber":{
"name":"DeleteSubscriber",
@ -105,7 +105,7 @@
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"}
],
"documentation":"Delete a Subscriber for a notification"
"documentation":"<p>Deletes a subscriber.</p> <p> <b>Deleting the last subscriber to a notification also deletes the notification.</b> </p>"
},
"DescribeBudget":{
"name":"DescribeBudget",
@ -120,7 +120,7 @@
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"}
],
"documentation":"Get a single budget"
"documentation":"<p>Describes a budget.</p>"
},
"DescribeBudgets":{
"name":"DescribeBudgets",
@ -137,7 +137,7 @@
{"shape":"InvalidNextTokenException"},
{"shape":"ExpiredNextTokenException"}
],
"documentation":"Get all budgets for an account"
"documentation":"<p>Lists the budgets associated with an account.</p>"
},
"DescribeNotificationsForBudget":{
"name":"DescribeNotificationsForBudget",
@ -154,7 +154,7 @@
{"shape":"InvalidNextTokenException"},
{"shape":"ExpiredNextTokenException"}
],
"documentation":"Get notifications of a budget"
"documentation":"<p>Lists the notifications associated with a budget.</p>"
},
"DescribeSubscribersForNotification":{
"name":"DescribeSubscribersForNotification",
@ -171,7 +171,7 @@
{"shape":"InvalidNextTokenException"},
{"shape":"ExpiredNextTokenException"}
],
"documentation":"Get subscribers of a notification"
"documentation":"<p>Lists the subscribers associated with a notification.</p>"
},
"UpdateBudget":{
"name":"UpdateBudget",
@ -186,7 +186,7 @@
{"shape":"InvalidParameterException"},
{"shape":"NotFoundException"}
],
"documentation":"Update the information of a budget already created"
"documentation":"<p>Updates a budget. You can change every part of a budget except for the <code>budgetName</code> and the <code>calculatedSpend</code>. When a budget is modified, the <code>calculatedSpend</code> drops to zero until AWS has new usage data to use for forecasting.</p>"
},
"UpdateNotification":{
"name":"UpdateNotification",
@ -202,7 +202,7 @@
{"shape":"NotFoundException"},
{"shape":"DuplicateRecordException"}
],
"documentation":"Update the information about a notification already created"
"documentation":"<p>Updates a notification.</p>"
},
"UpdateSubscriber":{
"name":"UpdateSubscriber",
@ -218,13 +218,13 @@
{"shape":"NotFoundException"},
{"shape":"DuplicateRecordException"}
],
"documentation":"Update a subscriber"
"documentation":"<p>Updates a subscriber.</p>"
}
},
"shapes":{
"AccountId":{
"type":"string",
"documentation":"Account Id of the customer. It should be a 12 digit number.",
"documentation":"<p>The account ID of the customer. It should be a 12 digit number.</p>",
"max":12,
"min":12
},
@ -232,32 +232,54 @@
"type":"structure",
"required":[
"BudgetName",
"BudgetLimit",
"TimeUnit",
"TimePeriod",
"BudgetType"
],
"members":{
"BudgetName":{"shape":"BudgetName"},
"BudgetLimit":{"shape":"Spend"},
"CostFilters":{"shape":"CostFilters"},
"CostTypes":{"shape":"CostTypes"},
"TimeUnit":{"shape":"TimeUnit"},
"TimePeriod":{"shape":"TimePeriod"},
"CalculatedSpend":{"shape":"CalculatedSpend"},
"BudgetType":{"shape":"BudgetType"}
"BudgetName":{
"shape":"BudgetName",
"documentation":"<p>The name of a budget. Unique within accounts. <code>:</code> and <code>\\</code> characters are not allowed in the <code>BudgetName</code>.</p>"
},
"BudgetLimit":{
"shape":"Spend",
"documentation":"<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>"
},
"CostFilters":{
"shape":"CostFilters",
"documentation":"<p>The cost filters applied to a budget, such as service or region.</p>"
},
"CostTypes":{
"shape":"CostTypes",
"documentation":"<p>The types of costs included in this budget.</p>"
},
"TimeUnit":{
"shape":"TimeUnit",
"documentation":"<p>The length of time until a budget resets the actual and forecasted spend.</p>"
},
"TimePeriod":{
"shape":"TimePeriod",
"documentation":"<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>"
},
"CalculatedSpend":{
"shape":"CalculatedSpend",
"documentation":"<p>The actual and forecasted cost or usage being tracked by a budget.</p>"
},
"BudgetType":{
"shape":"BudgetType",
"documentation":"<p>Whether this budget tracks monetary costs, usage, or RI utilization.</p>"
}
},
"documentation":"AWS Budget model"
"documentation":"<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>"
},
"BudgetName":{
"type":"string",
"documentation":"A string represents the budget name. No \":\" and \"\\\" character is allowed.",
"documentation":"<p> A string represents the budget name. No \":\" and \"\\\" character is allowed.</p>",
"max":100,
"pattern":"[^:\\\\]+"
},
"BudgetType":{
"type":"string",
"documentation":"The type of a budget. It should be COST, USAGE, or RI_UTILIZATION.",
"documentation":"<p> The type of a budget. It should be COST, USAGE, or RI_UTILIZATION.</p>",
"enum":[
"USAGE",
"COST",
@ -267,20 +289,26 @@
"Budgets":{
"type":"list",
"member":{"shape":"Budget"},
"documentation":"A list of budgets"
"documentation":"<p> A list of budgets</p>"
},
"CalculatedSpend":{
"type":"structure",
"required":["ActualSpend"],
"members":{
"ActualSpend":{"shape":"Spend"},
"ForecastedSpend":{"shape":"Spend"}
"ActualSpend":{
"shape":"Spend",
"documentation":"<p>The amount of cost, usage, or RI units that you have used.</p>"
},
"ForecastedSpend":{
"shape":"Spend",
"documentation":"<p>The amount of cost, usage, or RI units that you are forecasted to use.</p>"
}
},
"documentation":"A structure that holds the actual and forecasted spend for a budget."
"documentation":"<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>"
},
"ComparisonOperator":{
"type":"string",
"documentation":"The comparison operator of a notification. Currently we support less than, equal to and greater than.",
"documentation":"<p> The comparison operator of a notification. Currently we support less than, equal to and greater than.</p>",
"enum":[
"GREATER_THAN",
"LESS_THAN",
@ -291,57 +319,57 @@
"type":"map",
"key":{"shape":"GenericString"},
"value":{"shape":"DimensionValues"},
"documentation":"A map that represents the cost filters applied to the budget."
"documentation":"<p> A map that represents the cost filters applied to the budget.</p>"
},
"CostTypes":{
"type":"structure",
"members":{
"IncludeTax":{
"shape":"NullableBoolean",
"documentation":"A boolean value whether to include tax in the cost budget."
"documentation":"<p>Specifies whether a budget includes taxes.</p> <p>The default value is <code>true</code>.</p>"
},
"IncludeSubscription":{
"shape":"NullableBoolean",
"documentation":"A boolean value whether to include subscriptions in the cost budget."
"documentation":"<p>Specifies whether a budget includes subscriptions.</p> <p>The default value is <code>true</code>.</p>"
},
"UseBlended":{
"shape":"NullableBoolean",
"documentation":"A boolean value whether to use blended costs in the cost budget."
"documentation":"<p>Specifies whether a budget uses blended rate.</p> <p>The default value is <code>false</code>.</p>"
},
"IncludeRefund":{
"shape":"NullableBoolean",
"documentation":"A boolean value whether to include refunds in the cost budget."
"documentation":"<p>Specifies whether a budget includes refunds.</p> <p>The default value is <code>true</code>.</p>"
},
"IncludeCredit":{
"shape":"NullableBoolean",
"documentation":"A boolean value whether to include credits in the cost budget."
"documentation":"<p>Specifies whether a budget includes credits.</p> <p>The default value is <code>true</code>.</p>"
},
"IncludeUpfront":{
"shape":"NullableBoolean",
"documentation":"A boolean value whether to include upfront costs in the cost budget."
"documentation":"<p>Specifies whether a budget includes upfront RI costs.</p> <p>The default value is <code>true</code>.</p>"
},
"IncludeRecurring":{
"shape":"NullableBoolean",
"documentation":"A boolean value whether to include recurring costs in the cost budget."
"documentation":"<p>Specifies whether a budget includes recurring fees such as monthly RI fees.</p> <p>The default value is <code>true</code>.</p>"
},
"IncludeOtherSubscription":{
"shape":"NullableBoolean",
"documentation":"A boolean value whether to include other subscription costs in the cost budget."
"documentation":"<p>Specifies whether a budget includes non-RI subscription costs.</p> <p>The default value is <code>true</code>.</p>"
},
"IncludeSupport":{
"shape":"NullableBoolean",
"documentation":"A boolean value whether to include support costs in the cost budget."
"documentation":"<p>Specifies whether a budget includes support subscription fees.</p> <p>The default value is <code>true</code>.</p>"
},
"IncludeDiscount":{
"shape":"NullableBoolean",
"documentation":"A boolean value whether to include discounts in the cost budget."
"documentation":"<p>Specifies whether a budget includes discounts.</p> <p>The default value is <code>true</code>.</p>"
},
"UseAmortized":{
"shape":"NullableBoolean",
"documentation":"A boolean value whether to include amortized costs in the cost budget."
"documentation":"<p>Specifies whether a budget uses the amortized rate.</p> <p>The default value is <code>false</code>.</p>"
}
},
"documentation":"This includes the options for getting the cost of a budget."
"documentation":"<p>The types of cost included in a budget, such as tax and subscriptions.</p>"
},
"CreateBudgetRequest":{
"type":"structure",
@ -350,17 +378,26 @@
"Budget"
],
"members":{
"AccountId":{"shape":"AccountId"},
"Budget":{"shape":"Budget"},
"NotificationsWithSubscribers":{"shape":"NotificationWithSubscribersList"}
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The <code>accountId</code> that is associated with the budget.</p>"
},
"Budget":{
"shape":"Budget",
"documentation":"<p>The budget object that you want to create.</p>"
},
"NotificationsWithSubscribers":{
"shape":"NotificationWithSubscribersList",
"documentation":"<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>"
}
},
"documentation":"Request of CreateBudget"
"documentation":"<p> Request of CreateBudget </p>"
},
"CreateBudgetResponse":{
"type":"structure",
"members":{
},
"documentation":"Response of CreateBudget"
"documentation":"<p> Response of CreateBudget </p>"
},
"CreateNotificationRequest":{
"type":"structure",
@ -371,18 +408,30 @@
"Subscribers"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"Notification":{"shape":"Notification"},
"Subscribers":{"shape":"Subscribers"}
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The <code>accountId</code> that is associated with the budget that you want to create a notification for.</p>"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"<p>The name of the budget that you want AWS to notified you about. Budget names must be unique within an account.</p>"
},
"Notification":{
"shape":"Notification",
"documentation":"<p>The notification that you want to create.</p>"
},
"Subscribers":{
"shape":"Subscribers",
"documentation":"<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>"
}
},
"documentation":"Request of CreateNotification"
"documentation":"<p> Request of CreateNotification </p>"
},
"CreateNotificationResponse":{
"type":"structure",
"members":{
},
"documentation":"Response of CreateNotification"
"documentation":"<p> Response of CreateNotification </p>"
},
"CreateSubscriberRequest":{
"type":"structure",
@ -393,25 +442,37 @@
"Subscriber"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"Notification":{"shape":"Notification"},
"Subscriber":{"shape":"Subscriber"}
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The <code>accountId</code> associated with the budget that you want to create a subscriber for.</p>"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"<p>The name of the budget that you want to subscribe to. Budget names must be unique within an account.</p>"
},
"Notification":{
"shape":"Notification",
"documentation":"<p>The notification that you want to create a subscriber for.</p>"
},
"Subscriber":{
"shape":"Subscriber",
"documentation":"<p>The subscriber that you want to associate with a budget notification.</p>"
}
},
"documentation":"Request of CreateSubscriber"
"documentation":"<p> Request of CreateSubscriber </p>"
},
"CreateSubscriberResponse":{
"type":"structure",
"members":{
},
"documentation":"Response of CreateSubscriber"
"documentation":"<p> Response of CreateSubscriber </p>"
},
"CreationLimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"The exception is thrown when customer tries to create a record (e.g. budget), but the number this record already exceeds the limitation.",
"documentation":"<p>You've exceeded the notification or subscriber limit.</p>",
"exception":true
},
"DeleteBudgetRequest":{
@ -421,16 +482,22 @@
"BudgetName"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"}
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The <code>accountId</code> that is associated with the budget that you want to delete.</p>"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"<p>The name of the budget that you want to delete.</p>"
}
},
"documentation":"Request of DeleteBudget"
"documentation":"<p> Request of DeleteBudget </p>"
},
"DeleteBudgetResponse":{
"type":"structure",
"members":{
},
"documentation":"Response of DeleteBudget"
"documentation":"<p> Response of DeleteBudget </p>"
},
"DeleteNotificationRequest":{
"type":"structure",
@ -440,17 +507,26 @@
"Notification"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"Notification":{"shape":"Notification"}
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The <code>accountId</code> that is associated with the budget whose notification you want to delete.</p>"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"<p>The name of the budget whose notification you want to delete.</p>"
},
"Notification":{
"shape":"Notification",
"documentation":"<p>The notification that you want to delete.</p>"
}
},
"documentation":"Request of DeleteNotification"
"documentation":"<p> Request of DeleteNotification </p>"
},
"DeleteNotificationResponse":{
"type":"structure",
"members":{
},
"documentation":"Response of DeleteNotification"
"documentation":"<p> Response of DeleteNotification </p>"
},
"DeleteSubscriberRequest":{
"type":"structure",
@ -461,18 +537,30 @@
"Subscriber"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"Notification":{"shape":"Notification"},
"Subscriber":{"shape":"Subscriber"}
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The <code>accountId</code> that is associated with the budget whose subscriber you want to delete.</p>"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"<p>The name of the budget whose subscriber you want to delete.</p>"
},
"Notification":{
"shape":"Notification",
"documentation":"<p>The notification whose subscriber you want to delete.</p>"
},
"Subscriber":{
"shape":"Subscriber",
"documentation":"<p>The subscriber that you want to delete.</p>"
}
},
"documentation":"Request of DeleteSubscriber"
"documentation":"<p> Request of DeleteSubscriber </p>"
},
"DeleteSubscriberResponse":{
"type":"structure",
"members":{
},
"documentation":"Response of DeleteSubscriber"
"documentation":"<p> Response of DeleteSubscriber </p>"
},
"DescribeBudgetRequest":{
"type":"structure",
@ -481,35 +569,59 @@
"BudgetName"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"}
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The <code>accountId</code> that is associated with the budget that you want a description of.</p>"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"<p>The name of the budget that you want a description of.</p>"
}
},
"documentation":"Request of DescribeBudget"
"documentation":"<p> Request of DescribeBudget </p>"
},
"DescribeBudgetResponse":{
"type":"structure",
"members":{
"Budget":{"shape":"Budget"}
"Budget":{
"shape":"Budget",
"documentation":"<p>The description of the budget.</p>"
}
},
"documentation":"Response of DescribeBudget"
"documentation":"<p> Response of DescribeBudget </p>"
},
"DescribeBudgetsRequest":{
"type":"structure",
"required":["AccountId"],
"members":{
"AccountId":{"shape":"AccountId"},
"MaxResults":{"shape":"MaxResults"},
"NextToken":{"shape":"GenericString"}
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The <code>accountId</code> that is associated with the budgets that you want descriptions of.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>Optional integer. Specifies the maximum number of results to return in response.</p>"
},
"NextToken":{
"shape":"GenericString",
"documentation":"<p>The pagination token that indicates the next set of results to retrieve.</p>"
}
},
"documentation":"Request of DescribeBudgets"
"documentation":"<p> Request of DescribeBudgets </p>"
},
"DescribeBudgetsResponse":{
"type":"structure",
"members":{
"Budgets":{"shape":"Budgets"},
"NextToken":{"shape":"GenericString"}
"Budgets":{
"shape":"Budgets",
"documentation":"<p>A list of budgets.</p>"
},
"NextToken":{
"shape":"GenericString",
"documentation":"<p>The pagination token that indicates the next set of results that you can retrieve.</p>"
}
},
"documentation":"Response of DescribeBudgets"
"documentation":"<p> Response of DescribeBudgets </p>"
},
"DescribeNotificationsForBudgetRequest":{
"type":"structure",
@ -518,20 +630,38 @@
"BudgetName"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"MaxResults":{"shape":"MaxResults"},
"NextToken":{"shape":"GenericString"}
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The <code>accountId</code> that is associated with the budget whose notifications you want descriptions of.</p>"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"<p>The name of the budget whose notifications you want descriptions of.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>Optional integer. Specifies the maximum number of results to return in response.</p>"
},
"NextToken":{
"shape":"GenericString",
"documentation":"<p>The pagination token that indicates the next set of results to retrieve.</p>"
}
},
"documentation":"Request of DescribeNotificationsForBudget"
"documentation":"<p> Request of DescribeNotificationsForBudget </p>"
},
"DescribeNotificationsForBudgetResponse":{
"type":"structure",
"members":{
"Notifications":{"shape":"Notifications"},
"NextToken":{"shape":"GenericString"}
"Notifications":{
"shape":"Notifications",
"documentation":"<p>A list of notifications associated with a budget.</p>"
},
"NextToken":{
"shape":"GenericString",
"documentation":"<p>The pagination token that indicates the next set of results that you can retrieve.</p>"
}
},
"documentation":"Response of GetNotificationsForBudget"
"documentation":"<p> Response of GetNotificationsForBudget </p>"
},
"DescribeSubscribersForNotificationRequest":{
"type":"structure",
@ -541,21 +671,42 @@
"Notification"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"Notification":{"shape":"Notification"},
"MaxResults":{"shape":"MaxResults"},
"NextToken":{"shape":"GenericString"}
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The <code>accountId</code> that is associated with the budget whose subscribers you want descriptions of.</p>"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"<p>The name of the budget whose subscribers you want descriptions of.</p>"
},
"Notification":{
"shape":"Notification",
"documentation":"<p>The notification whose subscribers you want to list.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>Optional integer. Specifies the maximum number of results to return in response.</p>"
},
"NextToken":{
"shape":"GenericString",
"documentation":"<p>The pagination token that indicates the next set of results to retrieve.</p>"
}
},
"documentation":"Request of DescribeSubscribersForNotification"
"documentation":"<p> Request of DescribeSubscribersForNotification </p>"
},
"DescribeSubscribersForNotificationResponse":{
"type":"structure",
"members":{
"Subscribers":{"shape":"Subscribers"},
"NextToken":{"shape":"GenericString"}
"Subscribers":{
"shape":"Subscribers",
"documentation":"<p>A list of subscribers associated with a notification.</p>"
},
"NextToken":{
"shape":"GenericString",
"documentation":"<p>The pagination token that indicates the next set of results that you can retrieve.</p>"
}
},
"documentation":"Response of DescribeSubscribersForNotification"
"documentation":"<p> Response of DescribeSubscribersForNotification </p>"
},
"DimensionValues":{
"type":"list",
@ -566,7 +717,7 @@
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"The exception is thrown when customer tries to create a record (e.g. budget) that already exists.",
"documentation":"<p>The budget name already exists. Budget names must be unique within an account.</p>",
"exception":true
},
"ExpiredNextTokenException":{
@ -574,23 +725,23 @@
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"This exception is thrown if the paging token is expired - past its TTL",
"documentation":"<p>The pagination token expired.</p>",
"exception":true
},
"GenericString":{
"type":"string",
"documentation":"A generic String."
"documentation":"<p> A generic String.</p>"
},
"GenericTimestamp":{
"type":"timestamp",
"documentation":"A generic timestamp. In Java it is transformed to a Date object."
"documentation":"<p> A generic timestamp. In Java it is transformed to a Date object.</p>"
},
"InternalErrorException":{
"type":"structure",
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"This exception is thrown on an unknown internal failure.",
"documentation":"<p>An error on the server occurred during the processing of your request. Try again later.</p>",
"exception":true
},
"InvalidNextTokenException":{
@ -598,7 +749,7 @@
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"This exception is thrown if paging token signature didn't match the token, or the paging token isn't for this request",
"documentation":"<p>The pagination token is invalid.</p>",
"exception":true
},
"InvalidParameterException":{
@ -606,12 +757,12 @@
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"This exception is thrown if any request is given an invalid parameter. E.g., if a required Date field is null.",
"documentation":"<p>An error on the client occurred. Typically, the cause is an invalid input value.</p>",
"exception":true
},
"MaxResults":{
"type":"integer",
"documentation":"An integer to represent how many entries a paginated response contains. Maximum is set to 100.",
"documentation":"<p> An integer to represent how many entries a paginated response contains. Maximum is set to 100.</p>",
"box":true,
"max":100,
"min":1
@ -621,7 +772,7 @@
"members":{
"Message":{"shape":"errorMessage"}
},
"documentation":"This exception is thrown if a requested entity is not found. E.g., if a budget id doesn't exist for an account ID.",
"documentation":"<p>We can’t locate the resource that you specified.</p>",
"exception":true
},
"Notification":{
@ -632,22 +783,34 @@
"Threshold"
],
"members":{
"NotificationType":{"shape":"NotificationType"},
"ComparisonOperator":{"shape":"ComparisonOperator"},
"Threshold":{"shape":"NotificationThreshold"},
"ThresholdType":{"shape":"ThresholdType"}
"NotificationType":{
"shape":"NotificationType",
"documentation":"<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>"
},
"ComparisonOperator":{
"shape":"ComparisonOperator",
"documentation":"<p>The comparison used for this notification.</p>"
},
"Threshold":{
"shape":"NotificationThreshold",
"documentation":"<p>The threshold associated with a notification. Thresholds are always a percentage.</p>"
},
"ThresholdType":{
"shape":"ThresholdType",
"documentation":"<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>"
}
},
"documentation":"Notification model. Each budget may contain multiple notifications with different settings."
"documentation":"<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>"
},
"NotificationThreshold":{
"type":"double",
"documentation":"The threshold of a notification. It should be a number between 0 and 1,000,000,000.",
"documentation":"<p> The threshold of a notification. It should be a number between 0 and 1,000,000,000.</p>",
"max":1000000000,
"min":0.1
},
"NotificationType":{
"type":"string",
"documentation":"The type of a notification. It should be ACTUAL or FORECASTED.",
"documentation":"<p> The type of a notification. It should be ACTUAL or FORECASTED.</p>",
"enum":[
"ACTUAL",
"FORECASTED"
@ -660,21 +823,27 @@
"Subscribers"
],
"members":{
"Notification":{"shape":"Notification"},
"Subscribers":{"shape":"Subscribers"}
"Notification":{
"shape":"Notification",
"documentation":"<p>The notification associated with a budget.</p>"
},
"Subscribers":{
"shape":"Subscribers",
"documentation":"<p>A list of subscribers who are subscribed to this notification.</p>"
}
},
"documentation":"A structure to relate notification and a list of subscribers who belong to the notification."
"documentation":"<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>"
},
"NotificationWithSubscribersList":{
"type":"list",
"member":{"shape":"NotificationWithSubscribers"},
"documentation":"A list of Notifications, each with a list of subscribers.",
"documentation":"<p> A list of Notifications, each with a list of subscribers.</p>",
"max":5
},
"Notifications":{
"type":"list",
"member":{"shape":"Notification"},
"documentation":"A list of notifications."
"documentation":"<p> A list of notifications.</p>"
},
"NullableBoolean":{
"type":"boolean",
@ -682,7 +851,7 @@
},
"NumericValue":{
"type":"string",
"documentation":"A string to represent NumericValue.",
"documentation":"<p> A string to represent NumericValue.</p>",
"pattern":"[0-9]*(\\.)?[0-9]+"
},
"Spend":{
@ -692,10 +861,16 @@
"Unit"
],
"members":{
"Amount":{"shape":"NumericValue"},
"Unit":{"shape":"UnitValue"}
"Amount":{
"shape":"NumericValue",
"documentation":"<p>The cost or usage amount associated with a budget forecast, actual spend, or budget threshold.</p>"
},
"Unit":{
"shape":"UnitValue",
"documentation":"<p>The unit of measurement used for the budget forecast, actual spend, or budget threshold, such as dollars or GB.</p>"
}
},
"documentation":"A structure that represents either a cost spend or usage spend. Contains an amount and a unit."
"documentation":"<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>"
},
"Subscriber":{
"type":"structure",
@ -704,26 +879,32 @@
"Address"
],
"members":{
"SubscriptionType":{"shape":"SubscriptionType"},
"Address":{"shape":"SubscriberAddress"}
"SubscriptionType":{
"shape":"SubscriptionType",
"documentation":"<p>The type of notification that AWS sends to a subscriber.</p>"
},
"Address":{
"shape":"SubscriberAddress",
"documentation":"<p>The address that AWS sends budget notifications to, either an SNS topic or an email.</p>"
}
},
"documentation":"Subscriber model. Each notification may contain multiple subscribers with different addresses."
"documentation":"<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>"
},
"SubscriberAddress":{
"type":"string",
"documentation":"String containing email or sns topic for the subscriber address.",
"documentation":"<p> String containing email or sns topic for the subscriber address.</p>",
"min":1
},
"Subscribers":{
"type":"list",
"member":{"shape":"Subscriber"},
"documentation":"A list of subscribers.",
"documentation":"<p> A list of subscribers.</p>",
"max":11,
"min":1
},
"SubscriptionType":{
"type":"string",
"documentation":"The subscription type of the subscriber. It can be SMS or EMAIL.",
"documentation":"<p> The subscription type of the subscriber. It can be SMS or EMAIL.</p>",
"enum":[
"SNS",
"EMAIL"
@ -731,7 +912,7 @@
},
"ThresholdType":{
"type":"string",
"documentation":"The type of threshold for a notification. It can be PERCENTAGE or ABSOLUTE_VALUE.",
"documentation":"<p> The type of threshold for a notification. It can be PERCENTAGE or ABSOLUTE_VALUE.</p>",
"enum":[
"PERCENTAGE",
"ABSOLUTE_VALUE"
@ -739,19 +920,21 @@
},
"TimePeriod":{
"type":"structure",
"required":[
"Start",
"End"
],
"members":{
"Start":{"shape":"GenericTimestamp"},
"End":{"shape":"GenericTimestamp"}
"Start":{
"shape":"GenericTimestamp",
"documentation":"<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>"
},
"End":{
"shape":"GenericTimestamp",
"documentation":"<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>"
}
},
"documentation":"A time period indicating the start date and end date of a budget."
"documentation":"<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>"
},
"TimeUnit":{
"type":"string",
"documentation":"The time unit of the budget. e.g. MONTHLY, QUARTERLY, etc.",
"documentation":"<p> The time unit of the budget. e.g. MONTHLY, QUARTERLY, etc.</p>",
"enum":[
"DAILY",
"MONTHLY",
@ -761,7 +944,7 @@
},
"UnitValue":{
"type":"string",
"documentation":"A string to represent budget spend unit. It should be not null and not empty.",
"documentation":"<p> A string to represent budget spend unit. It should be not null and not empty.</p>",
"min":1
},
"UpdateBudgetRequest":{
@ -771,16 +954,22 @@
"NewBudget"
],
"members":{
"AccountId":{"shape":"AccountId"},
"NewBudget":{"shape":"Budget"}
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The <code>accountId</code> that is associated with the budget that you want to update.</p>"
},
"NewBudget":{
"shape":"Budget",
"documentation":"<p>The budget that you want to update your budget to.</p>"
}
},
"documentation":"Request of UpdateBudget"
"documentation":"<p> Request of UpdateBudget </p>"
},
"UpdateBudgetResponse":{
"type":"structure",
"members":{
},
"documentation":"Response of UpdateBudget"
"documentation":"<p> Response of UpdateBudget </p>"
},
"UpdateNotificationRequest":{
"type":"structure",
@ -791,18 +980,30 @@
"NewNotification"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"OldNotification":{"shape":"Notification"},
"NewNotification":{"shape":"Notification"}
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The <code>accountId</code> that is associated with the budget whose notification you want to update.</p>"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"<p>The name of the budget whose notification you want to update.</p>"
},
"OldNotification":{
"shape":"Notification",
"documentation":"<p>The previous notification associated with a budget.</p>"
},
"NewNotification":{
"shape":"Notification",
"documentation":"<p>The updated notification to be associated with a budget.</p>"
}
},
"documentation":"Request of UpdateNotification"
"documentation":"<p> Request of UpdateNotification </p>"
},
"UpdateNotificationResponse":{
"type":"structure",
"members":{
},
"documentation":"Response of UpdateNotification"
"documentation":"<p> Response of UpdateNotification </p>"
},
"UpdateSubscriberRequest":{
"type":"structure",
@ -814,24 +1015,39 @@
"NewSubscriber"
],
"members":{
"AccountId":{"shape":"AccountId"},
"BudgetName":{"shape":"BudgetName"},
"Notification":{"shape":"Notification"},
"OldSubscriber":{"shape":"Subscriber"},
"NewSubscriber":{"shape":"Subscriber"}
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The <code>accountId</code> that is associated with the budget whose subscriber you want to update.</p>"
},
"BudgetName":{
"shape":"BudgetName",
"documentation":"<p>The name of the budget whose subscriber you want to update.</p>"
},
"Notification":{
"shape":"Notification",
"documentation":"<p>The notification whose subscriber you want to update.</p>"
},
"OldSubscriber":{
"shape":"Subscriber",
"documentation":"<p>The previous subscriber associated with a budget notification.</p>"
},
"NewSubscriber":{
"shape":"Subscriber",
"documentation":"<p>The updated subscriber associated with a budget notification.</p>"
}
},
"documentation":"Request of UpdateSubscriber"
"documentation":"<p> Request of UpdateSubscriber </p>"
},
"UpdateSubscriberResponse":{
"type":"structure",
"members":{
},
"documentation":"Response of UpdateSubscriber"
"documentation":"<p> Response of UpdateSubscriber </p>"
},
"errorMessage":{
"type":"string",
"documentation":"The error message the exception carries."
"documentation":"<p>The error message the exception carries.</p>"
}
},
"documentation":"All public APIs for AWS Budgets"
"documentation":"<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>"
}

14
botocore/data/cloud9/2017-09-23/service-2.json
View file

@ -28,7 +28,7 @@
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then hosts the environment on the instance.</p>",
"documentation":"<p>Creates an AWS Cloud9 development environment, launches an Amazon Elastic Compute Cloud (Amazon EC2) instance, and then connects from the instance to the environment.</p>",
"idempotent":true
},
"CreateEnvironmentMembership":{
@ -68,7 +68,7 @@
{"shape":"LimitExceededException"},
{"shape":"InternalServerErrorException"}
],
"documentation":"<p>Deletes an AWS Cloud9 development environment. If the environment is hosted on an Amazon Elastic Compute Cloud (Amazon EC2) instance, also terminates the instance.</p>",
"documentation":"<p>Deletes an AWS Cloud9 development environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.</p>",
"idempotent":true
},
"DeleteEnvironmentMembership":{
@ -259,7 +259,7 @@
},
"instanceType":{
"shape":"InstanceType",
"documentation":"<p>The type of instance to host the environment on (for example, <code>t2.micro</code>).</p>"
"documentation":"<p>The type of instance to connect to the environment (for example, <code>t2.micro</code>).</p>"
},
"subnetId":{
"shape":"SubnetId",
@ -419,7 +419,7 @@
"members":{
"environmentIds":{
"shape":"BoundedEnvironmentIdList",
"documentation":"<p>The IDs of invidividual environments to get information about.</p>"
"documentation":"<p>The IDs of individual environments to get information about.</p>"
}
}
},
@ -449,7 +449,7 @@
},
"type":{
"shape":"EnvironmentType",
"documentation":"<p>The type of environment. Valid values include the following:</p> <ul> <li> <p> <code>ec2</code>: An environment hosted on an Amazon Elastic Compute Cloud (Amazon EC2) instance.</p> </li> <li> <p> <code>ssh</code>: An environment hosted on your own server.</p> </li> </ul>"
"documentation":"<p>The type of environment. Valid values include the following:</p> <ul> <li> <p> <code>ec2</code>: An Amazon Elastic Compute Cloud (Amazon EC2) instance connects to the environment.</p> </li> <li> <p> <code>ssh</code>: Your own server connects to the environment.</p> </li> </ul>"
},
"arn":{
"shape":"String",
@ -673,7 +673,7 @@
},
"name":{
"shape":"EnvironmentName",
"documentation":"<p>Any replacement name for the environment.</p>"
"documentation":"<p>A replacement name for the environment.</p>"
},
"description":{
"shape":"EnvironmentDescription",
@ -691,5 +691,5 @@
"pattern":"arn:aws:(iam|sts)::\\d+:\\S+"
}
},
"documentation":"<fullname>AWS Cloud9</fullname> <p>AWS Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.</p> <p>In the background, these tools are available through development environments running on Amazon Elastic Compute Cloud (Amazon EC2) instances (known as <i>Amazon EC2 environments</i>), your own servers (known as <i>SSH environments</i>), or a combination. This enables you to create and switch between multiple environments, with each environment set up for a specific development project.</p> <p>For more information about AWS Cloud9, see the <i>AWS Cloud9 User Guide</i>.</p> <p>AWS Cloud9 supports these operations:</p> <ul> <li> <p> <code>CreateEnvironmentEC2</code>: Creates an AWS Cloud9 development environment, launches an Amazon EC2 instance, and then hosts the environment on the instance.</p> </li> <li> <p> <code>CreateEnvironmentMembership</code>: Adds an environment member to an environment.</p> </li> <li> <p> <code>DeleteEnvironment</code>: Deletes an environment. If the environment is hosted on an Amazon EC2 instance, also terminates the instance.</p> </li> <li> <p> <code>DeleteEnvironmentMembership</code>: Deletes an environment member from an environment.</p> </li> <li> <p> <code>DescribeEnvironmentMemberships</code>: Gets information about environment members for an environment.</p> </li> <li> <p> <code>DescribeEnvironments</code>: Gets information about environments.</p> </li> <li> <p> <code>DescribeEnvironmentStatus</code>: Gets status information for an environment.</p> </li> <li> <p> <code>ListEnvironments</code>: Gets a list of environment identifiers.</p> </li> <li> <p> <code>UpdateEnvironment</code>: Changes the settings of an existing environment.</p> </li> <li> <p> <code>UpdateEnvironmentMembership</code>: Changes the settings of an existing environment member for an environment.</p> </li> </ul>"
"documentation":"<fullname>AWS Cloud9</fullname> <p>AWS Cloud9 is a collection of tools that you can use to code, build, run, test, debug, and release software in the cloud.</p> <p>For more information about AWS Cloud9, see the <a href=\"https://docs.aws.amazon.com/cloud9/latest/user-guide\">AWS Cloud9 User Guide</a>.</p> <p>AWS Cloud9 supports these operations:</p> <ul> <li> <p> <code>CreateEnvironmentEC2</code>: Creates an AWS Cloud9 development environment, launches an Amazon EC2 instance, and then connects from the instance to the environment.</p> </li> <li> <p> <code>CreateEnvironmentMembership</code>: Adds an environment member to an environment.</p> </li> <li> <p> <code>DeleteEnvironment</code>: Deletes an environment. If an Amazon EC2 instance is connected to the environment, also terminates the instance.</p> </li> <li> <p> <code>DeleteEnvironmentMembership</code>: Deletes an environment member from an environment.</p> </li> <li> <p> <code>DescribeEnvironmentMemberships</code>: Gets information about environment members for an environment.</p> </li> <li> <p> <code>DescribeEnvironments</code>: Gets information about environments.</p> </li> <li> <p> <code>DescribeEnvironmentStatus</code>: Gets status information for an environment.</p> </li> <li> <p> <code>ListEnvironments</code>: Gets a list of environment identifiers.</p> </li> <li> <p> <code>UpdateEnvironment</code>: Changes the settings of an existing environment.</p> </li> <li> <p> <code>UpdateEnvironmentMembership</code>: Changes the settings of an existing environment member for an environment.</p> </li> </ul>"
}

1
botocore/data/cloudformation/2010-05-15/waiters-2.json
View file

@ -153,7 +153,6 @@
}
]
},
"ChangeSetCreateComplete": {
"delay": 30,
"operation": "DescribeChangeSet",

0
botocore/data/cloudfront/2016-09-07/service-2.json Executable file → Normal file
View file

2
botocore/data/cloudfront/2017-03-25/waiters-2.json
View file

@ -18,7 +18,7 @@
"InvalidationCompleted": {
"delay": 20,
"operation": "GetInvalidation",
"maxAttempts": 60,
"maxAttempts": 30,
"description": "Wait until an invalidation has completed.",
"acceptors": [
{

0
botocore/data/cognito-idp/2016-04-18/examples-1.json Executable file → Normal file
View file

0
botocore/data/config/2014-11-12/examples-1.json Executable file → Normal file
View file

119
botocore/data/dms/2016-01-01/service-2.json
View file

@ -318,6 +318,20 @@
],
"documentation":"<p>Returns the status of the RefreshSchemas operation.</p>"
},
"DescribeReplicationInstanceTaskLogs":{
"name":"DescribeReplicationInstanceTaskLogs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeReplicationInstanceTaskLogsMessage"},
"output":{"shape":"DescribeReplicationInstanceTaskLogsResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"},
{"shape":"InvalidResourceStateFault"}
],
"documentation":"<p>Returns information about the task logs for the specified task.</p>"
},
"DescribeReplicationInstances":{
"name":"DescribeReplicationInstances",
"http":{
@ -408,7 +422,8 @@
"output":{"shape":"ImportCertificateResponse"},
"errors":[
{"shape":"ResourceAlreadyExistsFault"},
{"shape":"InvalidCertificateFault"}
{"shape":"InvalidCertificateFault"},
{"shape":"ResourceQuotaExceededFault"}
],
"documentation":"<p>Uploads the specified certificate.</p>"
},
@ -510,6 +525,20 @@
],
"documentation":"<p>Modifies the specified replication task.</p> <p>You can't modify the task endpoints. The task must be stopped before you can modify it. </p> <p>For more information about AWS DMS tasks, see the AWS DMS user guide at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html\"> Working with Migration Tasks </a> </p>"
},
"RebootReplicationInstance":{
"name":"RebootReplicationInstance",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RebootReplicationInstanceMessage"},
"output":{"shape":"RebootReplicationInstanceResponse"},
"errors":[
{"shape":"ResourceNotFoundFault"},
{"shape":"InvalidResourceStateFault"}
],
"documentation":"<p>Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.</p>"
},
"RefreshSchemas":{
"name":"RefreshSchemas",
"http":{
@ -807,7 +836,7 @@
},
"EngineName":{
"shape":"String",
"documentation":"<p>The type of engine for the endpoint. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.</p>"
"documentation":"<p>The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, redshift, S3, sybase, dynamodb, mongodb, and sqlserver.</p>"
},
"Username":{
"shape":"String",
@ -1518,6 +1547,41 @@
},
"documentation":"<p/>"
},
"DescribeReplicationInstanceTaskLogsMessage":{
"type":"structure",
"required":["ReplicationInstanceArn"],
"members":{
"ReplicationInstanceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the replication instance.</p>"
},
"MaxRecords":{
"shape":"IntegerOptional",
"documentation":"<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
}
}
},
"DescribeReplicationInstanceTaskLogsResponse":{
"type":"structure",
"members":{
"ReplicationInstanceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the replication instance.</p>"
},
"ReplicationInstanceTaskLogs":{
"shape":"ReplicationInstanceTaskLogsList",
"documentation":"<p>An array of replication task log metadata. Each member of the array contains the replication task name, ARN, and task log size (in bytes).</p>"
},
"Marker":{
"shape":"String",
"documentation":"<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>"
}
}
},
"DescribeReplicationInstancesMessage":{
"type":"structure",
"members":{
@ -1757,7 +1821,7 @@
},
"EngineName":{
"shape":"String",
"documentation":"<p>The database engine name. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.</p>"
"documentation":"<p>The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, redshift, S3, sybase, dynamodb, mongodb, and sqlserver.</p>"
},
"Username":{
"shape":"String",
@ -2084,7 +2148,7 @@
},
"EngineName":{
"shape":"String",
"documentation":"<p>The type of engine for the endpoint. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, DYNAMODB, MONGODB, SYBASE, and SQLSERVER.</p>"
"documentation":"<p>The type of engine for the endpoint. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, redshift, S3, sybase, dynamodb, mongodb, and sqlserver.</p>"
},
"Username":{
"shape":"String",
@ -2409,6 +2473,29 @@
"type":"list",
"member":{"shape":"OrderableReplicationInstance"}
},
"RebootReplicationInstanceMessage":{
"type":"structure",
"required":["ReplicationInstanceArn"],
"members":{
"ReplicationInstanceArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the replication instance.</p>"
},
"ForceFailover":{
"shape":"BooleanOptional",
"documentation":"<p>If this parameter is <code>true</code>, the reboot is conducted through a Multi-AZ failover. (If the instance isn't configured for Multi-AZ, then you can't specify <code>true</code>.)</p>"
}
}
},
"RebootReplicationInstanceResponse":{
"type":"structure",
"members":{
"ReplicationInstance":{
"shape":"ReplicationInstance",
"documentation":"<p>The replication instance that is being rebooted. </p>"
}
}
},
"RefreshSchemasMessage":{
"type":"structure",
"required":[
@ -2632,6 +2719,28 @@
"type":"list",
"member":{"shape":"String"}
},
"ReplicationInstanceTaskLog":{
"type":"structure",
"members":{
"ReplicationTaskName":{
"shape":"String",
"documentation":"<p>The name of the replication task.</p>"
},
"ReplicationTaskArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the replication task.</p>"
},
"ReplicationInstanceTaskLogSize":{
"shape":"Long",
"documentation":"<p>The size, in bytes, of the replication task log.</p>"
}
},
"documentation":"<p>Contains metadata for a replication instance task log.</p>"
},
"ReplicationInstanceTaskLogsList":{
"type":"list",
"member":{"shape":"ReplicationInstanceTaskLog"}
},
"ReplicationPendingModifiedValues":{
"type":"structure",
"members":{
@ -3070,7 +3179,7 @@
"members":{
"EngineName":{
"shape":"String",
"documentation":"<p>The database engine name. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.</p>"
"documentation":"<p>The database engine name. Valid values, depending on the EndPointType, include mysql, oracle, postgres, mariadb, aurora, redshift, S3, sybase, dynamodb, mongodb, and sqlserver.</p>"
},
"SupportsCDC":{
"shape":"Boolean",

7
botocore/data/ds/2015-04-16/service-2.json
View file

@ -7,6 +7,7 @@
"protocol":"json",
"serviceAbbreviation":"Directory Service",
"serviceFullName":"AWS Directory Service",
"serviceId":"Directory Service",
"signatureVersion":"v4",
"targetPrefix":"DirectoryService_20150416",
"uid":"ds-2015-04-16"
@ -2562,7 +2563,7 @@
},
"SecurityGroupId":{
"type":"string",
"pattern":"^(sg-[0-9a-f]{8})$"
"pattern":"^(sg-[0-9a-f]{8}|sg-[0-9a-f]{17})$"
},
"Server":{
"type":"string",
@ -2718,7 +2719,7 @@
"StateLastUpdatedDateTime":{"type":"timestamp"},
"SubnetId":{
"type":"string",
"pattern":"^(subnet-[0-9a-f]{8})$"
"pattern":"^(subnet-[0-9a-f]{8}|subnet-[0-9a-f]{17})$"
},
"SubnetIds":{
"type":"list",
@ -2995,7 +2996,7 @@
},
"VpcId":{
"type":"string",
"pattern":"^(vpc-[0-9a-f]{8})$"
"pattern":"^(vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$"
}
},
"documentation":"<fullname>AWS Directory Service</fullname> <p>AWS Directory Service is a web service that makes it easy for you to setup and run directories in the AWS cloud, or connect your AWS resources with an existing on-premises Microsoft Active Directory. This guide provides detailed information about AWS Directory Service operations, data types, parameters, 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> <note> <p>AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS Directory Service and other AWS services. For more information about the AWS SDKs, including how to download and install them, see <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services</a>.</p> </note>"

62
botocore/data/dynamodb/2012-08-10/service-2.json
View file

@ -60,7 +60,7 @@
{"shape":"LimitExceededException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Creates a backup for an existing table.</p> <p> Each time you create an On-Demand Backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken. </p> <p>You can call <code>CreateBackup</code> at a maximum rate of 50 times per second.</p> <p>All backups in DynamoDB work without consuming any provisioned throughput on the table. This results in a fast, low-cost, and scalable backup process. In general, the larger the table, the more time it takes to back up. The backup is stored in an S3 data store that is maintained and managed by DynamoDB.</p> <p>Backups incorporate all writes (delete, put, update) that were completed within the last minute before the backup request was initiated. Backups might include some writes (delete, put, update) that were completed before the backup request was finished.</p> <p> For example, if you submit the backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup may or may not contain data modifications made between 14:24:00 and 14:26:00. On-Demand Backup does not support causal consistency. </p> <p> Along with data, the following are also included on the backups: </p> <ul> <li> <p>Global secondary indexes (GSIs)</p> </li> <li> <p>Local secondary indexes (LSIs)</p> </li> <li> <p>Streams</p> </li> <li> <p>Provisioned read and write capacity</p> </li> </ul>"
"documentation":"<p>Creates a backup for an existing table.</p> <p> Each time you create an On-Demand Backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken. </p> <p> When you create an On-Demand Backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes. </p> <p>You can call <code>CreateBackup</code> at a maximum rate of 50 times per second.</p> <p>All backups in DynamoDB work without consuming any provisioned throughput on the table.</p> <p> If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup may or may not contain data modifications made between 14:24:00 and 14:26:00. On-Demand Backup does not support causal consistency. </p> <p> Along with data, the following are also included on the backups: </p> <ul> <li> <p>Global secondary indexes (GSIs)</p> </li> <li> <p>Local secondary indexes (LSIs)</p> </li> <li> <p>Streams</p> </li> <li> <p>Provisioned read and write capacity</p> </li> </ul>"
},
"CreateGlobalTable":{
"name":"CreateGlobalTable",
@ -182,7 +182,7 @@
{"shape":"InternalServerError"},
{"shape":"GlobalTableNotFoundException"}
],
"documentation":"<p>Returns information about the global table.</p>"
"documentation":"<p>Returns information about the specified global table.</p>"
},
"DescribeLimits":{
"name":"DescribeLimits",
@ -264,7 +264,7 @@
"errors":[
{"shape":"InternalServerError"}
],
"documentation":"<p>Lists all the global tables. Only those global tables that have replicas in the region specified as input are returned.</p>"
"documentation":"<p>Lists all global tables that have a replica in the specified region.</p>"
},
"ListTables":{
"name":"ListTables",
@ -341,7 +341,7 @@
{"shape":"LimitExceededException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Creates a new table from an existing backup. Any number of users can execute up to 10 concurrent restores in a given account. </p> <p>You can call <code>RestoreTableFromBackup</code> at a maximum rate of 10 times per second.</p> <p>You must manually set up the following on the restored table:</p> <ul> <li> <p>Auto scaling policies</p> </li> <li> <p>IAM policies</p> </li> <li> <p>Cloudwatch metrics and alarms</p> </li> <li> <p>Tags</p> </li> <li> <p>Time to Live (TTL) settings</p> </li> </ul>"
"documentation":"<p>Creates a new table from an existing backup. Any number of users can execute up to 10 concurrent restores in a given account. </p> <p>You can call <code>RestoreTableFromBackup</code> at a maximum rate of 10 times per second.</p> <p>You must manually set up the following on the restored table:</p> <ul> <li> <p>Auto scaling policies</p> </li> <li> <p>IAM policies</p> </li> <li> <p>Cloudwatch metrics and alarms</p> </li> <li> <p>Tags</p> </li> <li> <p>Stream settings</p> </li> <li> <p>Time to Live (TTL) settings</p> </li> </ul>"
},
"Scan":{
"name":"Scan",
@ -403,7 +403,7 @@
{"shape":"ReplicaNotFoundException"},
{"shape":"TableNotFoundException"}
],
"documentation":"<p>Adds or removes replicas to the specified global table. The global table should already exist to be able to use this operation. Currently, the replica to be added should be empty. </p>"
"documentation":"<p>Adds or removes replicas in the specified global table. The global table must already exist to be able to use this operation. Any replica to be added must be empty, must have the same name as the global table, must have the same key schema, must have DynamoDB Streams enabled, and cannot have any local secondary indexes (LSIs).</p> <note> <p>Although you can use <code>UpdateGlobalTable</code> to add replicas and remove replicas in a single request, for simplicity we recommend that you issue separate requests for adding or removing replicas.</p> </note>"
},
"UpdateItem":{
"name":"UpdateItem",
@ -560,7 +560,7 @@
"members":{
"Value":{
"shape":"AttributeValue",
"documentation":"<p>Represents the data for an attribute.</p> <p>Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes\">Data TYpes</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p>"
"documentation":"<p>Represents the data for an attribute.</p> <p>Each attribute value is described as a name-value pair. The name is the data type, and the value is the data itself.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes\">Data Types</a> in the <i>Amazon DynamoDB Developer Guide</i>. </p>"
},
"Action":{
"shape":"AttributeAction",
@ -637,7 +637,8 @@
"BackupName":{
"type":"string",
"max":255,
"min":3
"min":3,
"pattern":"[a-zA-Z0-9_.-]+"
},
"BackupNotFoundException":{
"type":"structure",
@ -1043,6 +1044,10 @@
"StreamSpecification":{
"shape":"StreamSpecification",
"documentation":"<p>The settings for DynamoDB Streams on the table. These settings consist of:</p> <ul> <li> <p> <code>StreamEnabled</code> - Indicates whether Streams is to be enabled (true) or disabled (false).</p> </li> <li> <p> <code>StreamViewType</code> - When an item in the table is modified, <code>StreamViewType</code> determines what information is written to the table's stream. Valid values for <code>StreamViewType</code> are:</p> <ul> <li> <p> <code>KEYS_ONLY</code> - Only the key attributes of the modified item are written to the stream.</p> </li> <li> <p> <code>NEW_IMAGE</code> - The entire item, as it appears after it was modified, is written to the stream.</p> </li> <li> <p> <code>OLD_IMAGE</code> - The entire item, as it appeared before it was modified, is written to the stream.</p> </li> <li> <p> <code>NEW_AND_OLD_IMAGES</code> - Both the new and the old item images of the item are written to the stream.</p> </li> </ul> </li> </ul>"
},
"SSESpecification":{
"shape":"SSESpecification",
"documentation":"<p>Represents the settings used to enable server-side encryption.</p>"
}
},
"documentation":"<p>Represents the input of a <code>CreateTable</code> operation.</p>"
@ -1779,7 +1784,7 @@
"documentation":"<p>Too many operations for a given subscriber.</p>"
}
},
"documentation":"<p>The number of concurrent table requests (cumulative number of tables in the <code>CREATING</code>, <code>DELETING</code> or <code>UPDATING</code> state) exceeds the maximum allowed of 10.</p> <p>Also, for tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously.</p> <p>The total limit of tables in the <code>ACTIVE</code> state is 250.</p>",
"documentation":"<p>Up to 50 <code>CreateBackup</code> operations are allowed per second, per account. There is no limit to the number of daily on-demand backups that can be taken. </p> <p>Up to 10 simultaneous table operations are allowed per account. These operations include <code>CreateTable</code>, <code>UpdateTable</code>, <code>DeleteTable</code>,<code>UpdateTimeToLive</code>, and <code>RestoreTableFromBackup</code>. </p> <p>For tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously.</p> <p>The total limit of tables in the <code>ACTIVE</code> state is 250.</p> <p>For tables with secondary indexes, only one of those tables can be in the <code>CREATING</code> state at any point in time. Do not attempt to create more than one such table simultaneously.</p> <p>The total limit of tables in the <code>ACTIVE</code> state is 250.</p>",
"exception":true
},
"ListAttributeValue":{
@ -2247,7 +2252,7 @@
},
"KeyConditionExpression":{
"shape":"KeyExpression",
"documentation":"<p>The condition that specifies the key value(s) for items to be retrieved by the <code>Query</code> action.</p> <p>The condition must perform an equality test on a single partition key value. The condition can also perform one of several comparison tests on a single sort key value. <code>Query</code> can use <code>KeyConditionExpression</code> to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values.</p> <p>The partition key equality test is required, and must be specified in the following format:</p> <p> <code>partitionKeyName</code> <i>=</i> <code>:partitionkeyval</code> </p> <p>If you also want to provide a condition for the sort key, it must be combined using <code>AND</code> with the condition for the sort key. Following is an example, using the <b>=</b> comparison operator for the sort key:</p> <p> <code>partitionKeyName</code> <code>=</code> <code>:partitionkeyval</code> <code>AND</code> <code>sortKeyName</code> <code>=</code> <code>:sortkeyval</code> </p> <p>Valid comparisons for the sort key condition are as follows:</p> <ul> <li> <p> <code>sortKeyName</code> <code>=</code> <code>:sortkeyval</code> - true if the sort key value is equal to <code>:sortkeyval</code>.</p> </li> <li> <p> <code>sortKeyName</code> <code>&lt;</code> <code>:sortkeyval</code> - true if the sort key value is less than <code>:sortkeyval</code>.</p> </li> <li> <p> <code>sortKeyName</code> <code>&lt;=</code> <code>:sortkeyval</code> - true if the sort key value is less than or equal to <code>:sortkeyval</code>.</p> </li> <li> <p> <code>sortKeyName</code> <code>&gt;</code> <code>:sortkeyval</code> - true if the sort key value is greater than <code>:sortkeyval</code>.</p> </li> <li> <p> <code>sortKeyName</code> <code>&gt;= </code> <code>:sortkeyval</code> - true if the sort key value is greater than or equal to <code>:sortkeyval</code>.</p> </li> <li> <p> <code>sortKeyName</code> <code>BETWEEN</code> <code>:sortkeyval1</code> <code>AND</code> <code>:sortkeyval2</code> - true if the sort key value is greater than or equal to <code>:sortkeyval1</code>, and less than or equal to <code>:sortkeyval2</code>.</p> </li> <li> <p> <code>begins_with (</code> <code>sortKeyName</code>, <code>:sortkeyval</code> <code>)</code> - true if the sort key value begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note that the function name <code>begins_with</code> is case-sensitive.</p> </li> </ul> <p>Use the <code>ExpressionAttributeValues</code> parameter to replace tokens such as <code>:partitionval</code> and <code>:sortval</code> with actual values at runtime.</p> <p>You can optionally use the <code>ExpressionAttributeNames</code> parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following <code>KeyConditionExpression</code> parameter causes an error because <i>Size</i> is a reserved word:</p> <ul> <li> <p> <code>Size = :myval</code> </p> </li> </ul> <p>To work around this, define a placeholder (such a <code>#S</code>) to represent the attribute name <i>Size</i>. <code>KeyConditionExpression</code> then is as follows:</p> <ul> <li> <p> <code>#S = :myval</code> </p> </li> </ul> <p>For a list of reserved words, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html\">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> <p>For more information on <code>ExpressionAttributeNames</code> and <code>ExpressionAttributeValues</code>, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ExpressionPlaceholders.html\">Using Placeholders for Attribute Names and Values</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>"
"documentation":"<p>The condition that specifies the key value(s) for items to be retrieved by the <code>Query</code> action.</p> <p>The condition must perform an equality test on a single partition key value.</p> <p>The condition can optionally perform one of several comparison tests on a single sort key value. This allows <code>Query</code> to retrieve one item with a given partition key value and sort key value, or several items that have the same partition key value but different sort key values.</p> <p>The partition key equality test is required, and must be specified in the following format:</p> <p> <code>partitionKeyName</code> <i>=</i> <code>:partitionkeyval</code> </p> <p>If you also want to provide a condition for the sort key, it must be combined using <code>AND</code> with the condition for the sort key. Following is an example, using the <b>=</b> comparison operator for the sort key:</p> <p> <code>partitionKeyName</code> <code>=</code> <code>:partitionkeyval</code> <code>AND</code> <code>sortKeyName</code> <code>=</code> <code>:sortkeyval</code> </p> <p>Valid comparisons for the sort key condition are as follows:</p> <ul> <li> <p> <code>sortKeyName</code> <code>=</code> <code>:sortkeyval</code> - true if the sort key value is equal to <code>:sortkeyval</code>.</p> </li> <li> <p> <code>sortKeyName</code> <code>&lt;</code> <code>:sortkeyval</code> - true if the sort key value is less than <code>:sortkeyval</code>.</p> </li> <li> <p> <code>sortKeyName</code> <code>&lt;=</code> <code>:sortkeyval</code> - true if the sort key value is less than or equal to <code>:sortkeyval</code>.</p> </li> <li> <p> <code>sortKeyName</code> <code>&gt;</code> <code>:sortkeyval</code> - true if the sort key value is greater than <code>:sortkeyval</code>.</p> </li> <li> <p> <code>sortKeyName</code> <code>&gt;= </code> <code>:sortkeyval</code> - true if the sort key value is greater than or equal to <code>:sortkeyval</code>.</p> </li> <li> <p> <code>sortKeyName</code> <code>BETWEEN</code> <code>:sortkeyval1</code> <code>AND</code> <code>:sortkeyval2</code> - true if the sort key value is greater than or equal to <code>:sortkeyval1</code>, and less than or equal to <code>:sortkeyval2</code>.</p> </li> <li> <p> <code>begins_with (</code> <code>sortKeyName</code>, <code>:sortkeyval</code> <code>)</code> - true if the sort key value begins with a particular operand. (You cannot use this function with a sort key that is of type Number.) Note that the function name <code>begins_with</code> is case-sensitive.</p> </li> </ul> <p>Use the <code>ExpressionAttributeValues</code> parameter to replace tokens such as <code>:partitionval</code> and <code>:sortval</code> with actual values at runtime.</p> <p>You can optionally use the <code>ExpressionAttributeNames</code> parameter to replace the names of the partition key and sort key with placeholder tokens. This option might be necessary if an attribute name conflicts with a DynamoDB reserved word. For example, the following <code>KeyConditionExpression</code> parameter causes an error because <i>Size</i> is a reserved word:</p> <ul> <li> <p> <code>Size = :myval</code> </p> </li> </ul> <p>To work around this, define a placeholder (such a <code>#S</code>) to represent the attribute name <i>Size</i>. <code>KeyConditionExpression</code> then is as follows:</p> <ul> <li> <p> <code>#S = :myval</code> </p> </li> </ul> <p>For a list of reserved words, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ReservedWords.html\">Reserved Words</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> <p>For more information on <code>ExpressionAttributeNames</code> and <code>ExpressionAttributeValues</code>, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/ExpressionPlaceholders.html\">Using Placeholders for Attribute Names and Values</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>"
},
"ExpressionAttributeNames":{
"shape":"ExpressionAttributeNameMap",
@ -2456,6 +2461,37 @@
"UPDATED_NEW"
]
},
"SSEDescription":{
"type":"structure",
"members":{
"Status":{
"shape":"SSEStatus",
"documentation":"<p>The current state of server-side encryption:</p> <ul> <li> <p> <code>ENABLING</code> - Server-side encryption is being enabled.</p> </li> <li> <p> <code>ENABLED</code> - Server-side encryption is enabled.</p> </li> <li> <p> <code>DISABLING</code> - Server-side encryption is being disabled.</p> </li> <li> <p> <code>DISABLED</code> - Server-side encryption is disabled.</p> </li> </ul>"
}
},
"documentation":"<p>The description of the server-side encryption status on the specified table.</p>"
},
"SSEEnabled":{"type":"boolean"},
"SSESpecification":{
"type":"structure",
"required":["Enabled"],
"members":{
"Enabled":{
"shape":"SSEEnabled",
"documentation":"<p>Indicates whether server-side encryption is enabled (true) or disabled (false) on the table.</p>"
}
},
"documentation":"<p>Represents the settings used to enable server-side encryption.</p>"
},
"SSEStatus":{
"type":"string",
"enum":[
"ENABLING",
"ENABLED",
"DISABLING",
"DISABLED"
]
},
"ScalarAttributeType":{
"type":"string",
"enum":[
@ -2645,6 +2681,10 @@
"TimeToLiveDescription":{
"shape":"TimeToLiveDescription",
"documentation":"<p>Time to Live settings on the table when the backup was created.</p>"
},
"SSEDescription":{
"shape":"SSEDescription",
"documentation":"<p>The description of the server-side encryption status on the table when the backup was created.</p>"
}
},
"documentation":"<p>Contains the details of the features enabled on the table when the backup was created. For example, LSIs, GSIs, streams, TTL. </p>"
@ -2760,6 +2800,10 @@
"RestoreSummary":{
"shape":"RestoreSummary",
"documentation":"<p>Contains details for the restore.</p>"
},
"SSEDescription":{
"shape":"SSEDescription",
"documentation":"<p>The description of the server-side encryption status on the specified table.</p>"
}
},
"documentation":"<p>Represents the properties of a table.</p>"

0
botocore/data/ec2/2016-09-15/examples-1.json Executable file → Normal file
View file

0
botocore/data/ec2/2016-09-15/paginators-1.json Executable file → Normal file
View file

0
botocore/data/ec2/2016-09-15/service-2.json Executable file → Normal file
View file

0
botocore/data/ec2/2016-09-15/waiters-2.json Executable file → Normal file
View file

0
botocore/data/ec2/2016-11-15/examples-1.json Executable file → Normal file
View file

153
botocore/data/ec2/2016-11-15/service-2.json
View file

@ -1000,6 +1000,16 @@
"output":{"shape":"DescribeAddressesResult"},
"documentation":"<p>Describes one or more of your Elastic IP addresses.</p> <p>An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html\">Elastic IP Addresses</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
},
"DescribeAggregateIdFormat":{
"name":"DescribeAggregateIdFormat",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeAggregateIdFormatRequest"},
"output":{"shape":"DescribeAggregateIdFormatResult"},
"documentation":"<p>Describes the longer ID format settings for all resource types in a specific region. This request is useful for performing a quick audit to determine whether a specific region is fully opted in for longer IDs (17-character IDs).</p> <p>This request only returns information about resource types that support longer IDs.</p> <p>The following resource types support longer IDs: <code>bundle</code> | <code>conversion-task</code> | <code>dhcp-options</code> | <code>elastic-ip-allocation</code> | <code>elastic-ip-association</code> | <code>export-task</code> | <code>flow-log</code> | <code>image</code> | <code>import-task</code> | <code>instance</code> | <code>internet-gateway</code> | <code>network-acl</code> | <code>network-acl-association</code> | <code>network-interface</code> | <code>network-interface-attachment</code> | <code>prefix-list</code> | <code>reservation</code> | <code>route-table</code> | <code>route-table-association</code> | <code>security-group</code> | <code>snapshot</code> | <code>subnet</code> | <code>subnet-cidr-block-association</code> | <code>volume</code> | <code>vpc</code> | <code>vpc-cidr-block-association</code> | <code>vpc-peering-connection</code>.</p>"
},
"DescribeAvailabilityZones":{
"name":"DescribeAvailabilityZones",
"http":{
@ -1168,7 +1178,7 @@
},
"input":{"shape":"DescribeIdFormatRequest"},
"output":{"shape":"DescribeIdFormatResult"},
"documentation":"<p>Describes the ID format settings for your resources on a per-region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.</p> <p>The following resource types support longer IDs: <code>instance</code> | <code>reservation</code> | <code>snapshot</code> | <code>volume</code>. </p> <p>These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the <a>ModifyIdFormat</a> command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant <code>Describe</code> command for the resource type.</p>"
"documentation":"<p>Describes the ID format settings for your resources on a per-region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.</p> <p>The following resource types support longer IDs: <code>bundle</code> | <code>conversion-task</code> | <code>dhcp-options</code> | <code>elastic-ip-allocation</code> | <code>elastic-ip-association</code> | <code>export-task</code> | <code>flow-log</code> | <code>image</code> | <code>import-task</code> | <code>instance</code> | <code>internet-gateway</code> | <code>network-acl</code> | <code>network-acl-association</code> | <code>network-interface</code> | <code>network-interface-attachment</code> | <code>prefix-list</code> | <code>reservation</code> | <code>route-table</code> | <code>route-table-association</code> | <code>security-group</code> | <code>snapshot</code> | <code>subnet</code> | <code>subnet-cidr-block-association</code> | <code>volume</code> | <code>vpc</code> | <code>vpc-cidr-block-association</code> | <code>vpc-peering-connection</code>. </p> <p>These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the <a>ModifyIdFormat</a> command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant <code>Describe</code> command for the resource type.</p>"
},
"DescribeIdentityIdFormat":{
"name":"DescribeIdentityIdFormat",
@ -1178,7 +1188,7 @@
},
"input":{"shape":"DescribeIdentityIdFormatRequest"},
"output":{"shape":"DescribeIdentityIdFormatResult"},
"documentation":"<p>Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html\">Resource IDs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </p> <p>The following resource types support longer IDs: <code>instance</code> | <code>reservation</code> | <code>snapshot</code> | <code>volume</code>. </p> <p>These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.</p>"
"documentation":"<p>Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html\">Resource IDs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </p> <p>The following resource types support longer IDs: <code>bundle</code> | <code>conversion-task</code> | <code>dhcp-options</code> | <code>elastic-ip-allocation</code> | <code>elastic-ip-association</code> | <code>export-task</code> | <code>flow-log</code> | <code>image</code> | <code>import-task</code> | <code>instance</code> | <code>internet-gateway</code> | <code>network-acl</code> | <code>network-acl-association</code> | <code>network-interface</code> | <code>network-interface-attachment</code> | <code>prefix-list</code> | <code>reservation</code> | <code>route-table</code> | <code>route-table-association</code> | <code>security-group</code> | <code>snapshot</code> | <code>subnet</code> | <code>subnet-cidr-block-association</code> | <code>volume</code> | <code>vpc</code> | <code>vpc-cidr-block-association</code> | <code>vpc-peering-connection</code>. </p> <p>These settings apply to the principal specified in the request. They do not apply to the principal that makes the request.</p>"
},
"DescribeImageAttribute":{
"name":"DescribeImageAttribute",
@ -1380,6 +1390,16 @@
"output":{"shape":"DescribePrefixListsResult"},
"documentation":"<p>Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a gateway VPC endpoint.</p>"
},
"DescribePrincipalIdFormat":{
"name":"DescribePrincipalIdFormat",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribePrincipalIdFormatRequest"},
"output":{"shape":"DescribePrincipalIdFormatResult"},
"documentation":"<p>Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference. </p> <p>By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings.</p> <p>The following resource types support longer IDs: <code>bundle</code> | <code>conversion-task</code> | <code>dhcp-options</code> | <code>elastic-ip-allocation</code> | <code>elastic-ip-association</code> | <code>export-task</code> | <code>flow-log</code> | <code>image</code> | <code>import-task</code> | <code>instance</code> | <code>internet-gateway</code> | <code>network-acl</code> | <code>network-acl-association</code> | <code>network-interface</code> | <code>network-interface-attachment</code> | <code>prefix-list</code> | <code>reservation</code> | <code>route-table</code> | <code>route-table-association</code> | <code>security-group</code> | <code>snapshot</code> | <code>subnet</code> | <code>subnet-cidr-block-association</code> | <code>volume</code> | <code>vpc</code> | <code>vpc-cidr-block-association</code> | <code>vpc-peering-connection</code>. </p>"
},
"DescribeRegions":{
"name":"DescribeRegions",
"http":{
@ -2059,7 +2079,7 @@
"requestUri":"/"
},
"input":{"shape":"ModifyIdFormatRequest"},
"documentation":"<p>Modifies the ID format for the specified resource on a per-region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created. The following resource types support longer IDs: <code>instance</code> | <code>reservation</code> | <code>snapshot</code> | <code>volume</code>.</p> <p>This setting applies to the IAM user who makes the request; it does not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html\">Resource IDs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </p> <p>Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant <code>Describe</code> command for the resource type.</p>"
"documentation":"<p>Modifies the ID format for the specified resource on a per-region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created.</p> <p>This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: <code>bundle</code> | <code>conversion-task</code> | <code>dhcp-options</code> | <code>elastic-ip-allocation</code> | <code>elastic-ip-association</code> | <code>export-task</code> | <code>flow-log</code> | <code>image</code> | <code>import-task</code> | <code>internet-gateway</code> | <code>network-acl</code> | <code>network-acl-association</code> | <code>network-interface</code> | <code>network-interface-attachment</code> | <code>prefix-list</code> | <code>route-table</code> | <code>route-table-association</code> | <code>security-group</code> | <code>subnet</code> | <code>subnet-cidr-block-association</code> | <code>vpc</code> | <code>vpc-cidr-block-association</code> | <code>vpc-peering-connection</code>.</p> <p>This setting applies to the IAM user who makes the request; it does not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html\">Resource IDs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </p> <p>Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant <code>Describe</code> command for the resource type.</p>"
},
"ModifyIdentityIdFormat":{
"name":"ModifyIdentityIdFormat",
@ -2068,7 +2088,7 @@
"requestUri":"/"
},
"input":{"shape":"ModifyIdentityIdFormatRequest"},
"documentation":"<p>Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created. </p> <p>The following resource types support longer IDs: <code>instance</code> | <code>reservation</code> | <code>snapshot</code> | <code>volume</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html\">Resource IDs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </p> <p>This setting applies to the principal specified in the request; it does not apply to the principal that makes the request. </p> <p>Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant <code>Describe</code> command for the resource type.</p>"
"documentation":"<p>Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created. </p> <p>This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: <code>bundle</code> | <code>conversion-task</code> | <code>dhcp-options</code> | <code>elastic-ip-allocation</code> | <code>elastic-ip-association</code> | <code>export-task</code> | <code>flow-log</code> | <code>image</code> | <code>import-task</code> | <code>internet-gateway</code> | <code>network-acl</code> | <code>network-acl-association</code> | <code>network-interface</code> | <code>network-interface-attachment</code> | <code>prefix-list</code> | <code>route-table</code> | <code>route-table-association</code> | <code>security-group</code> | <code>subnet</code> | <code>subnet-cidr-block-association</code> | <code>vpc</code> | <code>vpc-cidr-block-association</code> | <code>vpc-peering-connection</code>.. </p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html\">Resource IDs</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>. </p> <p>This setting applies to the principal specified in the request; it does not apply to the principal that makes the request. </p> <p>Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant <code>Describe</code> command for the resource type.</p>"
},
"ModifyImageAttribute":{
"name":"ModifyImageAttribute",
@ -5504,7 +5524,7 @@
},
"GroupName":{
"shape":"String",
"documentation":"<p>The name of the security group.</p> <p>Constraints: Up to 255 characters in length</p> <p>Constraints for EC2-Classic: ASCII characters</p> <p>Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&amp;;{}!$*</p>"
"documentation":"<p>The name of the security group.</p> <p>Constraints: Up to 255 characters in length. Cannot start with <code>sg-</code>.</p> <p>Constraints for EC2-Classic: ASCII characters</p> <p>Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&amp;;{}!$*</p>"
},
"VpcId":{
"shape":"String",
@ -6937,6 +6957,30 @@
},
"documentation":"<p>Contains the output of DescribeAddresses.</p>"
},
"DescribeAggregateIdFormatRequest":{
"type":"structure",
"members":{
"DryRun":{
"shape":"Boolean",
"documentation":"<p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"
}
}
},
"DescribeAggregateIdFormatResult":{
"type":"structure",
"members":{
"UseLongIdsAggregated":{
"shape":"Boolean",
"documentation":"<p>Indicates whether all resrouces types in the region are configured to use longer IDs. This value will only be <code>true</code> if all users are configured to use longer IDs for all resources types in the region.</p>",
"locationName":"useLongIdsAggregated"
},
"Statuses":{
"shape":"IdFormatList",
"documentation":"<p>Information about each resource's ID format.</p>",
"locationName":"statusSet"
}
}
},
"DescribeAvailabilityZonesRequest":{
"type":"structure",
"members":{
@ -7534,7 +7578,7 @@
"members":{
"Resource":{
"shape":"String",
"documentation":"<p>The type of resource: <code>instance</code> | <code>reservation</code> | <code>snapshot</code> | <code>volume</code> </p>"
"documentation":"<p>The type of resource: <code>bundle</code> | <code>conversion-task</code> | <code>dhcp-options</code> | <code>elastic-ip-allocation</code> | <code>elastic-ip-association</code> | <code>export-task</code> | <code>flow-log</code> | <code>image</code> | <code>import-task</code> | <code>instance</code> | <code>internet-gateway</code> | <code>network-acl</code> | <code>network-acl-association</code> | <code>network-interface</code> | <code>network-interface-attachment</code> | <code>prefix-list</code> | <code>reservation</code> | <code>route-table</code> | <code>route-table-association</code> | <code>security-group</code> | <code>snapshot</code> | <code>subnet</code> | <code>subnet-cidr-block-association</code> | <code>volume</code> | <code>vpc</code> | <code>vpc-cidr-block-association</code> | <code>vpc-peering-connection</code> </p>"
}
},
"documentation":"<p>Contains the parameters for DescribeIdFormat.</p>"
@ -7561,7 +7605,7 @@
},
"Resource":{
"shape":"String",
"documentation":"<p>The type of resource: <code>instance</code> | <code>reservation</code> | <code>snapshot</code> | <code>volume</code> </p>",
"documentation":"<p>The type of resource: <code>bundle</code> | <code>conversion-task</code> | <code>dhcp-options</code> | <code>elastic-ip-allocation</code> | <code>elastic-ip-association</code> | <code>export-task</code> | <code>flow-log</code> | <code>image</code> | <code>import-task</code> | <code>instance</code> | <code>internet-gateway</code> | <code>network-acl</code> | <code>network-acl-association</code> | <code>network-interface</code> | <code>network-interface-attachment</code> | <code>prefix-list</code> | <code>reservation</code> | <code>route-table</code> | <code>route-table-association</code> | <code>security-group</code> | <code>snapshot</code> | <code>subnet</code> | <code>subnet-cidr-block-association</code> | <code>volume</code> | <code>vpc</code> | <code>vpc-cidr-block-association</code> | <code>vpc-peering-connection</code> </p>",
"locationName":"resource"
}
},
@ -8381,6 +8425,43 @@
},
"documentation":"<p>Contains the output of DescribePrefixLists.</p>"
},
"DescribePrincipalIdFormatRequest":{
"type":"structure",
"members":{
"DryRun":{
"shape":"Boolean",
"documentation":"<p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"
},
"Resources":{
"shape":"ResourceList",
"documentation":"<p>The type of resource: <code>bundle</code> | <code>conversion-task</code> | <code>dhcp-options</code> | <code>elastic-ip-allocation</code> | <code>elastic-ip-association</code> | <code>export-task</code> | <code>flow-log</code> | <code>image</code> | <code>import-task</code> | <code>instance</code> | <code>internet-gateway</code> | <code>network-acl</code> | <code>network-acl-association</code> | <code>network-interface</code> | <code>network-interface-attachment</code> | <code>prefix-list</code> | <code>reservation</code> | <code>route-table</code> | <code>route-table-association</code> | <code>security-group</code> | <code>snapshot</code> | <code>subnet</code> | <code>subnet-cidr-block-association</code> | <code>volume</code> | <code>vpc</code> | <code>vpc-cidr-block-association</code> | <code>vpc-peering-connection</code> </p>",
"locationName":"Resource"
},
"MaxResults":{
"shape":"Integer",
"documentation":"<p>The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. </p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token to request the next page of results.</p>"
}
}
},
"DescribePrincipalIdFormatResult":{
"type":"structure",
"members":{
"Principals":{
"shape":"PrincipalIdFormatList",
"documentation":"<p>Information about the ID format settings for the ARN.</p>",
"locationName":"principalSet"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token to use to retrieve the next page of results. This value is null when there are no more results to return.</p>",
"locationName":"nextToken"
}
}
},
"DescribeRegionsRequest":{
"type":"structure",
"members":{
@ -8804,7 +8885,7 @@
},
"MaxResults":{
"shape":"Integer",
"documentation":"<p>The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned <code>NextToken</code> value. This value can be between 5 and 1000.</p>"
"documentation":"<p>The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned <code>NextToken</code> value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.</p>"
}
},
"documentation":"<p>Contains the parameters for DescribeSecurityGroups.</p>"
@ -9206,7 +9287,7 @@
"members":{
"NextToken":{
"shape":"String",
"documentation":"<p>The token required to retrieve the next set of results. This value is <code>null</code> when there are no more results to return.</p>",
"documentation":"<p>The token required to retrieve the next set of results. This value is an empty string when there are no more results to return.</p>",
"locationName":"nextToken"
},
"SpotPriceHistory":{
@ -12217,7 +12298,7 @@
},
"Format":{
"shape":"String",
"documentation":"<p>The format of the disk image being imported.</p> <p>Valid values: <code>RAW</code> | <code>VHD</code> | <code>VMDK</code> | <code>OVA</code> </p>"
"documentation":"<p>The format of the disk image being imported.</p> <p>Valid values: <code>VHD</code> | <code>VMDK</code> | <code>OVA</code> </p>"
},
"SnapshotId":{
"shape":"String",
@ -12506,7 +12587,7 @@
},
"UserData":{
"shape":"UserData",
"documentation":"<p>The user data to make available to the instance. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.</p>",
"documentation":"<p>The Base64-encoded user data to make available to the instance.</p>",
"locationName":"userData"
}
},
@ -14240,7 +14321,7 @@
"members":{
"UserData":{
"shape":"String",
"documentation":"<p>The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.</p>",
"documentation":"<p>The Base64-encoded user data for the instance.</p>",
"locationName":"userData"
},
"SecurityGroups":{
@ -15253,7 +15334,7 @@
"members":{
"Resource":{
"shape":"String",
"documentation":"<p>The type of resource: <code>instance</code> | <code>reservation</code> | <code>snapshot</code> | <code>volume</code> </p>"
"documentation":"<p>The type of resource: <code>bundle</code> | <code>conversion-task</code> | <code>dhcp-options</code> | <code>elastic-ip-allocation</code> | <code>elastic-ip-association</code> | <code>export-task</code> | <code>flow-log</code> | <code>image</code> | <code>import-task</code> | <code>internet-gateway</code> | <code>network-acl</code> | <code>network-acl-association</code> | <code>network-interface</code> | <code>network-interface-attachment</code> | <code>prefix-list</code> | <code>route-table</code> | <code>route-table-association</code> | <code>security-group</code> | <code>subnet</code> | <code>subnet-cidr-block-association</code> | <code>vpc</code> | <code>vpc-cidr-block-association</code> | <code>vpc-peering-connection</code>.</p> <p>Alternatively, use the <code>all-current</code> option to include all resource types that are currently within their opt-in period for longer IDs.</p>"
},
"UseLongIds":{
"shape":"Boolean",
@ -15277,7 +15358,7 @@
},
"Resource":{
"shape":"String",
"documentation":"<p>The type of resource: <code>instance</code> | <code>reservation</code> | <code>snapshot</code> | <code>volume</code> </p>",
"documentation":"<p>The type of resource: <code>bundle</code> | <code>conversion-task</code> | <code>dhcp-options</code> | <code>elastic-ip-allocation</code> | <code>elastic-ip-association</code> | <code>export-task</code> | <code>flow-log</code> | <code>image</code> | <code>import-task</code> | <code>internet-gateway</code> | <code>network-acl</code> | <code>network-acl-association</code> | <code>network-interface</code> | <code>network-interface-attachment</code> | <code>prefix-list</code> | <code>route-table</code> | <code>route-table-association</code> | <code>security-group</code> | <code>subnet</code> | <code>subnet-cidr-block-association</code> | <code>vpc</code> | <code>vpc-cidr-block-association</code> | <code>vpc-peering-connection</code>.</p> <p>Alternatively, use the <code>all-current</code> option to include all resource types that are currently within their opt-in period for longer IDs.</p>",
"locationName":"resource"
},
"UseLongIds":{
@ -15888,12 +15969,12 @@
"AddNetworkLoadBalancerArns":{
"shape":"ValueStringList",
"documentation":"<p>The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.</p>",
"locationName":"addNetworkLoadBalancerArn"
"locationName":"AddNetworkLoadBalancerArn"
},
"RemoveNetworkLoadBalancerArns":{
"shape":"ValueStringList",
"documentation":"<p>The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.</p>",
"locationName":"removeNetworkLoadBalancerArn"
"locationName":"RemoveNetworkLoadBalancerArn"
}
}
},
@ -17101,6 +17182,29 @@
"locationName":"item"
}
},
"PrincipalIdFormat":{
"type":"structure",
"members":{
"Arn":{
"shape":"String",
"documentation":"<p>PrincipalIdFormatARN description</p>",
"locationName":"arn"
},
"Statuses":{
"shape":"IdFormatList",
"documentation":"<p>PrincipalIdFormatStatuses description</p>",
"locationName":"statusSet"
}
},
"documentation":"<p>PrincipalIdFormat description</p>"
},
"PrincipalIdFormatList":{
"type":"list",
"member":{
"shape":"PrincipalIdFormat",
"locationName":"item"
}
},
"PrincipalType":{
"type":"string",
"enum":[
@ -18101,7 +18205,7 @@
},
"UserData":{
"shape":"String",
"documentation":"<p>The user data to make available to the instance. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html\">Running Commands on Your Linux Instance at Launch</a> (Linux) and <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html#instancedata-add-user-data\">Adding User Data</a> (Windows). If you are using a command line tool, base64-encoding is performed for you and you can load the text from a file. Otherwise, you must provide base64-encoded text.</p>"
"documentation":"<p>The Base64-encoded user data to make available to the instance. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html\">Running Commands on Your Linux Instance at Launch</a> (Linux) and <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html#instancedata-add-user-data\">Adding User Data</a> (Windows).</p>"
},
"TagSpecifications":{
"shape":"LaunchTemplateTagSpecificationRequestList",
@ -18318,7 +18422,7 @@
},
"UserData":{
"shape":"String",
"documentation":"<p>The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.</p>",
"documentation":"<p>The Base64-encoded user data for the instance.</p>",
"locationName":"userData"
}
},
@ -18989,6 +19093,13 @@
"type":"list",
"member":{"shape":"String"}
},
"ResourceList":{
"type":"list",
"member":{
"shape":"String",
"locationName":"item"
}
},
"ResourceType":{
"type":"string",
"enum":[
@ -20633,7 +20744,7 @@
},
"Format":{
"shape":"String",
"documentation":"<p>The format of the disk image being imported.</p> <p>Valid values: <code>RAW</code> | <code>VHD</code> | <code>VMDK</code> | <code>OVA</code> </p>"
"documentation":"<p>The format of the disk image being imported.</p> <p>Valid values: <code>VHD</code> | <code>VMDK</code> | <code>OVA</code> </p>"
},
"Url":{
"shape":"String",
@ -20830,7 +20941,7 @@
},
"UserData":{
"shape":"String",
"documentation":"<p>The user data to make available to the instances. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.</p>",
"documentation":"<p>The Base64-encoded user data to make available to the instances.</p>",
"locationName":"userData"
},
"WeightedCapacity":{
@ -23305,7 +23416,7 @@
"members":{
"StaticRoutesOnly":{
"shape":"Boolean",
"documentation":"<p>Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify <code>true</code>.</p> <p>Default: <code>false</code> </p>",
"documentation":"<p>Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify <code>true</code>. Use <a>CreateVpnConnectionRoute</a> to create a static route.</p> <p>Default: <code>false</code> </p>",
"locationName":"staticRoutesOnly"
},
"TunnelOptions":{

29
botocore/data/ec2/2016-11-15/waiters-2.json Executable file → Normal file
View file

@ -390,6 +390,12 @@
"argument": "SpotInstanceRequests[].Status.Code",
"expected": "fulfilled"
},
{
"state": "success",
"matcher": "pathAll",
"argument": "SpotInstanceRequests[].Status.Code",
"expected": "request-canceled-and-instance-running"
},
{
"state": "failure",
"matcher": "pathAny",
@ -413,6 +419,11 @@
"matcher": "pathAny",
"argument": "SpotInstanceRequests[].Status.Code",
"expected": "system-error"
},
{
"state": "retry",
"matcher": "error",
"expected": "InvalidSpotInstanceRequestID.NotFound"
}
]
},
@ -588,6 +599,24 @@
"state": "retry"
}
]
},
"VpcPeeringConnectionDeleted": {
"delay": 15,
"operation": "DescribeVpcPeeringConnections",
"maxAttempts": 40,
"acceptors": [
{
"expected": "deleted",
"matcher": "pathAll",
"state": "success",
"argument": "VpcPeeringConnections[].Status.Code"
},
{
"matcher": "error",
"expected": "InvalidVpcPeeringConnectionID.NotFound",
"state": "success"
}
]
}
}
}

0
botocore/data/ecr/2015-09-21/examples-1.json Executable file → Normal file
View file

2
botocore/data/ecs/2014-11-13/waiters-2.json
View file

@ -66,7 +66,7 @@
"expected": true,
"matcher": "path",
"state": "success",
"argument": "services | [@[?length(deployments)!=`1`], @[?desiredCount!=runningCount]][] | length(@) == `0`"
"argument": "length(services[?!(length(deployments) == `1` && runningCount == desiredCount)]) == `0`"
}
]
},

268
botocore/data/elasticache/2015-02-02/waiters-2.json
View file

@ -1,139 +1,143 @@
{
"version": 2,
"waiters": {
"CacheClusterAvailable": {
"delay": 30,
"operation": "DescribeCacheClusters",
"maxAttempts": 60,
"acceptors": [
{
"expected": "available",
"matcher": "pathAll",
"state": "success",
"argument": "CacheClusters[].CacheClusterStatus"
"version":2,
"waiters":{
"CacheClusterAvailable":{
"acceptors":[
{
"argument":"CacheClusters[].CacheClusterStatus",
"expected":"available",
"matcher":"pathAll",
"state":"success"
},
{
"argument":"CacheClusters[].CacheClusterStatus",
"expected":"deleted",
"matcher":"pathAny",
"state":"failure"
},
{
"argument":"CacheClusters[].CacheClusterStatus",
"expected":"deleting",
"matcher":"pathAny",
"state":"failure"
},
{
"argument":"CacheClusters[].CacheClusterStatus",
"expected":"incompatible-network",
"matcher":"pathAny",
"state":"failure"
},
{
"argument":"CacheClusters[].CacheClusterStatus",
"expected":"restore-failed",
"matcher":"pathAny",
"state":"failure"
}
],
"delay":15,
"description":"Wait until ElastiCache cluster is available.",
"maxAttempts":40,
"operation":"DescribeCacheClusters"
},
{
"expected": "deleted",
"matcher": "pathAny",
"state": "failure",
"argument": "CacheClusters[].CacheClusterStatus"
"CacheClusterDeleted":{
"acceptors":[
{
"argument":"CacheClusters[].CacheClusterStatus",
"expected":"deleted",
"matcher":"pathAll",
"state":"success"
},
{
"expected":"CacheClusterNotFound",
"matcher":"error",
"state":"success"
},
{
"argument":"CacheClusters[].CacheClusterStatus",
"expected":"available",
"matcher":"pathAny",
"state":"failure"
},
{
"argument":"CacheClusters[].CacheClusterStatus",
"expected":"creating",
"matcher":"pathAny",
"state":"failure"
},
{
"argument":"CacheClusters[].CacheClusterStatus",
"expected":"incompatible-network",
"matcher":"pathAny",
"state":"failure"
},
{
"argument":"CacheClusters[].CacheClusterStatus",
"expected":"modifying",
"matcher":"pathAny",
"state":"failure"
},
{
"argument":"CacheClusters[].CacheClusterStatus",
"expected":"restore-failed",
"matcher":"pathAny",
"state":"failure"
},
{
"argument":"CacheClusters[].CacheClusterStatus",
"expected":"snapshotting",
"matcher":"pathAny",
"state":"failure"
}
],
"delay":15,
"description":"Wait until ElastiCache cluster is deleted.",
"maxAttempts":40,
"operation":"DescribeCacheClusters"
},
{
"expected": "deleting",
"matcher": "pathAny",
"state": "failure",
"argument": "CacheClusters[].CacheClusterStatus"
"ReplicationGroupAvailable":{
"acceptors":[
{
"argument":"ReplicationGroups[].Status",
"expected":"available",
"matcher":"pathAll",
"state":"success"
},
{
"argument":"ReplicationGroups[].Status",
"expected":"deleted",
"matcher":"pathAny",
"state":"failure"
}
],
"delay":15,
"description":"Wait until ElastiCache replication group is available.",
"maxAttempts":40,
"operation":"DescribeReplicationGroups"
},
{
"expected": "incompatible-network",
"matcher": "pathAny",
"state": "failure",
"argument": "CacheClusters[].CacheClusterStatus"
},
{
"expected": "restore-failed",
"matcher": "pathAny",
"state": "failure",
"argument": "CacheClusters[].CacheClusterStatus"
"ReplicationGroupDeleted":{
"acceptors":[
{
"argument":"ReplicationGroups[].Status",
"expected":"deleted",
"matcher":"pathAll",
"state":"success"
},
{
"argument":"ReplicationGroups[].Status",
"expected":"available",
"matcher":"pathAny",
"state":"failure"
},
{
"expected":"ReplicationGroupNotFoundFault",
"matcher":"error",
"state":"success"
}
],
"delay":15,
"description":"Wait until ElastiCache replication group is deleted.",
"maxAttempts":40,
"operation":"DescribeReplicationGroups"
}
]
},
"CacheClusterDeleted": {
"delay": 30,
"operation": "DescribeCacheClusters",
"maxAttempts": 60,
"acceptors": [
{
"expected": "CacheClusterNotFound",
"matcher": "error",
"state": "success"
},
{
"expected": "creating",
"matcher": "pathAny",
"state": "failure",
"argument": "CacheClusters[].CacheClusterStatus"
},
{
"expected": "modifying",
"matcher": "pathAny",
"state": "failure",
"argument": "CacheClusters[].CacheClusterStatus"
},
{
"expected": "rebooting",
"matcher": "pathAny",
"state": "failure",
"argument": "CacheClusters[].CacheClusterStatus"
}
]
},
"ReplicationGroupAvailable": {
"delay": 30,
"operation": "DescribeReplicationGroups",
"maxAttempts": 60,
"acceptors": [
{
"expected": "available",
"matcher": "pathAll",
"state": "success",
"argument": "ReplicationGroups[].Status"
},
{
"expected": "deleted",
"matcher": "pathAny",
"state": "failure",
"argument": "ReplicationGroups[].Status"
},
{
"expected": "deleting",
"matcher": "pathAny",
"state": "failure",
"argument": "ReplicationGroups[].Status"
},
{
"expected": "incompatible-network",
"matcher": "pathAny",
"state": "failure",
"argument": "ReplicationGroups[].Status"
},
{
"expected": "restore-failed",
"matcher": "pathAny",
"state": "failure",
"argument": "ReplicationGroups[].Status"
}
]
},
"ReplicationGroupDeleted": {
"delay": 30,
"operation": "DescribeReplicationGroups",
"maxAttempts": 60,
"acceptors": [
{
"expected": "ReplicationGroupNotFoundFault",
"matcher": "error",
"state": "success"
},
{
"expected": "creating",
"matcher": "pathAny",
"state": "failure",
"argument": "ReplicationGroups[].Status"
},
{
"expected": "modifying",
"matcher": "pathAny",
"state": "failure",
"argument": "ReplicationGroups[].Status"
},
{
"expected": "rebooting",
"matcher": "pathAny",
"state": "failure",
"argument": "ReplicationGroups[].Status"
}
]
}
}
}

0
botocore/data/elasticbeanstalk/2010-12-01/examples-1.json Executable file → Normal file
View file

23
botocore/data/elb/2012-06-01/waiters-2.json
View file

@ -1,6 +1,24 @@
{
"version":2,
"waiters":{
"InstanceDeregistered": {
"delay": 15,
"operation": "DescribeInstanceHealth",
"maxAttempts": 40,
"acceptors": [
{
"expected": "OutOfService",
"matcher": "pathAll",
"state": "success",
"argument": "InstanceStates[].State"
},
{
"matcher": "error",
"expected": "InvalidInstance",
"state": "success"
}
]
},
"AnyInstanceInService":{
"acceptors":[
{
@ -21,6 +39,11 @@
"expected":"InService",
"matcher":"pathAll",
"state":"success"
},
{
"matcher": "error",
"expected": "InvalidInstance",
"state": "retry"
}
],
"delay":15,

100
botocore/data/elbv2/2015-12-01/waiters-2.json Normal file
View file

@ -0,0 +1,100 @@
{
"version": 2,
"waiters": {
"LoadBalancerExists": {
"delay": 15,
"operation": "DescribeLoadBalancers",
"maxAttempts": 40,
"acceptors": [
{
"matcher": "status",
"expected": 200,
"state": "success"
},
{
"matcher": "error",
"expected": "LoadBalancerNotFound",
"state": "retry"
}
]
},
"LoadBalancerAvailable": {
"delay": 15,
"operation": "DescribeLoadBalancers",
"maxAttempts": 40,
"acceptors": [
{
"state": "success",
"matcher": "pathAll",
"argument": "LoadBalancers[].State.Code",
"expected": "active"
},
{
"state": "retry",
"matcher": "pathAny",
"argument": "LoadBalancers[].State.Code",
"expected": "provisioning"
},
{
"state": "retry",
"matcher": "error",
"expected": "LoadBalancerNotFound"
}
]
},
"LoadBalancersDeleted": {
"delay": 15,
"operation": "DescribeLoadBalancers",
"maxAttempts": 40,
"acceptors": [
{
"state": "retry",
"matcher": "pathAll",
"argument": "LoadBalancers[].State.Code",
"expected": "active"
},
{
"matcher": "error",
"expected": "LoadBalancerNotFound",
"state": "success"
}
]
},
"TargetInService":{
"delay":15,
"maxAttempts":40,
"operation":"DescribeTargetHealth",
"acceptors":[
{
"argument":"TargetHealthDescriptions[].TargetHealth.State",
"expected":"healthy",
"matcher":"pathAll",
"state":"success"
},
{
"matcher": "error",
"expected": "InvalidInstance",
"state": "retry"
}
]
},
"TargetDeregistered": {
"delay": 15,
"maxAttempts": 40,
"operation": "DescribeTargetHealth",
"acceptors": [
{
"matcher": "error",
"expected": "InvalidTarget",
"state": "success"
},
{
"argument":"TargetHealthDescriptions[].TargetHealth.State",
"expected":"unused",
"matcher":"pathAll",
"state":"success"
}
]
}
}
}

25
botocore/data/emr/2009-03-31/waiters-2.json
View file

@ -38,6 +38,31 @@
}
]
},
"StepComplete": {
"delay": 30,
"operation": "DescribeStep",
"maxAttempts": 60,
"acceptors": [
{
"state": "success",
"matcher": "path",
"argument": "Step.Status.State",
"expected": "COMPLETED"
},
{
"state": "failure",
"matcher": "path",
"argument": "Step.Status.State",
"expected": "FAILED"
},
{
"state": "failure",
"matcher": "path",
"argument": "Step.Status.State",
"expected": "CANCELLED"
}
]
},
"ClusterTerminated": {
"delay": 30,
"operation": "DescribeCluster",

10
botocore/data/endpoints.json
View file

@ -952,6 +952,7 @@
"eu-central-1" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
"us-west-2" : { }
}
@ -1503,7 +1504,9 @@
"states" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
@ -1676,6 +1679,8 @@
"waf-regional" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"us-east-1" : { },
"us-west-1" : { },
@ -1952,6 +1957,11 @@
"cn-northwest-1" : { }
}
},
"sms" : {
"endpoints" : {
"cn-north-1" : { }
}
},
"snowball" : {
"endpoints" : {
"cn-north-1" : { }

0
botocore/data/gamelift/2015-10-01/examples-1.json Executable file → Normal file
View file

160
botocore/data/gamelift/2015-10-01/service-2.json
View file

File diff suppressed because one or more lines are too long

84
botocore/data/glue/2017-03-31/service-2.json
View file

@ -135,7 +135,7 @@
{"shape":"InvalidInputException"},
{"shape":"OperationTimeoutException"}
],
"documentation":"<p>Creates a classifier in the user's account. This may be either a <code>GrokClassifier</code> or an <code>XMLClassifier</code>. </p>"
"documentation":"<p>Creates a classifier in the user's account. This may be a <code>GrokClassifier</code>, an <code>XMLClassifier</code>, or abbrev <code>JsonClassifier</code>, depending on which field of the request is present.</p>"
},
"CreateConnection":{
"name":"CreateConnection",
@ -1087,7 +1087,7 @@
{"shape":"EntityNotFoundException"},
{"shape":"OperationTimeoutException"}
],
"documentation":"<p>Modifies an existing classifier (either a <code>GrokClassifier</code> or an <code>XMLClassifier</code>).</p>"
"documentation":"<p>Modifies an existing classifier (a <code>GrokClassifier</code>, <code>XMLClassifier</code>, or <code>JsonClassifier</code>, depending on which field is present).</p>"
},
"UpdateConnection":{
"name":"UpdateConnection",
@ -1665,9 +1665,13 @@
"XMLClassifier":{
"shape":"XMLClassifier",
"documentation":"<p>An <code>XMLClassifier</code> object.</p>"
},
"JsonClassifier":{
"shape":"JsonClassifier",
"documentation":"<p>A <code>JsonClassifier</code> object.</p>"
}
},
"documentation":"<p>Classifiers are written in Python and triggered during a crawl task. You can write your own classifiers to best categorize your data sources and specify the appropriate schemas to use for them. A classifier checks whether a given file is in a format it can handle, and if it is, the classifier creates a schema in the form of a <code>StructType</code> object that matches that data format.</p> <p>A classifier can be either a <code>grok</code> classifier or an XML classifier, specified in one or the other field of the <code>Classifier</code> object.</p>"
"documentation":"<p>Classifiers are written in Python and triggered during a crawl task. You can write your own classifiers to best categorize your data sources and specify the appropriate schemas to use for them. A classifier checks whether a given file is in a format it can handle, and if it is, the classifier creates a schema in the form of a <code>StructType</code> object that matches that data format.</p> <p>A classifier can be a <code>grok</code> classifier, an XML classifier, or a JSON classifier, asspecified in one of the fields in the <code>Classifier</code> object.</p>"
},
"ClassifierList":{
"type":"list",
@ -2157,6 +2161,10 @@
"XMLClassifier":{
"shape":"CreateXMLClassifierRequest",
"documentation":"<p>An <code>XMLClassifier</code> object specifying the classifier to create.</p>"
},
"JsonClassifier":{
"shape":"CreateJsonClassifierRequest",
"documentation":"<p>A <code>JsonClassifier</code> object specifying the classifier to create.</p>"
}
}
},
@ -2448,6 +2456,24 @@
}
}
},
"CreateJsonClassifierRequest":{
"type":"structure",
"required":[
"Name",
"JsonPath"
],
"members":{
"Name":{
"shape":"NameString",
"documentation":"<p>The name of the classifier.</p>"
},
"JsonPath":{
"shape":"JsonPath",
"documentation":"<p>A <code>JsonPath</code> string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in <a href=\"https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json\">Writing JsonPath Custom Classifiers</a>.</p>"
}
},
"documentation":"<p>Specifies a JSON classifier for <code>CreateClassifier</code> to create.</p>"
},
"CreatePartitionRequest":{
"type":"structure",
"required":[
@ -4315,6 +4341,37 @@
},
"documentation":"<p>Specifies information used to update an existing job. Note that the previous job definition will be completely overwritten by this information.</p>"
},
"JsonClassifier":{
"type":"structure",
"required":[
"Name",
"JsonPath"
],
"members":{
"Name":{
"shape":"NameString",
"documentation":"<p>The name of the classifier.</p>"
},
"CreationTime":{
"shape":"Timestamp",
"documentation":"<p>The time this classifier was registered.</p>"
},
"LastUpdated":{
"shape":"Timestamp",
"documentation":"<p>The time this classifier was last updated.</p>"
},
"Version":{
"shape":"VersionId",
"documentation":"<p>The version of this classifier.</p>"
},
"JsonPath":{
"shape":"JsonPath",
"documentation":"<p>A <code>JsonPath</code> string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in <a href=\"https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json\">Writing JsonPath Custom Classifiers</a>.</p>"
}
},
"documentation":"<p>A classifier for <code>JSON</code> content.</p>"
},
"JsonPath":{"type":"string"},
"JsonValue":{"type":"string"},
"KeyString":{
"type":"string",
@ -5430,6 +5487,10 @@
"XMLClassifier":{
"shape":"UpdateXMLClassifierRequest",
"documentation":"<p>An <code>XMLClassifier</code> object with updated fields.</p>"
},
"JsonClassifier":{
"shape":"UpdateJsonClassifierRequest",
"documentation":"<p>A <code>JsonClassifier</code> object with updated fields.</p>"
}
}
},
@ -5506,7 +5567,7 @@
},
"Configuration":{
"shape":"CrawlerConfiguration",
"documentation":"<p>Crawler configuration information. This versioned JSON string allows users to specify aspects of a Crawler's behavior.</p> <p>You can use this field to force partitions to inherit metadata such as classification, input format, output format, serde information, and schema from their parent table, rather than detect this information separately for each partition. Use the following JSON string to specify that behavior:</p> <p>Example:  <code>'{ \"Version\": 1.0, \"CrawlerOutput\": { \"Partitions\": { \"AddOrUpdateBehavior\": \"InheritFromTable\" } } }'</code> </p>"
"documentation":"<p>Crawler configuration information. This versioned JSON string allows users to specify aspects of a Crawler's behavior.</p> <p>You can use this field to force partitions to inherit metadata such as classification, input format, output format, serde information, and schema from their parent table, rather than detect this information separately for each partition. Use the following JSON string to specify that behavior:</p> <p>Example: <code>'{ \"Version\": 1.0, \"CrawlerOutput\": { \"Partitions\": { \"AddOrUpdateBehavior\": \"InheritFromTable\" } } }'</code> </p>"
}
}
},
@ -5636,6 +5697,21 @@
}
}
},
"UpdateJsonClassifierRequest":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"NameString",
"documentation":"<p>The name of the classifier.</p>"
},
"JsonPath":{
"shape":"JsonPath",
"documentation":"<p>A <code>JsonPath</code> string defining the JSON data for the classifier to classify. AWS Glue supports a subset of JsonPath, as described in <a href=\"https://docs.aws.amazon.com/glue/latest/dg/custom-classifier.html#custom-classifier-json\">Writing JsonPath Custom Classifiers</a>.</p>"
}
},
"documentation":"<p>Specifies a JSON classifier to be updated.</p>"
},
"UpdatePartitionRequest":{
"type":"structure",
"required":[

180
botocore/data/kinesis/2013-12-02/service-2.json
View file

@ -26,7 +26,7 @@
{"shape":"InvalidArgumentException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Adds or updates tags for the specified Kinesis stream. Each stream can have up to 10 tags.</p> <p>If tags have already been assigned to the stream, <code>AddTagsToStream</code> overwrites any existing tags that correspond to the specified tag keys.</p>"
"documentation":"<p>Adds or updates tags for the specified Kinesis data stream. Each stream can have up to 10 tags.</p> <p>If tags have already been assigned to the stream, <code>AddTagsToStream</code> overwrites any existing tags that correspond to the specified tag keys.</p> <p> <a>AddTagsToStream</a> has a limit of five transactions per second per account.</p>"
},
"CreateStream":{
"name":"CreateStream",
@ -40,7 +40,7 @@
{"shape":"LimitExceededException"},
{"shape":"InvalidArgumentException"}
],
"documentation":"<p>Creates a Kinesis stream. A stream captures and transports data records that are continuously emitted from different data sources or <i>producers</i>. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.</p> <p>You specify and control the number of shards that a stream is composed of. Each shard can support reads up to 5 transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. I the amount of data input increases or decreases, you can add or remove shards.</p> <p>The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different regions, can have the same name.</p> <p> <code>CreateStream</code> is an asynchronous operation. Upon receiving a <code>CreateStream</code> request, Kinesis Streams immediately returns and sets the stream status to <code>CREATING</code>. After the stream is created, Kinesis Streams sets the stream status to <code>ACTIVE</code>. You should perform read and write operations only on an <code>ACTIVE</code> stream. </p> <p>You receive a <code>LimitExceededException</code> when making a <code>CreateStream</code> request when you try to do one of the following:</p> <ul> <li> <p>Have more than five streams in the <code>CREATING</code> state at any point in time.</p> </li> <li> <p>Create more shards than are authorized for your account.</p> </li> </ul> <p>For the default shard limit for an AWS account, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Streams Limits</a> in the <i>Amazon Kinesis Streams Developer Guide</i>. To increase this limit, <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">contact AWS Support</a>.</p> <p>You can use <code>DescribeStream</code> to check the stream status, which is returned in <code>StreamStatus</code>.</p> <p> <a>CreateStream</a> has a limit of 5 transactions per second per account.</p>"
"documentation":"<p>Creates a Kinesis data stream. A stream captures and transports data records that are continuously emitted from different data sources or <i>producers</i>. Scale-out within a stream is explicitly supported by means of shards, which are uniquely identified groups of data records in a stream.</p> <p>You specify and control the number of shards that a stream is composed of. Each shard can support reads up to five transactions per second, up to a maximum data read total of 2 MB per second. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second. If the amount of data input increases or decreases, you can add or remove shards.</p> <p>The stream name identifies the stream. The name is scoped to the AWS account used by the application. It is also scoped by AWS Region. That is, two streams in two different accounts can have the same name, and two streams in the same account, but in two different Regions, can have the same name.</p> <p> <code>CreateStream</code> is an asynchronous operation. Upon receiving a <code>CreateStream</code> request, Kinesis Data Streams immediately returns and sets the stream status to <code>CREATING</code>. After the stream is created, Kinesis Data Streams sets the stream status to <code>ACTIVE</code>. You should perform read and write operations only on an <code>ACTIVE</code> stream. </p> <p>You receive a <code>LimitExceededException</code> when making a <code>CreateStream</code> request when you try to do one of the following:</p> <ul> <li> <p>Have more than five streams in the <code>CREATING</code> state at any point in time.</p> </li> <li> <p>Create more shards than are authorized for your account.</p> </li> </ul> <p>For the default shard limit for an AWS account, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Amazon Kinesis Data Streams Limits</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>. To increase this limit, <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">contact AWS Support</a>.</p> <p>You can use <code>DescribeStream</code> to check the stream status, which is returned in <code>StreamStatus</code>.</p> <p> <a>CreateStream</a> has a limit of five transactions per second per account.</p>"
},
"DecreaseStreamRetentionPeriod":{
"name":"DecreaseStreamRetentionPeriod",
@ -52,9 +52,10 @@
"errors":[
{"shape":"ResourceInUseException"},
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidArgumentException"}
],
"documentation":"<p>Decreases the Kinesis stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours.</p> <p>This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.</p>"
"documentation":"<p>Decreases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The minimum value of a stream's retention period is 24 hours.</p> <p>This operation may result in lost data. For example, if the stream's retention period is 48 hours and is decreased to 24 hours, any data already in the stream that is older than 24 hours is inaccessible.</p>"
},
"DeleteStream":{
"name":"DeleteStream",
@ -67,7 +68,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Deletes a Kinesis stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it receives the exception <code>ResourceNotFoundException</code>.</p> <p>If the stream is in the <code>ACTIVE</code> state, you can delete it. After a <code>DeleteStream</code> request, the specified stream is in the <code>DELETING</code> state until Kinesis Streams completes the deletion.</p> <p> <b>Note:</b> Kinesis Streams might continue to accept data read and write operations, such as <a>PutRecord</a>, <a>PutRecords</a>, and <a>GetRecords</a>, on a stream in the <code>DELETING</code> state until the stream deletion is complete.</p> <p>When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.</p> <p>You can use the <a>DescribeStream</a> operation to check the state of the stream, which is returned in <code>StreamStatus</code>.</p> <p> <a>DeleteStream</a> has a limit of 5 transactions per second per account.</p>"
"documentation":"<p>Deletes a Kinesis data stream and all its shards and data. You must shut down any applications that are operating on the stream before you delete the stream. If an application attempts to operate on a deleted stream, it receives the exception <code>ResourceNotFoundException</code>.</p> <p>If the stream is in the <code>ACTIVE</code> state, you can delete it. After a <code>DeleteStream</code> request, the specified stream is in the <code>DELETING</code> state until Kinesis Data Streams completes the deletion.</p> <p> <b>Note:</b> Kinesis Data Streams might continue to accept data read and write operations, such as <a>PutRecord</a>, <a>PutRecords</a>, and <a>GetRecords</a>, on a stream in the <code>DELETING</code> state until the stream deletion is complete.</p> <p>When you delete a stream, any shards in that stream are also deleted, and any tags are dissociated from the stream.</p> <p>You can use the <a>DescribeStream</a> operation to check the state of the stream, which is returned in <code>StreamStatus</code>.</p> <p> <a>DeleteStream</a> has a limit of five transactions per second per account.</p>"
},
"DescribeLimits":{
"name":"DescribeLimits",
@ -80,7 +81,7 @@
"errors":[
{"shape":"LimitExceededException"}
],
"documentation":"<p>Describes the shard limits and usage for the account.</p> <p>If you update your account limits, the old limits might be returned for a few minutes.</p> <p>This operation has a limit of 1 transaction per second per account.</p>"
"documentation":"<p>Describes the shard limits and usage for the account.</p> <p>If you update your account limits, the old limits might be returned for a few minutes.</p> <p>This operation has a limit of one transaction per second per account.</p>"
},
"DescribeStream":{
"name":"DescribeStream",
@ -94,7 +95,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Describes the specified Kinesis stream.</p> <p>The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream.</p> <p>You can limit the number of shards returned by each call. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html\">Retrieving Shards from a Stream</a> in the <i>Amazon Kinesis Streams Developer Guide</i>.</p> <p>There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard.</p> <p>This operation has a limit of 10 transactions per second per account.</p>"
"documentation":"<p>Describes the specified Kinesis data stream.</p> <p>The information returned includes the stream name, Amazon Resource Name (ARN), creation time, enhanced metric configuration, and shard map. The shard map is an array of shard objects. For each shard object, there is the hash key and sequence number ranges that the shard spans, and the IDs of any earlier shards that played in a role in creating the shard. Every record ingested in the stream is identified by a sequence number, which is assigned when the record is put into the stream.</p> <p>You can limit the number of shards returned by each call. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-retrieve-shards.html\">Retrieving Shards from a Stream</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p> <p>There are no guarantees about the chronological order shards returned. To process shards in chronological order, use the ID of the parent shard to track the lineage to the oldest shard.</p> <p>This operation has a limit of 10 transactions per second per account.</p>"
},
"DescribeStreamSummary":{
"name":"DescribeStreamSummary",
@ -108,7 +109,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Provides a summarized description of the specified Kinesis stream without the shard list.</p> <p>The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count. </p>"
"documentation":"<p>Provides a summarized description of the specified Kinesis data stream without the shard list.</p> <p>The information returned includes the stream name, Amazon Resource Name (ARN), status, record retention period, approximate creation time, monitoring, encryption details, and open shard count. </p>"
},
"DisableEnhancedMonitoring":{
"name":"DisableEnhancedMonitoring",
@ -140,7 +141,7 @@
{"shape":"ResourceInUseException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Enables enhanced Kinesis stream monitoring for shard-level metrics.</p>"
"documentation":"<p>Enables enhanced Kinesis data stream monitoring for shard-level metrics.</p>"
},
"GetRecords":{
"name":"GetRecords",
@ -162,7 +163,7 @@
{"shape":"KMSOptInRequired"},
{"shape":"KMSThrottlingException"}
],
"documentation":"<p>Gets data records from a Kinesis stream's shard.</p> <p>Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, <a>GetRecords</a> returns an empty list. It might take multiple calls to get to a portion of the shard that contains records.</p> <p>You can scale by provisioning multiple shards per stream while considering service limits (for more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Streams Limits</a> in the <i>Amazon Kinesis Streams Developer Guide</i>). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call <a>GetRecords</a> in a loop. Use <a>GetShardIterator</a> to get the shard iterator to specify in the first <a>GetRecords</a> call. <a>GetRecords</a> returns a new shard iterator in <code>NextShardIterator</code>. Specify the shard iterator returned in <code>NextShardIterator</code> in subsequent calls to <a>GetRecords</a>. If the shard has been closed, the shard iterator can't return more data and <a>GetRecords</a> returns <code>null</code> in <code>NextShardIterator</code>. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.</p> <p>Each data record can be up to 1 MB in size, and each shard can read up to 2 MB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the <code>Limit</code> parameter to specify the maximum number of records that <a>GetRecords</a> can return. Consider your average record size when determining this limit.</p> <p>The size of the data returned by <a>GetRecords</a> varies depending on the utilization of the shard. The maximum size of data that <a>GetRecords</a> can return is 10 MB. If a call returns this amount of data, subsequent calls made within the next 5 seconds throw <code>ProvisionedThroughputExceededException</code>. If there is insufficient provisioned throughput on the shard, subsequent calls made within the next 1 second throw <code>ProvisionedThroughputExceededException</code>. <a>GetRecords</a> won't return any data when it throws an exception. For this reason, we recommend that you wait one second between calls to <a>GetRecords</a>; however, it's possible that the application will get exceptions for longer than 1 second.</p> <p>To detect whether the application is falling behind in processing, you can use the <code>MillisBehindLatest</code> response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html\">Monitoring</a> in the <i>Amazon Kinesis Streams Developer Guide</i>).</p> <p>Each Amazon Kinesis record includes a value, <code>ApproximateArrivalTimestamp</code>, that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side time stamp, whereas a client-side time stamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with <a>PutRecords</a>). The time stamp has millisecond precision. There are no guarantees about the time stamp accuracy, or that the time stamp is always increasing. For example, records in a shard or across a stream might have time stamps that are out of order.</p>"
"documentation":"<p>Gets data records from a Kinesis data stream's shard.</p> <p>Specify a shard iterator using the <code>ShardIterator</code> parameter. The shard iterator specifies the position in the shard from which you want to start reading data records sequentially. If there are no records available in the portion of the shard that the iterator points to, <a>GetRecords</a> returns an empty list. It might take multiple calls to get to a portion of the shard that contains records.</p> <p>You can scale by provisioning multiple shards per stream while considering service limits (for more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Amazon Kinesis Data Streams Limits</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>). Your application should have one thread per shard, each reading continuously from its stream. To read from a stream continually, call <a>GetRecords</a> in a loop. Use <a>GetShardIterator</a> to get the shard iterator to specify in the first <a>GetRecords</a> call. <a>GetRecords</a> returns a new shard iterator in <code>NextShardIterator</code>. Specify the shard iterator returned in <code>NextShardIterator</code> in subsequent calls to <a>GetRecords</a>. If the shard has been closed, the shard iterator can't return more data and <a>GetRecords</a> returns <code>null</code> in <code>NextShardIterator</code>. You can terminate the loop when the shard is closed, or when the shard iterator reaches the record with the sequence number or other attribute that marks it as the last record to process.</p> <p>Each data record can be up to 1 MB in size, and each shard can read up to 2 MB per second. You can ensure that your calls don't exceed the maximum supported size or throughput by using the <code>Limit</code> parameter to specify the maximum number of records that <a>GetRecords</a> can return. Consider your average record size when determining this limit.</p> <p>The size of the data returned by <a>GetRecords</a> varies depending on the utilization of the shard. The maximum size of data that <a>GetRecords</a> can return is 10 MB. If a call returns this amount of data, subsequent calls made within the next five seconds throw <code>ProvisionedThroughputExceededException</code>. If there is insufficient provisioned throughput on the stream, subsequent calls made within the next one second throw <code>ProvisionedThroughputExceededException</code>. <a>GetRecords</a> won't return any data when it throws an exception. For this reason, we recommend that you wait one second between calls to <a>GetRecords</a>; however, it's possible that the application will get exceptions for longer than 1 second.</p> <p>To detect whether the application is falling behind in processing, you can use the <code>MillisBehindLatest</code> response attribute. You can also monitor the stream using CloudWatch metrics and other mechanisms (see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/monitoring.html\">Monitoring</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>).</p> <p>Each Amazon Kinesis record includes a value, <code>ApproximateArrivalTimestamp</code>, that is set when a stream successfully receives and stores a record. This is commonly referred to as a server-side time stamp, whereas a client-side time stamp is set when a data producer creates or sends the record to a stream (a data producer is any data source putting data records into a stream, for example with <a>PutRecords</a>). The time stamp has millisecond precision. There are no guarantees about the time stamp accuracy, or that the time stamp is always increasing. For example, records in a shard or across a stream might have time stamps that are out of order.</p>"
},
"GetShardIterator":{
"name":"GetShardIterator",
@ -177,7 +178,7 @@
{"shape":"InvalidArgumentException"},
{"shape":"ProvisionedThroughputExceededException"}
],
"documentation":"<p>Gets an Amazon Kinesis shard iterator. A shard iterator expires five minutes after it is returned to the requester.</p> <p>A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.</p> <p>You must specify the shard iterator type. For example, you can set the <code>ShardIteratorType</code> parameter to read exactly from the position denoted by a specific sequence number by using the <code>AT_SEQUENCE_NUMBER</code> shard iterator type. Alternatively, the parameter can read right after the sequence number by using the <code>AFTER_SEQUENCE_NUMBER</code> shard iterator type, using sequence numbers returned by earlier calls to <a>PutRecord</a>, <a>PutRecords</a>, <a>GetRecords</a>, or <a>DescribeStream</a>. In the request, you can specify the shard iterator type <code>AT_TIMESTAMP</code> to read records from an arbitrary point in time, <code>TRIM_HORIZON</code> to cause <code>ShardIterator</code> to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or <code>LATEST</code> so that you always read the most recent data in the shard. </p> <p>When you read repeatedly from a stream, use a <a>GetShardIterator</a> request to get the first shard iterator for use in your first <a>GetRecords</a> request and for subsequent reads use the shard iterator returned by the <a>GetRecords</a> request in <code>NextShardIterator</code>. A new shard iterator is returned by every <a>GetRecords</a> request in <code>NextShardIterator</code>, which you use in the <code>ShardIterator</code> parameter of the next <a>GetRecords</a> request. </p> <p>If a <a>GetShardIterator</a> request is made too often, you receive a <code>ProvisionedThroughputExceededException</code>. For more information about throughput limits, see <a>GetRecords</a>, and <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Streams Limits</a> in the <i>Amazon Kinesis Streams Developer Guide</i>.</p> <p>If the shard is closed, <a>GetShardIterator</a> returns a valid iterator for the last sequence number of the shard. A shard can be closed as a result of using <a>SplitShard</a> or <a>MergeShards</a>.</p> <p> <a>GetShardIterator</a> has a limit of 5 transactions per second per account per open shard.</p>"
"documentation":"<p>Gets an Amazon Kinesis shard iterator. A shard iterator expires five minutes after it is returned to the requester.</p> <p>A shard iterator specifies the shard position from which to start reading data records sequentially. The position is specified using the sequence number of a data record in a shard. A sequence number is the identifier associated with every record ingested in the stream, and is assigned when a record is put into the stream. Each stream has one or more shards.</p> <p>You must specify the shard iterator type. For example, you can set the <code>ShardIteratorType</code> parameter to read exactly from the position denoted by a specific sequence number by using the <code>AT_SEQUENCE_NUMBER</code> shard iterator type. Alternatively, the parameter can read right after the sequence number by using the <code>AFTER_SEQUENCE_NUMBER</code> shard iterator type, using sequence numbers returned by earlier calls to <a>PutRecord</a>, <a>PutRecords</a>, <a>GetRecords</a>, or <a>DescribeStream</a>. In the request, you can specify the shard iterator type <code>AT_TIMESTAMP</code> to read records from an arbitrary point in time, <code>TRIM_HORIZON</code> to cause <code>ShardIterator</code> to point to the last untrimmed record in the shard in the system (the oldest data record in the shard), or <code>LATEST</code> so that you always read the most recent data in the shard. </p> <p>When you read repeatedly from a stream, use a <a>GetShardIterator</a> request to get the first shard iterator for use in your first <a>GetRecords</a> request and for subsequent reads use the shard iterator returned by the <a>GetRecords</a> request in <code>NextShardIterator</code>. A new shard iterator is returned by every <a>GetRecords</a> request in <code>NextShardIterator</code>, which you use in the <code>ShardIterator</code> parameter of the next <a>GetRecords</a> request. </p> <p>If a <a>GetShardIterator</a> request is made too often, you receive a <code>ProvisionedThroughputExceededException</code>. For more information about throughput limits, see <a>GetRecords</a>, and <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Streams Limits</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p> <p>If the shard is closed, <a>GetShardIterator</a> returns a valid iterator for the last sequence number of the shard. A shard can be closed as a result of using <a>SplitShard</a> or <a>MergeShards</a>.</p> <p> <a>GetShardIterator</a> has a limit of five transactions per second per account per open shard.</p>"
},
"IncreaseStreamRetentionPeriod":{
"name":"IncreaseStreamRetentionPeriod",
@ -189,9 +190,27 @@
"errors":[
{"shape":"ResourceInUseException"},
{"shape":"ResourceNotFoundException"},
{"shape":"LimitExceededException"},
{"shape":"InvalidArgumentException"}
],
"documentation":"<p>Increases the Amazon Kinesis stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours (7 days).</p> <p>If you choose a longer stream retention period, this operation increases the time period during which records that have not yet expired are accessible. However, it does not make previous, expired data (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours remains inaccessible to consumer applications.</p>"
"documentation":"<p>Increases the Kinesis data stream's retention period, which is the length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 168 hours (7 days).</p> <p>If you choose a longer stream retention period, this operation increases the time period during which records that have not yet expired are accessible. However, it does not make previous, expired data (older than the stream's previous retention period) accessible after the operation has been called. For example, if a stream's retention period is set to 24 hours and is increased to 168 hours, any data that is older than 24 hours remains inaccessible to consumer applications.</p>"
},
"ListShards":{
"name":"ListShards",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListShardsInput"},
"output":{"shape":"ListShardsOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArgumentException"},
{"shape":"LimitExceededException"},
{"shape":"ExpiredNextTokenException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Lists the shards in a stream and provides information about each shard.</p> <important> <p>This API is a new operation that is used by the Amazon Kinesis Client Library (KCL). If you have a fine-grained IAM policy that only allows specific operations, you must update your policy to allow calls to this API. For more information, see <a href=\"https://docs.aws.amazon.com/streams/latest/dev/controlling-access.html\">Controlling Access to Amazon Kinesis Data Streams Resources Using IAM</a>.</p> </important>"
},
"ListStreams":{
"name":"ListStreams",
@ -204,7 +223,7 @@
"errors":[
{"shape":"LimitExceededException"}
],
"documentation":"<p>Lists your Kinesis streams.</p> <p>The number of streams may be too large to return from a single call to <code>ListStreams</code>. You can limit the number of returned streams using the <code>Limit</code> parameter. If you do not specify a value for the <code>Limit</code> parameter, Kinesis Streams uses the default limit, which is currently 10.</p> <p>You can detect if there are more streams available to list by using the <code>HasMoreStreams</code> flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the <code>ListStreams</code> request in the <code>ExclusiveStartStreamName</code> parameter in a subsequent request to <code>ListStreams</code>. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list. </p> <p> <a>ListStreams</a> has a limit of 5 transactions per second per account.</p>"
"documentation":"<p>Lists your Kinesis data streams.</p> <p>The number of streams may be too large to return from a single call to <code>ListStreams</code>. You can limit the number of returned streams using the <code>Limit</code> parameter. If you do not specify a value for the <code>Limit</code> parameter, Kinesis Data Streams uses the default limit, which is currently 10.</p> <p>You can detect if there are more streams available to list by using the <code>HasMoreStreams</code> flag from the returned output. If there are more streams available, you can request more streams by using the name of the last stream returned by the <code>ListStreams</code> request in the <code>ExclusiveStartStreamName</code> parameter in a subsequent request to <code>ListStreams</code>. The group of stream names returned by the subsequent request is then added to the list. You can continue this process until all the stream names have been collected in the list. </p> <p> <a>ListStreams</a> has a limit of five transactions per second per account.</p>"
},
"ListTagsForStream":{
"name":"ListTagsForStream",
@ -219,7 +238,7 @@
{"shape":"InvalidArgumentException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Lists the tags for the specified Kinesis stream.</p>"
"documentation":"<p>Lists the tags for the specified Kinesis data stream. This operation has a limit of five transactions per second per account.</p>"
},
"MergeShards":{
"name":"MergeShards",
@ -234,7 +253,7 @@
{"shape":"InvalidArgumentException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Merges two adjacent shards in a Kinesis stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.</p> <p> <code>MergeShards</code> is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html\">Merge Two Shards</a> in the <i>Amazon Kinesis Streams Developer Guide</i>.</p> <p>If the stream is in the <code>ACTIVE</code> state, you can call <code>MergeShards</code>. If a stream is in the <code>CREATING</code>, <code>UPDATING</code>, or <code>DELETING</code> state, <code>MergeShards</code> returns a <code>ResourceInUseException</code>. If the specified stream does not exist, <code>MergeShards</code> returns a <code>ResourceNotFoundException</code>. </p> <p>You can use <a>DescribeStream</a> to check the state of the stream, which is returned in <code>StreamStatus</code>.</p> <p> <code>MergeShards</code> is an asynchronous operation. Upon receiving a <code>MergeShards</code> request, Amazon Kinesis immediately returns a response and sets the <code>StreamStatus</code> to <code>UPDATING</code>. After the operation is completed, Amazon Kinesis sets the <code>StreamStatus</code> to <code>ACTIVE</code>. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state. </p> <p>You use <a>DescribeStream</a> to determine the shard IDs that are specified in the <code>MergeShards</code> request. </p> <p>If you try to operate on too many streams in parallel using <a>CreateStream</a>, <a>DeleteStream</a>, <code>MergeShards</code> or <a>SplitShard</a>, you will receive a <code>LimitExceededException</code>. </p> <p> <code>MergeShards</code> has a limit of 5 transactions per second per account.</p>"
"documentation":"<p>Merges two adjacent shards in a Kinesis data stream and combines them into a single shard to reduce the stream's capacity to ingest and transport data. Two shards are considered adjacent if the union of the hash key ranges for the two shards form a contiguous set with no gaps. For example, if you have two shards, one with a hash key range of 276...381 and the other with a hash key range of 382...454, then you could merge these two shards into a single shard that would have a hash key range of 276...454. After the merge, the single child shard receives data for all hash key values covered by the two parent shards.</p> <p> <code>MergeShards</code> is called when there is a need to reduce the overall capacity of a stream because of excess capacity that is not being used. You must specify the shard to be merged and the adjacent shard for a stream. For more information about merging shards, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-merge.html\">Merge Two Shards</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p> <p>If the stream is in the <code>ACTIVE</code> state, you can call <code>MergeShards</code>. If a stream is in the <code>CREATING</code>, <code>UPDATING</code>, or <code>DELETING</code> state, <code>MergeShards</code> returns a <code>ResourceInUseException</code>. If the specified stream does not exist, <code>MergeShards</code> returns a <code>ResourceNotFoundException</code>. </p> <p>You can use <a>DescribeStream</a> to check the state of the stream, which is returned in <code>StreamStatus</code>.</p> <p> <code>MergeShards</code> is an asynchronous operation. Upon receiving a <code>MergeShards</code> request, Amazon Kinesis Data Streams immediately returns a response and sets the <code>StreamStatus</code> to <code>UPDATING</code>. After the operation is completed, Kinesis Data Streams sets the <code>StreamStatus</code> to <code>ACTIVE</code>. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state. </p> <p>You use <a>DescribeStream</a> to determine the shard IDs that are specified in the <code>MergeShards</code> request. </p> <p>If you try to operate on too many streams in parallel using <a>CreateStream</a>, <a>DeleteStream</a>, <code>MergeShards</code>, or <a>SplitShard</a>, you receive a <code>LimitExceededException</code>. </p> <p> <code>MergeShards</code> has a limit of five transactions per second per account.</p>"
},
"PutRecord":{
"name":"PutRecord",
@ -255,7 +274,7 @@
{"shape":"KMSOptInRequired"},
{"shape":"KMSThrottlingException"}
],
"documentation":"<p>Writes a single data record into an Amazon Kinesis stream. Call <code>PutRecord</code> to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.</p> <p>You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.</p> <p>The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.</p> <p>The partition key is used by Kinesis Streams to distribute data across shards. Kinesis Streams segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine the shard to which a given data record belongs.</p> <p>Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the <code>ExplicitHashKey</code> parameter. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream\">Adding Data to a Stream</a> in the <i>Amazon Kinesis Streams Developer Guide</i>.</p> <p> <code>PutRecord</code> returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.</p> <p>Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the <code>SequenceNumberForOrdering</code> parameter. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream\">Adding Data to a Stream</a> in the <i>Amazon Kinesis Streams Developer Guide</i>.</p> <p>If a <code>PutRecord</code> request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, <code>PutRecord</code> throws <code>ProvisionedThroughputExceededException</code>. </p> <p>By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use <a>IncreaseStreamRetentionPeriod</a> or <a>DecreaseStreamRetentionPeriod</a> to modify this retention period.</p>"
"documentation":"<p>Writes a single data record into an Amazon Kinesis data stream. Call <code>PutRecord</code> to send data into the stream for real-time ingestion and subsequent processing, one record at a time. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.</p> <p>You must specify the name of the stream that captures, stores, and transports the data; a partition key; and the data blob itself.</p> <p>The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.</p> <p>The partition key is used by Kinesis Data Streams to distribute data across shards. Kinesis Data Streams segregates the data records that belong to a stream into multiple shards, using the partition key associated with each data record to determine the shard to which a given data record belongs.</p> <p>Partition keys are Unicode strings, with a maximum length limit of 256 characters for each key. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards using the hash key ranges of the shards. You can override hashing the partition key to determine the shard by explicitly specifying a hash value using the <code>ExplicitHashKey</code> parameter. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream\">Adding Data to a Stream</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p> <p> <code>PutRecord</code> returns the shard ID of where the data record was placed and the sequence number that was assigned to the data record.</p> <p>Sequence numbers increase over time and are specific to a shard within a stream, not across all shards within a stream. To guarantee strictly increasing ordering, write serially to a shard and use the <code>SequenceNumberForOrdering</code> parameter. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream\">Adding Data to a Stream</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p> <p>If a <code>PutRecord</code> request cannot be processed because of insufficient provisioned throughput on the shard involved in the request, <code>PutRecord</code> throws <code>ProvisionedThroughputExceededException</code>. </p> <p>By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use <a>IncreaseStreamRetentionPeriod</a> or <a>DecreaseStreamRetentionPeriod</a> to modify this retention period.</p>"
},
"PutRecords":{
"name":"PutRecords",
@ -276,7 +295,7 @@
{"shape":"KMSOptInRequired"},
{"shape":"KMSThrottlingException"}
],
"documentation":"<p>Writes multiple data records into a Kinesis stream in a single call (also referred to as a <code>PutRecords</code> request). Use this operation to send data into the stream for data ingestion and processing. </p> <p>Each <code>PutRecords</code> request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.</p> <p>You must specify the name of the stream that captures, stores, and transports the data; and an array of request <code>Records</code>, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob.</p> <p>The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.</p> <p>The partition key is used by Kinesis Streams as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream\">Adding Data to a Stream</a> in the <i>Amazon Kinesis Streams Developer Guide</i>.</p> <p>Each record in the <code>Records</code> array may include an optional parameter, <code>ExplicitHashKey</code>, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords\">Adding Multiple Records with PutRecords</a> in the <i>Amazon Kinesis Streams Developer Guide</i>.</p> <p>The <code>PutRecords</code> response includes an array of response <code>Records</code>. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response <code>Records</code> array always includes the same number of records as the request array.</p> <p>The response <code>Records</code> array includes both successfully and unsuccessfully processed records. Amazon Kinesis attempts to process all records in each <code>PutRecords</code> request. A single record failure does not stop the processing of subsequent records.</p> <p>A successfully processed record includes <code>ShardId</code> and <code>SequenceNumber</code> values. The <code>ShardId</code> parameter identifies the shard in the stream where the record is stored. The <code>SequenceNumber</code> parameter is an identifier assigned to the put record, unique to all records in the stream.</p> <p>An unsuccessfully processed record includes <code>ErrorCode</code> and <code>ErrorMessage</code> values. <code>ErrorCode</code> reflects the type of error and can be one of the following values: <code>ProvisionedThroughputExceededException</code> or <code>InternalFailure</code>. <code>ErrorMessage</code> provides more detailed information about the <code>ProvisionedThroughputExceededException</code> exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords\">Adding Multiple Records with PutRecords</a> in the <i>Amazon Kinesis Streams Developer Guide</i>.</p> <p>By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use <a>IncreaseStreamRetentionPeriod</a> or <a>DecreaseStreamRetentionPeriod</a> to modify this retention period.</p>"
"documentation":"<p>Writes multiple data records into a Kinesis data stream in a single call (also referred to as a <code>PutRecords</code> request). Use this operation to send data into the stream for data ingestion and processing. </p> <p>Each <code>PutRecords</code> request can support up to 500 records. Each record in the request can be as large as 1 MB, up to a limit of 5 MB for the entire request, including partition keys. Each shard can support writes up to 1,000 records per second, up to a maximum data write total of 1 MB per second.</p> <p>You must specify the name of the stream that captures, stores, and transports the data; and an array of request <code>Records</code>, with each record in the array requiring a partition key and data blob. The record size limit applies to the total size of the partition key and data blob.</p> <p>The data blob can be any type of data; for example, a segment from a log file, geographic/location data, website clickstream data, and so on.</p> <p>The partition key is used by Kinesis Data Streams as input to a hash function that maps the partition key and associated data to a specific shard. An MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-add-data-to-stream\">Adding Data to a Stream</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p> <p>Each record in the <code>Records</code> array may include an optional parameter, <code>ExplicitHashKey</code>, which overrides the partition key to shard mapping. This parameter allows a data producer to determine explicitly the shard where the record is stored. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/developing-producers-with-sdk.html#kinesis-using-sdk-java-putrecords\">Adding Multiple Records with PutRecords</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p> <p>The <code>PutRecords</code> response includes an array of response <code>Records</code>. Each record in the response array directly correlates with a record in the request array using natural ordering, from the top to the bottom of the request and response. The response <code>Records</code> array always includes the same number of records as the request array.</p> <p>The response <code>Records</code> array includes both successfully and unsuccessfully processed records. Kinesis Data Streams attempts to process all records in each <code>PutRecords</code> request. A single record failure does not stop the processing of subsequent records.</p> <p>A successfully processed record includes <code>ShardId</code> and <code>SequenceNumber</code> values. The <code>ShardId</code> parameter identifies the shard in the stream where the record is stored. The <code>SequenceNumber</code> parameter is an identifier assigned to the put record, unique to all records in the stream.</p> <p>An unsuccessfully processed record includes <code>ErrorCode</code> and <code>ErrorMessage</code> values. <code>ErrorCode</code> reflects the type of error and can be one of the following values: <code>ProvisionedThroughputExceededException</code> or <code>InternalFailure</code>. <code>ErrorMessage</code> provides more detailed information about the <code>ProvisionedThroughputExceededException</code> exception including the account ID, stream name, and shard ID of the record that was throttled. For more information about partially successful responses, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-add-data-to-stream.html#kinesis-using-sdk-java-putrecords\">Adding Multiple Records with PutRecords</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p> <p>By default, data records are accessible for 24 hours from the time that they are added to a stream. You can use <a>IncreaseStreamRetentionPeriod</a> or <a>DecreaseStreamRetentionPeriod</a> to modify this retention period.</p>"
},
"RemoveTagsFromStream":{
"name":"RemoveTagsFromStream",
@ -291,7 +310,7 @@
{"shape":"InvalidArgumentException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Removes tags from the specified Kinesis stream. Removed tags are deleted and cannot be recovered after this operation successfully completes.</p> <p>If you specify a tag that does not exist, it is ignored.</p>"
"documentation":"<p>Removes tags from the specified Kinesis data stream. Removed tags are deleted and cannot be recovered after this operation successfully completes.</p> <p>If you specify a tag that does not exist, it is ignored.</p> <p> <a>RemoveTagsFromStream</a> has a limit of five transactions per second per account.</p>"
},
"SplitShard":{
"name":"SplitShard",
@ -306,7 +325,7 @@
{"shape":"InvalidArgumentException"},
{"shape":"LimitExceededException"}
],
"documentation":"<p>Splits a shard into two new shards in the Kinesis stream, to increase the stream's capacity to ingest and transport data. <code>SplitShard</code> is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested. </p> <p>You can also use <code>SplitShard</code> when a shard appears to be approaching its maximum utilization; for example, the producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call <code>SplitShard</code> to increase stream capacity, so that more Kinesis Streams applications can simultaneously read data from the stream for real-time processing. </p> <p>You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html\">Split a Shard</a> in the <i>Amazon Kinesis Streams Developer Guide</i>.</p> <p>You can use <a>DescribeStream</a> to determine the shard ID and hash key values for the <code>ShardToSplit</code> and <code>NewStartingHashKey</code> parameters that are specified in the <code>SplitShard</code> request.</p> <p> <code>SplitShard</code> is an asynchronous operation. Upon receiving a <code>SplitShard</code> request, Kinesis Streams immediately returns a response and sets the stream status to <code>UPDATING</code>. After the operation is completed, Kinesis Streams sets the stream status to <code>ACTIVE</code>. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state. </p> <p>You can use <code>DescribeStream</code> to check the status of the stream, which is returned in <code>StreamStatus</code>. If the stream is in the <code>ACTIVE</code> state, you can call <code>SplitShard</code>. If a stream is in <code>CREATING</code> or <code>UPDATING</code> or <code>DELETING</code> states, <code>DescribeStream</code> returns a <code>ResourceInUseException</code>.</p> <p>If the specified stream does not exist, <code>DescribeStream</code> returns a <code>ResourceNotFoundException</code>. If you try to create more shards than are authorized for your account, you receive a <code>LimitExceededException</code>. </p> <p>For the default shard limit for an AWS account, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Streams Limits</a> in the <i>Amazon Kinesis Streams Developer Guide</i>. To increase this limit, <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">contact AWS Support</a>.</p> <p>If you try to operate on too many streams simultaneously using <a>CreateStream</a>, <a>DeleteStream</a>, <a>MergeShards</a>, and/or <a>SplitShard</a>, you receive a <code>LimitExceededException</code>. </p> <p> <code>SplitShard</code> has a limit of 5 transactions per second per account.</p>"
"documentation":"<p>Splits a shard into two new shards in the Kinesis data stream, to increase the stream's capacity to ingest and transport data. <code>SplitShard</code> is called when there is a need to increase the overall capacity of a stream because of an expected increase in the volume of data records being ingested. </p> <p>You can also use <code>SplitShard</code> when a shard appears to be approaching its maximum utilization; for example, the producers sending data into the specific shard are suddenly sending more than previously anticipated. You can also call <code>SplitShard</code> to increase stream capacity, so that more Kinesis Data Streams applications can simultaneously read data from the stream for real-time processing. </p> <p>You must specify the shard to be split and the new hash key, which is the position in the shard where the shard gets split in two. In many cases, the new hash key might be the average of the beginning and ending hash key, but it can be any hash key value in the range being mapped into the shard. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/kinesis-using-sdk-java-resharding-split.html\">Split a Shard</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p> <p>You can use <a>DescribeStream</a> to determine the shard ID and hash key values for the <code>ShardToSplit</code> and <code>NewStartingHashKey</code> parameters that are specified in the <code>SplitShard</code> request.</p> <p> <code>SplitShard</code> is an asynchronous operation. Upon receiving a <code>SplitShard</code> request, Kinesis Data Streams immediately returns a response and sets the stream status to <code>UPDATING</code>. After the operation is completed, Kinesis Data Streams sets the stream status to <code>ACTIVE</code>. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state. </p> <p>You can use <code>DescribeStream</code> to check the status of the stream, which is returned in <code>StreamStatus</code>. If the stream is in the <code>ACTIVE</code> state, you can call <code>SplitShard</code>. If a stream is in <code>CREATING</code> or <code>UPDATING</code> or <code>DELETING</code> states, <code>DescribeStream</code> returns a <code>ResourceInUseException</code>.</p> <p>If the specified stream does not exist, <code>DescribeStream</code> returns a <code>ResourceNotFoundException</code>. If you try to create more shards than are authorized for your account, you receive a <code>LimitExceededException</code>. </p> <p>For the default shard limit for an AWS account, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Streams Limits</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>. To increase this limit, <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">contact AWS Support</a>.</p> <p>If you try to operate on too many streams simultaneously using <a>CreateStream</a>, <a>DeleteStream</a>, <a>MergeShards</a>, and/or <a>SplitShard</a>, you receive a <code>LimitExceededException</code>. </p> <p> <code>SplitShard</code> has a limit of five transactions per second per account.</p>"
},
"StartStreamEncryption":{
"name":"StartStreamEncryption",
@ -327,7 +346,7 @@
{"shape":"KMSOptInRequired"},
{"shape":"KMSThrottlingException"}
],
"documentation":"<p>Enables or updates server-side encryption using an AWS KMS key for a specified stream. </p> <p>Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis Streams returns immediately and sets the status of the stream to <code>UPDATING</code>. After the update is complete, Kinesis Streams sets the status of the stream back to <code>ACTIVE</code>. Updating or applying encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is <code>UPDATING</code>. Once the status of the stream is <code>ACTIVE</code>, encryption begins for records written to the stream. </p> <p>API Limits: You can successfully apply a new AWS KMS key for server-side encryption 25 times in a rolling 24-hour period.</p> <p>Note: It can take up to five seconds after the stream is in an <code>ACTIVE</code> status before all records written to the stream are encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response from <code>PutRecord</code> or <code>PutRecords</code>.</p>"
"documentation":"<p>Enables or updates server-side encryption using an AWS KMS key for a specified stream. </p> <p>Starting encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to <code>UPDATING</code>. After the update is complete, Kinesis Data Streams sets the status of the stream back to <code>ACTIVE</code>. Updating or applying encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is <code>UPDATING</code>. Once the status of the stream is <code>ACTIVE</code>, encryption begins for records written to the stream. </p> <p>API Limits: You can successfully apply a new AWS KMS key for server-side encryption 25 times in a rolling 24-hour period.</p> <p>Note: It can take up to five seconds after the stream is in an <code>ACTIVE</code> status before all records written to the stream are encrypted. After you enable encryption, you can verify that encryption is applied by inspecting the API response from <code>PutRecord</code> or <code>PutRecords</code>.</p>"
},
"StopStreamEncryption":{
"name":"StopStreamEncryption",
@ -342,7 +361,7 @@
{"shape":"ResourceInUseException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Disables server-side encryption for a specified stream. </p> <p>Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis Streams returns immediately and sets the status of the stream to <code>UPDATING</code>. After the update is complete, Kinesis Streams sets the status of the stream back to <code>ACTIVE</code>. Stopping encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is <code>UPDATING</code>. Once the status of the stream is <code>ACTIVE</code>, records written to the stream are no longer encrypted by Kinesis Streams. </p> <p>API Limits: You can successfully disable server-side encryption 25 times in a rolling 24-hour period. </p> <p>Note: It can take up to five seconds after the stream is in an <code>ACTIVE</code> status before all records written to the stream are no longer subject to encryption. After you disabled encryption, you can verify that encryption is not applied by inspecting the API response from <code>PutRecord</code> or <code>PutRecords</code>.</p>"
"documentation":"<p>Disables server-side encryption for a specified stream. </p> <p>Stopping encryption is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to <code>UPDATING</code>. After the update is complete, Kinesis Data Streams sets the status of the stream back to <code>ACTIVE</code>. Stopping encryption normally takes a few seconds to complete, but it can take minutes. You can continue to read and write data to your stream while its status is <code>UPDATING</code>. Once the status of the stream is <code>ACTIVE</code>, records written to the stream are no longer encrypted by Kinesis Data Streams. </p> <p>API Limits: You can successfully disable server-side encryption 25 times in a rolling 24-hour period. </p> <p>Note: It can take up to five seconds after the stream is in an <code>ACTIVE</code> status before all records written to the stream are no longer subject to encryption. After you disabled encryption, you can verify that encryption is not applied by inspecting the API response from <code>PutRecord</code> or <code>PutRecords</code>.</p>"
},
"UpdateShardCount":{
"name":"UpdateShardCount",
@ -358,7 +377,7 @@
{"shape":"ResourceInUseException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Updates the shard count of the specified stream to the specified number of shards.</p> <p>Updating the shard count is an asynchronous operation. Upon receiving the request, Kinesis Streams returns immediately and sets the status of the stream to <code>UPDATING</code>. After the update is complete, Kinesis Streams sets the status of the stream back to <code>ACTIVE</code>. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status is <code>UPDATING</code>.</p> <p>To update the shard count, Kinesis Streams performs splits or merges on individual shards. This can cause short-lived shards to be created, in addition to the final shards. We recommend that you double or halve the shard count, as this results in the fewest number of splits or merges.</p> <p>This operation has the following limits, which are per region per account unless otherwise noted. You cannot:</p> <ul> <li> <p>Scale more than twice per rolling 24 hour period</p> </li> <li> <p>Scale up to double your current shard count</p> </li> <li> <p>Scale down below half your current shard count</p> </li> <li> <p>Scale up to more 500 shards in a stream</p> </li> <li> <p>Scale a stream with more than 500 shards down unless the result is less than 500 shards</p> </li> <li> <p>Scale up more the shard limits for your account</p> </li> <li> <p/> </li> </ul> <p>For the default limits for an AWS account, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Streams Limits</a> in the <i>Amazon Kinesis Streams Developer Guide</i>. To increase a limit, <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html\">contact AWS Support</a>.</p>"
"documentation":"<p>Updates the shard count of the specified stream to the specified number of shards.</p> <p>Updating the shard count is an asynchronous operation. Upon receiving the request, Kinesis Data Streams returns immediately and sets the status of the stream to <code>UPDATING</code>. After the update is complete, Kinesis Data Streams sets the status of the stream back to <code>ACTIVE</code>. Depending on the size of the stream, the scaling action could take a few minutes to complete. You can continue to read and write data to your stream while its status is <code>UPDATING</code>.</p> <p>To update the shard count, Kinesis Data Streams performs splits or merges on individual shards. This can cause short-lived shards to be created, in addition to the final shards. We recommend that you double or halve the shard count, as this results in the fewest number of splits or merges.</p> <p>This operation has the following limits. You cannot do the following:</p> <ul> <li> <p>Scale more than twice per rolling 24-hour period per stream</p> </li> <li> <p>Scale up to more than double your current shard count for a stream</p> </li> <li> <p>Scale down below half your current shard count for a stream</p> </li> <li> <p>Scale up to more than 500 shards in a stream</p> </li> <li> <p>Scale a stream with more than 500 shards down unless the result is less than 500 shards</p> </li> <li> <p>Scale up to more than the shard limit for your account</p> </li> </ul> <p>For the default limits for an AWS account, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Streams Limits</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>. To request an increase in the call rate limit, the shard limit for this API, or your overall shard limit, use the <a href=\"https://console.aws.amazon.com/support/v1#/case/create?issueType=service-limit-increase&amp;limitType=service-code-kinesis\">limits form</a>.</p>"
}
},
"shapes":{
@ -390,7 +409,7 @@
"members":{
"StreamName":{
"shape":"StreamName",
"documentation":"<p>A name to identify the stream. The stream name is scoped to the AWS account used by the application that creates the stream. It is also scoped by region. That is, two streams in two different AWS accounts can have the same name. Two streams in the same AWS account but in two different regions can also have the same name.</p>"
"documentation":"<p>A name to identify the stream. The stream name is scoped to the AWS account used by the application that creates the stream. It is also scoped by AWS Region. That is, two streams in two different AWS accounts can have the same name. Two streams in the same AWS account but in two different Regions can also have the same name.</p>"
},
"ShardCount":{
"shape":"PositiveIntegerObject",
@ -416,7 +435,7 @@
"documentation":"<p>The name of the stream to modify.</p>"
},
"RetentionPeriodHours":{
"shape":"PositiveIntegerObject",
"shape":"RetentionPeriodHours",
"documentation":"<p>The new retention period of the stream, in hours. Must be less than the current retention period.</p>"
}
},
@ -485,7 +504,7 @@
"members":{
"StreamDescription":{
"shape":"StreamDescription",
"documentation":"<p>The current status of the stream, the stream ARN, an array of shard objects that comprise the stream, and whether there are more shards available.</p>"
"documentation":"<p>The current status of the stream, the stream Amazon Resource Name (ARN), an array of shard objects that comprise the stream, and whether there are more shards available.</p>"
}
},
"documentation":"<p>Represents the output for <code>DescribeStream</code>.</p>"
@ -519,11 +538,11 @@
"members":{
"StreamName":{
"shape":"StreamName",
"documentation":"<p>The name of the Kinesis stream for which to disable enhanced monitoring.</p>"
"documentation":"<p>The name of the Kinesis data stream for which to disable enhanced monitoring.</p>"
},
"ShardLevelMetrics":{
"shape":"MetricsNameList",
"documentation":"<p>List of shard-level metrics to disable.</p> <p>The following are the valid shard-level metrics. The value \"<code>ALL</code>\" disables every metric.</p> <ul> <li> <p> <code>IncomingBytes</code> </p> </li> <li> <p> <code>IncomingRecords</code> </p> </li> <li> <p> <code>OutgoingBytes</code> </p> </li> <li> <p> <code>OutgoingRecords</code> </p> </li> <li> <p> <code>WriteProvisionedThroughputExceeded</code> </p> </li> <li> <p> <code>ReadProvisionedThroughputExceeded</code> </p> </li> <li> <p> <code>IteratorAgeMilliseconds</code> </p> </li> <li> <p> <code>ALL</code> </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html\">Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch</a> in the <i>Amazon Kinesis Streams Developer Guide</i>.</p>"
"documentation":"<p>List of shard-level metrics to disable.</p> <p>The following are the valid shard-level metrics. The value \"<code>ALL</code>\" disables every metric.</p> <ul> <li> <p> <code>IncomingBytes</code> </p> </li> <li> <p> <code>IncomingRecords</code> </p> </li> <li> <p> <code>OutgoingBytes</code> </p> </li> <li> <p> <code>OutgoingRecords</code> </p> </li> <li> <p> <code>WriteProvisionedThroughputExceeded</code> </p> </li> <li> <p> <code>ReadProvisionedThroughputExceeded</code> </p> </li> <li> <p> <code>IteratorAgeMilliseconds</code> </p> </li> <li> <p> <code>ALL</code> </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html\">Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p>"
}
},
"documentation":"<p>Represents the input for <a>DisableEnhancedMonitoring</a>.</p>"
@ -541,7 +560,7 @@
},
"ShardLevelMetrics":{
"shape":"MetricsNameList",
"documentation":"<p>List of shard-level metrics to enable.</p> <p>The following are the valid shard-level metrics. The value \"<code>ALL</code>\" enables every metric.</p> <ul> <li> <p> <code>IncomingBytes</code> </p> </li> <li> <p> <code>IncomingRecords</code> </p> </li> <li> <p> <code>OutgoingBytes</code> </p> </li> <li> <p> <code>OutgoingRecords</code> </p> </li> <li> <p> <code>WriteProvisionedThroughputExceeded</code> </p> </li> <li> <p> <code>ReadProvisionedThroughputExceeded</code> </p> </li> <li> <p> <code>IteratorAgeMilliseconds</code> </p> </li> <li> <p> <code>ALL</code> </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html\">Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch</a> in the <i>Amazon Kinesis Streams Developer Guide</i>.</p>"
"documentation":"<p>List of shard-level metrics to enable.</p> <p>The following are the valid shard-level metrics. The value \"<code>ALL</code>\" enables every metric.</p> <ul> <li> <p> <code>IncomingBytes</code> </p> </li> <li> <p> <code>IncomingRecords</code> </p> </li> <li> <p> <code>OutgoingBytes</code> </p> </li> <li> <p> <code>OutgoingRecords</code> </p> </li> <li> <p> <code>WriteProvisionedThroughputExceeded</code> </p> </li> <li> <p> <code>ReadProvisionedThroughputExceeded</code> </p> </li> <li> <p> <code>IteratorAgeMilliseconds</code> </p> </li> <li> <p> <code>ALL</code> </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html\">Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p>"
}
},
"documentation":"<p>Represents the input for <a>EnableEnhancedMonitoring</a>.</p>"
@ -558,7 +577,7 @@
"members":{
"ShardLevelMetrics":{
"shape":"MetricsNameList",
"documentation":"<p>List of shard-level metrics.</p> <p>The following are the valid shard-level metrics. The value \"<code>ALL</code>\" enhances every metric.</p> <ul> <li> <p> <code>IncomingBytes</code> </p> </li> <li> <p> <code>IncomingRecords</code> </p> </li> <li> <p> <code>OutgoingBytes</code> </p> </li> <li> <p> <code>OutgoingRecords</code> </p> </li> <li> <p> <code>WriteProvisionedThroughputExceeded</code> </p> </li> <li> <p> <code>ReadProvisionedThroughputExceeded</code> </p> </li> <li> <p> <code>IteratorAgeMilliseconds</code> </p> </li> <li> <p> <code>ALL</code> </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html\">Monitoring the Amazon Kinesis Streams Service with Amazon CloudWatch</a> in the <i>Amazon Kinesis Streams Developer Guide</i>.</p>"
"documentation":"<p>List of shard-level metrics.</p> <p>The following are the valid shard-level metrics. The value \"<code>ALL</code>\" enhances every metric.</p> <ul> <li> <p> <code>IncomingBytes</code> </p> </li> <li> <p> <code>IncomingRecords</code> </p> </li> <li> <p> <code>OutgoingBytes</code> </p> </li> <li> <p> <code>OutgoingRecords</code> </p> </li> <li> <p> <code>WriteProvisionedThroughputExceeded</code> </p> </li> <li> <p> <code>ReadProvisionedThroughputExceeded</code> </p> </li> <li> <p> <code>IteratorAgeMilliseconds</code> </p> </li> <li> <p> <code>ALL</code> </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/monitoring-with-cloudwatch.html\">Monitoring the Amazon Kinesis Data Streams Service with Amazon CloudWatch</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>.</p>"
}
},
"documentation":"<p>Represents enhanced metrics types.</p>"
@ -572,7 +591,7 @@
"members":{
"StreamName":{
"shape":"StreamName",
"documentation":"<p>The name of the Kinesis stream.</p>"
"documentation":"<p>The name of the Kinesis data stream.</p>"
},
"CurrentShardLevelMetrics":{
"shape":"MetricsNameList",
@ -598,6 +617,14 @@
"documentation":"<p>The provided iterator exceeds the maximum age allowed.</p>",
"exception":true
},
"ExpiredNextTokenException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The pagination token passed to the <code>ListShards</code> operation is expired. For more information, see <a>ListShardsInput$NextToken</a>.</p>",
"exception":true
},
"GetRecordsInput":{
"type":"structure",
"required":["ShardIterator"],
@ -647,11 +674,11 @@
"members":{
"StreamName":{
"shape":"StreamName",
"documentation":"<p>The name of the Amazon Kinesis stream.</p>"
"documentation":"<p>The name of the Amazon Kinesis data stream.</p>"
},
"ShardId":{
"shape":"ShardId",
"documentation":"<p>The shard ID of the Kinesis Streams shard to get the iterator for.</p>"
"documentation":"<p>The shard ID of the Kinesis Data Streams shard to get the iterator for.</p>"
},
"ShardIteratorType":{
"shape":"ShardIteratorType",
@ -712,7 +739,7 @@
"documentation":"<p>The name of the stream to modify.</p>"
},
"RetentionPeriodHours":{
"shape":"PositiveIntegerObject",
"shape":"RetentionPeriodHours",
"documentation":"<p>The new retention period of the stream, in hours. Must be more than the current retention period.</p>"
}
},
@ -811,6 +838,49 @@
"documentation":"<p>The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed. </p>",
"exception":true
},
"ListShardsInput":{
"type":"structure",
"members":{
"StreamName":{
"shape":"StreamName",
"documentation":"<p>The name of the data stream whose shards you want to list. </p> <p>You cannot specify this parameter if you specify the <code>NextToken</code> parameter.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>When the number of shards in the data stream is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of shards in the data stream, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListShards</code> to list the next set of shards.</p> <p>Don't specify <code>StreamName</code> or <code>StreamCreationTimestamp</code> if you specify <code>NextToken</code> because the latter unambiguously identifies the stream.</p> <p>You can optionally specify a value for the <code>MaxResults</code> parameter when you specify <code>NextToken</code>. If you specify a <code>MaxResults</code> value that is less than the number of shards that the operation returns if you don't specify <code>MaxResults</code>, the response will contain a new <code>NextToken</code> value. You can use the new <code>NextToken</code> value in a subsequent call to the <code>ListShards</code> operation.</p> <important> <p>Tokens expire after 300 seconds. When you obtain a value for <code>NextToken</code> in the response to a call to <code>ListShards</code>, you have 300 seconds to use that value. If you specify an expired token in a call to <code>ListShards</code>, you get <code>ExpiredNextTokenException</code>.</p> </important>"
},
"ExclusiveStartShardId":{
"shape":"ShardId",
"documentation":"<p>The ID of the shard to start the list with. </p> <p>If you don't specify this parameter, the default behavior is for <code>ListShards</code> to list the shards starting with the first one in the stream.</p> <p>You cannot specify this parameter if you specify <code>NextToken</code>.</p>"
},
"MaxResults":{
"shape":"ListShardsInputLimit",
"documentation":"<p>The maximum number of shards to return in a single call to <code>ListShards</code>. The minimum value you can specify for this parameter is 1, and the maximum is 1,000, which is also the default.</p> <p>When the number of shards to be listed is greater than the value of <code>MaxResults</code>, the response contains a <code>NextToken</code> value that you can use in a subsequent call to <code>ListShards</code> to list the next set of shards.</p>"
},
"StreamCreationTimestamp":{
"shape":"Timestamp",
"documentation":"<p>Specify this input parameter to distinguish data streams that have the same name. For example, if you create a data stream and then delete it, and you later create another data stream with the same name, you can use this input parameter to specify which of the two streams you want to list the shards for.</p> <p>You cannot specify this parameter if you specify the <code>NextToken</code> parameter.</p>"
}
}
},
"ListShardsInputLimit":{
"type":"integer",
"max":10000,
"min":1
},
"ListShardsOutput":{
"type":"structure",
"members":{
"Shards":{
"shape":"ShardList",
"documentation":"<p>An array of JSON objects. Each object represents one shard and specifies the IDs of the shard, the shard's parent, and the shard that's adjacent to the shard's parent. Each object also contains the starting and ending hash keys and the starting and ending sequence numbers for the shard.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>When the number of shards in the data stream is greater than the default value for the <code>MaxResults</code> parameter, or if you explicitly specify a value for <code>MaxResults</code> that is less than the number of shards in the data stream, the response includes a pagination token named <code>NextToken</code>. You can specify this <code>NextToken</code> value in a subsequent call to <code>ListShards</code> to list the next set of shards. For more information about the use of this pagination token when calling the <code>ListShards</code> operation, see <a>ListShardsInput$NextToken</a>.</p> <important> <p>Tokens expire after 300 seconds. When you obtain a value for <code>NextToken</code> in the response to a call to <code>ListShards</code>, you have 300 seconds to use that value. If you specify an expired token in a call to <code>ListShards</code>, you get <code>ExpiredNextTokenException</code>.</p> </important>"
}
}
},
"ListStreamsInput":{
"type":"structure",
"members":{
@ -936,6 +1006,11 @@
"type":"long",
"min":0
},
"NextToken":{
"type":"string",
"max":1048576,
"min":1
},
"PartitionKey":{
"type":"string",
"max":256,
@ -954,7 +1029,7 @@
"documentation":"<p>A message that provides information about the error.</p>"
}
},
"documentation":"<p>The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Streams Limits</a> in the <i>Amazon Kinesis Streams Developer Guide</i>, and <a href=\"http://docs.aws.amazon.com/general/latest/gr/api-retries.html\">Error Retries and Exponential Backoff in AWS</a> in the <i>AWS General Reference</i>.</p>",
"documentation":"<p>The request rate for the stream is too high, or the requested data is too large for the available throughput. Reduce the frequency or size of your requests. For more information, see <a href=\"http://docs.aws.amazon.com/kinesis/latest/dev/service-sizes-and-limits.html\">Streams Limits</a> in the <i>Amazon Kinesis Data Streams Developer Guide</i>, and <a href=\"http://docs.aws.amazon.com/general/latest/gr/api-retries.html\">Error Retries and Exponential Backoff in AWS</a> in the <i>AWS General Reference</i>.</p>",
"exception":true
},
"PutRecordInput":{
@ -975,7 +1050,7 @@
},
"PartitionKey":{
"shape":"PartitionKey",
"documentation":"<p>Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.</p>"
"documentation":"<p>Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.</p>"
},
"ExplicitHashKey":{
"shape":"HashKey",
@ -1005,7 +1080,7 @@
},
"EncryptionType":{
"shape":"EncryptionType",
"documentation":"<p>The encryption type to use on the record. This parameter can be one of the following values:</p> <ul> <li> <p> <code>NONE</code>: Do not encrypt the records in the stream.</p> </li> <li> <p> <code>KMS</code>: Use server-side encryption on the records in the stream using a customer-managed KMS key.</p> </li> </ul>"
"documentation":"<p>The encryption type to use on the record. This parameter can be one of the following values:</p> <ul> <li> <p> <code>NONE</code>: Do not encrypt the records in the stream.</p> </li> <li> <p> <code>KMS</code>: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.</p> </li> </ul>"
}
},
"documentation":"<p>Represents the output for <code>PutRecord</code>.</p>"
@ -1042,7 +1117,7 @@
},
"EncryptionType":{
"shape":"EncryptionType",
"documentation":"<p>The encryption type used on the records. This parameter can be one of the following values:</p> <ul> <li> <p> <code>NONE</code>: Do not encrypt the records.</p> </li> <li> <p> <code>KMS</code>: Use server-side encryption on the records using a customer-managed KMS key.</p> </li> </ul>"
"documentation":"<p>The encryption type used on the records. This parameter can be one of the following values:</p> <ul> <li> <p> <code>NONE</code>: Do not encrypt the records.</p> </li> <li> <p> <code>KMS</code>: Use server-side encryption on the records using a customer-managed AWS KMS key.</p> </li> </ul>"
}
},
"documentation":"<p> <code>PutRecords</code> results.</p>"
@ -1064,7 +1139,7 @@
},
"PartitionKey":{
"shape":"PartitionKey",
"documentation":"<p>Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.</p>"
"documentation":"<p>Determines which shard in the stream the data record is assigned to. Partition keys are Unicode strings with a maximum length limit of 256 characters for each key. Amazon Kinesis Data Streams uses the partition key as input to a hash function that maps the partition key and associated data to a specific shard. Specifically, an MD5 hash function is used to map partition keys to 128-bit integer values and to map associated data records to shards. As a result of this hashing mechanism, all data records with the same partition key map to the same shard within the stream.</p>"
}
},
"documentation":"<p>Represents the output for <code>PutRecords</code>.</p>"
@ -1121,7 +1196,7 @@
},
"Data":{
"shape":"Data",
"documentation":"<p>The data blob. The data in the blob is both opaque and immutable to Kinesis Streams, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).</p>"
"documentation":"<p>The data blob. The data in the blob is both opaque and immutable to Kinesis Data Streams, which does not inspect, interpret, or change the data in the blob in any way. When the data blob (the payload before base64-encoding) is added to the partition key size, the total size must not exceed the maximum record size (1 MB).</p>"
},
"PartitionKey":{
"shape":"PartitionKey",
@ -1129,10 +1204,10 @@
},
"EncryptionType":{
"shape":"EncryptionType",
"documentation":"<p>The encryption type used on the record. This parameter can be one of the following values:</p> <ul> <li> <p> <code>NONE</code>: Do not encrypt the records in the stream.</p> </li> <li> <p> <code>KMS</code>: Use server-side encryption on the records in the stream using a customer-managed KMS key.</p> </li> </ul>"
"documentation":"<p>The encryption type used on the record. This parameter can be one of the following values:</p> <ul> <li> <p> <code>NONE</code>: Do not encrypt the records in the stream.</p> </li> <li> <p> <code>KMS</code>: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.</p> </li> </ul>"
}
},
"documentation":"<p>The unit of data of the Kinesis stream, which is composed of a sequence number, a partition key, and a data blob.</p>"
"documentation":"<p>The unit of data of the Kinesis data stream, which is composed of a sequence number, a partition key, and a data blob.</p>"
},
"RecordList":{
"type":"list",
@ -1178,6 +1253,11 @@
"documentation":"<p>The requested resource could not be found. The stream might not be specified correctly.</p>",
"exception":true
},
"RetentionPeriodHours":{
"type":"integer",
"max":168,
"min":1
},
"ScalingType":{
"type":"string",
"enum":["UNIFORM_SCALING"]
@ -1230,7 +1310,7 @@
"documentation":"<p>The range of possible sequence numbers for the shard.</p>"
}
},
"documentation":"<p>A uniquely identified group of data records in a Kinesis stream.</p>"
"documentation":"<p>A uniquely identified group of data records in a Kinesis data stream.</p>"
},
"ShardCountObject":{
"type":"integer",
@ -1303,7 +1383,7 @@
},
"KeyId":{
"shape":"KeyId",
"documentation":"<p>The GUID for the customer-managed KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Streams by specifying the alias <code>aws/kinesis</code>.</p> <ul> <li> <p>Key ARN example: <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias ARN example: <code>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code> </p> </li> <li> <p>Globally unique key ID example: <code>12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias name example: <code>alias/MyAliasName</code> </p> </li> <li> <p>Master key owned by Kinesis Streams: <code>alias/aws/kinesis</code> </p> </li> </ul>"
"documentation":"<p>The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data Streams by specifying the alias <code>aws/kinesis</code>.</p> <ul> <li> <p>Key ARN example: <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias ARN example: <code>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code> </p> </li> <li> <p>Globally unique key ID example: <code>12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias name example: <code>alias/MyAliasName</code> </p> </li> <li> <p>Master key owned by Kinesis Data Streams: <code>alias/aws/kinesis</code> </p> </li> </ul>"
}
}
},
@ -1325,7 +1405,7 @@
},
"KeyId":{
"shape":"KeyId",
"documentation":"<p>The GUID for the customer-managed KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Streams by specifying the alias <code>aws/kinesis</code>.</p> <ul> <li> <p>Key ARN example: <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias ARN example: <code>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code> </p> </li> <li> <p>Globally unique key ID example: <code>12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias name example: <code>alias/MyAliasName</code> </p> </li> <li> <p>Master key owned by Kinesis Streams: <code>alias/aws/kinesis</code> </p> </li> </ul>"
"documentation":"<p>The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data Streams by specifying the alias <code>aws/kinesis</code>.</p> <ul> <li> <p>Key ARN example: <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias ARN example: <code>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code> </p> </li> <li> <p>Globally unique key ID example: <code>12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias name example: <code>alias/MyAliasName</code> </p> </li> <li> <p>Master key owned by Kinesis Data Streams: <code>alias/aws/kinesis</code> </p> </li> </ul>"
}
}
},
@ -1353,7 +1433,7 @@
},
"StreamStatus":{
"shape":"StreamStatus",
"documentation":"<p>The current status of the stream being described. The stream status is one of the following states:</p> <ul> <li> <p> <code>CREATING</code> - The stream is being created. Kinesis Streams immediately returns and sets <code>StreamStatus</code> to <code>CREATING</code>.</p> </li> <li> <p> <code>DELETING</code> - The stream is being deleted. The specified stream is in the <code>DELETING</code> state until Kinesis Streams completes the deletion.</p> </li> <li> <p> <code>ACTIVE</code> - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an <code>ACTIVE</code> stream.</p> </li> <li> <p> <code>UPDATING</code> - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state.</p> </li> </ul>"
"documentation":"<p>The current status of the stream being described. The stream status is one of the following states:</p> <ul> <li> <p> <code>CREATING</code> - The stream is being created. Kinesis Data Streams immediately returns and sets <code>StreamStatus</code> to <code>CREATING</code>.</p> </li> <li> <p> <code>DELETING</code> - The stream is being deleted. The specified stream is in the <code>DELETING</code> state until Kinesis Data Streams completes the deletion.</p> </li> <li> <p> <code>ACTIVE</code> - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an <code>ACTIVE</code> stream.</p> </li> <li> <p> <code>UPDATING</code> - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state.</p> </li> </ul>"
},
"Shards":{
"shape":"ShardList",
@ -1364,7 +1444,7 @@
"documentation":"<p>If set to <code>true</code>, more shards in the stream are available to describe.</p>"
},
"RetentionPeriodHours":{
"shape":"PositiveIntegerObject",
"shape":"RetentionPeriodHours",
"documentation":"<p>The current retention period, in hours.</p>"
},
"StreamCreationTimestamp":{
@ -1377,11 +1457,11 @@
},
"EncryptionType":{
"shape":"EncryptionType",
"documentation":"<p>The server-side encryption type used on the stream. This parameter can be one of the following values:</p> <ul> <li> <p> <code>NONE</code>: Do not encrypt the records in the stream.</p> </li> <li> <p> <code>KMS</code>: Use server-side encryption on the records in the stream using a customer-managed KMS key.</p> </li> </ul>"
"documentation":"<p>The server-side encryption type used on the stream. This parameter can be one of the following values:</p> <ul> <li> <p> <code>NONE</code>: Do not encrypt the records in the stream.</p> </li> <li> <p> <code>KMS</code>: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.</p> </li> </ul>"
},
"KeyId":{
"shape":"KeyId",
"documentation":"<p>The GUID for the customer-managed KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Streams by specifying the alias <code>aws/kinesis</code>.</p> <ul> <li> <p>Key ARN example: <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias ARN example: <code>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code> </p> </li> <li> <p>Globally unique key ID example: <code>12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias name example: <code>alias/MyAliasName</code> </p> </li> <li> <p>Master key owned by Kinesis Streams: <code>alias/aws/kinesis</code> </p> </li> </ul>"
"documentation":"<p>The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data Streams by specifying the alias <code>aws/kinesis</code>.</p> <ul> <li> <p>Key ARN example: <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias ARN example: <code>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code> </p> </li> <li> <p>Globally unique key ID example: <code>12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias name example: <code>alias/MyAliasName</code> </p> </li> <li> <p>Master key owned by Kinesis Data Streams: <code>alias/aws/kinesis</code> </p> </li> </ul>"
}
},
"documentation":"<p>Represents the output for <a>DescribeStream</a>.</p>"
@ -1408,7 +1488,7 @@
},
"StreamStatus":{
"shape":"StreamStatus",
"documentation":"<p>The current status of the stream being described. The stream status is one of the following states:</p> <ul> <li> <p> <code>CREATING</code> - The stream is being created. Kinesis Streams immediately returns and sets <code>StreamStatus</code> to <code>CREATING</code>.</p> </li> <li> <p> <code>DELETING</code> - The stream is being deleted. The specified stream is in the <code>DELETING</code> state until Kinesis Streams completes the deletion.</p> </li> <li> <p> <code>ACTIVE</code> - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an <code>ACTIVE</code> stream.</p> </li> <li> <p> <code>UPDATING</code> - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state.</p> </li> </ul>"
"documentation":"<p>The current status of the stream being described. The stream status is one of the following states:</p> <ul> <li> <p> <code>CREATING</code> - The stream is being created. Kinesis Data Streams immediately returns and sets <code>StreamStatus</code> to <code>CREATING</code>.</p> </li> <li> <p> <code>DELETING</code> - The stream is being deleted. The specified stream is in the <code>DELETING</code> state until Kinesis Data Streams completes the deletion.</p> </li> <li> <p> <code>ACTIVE</code> - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an <code>ACTIVE</code> stream.</p> </li> <li> <p> <code>UPDATING</code> - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the <code>UPDATING</code> state.</p> </li> </ul>"
},
"RetentionPeriodHours":{
"shape":"PositiveIntegerObject",
@ -1428,7 +1508,7 @@
},
"KeyId":{
"shape":"KeyId",
"documentation":"<p>The GUID for the customer-managed KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Streams by specifying the alias <code>aws/kinesis</code>.</p> <ul> <li> <p>Key ARN example: <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias ARN example: <code> arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code> </p> </li> <li> <p>Globally unique key ID example: <code>12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias name example: <code>alias/MyAliasName</code> </p> </li> <li> <p>Master key owned by Kinesis: <code>alias/aws/kinesis</code> </p> </li> </ul>"
"documentation":"<p>The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by \"alias/\".You can also use a master key owned by Kinesis Data Streams by specifying the alias <code>aws/kinesis</code>.</p> <ul> <li> <p>Key ARN example: <code>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias ARN example: <code> arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</code> </p> </li> <li> <p>Globally unique key ID example: <code>12345678-1234-1234-1234-123456789012</code> </p> </li> <li> <p>Alias name example: <code>alias/MyAliasName</code> </p> </li> <li> <p>Master key owned by Kinesis Data Streams: <code>alias/aws/kinesis</code> </p> </li> </ul>"
},
"OpenShardCount":{
"shape":"ShardCountObject",
@ -1540,5 +1620,5 @@
}
}
},
"documentation":"<fullname>Amazon Kinesis Streams Service API Reference</fullname> <p>Amazon Kinesis Streams is a managed service that scales elastically for real time processing of streaming big data.</p>"
"documentation":"<fullname>Amazon Kinesis Data Streams Service API Reference</fullname> <p>Amazon Kinesis Data Streams is a managed service that scales elastically for real-time processing of streaming big data.</p>"
}

25
botocore/data/lex-models/2017-04-19/service-2.json
View file

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceFullName":"Amazon Lex Model Building Service",
"serviceId":"Lex Model Building Service",
"signatureVersion":"v4",
"signingName":"lex",
"uid":"lex-models-2017-04-19"
@ -225,7 +226,7 @@
{"shape":"InternalFailureException"},
{"shape":"BadRequestException"}
],
"documentation":"<p>Deletes stored utterances.</p> <p>Amazon Lex stores the utterances that users send to your bot unless the <code>childDirected</code> field in the bot is set to <code>true</code>. Utterances are stored for 15 days for use with the <a>GetUtterancesView</a> operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input.</p> <p>Use the <code>DeleteStoredUtterances</code> operation to manually delete stored utterances for a specific user.</p> <p>This operation requires permissions for the <code>lex:DeleteUtterances</code> action.</p>"
"documentation":"<p>Deletes stored utterances.</p> <p>Amazon Lex stores the utterances that users send to your bot. Utterances are stored for 15 days for use with the <a>GetUtterancesView</a> operation, and then stored indefinitely for use in improving the ability of your bot to respond to user input.</p> <p>Use the <code>DeleteStoredUtterances</code> operation to manually delete stored utterances for a specific user.</p> <p>This operation requires permissions for the <code>lex:DeleteUtterances</code> action.</p>"
},
"GetBot":{
"name":"GetBot",
@ -526,7 +527,7 @@
{"shape":"InternalFailureException"},
{"shape":"BadRequestException"}
],
"documentation":"<p>Use the <code>GetUtterancesView</code> operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to.</p> <p>For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the <code>GetUtterancesView</code> operation to see the requests that they have made and whether they have been successful. You might find that the utterance \"I want flowers\" is not being recognized. You could add this utterance to the <code>OrderFlowers</code> intent so that your bot recognizes that utterance.</p> <p>After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions. </p> <p>Data is available for the last 15 days. You can request information for up to 5 versions in each request. The response contains information about a maximum of 100 utterances for each version.</p> <p>If the bot's <code>childDirected</code> field is set to <code>true</code>, utterances for the bot are not stored and cannot be retrieved with the <code>GetUtterancesView</code> operation. For more information, see <a>PutBot</a>.</p> <p>This operation requires permissions for the <code>lex:GetUtterancesView</code> action.</p>"
"documentation":"<p>Use the <code>GetUtterancesView</code> operation to get information about the utterances that your users have made to your bot. You can use this list to tune the utterances that your bot responds to.</p> <p>For example, say that you have created a bot to order flowers. After your users have used your bot for a while, use the <code>GetUtterancesView</code> operation to see the requests that they have made and whether they have been successful. You might find that the utterance \"I want flowers\" is not being recognized. You could add this utterance to the <code>OrderFlowers</code> intent so that your bot recognizes that utterance.</p> <p>After you publish a new version of a bot, you can get information about the old version and the new so that you can compare the performance across the two versions. </p> <note> <p>Utterance statistics are generated once a day. Data is available for the last 15 days. You can request information for up to 5 versions in each request. The response contains information about a maximum of 100 utterances for each version.</p> </note> <p>This operation requires permissions for the <code>lex:GetUtterancesView</code> action.</p>"
},
"PutBot":{
"name":"PutBot",
@ -544,7 +545,7 @@
{"shape":"BadRequestException"},
{"shape":"PreconditionFailedException"}
],
"documentation":"<p>Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with a name only, the bot is created or updated but Amazon Lex returns the <code/> response <code>FAILED</code>. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see <a>how-it-works</a>. </p> <p>If you specify the name of an existing bot, the fields in the request replace the existing values in the <code>$LATEST</code> version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the <code>idleTTLInSeconds</code> and <code>privacySettings</code> fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception.</p> <p>This operation requires permissions for the <code>lex:PutBot</code> action. For more information, see <a>auth-and-access-control</a>.</p>"
"documentation":"<p>Creates an Amazon Lex conversational bot or replaces an existing bot. When you create or update a bot you are only required to specify a name, a locale, and whether the bot is directed toward children under age 13. You can use this to add intents later, or to remove intents from an existing bot. When you create a bot with the minimum information, the bot is created or updated but Amazon Lex returns the <code/> response <code>FAILED</code>. You can build the bot after you add one or more intents. For more information about Amazon Lex bots, see <a>how-it-works</a>. </p> <p>If you specify the name of an existing bot, the fields in the request replace the existing values in the <code>$LATEST</code> version of the bot. Amazon Lex removes any fields that you don't provide values for in the request, except for the <code>idleTTLInSeconds</code> and <code>privacySettings</code> fields, which are set to their default values. If you don't specify values for required fields, Amazon Lex throws an exception.</p> <p>This operation requires permissions for the <code>lex:PutBot</code> action. For more information, see <a>auth-and-access-control</a>.</p>"
},
"PutBotAlias":{
"name":"PutBotAlias",
@ -833,7 +834,8 @@
"enum":[
"Facebook",
"Slack",
"Twilio-Sms"
"Twilio-Sms",
"Kik"
]
},
"CodeHook":{
@ -872,7 +874,8 @@
"type":"string",
"enum":[
"PlainText",
"SSML"
"SSML",
"CustomPayload"
]
},
"Count":{"type":"integer"},
@ -2233,6 +2236,12 @@
}
}
},
"GroupNumber":{
"type":"integer",
"box":true,
"max":5,
"min":1
},
"Intent":{
"type":"structure",
"required":[
@ -2363,6 +2372,10 @@
"content":{
"shape":"ContentString",
"documentation":"<p>The text of the message.</p>"
},
"groupNumber":{
"shape":"GroupNumber",
"documentation":"<p>Identifies the message group that the message belongs to. When a group is assigned to a message, Amazon Lex returns one message from each group in the response.</p>"
}
},
"documentation":"<p>The message object that provides the message text and its type.</p>"
@ -2370,7 +2383,7 @@
"MessageList":{
"type":"list",
"member":{"shape":"Message"},
"max":5,
"max":15,
"min":1
},
"MessageVersion":{

24
botocore/data/lex-runtime/2016-11-28/service-2.json
View file

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceFullName":"Amazon Lex Runtime Service",
"serviceId":"Lex Runtime Service",
"signatureVersion":"v4",
"signingName":"lex",
"uid":"runtime.lex-2016-11-28"
@ -209,6 +210,15 @@
"error":{"httpStatusCode":508},
"exception":true
},
"MessageFormatType":{
"type":"string",
"enum":[
"PlainText",
"CustomPayload",
"SSML",
"Composite"
]
},
"NotAcceptableException":{
"type":"structure",
"members":{
@ -319,10 +329,16 @@
},
"message":{
"shape":"Text",
"documentation":"<p> Message to convey to the user. It can come from the bot's configuration or a code hook (Lambda function). If the current intent is not configured with a code hook or if the code hook returned <code>Delegate</code> as the <code>dialogAction.type</code> in its response, then Amazon Lex decides the next course of action and selects an appropriate message from the bot configuration based on the current user interaction context. For example, if Amazon Lex is not able to understand the user input, it uses a clarification prompt message (For more information, see the Error Handling section in the Amazon Lex console). Another example: if the intent requires confirmation before fulfillment, then Amazon Lex uses the confirmation prompt message in the intent configuration. If the code hook returns a message, Amazon Lex passes it as-is in its response to the client. </p>",
"documentation":"<p>The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.</p> <p>If the intent is not configured with a Lambda function, or if the Lambda function returned <code>Delegate</code> as the <code>dialogAction.type</code> its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.</p> <p>When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see <a>msg-prompts-formats</a>.</p> <p>If the Lambda function returns a message, Amazon Lex passes it to the client in its response.</p>",
"location":"header",
"locationName":"x-amz-lex-message"
},
"messageFormat":{
"shape":"MessageFormatType",
"documentation":"<p>The format of the response message. One of the following values:</p> <ul> <li> <p> <code>PlainText</code> - The message contains plain UTF-8 text.</p> </li> <li> <p> <code>CustomPayload</code> - The message is a custom format for the client.</p> </li> <li> <p> <code>SSML</code> - The message contains text formatted for voice output.</p> </li> <li> <p> <code>Composite</code> - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.</p> </li> </ul>",
"location":"header",
"locationName":"x-amz-lex-message-format"
},
"dialogState":{
"shape":"DialogState",
"documentation":"<p>Identifies the current state of the user interaction. Amazon Lex returns one of the following values as <code>dialogState</code>. The client can optionally use this information to customize the user interface. </p> <ul> <li> <p> <code>ElicitIntent</code> - Amazon Lex wants to elicit the user's intent. Consider the following examples: </p> <p> For example, a user might utter an intent (\"I want to order a pizza\"). If Amazon Lex cannot infer the user intent from this utterance, it will return this dialog state. </p> </li> <li> <p> <code>ConfirmIntent</code> - Amazon Lex is expecting a \"yes\" or \"no\" response. </p> <p>For example, Amazon Lex wants user confirmation before fulfilling an intent. Instead of a simple \"yes\" or \"no\" response, a user might respond with additional information. For example, \"yes, but make it a thick crust pizza\" or \"no, I want to order a drink.\" Amazon Lex can process such additional information (in these examples, update the crust type slot or change the intent from OrderPizza to OrderDrink). </p> </li> <li> <p> <code>ElicitSlot</code> - Amazon Lex is expecting the value of a slot for the current intent. </p> <p> For example, suppose that in the response Amazon Lex sends this message: \"What size pizza would you like?\". A user might reply with the slot value (e.g., \"medium\"). The user might also provide additional information in the response (e.g., \"medium thick crust pizza\"). Amazon Lex can process such additional information appropriately. </p> </li> <li> <p> <code>Fulfilled</code> - Conveys that the Lambda function has successfully fulfilled the intent. </p> </li> <li> <p> <code>ReadyForFulfillment</code> - Conveys that the client has to fulfill the request. </p> </li> <li> <p> <code>Failed</code> - Conveys that the conversation with the user failed. </p> <p> This can happen for various reasons, including that the user does not provide an appropriate response to prompts from the service (you can configure how many times Amazon Lex can prompt a user for specific information), or if the Lambda function fails to fulfill the intent. </p> </li> </ul>",
@ -406,7 +422,11 @@
},
"message":{
"shape":"Text",
"documentation":"<p> A message to convey to the user. It can come from the bot's configuration or a code hook (Lambda function). If the current intent is not configured with a code hook or the code hook returned <code>Delegate</code> as the <code>dialogAction.type</code> in its response, then Amazon Lex decides the next course of action and selects an appropriate message from the bot configuration based on the current user interaction context. For example, if Amazon Lex is not able to understand the user input, it uses a clarification prompt message (for more information, see the Error Handling section in the Amazon Lex console). Another example: if the intent requires confirmation before fulfillment, then Amazon Lex uses the confirmation prompt message in the intent configuration. If the code hook returns a message, Amazon Lex passes it as-is in its response to the client. </p>"
"documentation":"<p>The message to convey to the user. The message can come from the bot's configuration or from a Lambda function.</p> <p>If the intent is not configured with a Lambda function, or if the Lambda function returned <code>Delegate</code> as the <code>dialogAction.type</code> its response, Amazon Lex decides on the next course of action and selects an appropriate message from the bot's configuration based on the current interaction context. For example, if Amazon Lex isn't able to understand user input, it uses a clarification prompt message.</p> <p>When you create an intent you can assign messages to groups. When messages are assigned to groups Amazon Lex returns one message from each group in the response. The message field is an escaped JSON string containing the messages. For more information about the structure of the JSON string returned, see <a>msg-prompts-formats</a>.</p> <p>If the Lambda function returns a message, Amazon Lex passes it to the client in its response.</p>"
},
"messageFormat":{
"shape":"MessageFormatType",
"documentation":"<p>The format of the response message. One of the following values:</p> <ul> <li> <p> <code>PlainText</code> - The message contains plain UTF-8 text.</p> </li> <li> <p> <code>CustomPayload</code> - The message is a custom format defined by the Lambda function.</p> </li> <li> <p> <code>SSML</code> - The message contains text formatted for voice output.</p> </li> <li> <p> <code>Composite</code> - The message contains an escaped JSON object containing one or more messages from the groups that messages were assigned to when the intent was created.</p> </li> </ul>"
},
"dialogState":{
"shape":"DialogState",

145
botocore/data/medialive/2017-10-14/service-2.json
View file

@ -655,6 +655,52 @@
}
],
"documentation": "Stops a running channel"
},
"UpdateChannel": {
"name": "UpdateChannel",
"http": {
"method": "PUT",
"requestUri": "/prod/channels/{channelId}",
"responseCode": 200
},
"input": {
"shape": "UpdateChannelRequest"
},
"output": {
"shape": "UpdateChannelResponse",
"documentation": "Channel is successfully updated."
},
"errors": [
{
"shape": "UnprocessableEntityException",
"documentation": "The channel configuration failed validation and could not be updated."
},
{
"shape": "BadRequestException",
"documentation": "This request was invalid."
},
{
"shape": "InternalServerErrorException",
"documentation": "Unexpected internal service error."
},
{
"shape": "ForbiddenException",
"documentation": "You do not have permission to update the channel."
},
{
"shape": "BadGatewayException",
"documentation": "Bad Gateway Error"
},
{
"shape": "GatewayTimeoutException",
"documentation": "Gateway Timeout Error"
},
{
"shape": "ConflictException",
"documentation": "The channel is unable to update due to an issue with channel resources."
}
],
"documentation": "Updates a channel."
}
},
"shapes": {
@ -1555,7 +1601,7 @@
"CaptionChannel": {
"shape": "__integer",
"locationName": "captionChannel",
"documentation": "Channel to insert closed captions. Each channel mapping must have a unique channel number (maximum of 4)"
"documentation": "The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)"
},
"LanguageCode": {
"shape": "__string",
@ -1823,7 +1869,8 @@
"Reserved": {
"shape": "__string",
"locationName": "reserved",
"documentation": "Reserved for future use."
"documentation": "Deprecated field that's only usable by whitelisted customers.",
"deprecated": true
},
"RoleArn": {
"shape": "__string",
@ -1868,7 +1915,8 @@
"Reserved": {
"shape": "__string",
"locationName": "reserved",
"documentation": "Reserved for future use."
"documentation": "Deprecated field that's only usable by whitelisted customers.",
"deprecated": true
},
"RoleArn": {
"shape": "__string",
@ -6122,6 +6170,97 @@
},
"documentation": "Placeholder documentation for UnprocessableEntityException"
},
"UpdateChannel": {
"type": "structure",
"members": {
"Destinations": {
"shape": "ListOfOutputDestination",
"locationName": "destinations",
"documentation": "A list of output destinations for this channel."
},
"EncoderSettings": {
"shape": "EncoderSettings",
"locationName": "encoderSettings",
"documentation": "The encoder settings for this channel."
},
"InputSpecification": {
"shape": "InputSpecification",
"locationName": "inputSpecification",
"documentation": "Specification of input for this channel (max. bitrate, resolution, codec, etc.)"
},
"Name": {
"shape": "__string",
"locationName": "name",
"documentation": "The name of the channel."
},
"RoleArn": {
"shape": "__string",
"locationName": "roleArn",
"documentation": "An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this on an update call but the role was previously set that role will be removed."
}
},
"documentation": "Placeholder documentation for UpdateChannel"
},
"UpdateChannelRequest": {
"type": "structure",
"members": {
"ChannelId": {
"shape": "__string",
"location": "uri",
"locationName": "channelId",
"documentation": "channel ID"
},
"Destinations": {
"shape": "ListOfOutputDestination",
"locationName": "destinations",
"documentation": "A list of output destinations for this channel."
},
"EncoderSettings": {
"shape": "EncoderSettings",
"locationName": "encoderSettings",
"documentation": "The encoder settings for this channel."
},
"InputSpecification": {
"shape": "InputSpecification",
"locationName": "inputSpecification",
"documentation": "Specification of input for this channel (max. bitrate, resolution, codec, etc.)"
},
"Name": {
"shape": "__string",
"locationName": "name",
"documentation": "The name of the channel."
},
"RoleArn": {
"shape": "__string",
"locationName": "roleArn",
"documentation": "An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this on an update call but the role was previously set that role will be removed."
}
},
"documentation": "A request to update a channel.",
"required": [
"ChannelId"
]
},
"UpdateChannelResponse": {
"type": "structure",
"members": {
"Channel": {
"shape": "Channel",
"locationName": "channel"
}
},
"documentation": "Placeholder documentation for UpdateChannelResponse"
},
"UpdateChannelResultModel": {
"type": "structure",
"members": {
"Channel": {
"shape": "Channel",
"locationName": "channel"
}
},
"documentation": "The updated channel's description."
},
"ValidationError": {
"type": "structure",
"members": {

192
botocore/data/mediastore/2017-09-01/service-2.json
View file

@ -60,6 +60,22 @@
],
"documentation":"<p>Deletes the access policy that is associated with the specified container.</p>"
},
"DeleteCorsPolicy":{
"name":"DeleteCorsPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteCorsPolicyInput"},
"output":{"shape":"DeleteCorsPolicyOutput"},
"errors":[
{"shape":"ContainerInUseException"},
{"shape":"ContainerNotFoundException"},
{"shape":"CorsPolicyNotFoundException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.</p> <p>To use this operation, you must have permission to perform the <code>MediaStore:DeleteCorsPolicy</code> action. The container owner has this permission by default and can grant this permission to others.</p>"
},
"DescribeContainer":{
"name":"DescribeContainer",
"http":{
@ -72,7 +88,7 @@
{"shape":"ContainerNotFoundException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Retrieves the properties of the requested container. This returns a single <code>Container</code> object based on <code>ContainerName</code>. To return all <code>Container</code> objects that are associated with a specified AWS account, use <a>ListContainers</a>.</p>"
"documentation":"<p>Retrieves the properties of the requested container. This request is commonly used to retrieve the endpoint of a container. An endpoint is a value assigned by the service when a new container is created. A container's endpoint does not change after it has been assigned. The <code>DescribeContainer</code> request returns a single <code>Container</code> object based on <code>ContainerName</code>. To return all <code>Container</code> objects that are associated with a specified AWS account, use <a>ListContainers</a>.</p>"
},
"GetContainerPolicy":{
"name":"GetContainerPolicy",
@ -90,6 +106,22 @@
],
"documentation":"<p>Retrieves the access policy for the specified container. For information about the data that is included in an access policy, see the <a href=\"https://aws.amazon.com/documentation/iam/\">AWS Identity and Access Management User Guide</a>.</p>"
},
"GetCorsPolicy":{
"name":"GetCorsPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetCorsPolicyInput"},
"output":{"shape":"GetCorsPolicyOutput"},
"errors":[
{"shape":"ContainerInUseException"},
{"shape":"ContainerNotFoundException"},
{"shape":"CorsPolicyNotFoundException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.</p> <p>To use this operation, you must have permission to perform the <code>MediaStore:GetCorsPolicy</code> action. By default, the container owner has this permission and can grant it to others.</p>"
},
"ListContainers":{
"name":"ListContainers",
"http":{
@ -117,15 +149,44 @@
{"shape":"InternalServerError"}
],
"documentation":"<p>Creates an access policy for the specified container to restrict the users and clients that can access it. For information about the data that is included in an access policy, see the <a href=\"https://aws.amazon.com/documentation/iam/\">AWS Identity and Access Management User Guide</a>.</p> <p>For this release of the REST API, you can create only one policy for a container. If you enter <code>PutContainerPolicy</code> twice, the second command modifies the existing policy. </p>"
},
"PutCorsPolicy":{
"name":"PutCorsPolicy",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutCorsPolicyInput"},
"output":{"shape":"PutCorsPolicyOutput"},
"errors":[
{"shape":"ContainerNotFoundException"},
{"shape":"ContainerInUseException"},
{"shape":"InternalServerError"}
],
"documentation":"<p>Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your AWS Elemental MediaStore container at my.example.container.com by using the browser's XMLHttpRequest capability.</p> <p>To enable CORS on a container, you attach a CORS policy to the container. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container. The policy can contain up to 398,000 characters. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.</p>"
}
},
"shapes":{
"AllowedHeaders":{
"type":"list",
"member":{"shape":"Header"},
"max":100,
"min":0
},
"AllowedMethods":{
"type":"list",
"member":{"shape":"MethodName"}
},
"AllowedOrigins":{
"type":"list",
"member":{"shape":"Origin"}
},
"Container":{
"type":"structure",
"members":{
"Endpoint":{
"shape":"Endpoint",
"documentation":"<p>The DNS endpoint of the container. Use from 1 to 255 characters. Use this endpoint to identify this container when sending requests to the data plane. </p>"
"documentation":"<p>The DNS endpoint of the container. Use the endpoint to identify the specific container when sending requests to the data plane. The service assigns this value when the container is created. Once the value has been assigned, it does not change.</p>"
},
"CreationTime":{
"shape":"TimeStamp",
@ -199,6 +260,47 @@
"max":16,
"min":1
},
"CorsPolicy":{
"type":"list",
"member":{"shape":"CorsRule"},
"documentation":"<p>The CORS policy of the container. </p>",
"max":100,
"min":1
},
"CorsPolicyNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Could not perform an operation on a policy that does not exist.</p>",
"exception":true
},
"CorsRule":{
"type":"structure",
"members":{
"AllowedOrigins":{
"shape":"AllowedOrigins",
"documentation":"<p>One or more response headers that you want users to be able to access from their applications (for example, from a JavaScript <code>XMLHttpRequest</code> object).</p> <p>Each CORS rule must have at least one <code>AllowedOrigin</code> element. The string value can include only one wildcard character (*), for example, http://*.example.com. Additionally, you can specify only one wildcard character to allow cross-origin access for all origins.</p>"
},
"AllowedMethods":{
"shape":"AllowedMethods",
"documentation":"<p>Identifies an HTTP method that the origin that is specified in the rule is allowed to execute.</p> <p>Each CORS rule must contain at least one <code>AllowedMethod</code> and one <code>AllowedOrigin</code> element.</p>"
},
"AllowedHeaders":{
"shape":"AllowedHeaders",
"documentation":"<p>Specifies which headers are allowed in a preflight <code>OPTIONS</code> request through the <code>Access-Control-Request-Headers</code> header. Each header name that is specified in <code>Access-Control-Request-Headers</code> must have a corresponding entry in the rule. Only the headers that were requested are sent back. </p> <p>This element can contain only one wildcard character (*).</p>"
},
"MaxAgeSeconds":{
"shape":"MaxAgeSeconds",
"documentation":"<p>The time in seconds that your browser caches the preflight response for the specified resource.</p> <p>A CORS rule can have only one <code>MaxAgeSeconds</code> element.</p>"
},
"ExposeHeaders":{
"shape":"ExposeHeaders",
"documentation":"<p>One or more headers in the response that you want users to be able to access from their applications (for example, from a JavaScript <code>XMLHttpRequest</code> object).</p> <p>This element is optional for each rule.</p>"
}
},
"documentation":"<p>A rule for a CORS policy. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed.</p>"
},
"CreateContainerInput":{
"type":"structure",
"required":["ContainerName"],
@ -215,7 +317,7 @@
"members":{
"Container":{
"shape":"Container",
"documentation":"<p>ContainerARN: The Amazon Resource Name (ARN) of the newly created container. The ARN has the following format: arn:aws:&lt;region&gt;:&lt;account that owns this container&gt;:container/&lt;name of container&gt;. For example: arn:aws:mediastore:us-west-2:111122223333:container/movies </p> <p>ContainerName: The container name as specified in the request.</p> <p>CreationTime: Unix timestamp.</p> <p>Status: The status of container creation or deletion. The status is one of the following: <code>CREATING</code>, <code>ACTIVE</code>, or <code>DELETING</code>. While the service is creating the container, the status is <code>CREATING</code>. When an endpoint is available, the status changes to <code>ACTIVE</code>.</p> <p>The return value does not include the container's endpoint. To make downstream requests, you must obtain this value by using <a>DescribeContainer</a> or <a>ListContainers</a>.</p>"
"documentation":"<p>ContainerARN: The Amazon Resource Name (ARN) of the newly created container. The ARN has the following format: arn:aws:&lt;region&gt;:&lt;account that owns this container&gt;:container/&lt;name of container&gt;. For example: arn:aws:mediastore:us-west-2:111122223333:container/movies </p> <p>ContainerName: The container name as specified in the request.</p> <p>CreationTime: Unix time stamp.</p> <p>Status: The status of container creation or deletion. The status is one of the following: <code>CREATING</code>, <code>ACTIVE</code>, or <code>DELETING</code>. While the service is creating the container, the status is <code>CREATING</code>. When an endpoint is available, the status changes to <code>ACTIVE</code>.</p> <p>The return value does not include the container's endpoint. To make downstream requests, you must obtain this value by using <a>DescribeContainer</a> or <a>ListContainers</a>.</p>"
}
}
},
@ -249,6 +351,21 @@
"members":{
}
},
"DeleteCorsPolicyInput":{
"type":"structure",
"required":["ContainerName"],
"members":{
"ContainerName":{
"shape":"ContainerName",
"documentation":"<p>The name of the container to remove the policy from.</p>"
}
}
},
"DeleteCorsPolicyOutput":{
"type":"structure",
"members":{
}
},
"DescribeContainerInput":{
"type":"structure",
"members":{
@ -278,6 +395,12 @@
"min":1,
"pattern":"[ \\w:\\.\\?-]+"
},
"ExposeHeaders":{
"type":"list",
"member":{"shape":"Header"},
"max":100,
"min":0
},
"GetContainerPolicyInput":{
"type":"structure",
"required":["ContainerName"],
@ -298,6 +421,29 @@
}
}
},
"GetCorsPolicyInput":{
"type":"structure",
"required":["ContainerName"],
"members":{
"ContainerName":{
"shape":"ContainerName",
"documentation":"<p>The name of the container that the policy is assigned to.</p>"
}
}
},
"GetCorsPolicyOutput":{
"type":"structure",
"required":["CorsPolicy"],
"members":{
"CorsPolicy":{"shape":"CorsPolicy"}
}
},
"Header":{
"type":"string",
"max":8192,
"min":1,
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+"
},
"InternalServerError":{
"type":"structure",
"members":{
@ -342,6 +488,24 @@
}
}
},
"MaxAgeSeconds":{
"type":"integer",
"max":2147483647,
"min":0
},
"MethodName":{
"type":"string",
"enum":[
"PUT",
"GET",
"DELETE",
"HEAD"
]
},
"Origin":{
"type":"string",
"pattern":"[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+"
},
"PaginationToken":{
"type":"string",
"max":255,
@ -378,6 +542,28 @@
"members":{
}
},
"PutCorsPolicyInput":{
"type":"structure",
"required":[
"ContainerName",
"CorsPolicy"
],
"members":{
"ContainerName":{
"shape":"ContainerName",
"documentation":"<p>The name of the container that you want to assign the CORS policy to.</p>"
},
"CorsPolicy":{
"shape":"CorsPolicy",
"documentation":"<p>The CORS policy to apply to the container. </p>"
}
}
},
"PutCorsPolicyOutput":{
"type":"structure",
"members":{
}
},
"TimeStamp":{"type":"timestamp"}
},
"documentation":"<p>An AWS Elemental MediaStore container is a namespace that holds folders and objects. You use a container endpoint to create, read, and delete objects. </p>"

108
botocore/data/opsworks/2013-02-18/service-2.json
View file

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS OpsWorks",
"serviceId":"OpsWorks",
"signatureVersion":"v4",
"targetPrefix":"OpsWorks_20130218",
"uid":"opsworks-2013-02-18"
@ -438,6 +439,15 @@
"output":{"shape":"DescribeMyUserProfileResult"},
"documentation":"<p>Describes a user's SSH information.</p> <p> <b>Required Permissions</b>: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information on user permissions, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html\">Managing User Permissions</a>.</p>"
},
"DescribeOperatingSystems":{
"name":"DescribeOperatingSystems",
"http":{
"method":"POST",
"requestUri":"/"
},
"output":{"shape":"DescribeOperatingSystemsResponse"},
"documentation":"<p>Describes the operating systems that are supported by AWS OpsWorks Stacks.</p>"
},
"DescribePermissions":{
"name":"DescribePermissions",
"http":{
@ -1289,7 +1299,7 @@
},
"DefaultOs":{
"shape":"String",
"documentation":"<p>The stack's operating system, which must be set to one of the following.</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p> <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> <li> <p>A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\">Using Custom AMIs</a>.</p> </li> </ul> <p>The default option is the parent stack's operating system. For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p> <note> <p>You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.</p> </note>"
"documentation":"<p>The stack's operating system, which must be set to one of the following.</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p> <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> <li> <p>A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\">Using Custom AMIs</a>.</p> </li> </ul> <p>The default option is the parent stack's operating system. For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p> <note> <p>You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.</p> </note>"
},
"HostnameTheme":{
"shape":"String",
@ -1734,7 +1744,7 @@
},
"Os":{
"shape":"String",
"documentation":"<p>The instance's operating system, which must be set to one of the following.</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> <li> <p>A custom AMI: <code>Custom</code>.</p> </li> </ul> <p>For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p> <p>The default option is the current Amazon Linux version. If you set this parameter to <code>Custom</code>, you must use the <a>CreateInstance</a> action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is <code>Custom</code>. For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">Operating Systems</a>For more information on how to use custom AMIs with AWS OpsWorks Stacks, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\">Using Custom AMIs</a>.</p>"
"documentation":"<p>The instance's operating system, which must be set to one of the following.</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> <li> <p>A custom AMI: <code>Custom</code>.</p> </li> </ul> <p>For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p> <p>The default option is the current Amazon Linux version. If you set this parameter to <code>Custom</code>, you must use the <a>CreateInstance</a> action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is <code>Custom</code>. For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">Operating Systems</a>For more information on how to use custom AMIs with AWS OpsWorks Stacks, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\">Using Custom AMIs</a>.</p>"
},
"AmiId":{
"shape":"String",
@ -1924,7 +1934,7 @@
},
"DefaultOs":{
"shape":"String",
"documentation":"<p>The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> <li> <p>A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\"> Using Custom AMIs</a>.</p> </li> </ul> <p>The default option is the current Amazon Linux version. For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p>"
"documentation":"<p>The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> <li> <p>A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\"> Using Custom AMIs</a>.</p> </li> </ul> <p>The default option is the current Amazon Linux version. For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p>"
},
"HostnameTheme":{
"shape":"String",
@ -2025,7 +2035,7 @@
"members":{
"Type":{
"shape":"String",
"documentation":"<p>The data source's type, <code>AutoSelectOpsworksMysqlInstance</code>, <code>OpsworksMysqlInstance</code>, or <code>RdsDbInstance</code>.</p>"
"documentation":"<p>The data source's type, <code>AutoSelectOpsworksMysqlInstance</code>, <code>OpsworksMysqlInstance</code>, <code>RdsDbInstance</code>, or <code>None</code>.</p>"
},
"Arn":{
"shape":"String",
@ -2321,15 +2331,15 @@
"members":{
"StackId":{
"shape":"String",
"documentation":"<p>The stack ID. If you include this parameter, <code>DescribeDeployments</code> returns a description of the commands associated with the specified stack.</p>"
"documentation":"<p>The stack ID. If you include this parameter, the command returns a description of the commands associated with the specified stack.</p>"
},
"AppId":{
"shape":"String",
"documentation":"<p>The app ID. If you include this parameter, <code>DescribeDeployments</code> returns a description of the commands associated with the specified app.</p>"
"documentation":"<p>The app ID. If you include this parameter, the command returns a description of the commands associated with the specified app.</p>"
},
"DeploymentIds":{
"shape":"Strings",
"documentation":"<p>An array of deployment IDs to be described. If you include this parameter, <code>DescribeDeployments</code> returns a description of the specified deployments. Otherwise, it returns a description of every deployment.</p>"
"documentation":"<p>An array of deployment IDs to be described. If you include this parameter, the command returns a description of the specified deployments. Otherwise, it returns a description of every deployment.</p>"
}
}
},
@ -2508,6 +2518,13 @@
},
"documentation":"<p>Contains the response to a <code>DescribeMyUserProfile</code> request.</p>"
},
"DescribeOperatingSystemsResponse":{
"type":"structure",
"members":{
"OperatingSystems":{"shape":"OperatingSystems"}
},
"documentation":"<p>The response to a <code>DescribeOperatingSystems</code> request.</p>"
},
"DescribePermissionsRequest":{
"type":"structure",
"members":{
@ -2790,7 +2807,7 @@
},
"VolumeType":{
"shape":"VolumeType",
"documentation":"<p>The volume type. <code>gp2</code> for General Purpose (SSD) volumes, <code>io1</code> for Provisioned IOPS (SSD) volumes, and <code>standard</code> for Magnetic volumes.</p>"
"documentation":"<p>The volume type. <code>gp2</code> for General Purpose (SSD) volumes, <code>io1</code> for Provisioned IOPS (SSD) volumes, <code>st1</code> for Throughput Optimized hard disk drives (HDD), <code>sc1</code> for Cold HDD,and <code>standard</code> for Magnetic volumes.</p> <p>If you specify the <code>io1</code> volume type, you must also specify a value for the <code>Iops</code> attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size).</p>"
},
"DeleteOnTermination":{
"shape":"Boolean",
@ -3220,6 +3237,7 @@
"shape":"Integer",
"documentation":"<p>The number of instances with <code>start_failed</code> status.</p>"
},
"StopFailed":{"shape":"Integer"},
"Stopped":{
"shape":"Integer",
"documentation":"<p>The number of instances with <code>stopped</code> status.</p>"
@ -3471,6 +3489,62 @@
"min":1
},
"NextToken":{"type":"string"},
"OperatingSystem":{
"type":"structure",
"members":{
"Name":{
"shape":"String",
"documentation":"<p>The name of the operating system, such as <code>Amazon Linux 2017.09</code>.</p>"
},
"Id":{
"shape":"String",
"documentation":"<p>The ID of a supported operating system, such as <code>Amazon Linux 2017.09</code>.</p>"
},
"Type":{
"shape":"String",
"documentation":"<p>The type of a supported operating system, either <code>Linux</code> or <code>Windows</code>.</p>"
},
"ConfigurationManagers":{
"shape":"OperatingSystemConfigurationManagers",
"documentation":"<p>Supported configuration manager name and versions for an AWS OpsWorks Stacks operating system.</p>"
},
"ReportedName":{
"shape":"String",
"documentation":"<p>A short name for the operating system manufacturer.</p>"
},
"ReportedVersion":{
"shape":"String",
"documentation":"<p>The version of the operating system, including the release and edition, if applicable.</p>"
},
"Supported":{
"shape":"Boolean",
"documentation":"<p>Indicates that an operating system is not supported for new instances.</p>"
}
},
"documentation":"<p>Describes supported operating systems in AWS OpsWorks Stacks.</p>"
},
"OperatingSystemConfigurationManager":{
"type":"structure",
"members":{
"Name":{
"shape":"String",
"documentation":"<p>The name of the configuration manager, which is Chef.</p>"
},
"Version":{
"shape":"String",
"documentation":"<p>The versions of the configuration manager that are supported by an operating system.</p>"
}
},
"documentation":"<p>A block that contains information about the configuration manager (Chef) and the versions of the configuration manager that are supported for an operating system.</p>"
},
"OperatingSystemConfigurationManagers":{
"type":"list",
"member":{"shape":"OperatingSystemConfigurationManager"}
},
"OperatingSystems":{
"type":"list",
"member":{"shape":"OperatingSystem"}
},
"Parameters":{
"type":"map",
"key":{"shape":"String"},
@ -4207,7 +4281,8 @@
"InstanceId":{
"shape":"String",
"documentation":"<p>The instance ID.</p>"
}
},
"Force":{"shape":"Boolean"}
}
},
"StopStackRequest":{
@ -4421,7 +4496,7 @@
},
"Os":{
"shape":"String",
"documentation":"<p>The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI.</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> </ul> <p>For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p> <p>The default option is the current Amazon Linux version. If you set this parameter to <code>Custom</code>, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">Operating Systems</a>. For more information on how to use custom AMIs with OpsWorks, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\">Using Custom AMIs</a>.</p> <note> <p>You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.</p> </note>"
"documentation":"<p>The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI.</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> </ul> <p>For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p> <p>The default option is the current Amazon Linux version. If you set this parameter to <code>Custom</code>, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">Operating Systems</a>. For more information on how to use custom AMIs with OpsWorks, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\">Using Custom AMIs</a>.</p> <note> <p>You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.</p> </note>"
},
"AmiId":{
"shape":"String",
@ -4576,7 +4651,7 @@
},
"DefaultOs":{
"shape":"String",
"documentation":"<p>The stack's operating system, which must be set to one of the following:</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> <li> <p>A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\">Using Custom AMIs</a>.</p> </li> </ul> <p>The default option is the stack's current operating system. For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p>"
"documentation":"<p>The stack's operating system, which must be set to one of the following:</p> <ul> <li> <p>A supported Linux operating system: An Amazon Linux version, such as <code>Amazon Linux 2017.09</code>, <code>Amazon Linux 2017.03</code>, <code>Amazon Linux 2016.09</code>, <code>Amazon Linux 2016.03</code>, <code>Amazon Linux 2015.09</code>, or <code>Amazon Linux 2015.03</code>.</p> </li> <li> <p>A supported Ubuntu operating system, such as <code>Ubuntu 16.04 LTS</code>, <code>Ubuntu 14.04 LTS</code>, or <code>Ubuntu 12.04 LTS</code>.</p> </li> <li> <p> <code>CentOS Linux 7</code> </p> </li> <li> <p> <code>Red Hat Enterprise Linux 7</code> </p> </li> <li> <p>A supported Windows operating system, such as <code>Microsoft Windows Server 2012 R2 Base</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Express</code>, <code>Microsoft Windows Server 2012 R2 with SQL Server Standard</code>, or <code>Microsoft Windows Server 2012 R2 with SQL Server Web</code>.</p> </li> <li> <p>A custom AMI: <code>Custom</code>. You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html\">Using Custom AMIs</a>.</p> </li> </ul> <p>The default option is the stack's current operating system. For more information on the supported operating systems, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html\">AWS OpsWorks Stacks Operating Systems</a>.</p>"
},
"HostnameTheme":{
"shape":"String",
@ -4773,7 +4848,8 @@
"Iops":{
"shape":"Integer",
"documentation":"<p>For PIOPS volumes, the IOPS per disk.</p>"
}
},
"Encrypted":{"shape":"Boolean"}
},
"documentation":"<p>Describes an instance's Amazon EBS volume.</p>"
},
@ -4803,11 +4879,15 @@
},
"VolumeType":{
"shape":"String",
"documentation":"<p>The volume type:</p> <ul> <li> <p> <code>standard</code> - Magnetic</p> </li> <li> <p> <code>io1</code> - Provisioned IOPS (SSD)</p> </li> <li> <p> <code>gp2</code> - General Purpose (SSD)</p> </li> </ul>"
"documentation":"<p>The volume type. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html\"> Amazon EBS Volume Types</a>.</p> <ul> <li> <p> <code>standard</code> - Magnetic</p> </li> <li> <p> <code>io1</code> - Provisioned IOPS (SSD)</p> </li> <li> <p> <code>gp2</code> - General Purpose (SSD)</p> </li> <li> <p> <code>st1</code> - Throughput Optimized hard disk drive (HDD)</p> </li> <li> <p> <code>sc1</code> - Cold HDD</p> </li> </ul>"
},
"Iops":{
"shape":"Integer",
"documentation":"<p>For PIOPS volumes, the IOPS per disk.</p>"
},
"Encrypted":{
"shape":"Boolean",
"documentation":"<p>Specifies whether an Amazon EBS volume is encrypted. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html\">Amazon EBS Encryption</a>.</p>"
}
},
"documentation":"<p>Describes an Amazon EBS volume configuration.</p>"
@ -4863,5 +4943,5 @@
"documentation":"<p>Describes a time-based instance's auto scaling schedule. The schedule consists of a set of key-value pairs.</p> <ul> <li> <p>The key is the time period (a UTC hour) and must be an integer from 0 - 23.</p> </li> <li> <p>The value indicates whether the instance should be online or offline for the specified period, and must be set to \"on\" or \"off\"</p> </li> </ul> <p>The default setting for all time periods is off, so you use the following parameters primarily to specify the online periods. You don't have to explicitly specify offline periods unless you want to change an online period to an offline period.</p> <p>The following example specifies that the instance should be online for four hours, from UTC 1200 - 1600. It will be off for the remainder of the day.</p> <p> <code> { \"12\":\"on\", \"13\":\"on\", \"14\":\"on\", \"15\":\"on\" } </code> </p>"
}
},
"documentation":"<fullname>AWS OpsWorks</fullname> <p>Welcome to the <i>AWS OpsWorks Stacks API Reference</i>. This guide provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error codes. </p> <p>AWS OpsWorks Stacks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the <a href=\"http://aws.amazon.com/opsworks/\">AWS OpsWorks</a> details page. </p> <p> <b>SDKs and CLI</b> </p> <p>The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:</p> <ul> <li> <p> <a href=\"http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html\">AWS CLI</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/opsworks/AWSOpsWorksClient.html\">AWS SDK for Java</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/sdkfornet/latest/apidocs/html/N_Amazon_OpsWorks.htm\">AWS SDK for .NET</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/aws-sdk-php-2/latest/class-Aws.OpsWorks.OpsWorksClient.html\">AWS SDK for PHP 2</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/sdkforruby/api/\">AWS SDK for Ruby</a> </p> </li> <li> <p> <a href=\"http://aws.amazon.com/documentation/sdkforjavascript/\">AWS SDK for Node.js</a> </p> </li> <li> <p> <a href=\"http://docs.pythonboto.org/en/latest/ref/opsworks.html\">AWS SDK for Python(Boto)</a> </p> </li> </ul> <p> <b>Endpoints</b> </p> <p>AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.</p> <ul> <li> <p>opsworks.us-east-1.amazonaws.com</p> </li> <li> <p>opsworks.us-east-2.amazonaws.com</p> </li> <li> <p>opsworks.us-west-1.amazonaws.com</p> </li> <li> <p>opsworks.us-west-2.amazonaws.com</p> </li> <li> <p>opsworks.eu-west-1.amazonaws.com</p> </li> <li> <p>opsworks.eu-west-2.amazonaws.com</p> </li> <li> <p>opsworks.eu-central-1.amazonaws.com</p> </li> <li> <p>opsworks.ap-northeast-1.amazonaws.com</p> </li> <li> <p>opsworks.ap-northeast-2.amazonaws.com</p> </li> <li> <p>opsworks.ap-south-1.amazonaws.com</p> </li> <li> <p>opsworks.ap-southeast-1.amazonaws.com</p> </li> <li> <p>opsworks.ap-southeast-2.amazonaws.com</p> </li> <li> <p>opsworks.sa-east-1.amazonaws.com</p> </li> </ul> <p> <b>Chef Versions</b> </p> <p>When you call <a>CreateStack</a>, <a>CloneStack</a>, or <a>UpdateStack</a> we recommend you use the <code>ConfigurationManager</code> parameter to specify the Chef version. The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-chef11.html\">Chef Versions</a>.</p> <note> <p>You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.</p> </note>"
"documentation":"<fullname>AWS OpsWorks</fullname> <p>Welcome to the <i>AWS OpsWorks Stacks API Reference</i>. This guide provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error codes. </p> <p>AWS OpsWorks Stacks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the <a href=\"http://aws.amazon.com/opsworks/\">AWS OpsWorks</a> details page. </p> <p> <b>SDKs and CLI</b> </p> <p>The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:</p> <ul> <li> <p> <a href=\"http://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html\">AWS CLI</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/AWSJavaSDK/latest/javadoc/com/amazonaws/services/opsworks/AWSOpsWorksClient.html\">AWS SDK for Java</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/sdkfornet/latest/apidocs/html/N_Amazon_OpsWorks.htm\">AWS SDK for .NET</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/aws-sdk-php-2/latest/class-Aws.OpsWorks.OpsWorksClient.html\">AWS SDK for PHP 2</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/sdkforruby/api/\">AWS SDK for Ruby</a> </p> </li> <li> <p> <a href=\"http://aws.amazon.com/documentation/sdkforjavascript/\">AWS SDK for Node.js</a> </p> </li> <li> <p> <a href=\"http://docs.pythonboto.org/en/latest/ref/opsworks.html\">AWS SDK for Python(Boto)</a> </p> </li> </ul> <p> <b>Endpoints</b> </p> <p>AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.</p> <ul> <li> <p>opsworks.us-east-1.amazonaws.com</p> </li> <li> <p>opsworks.us-east-2.amazonaws.com</p> </li> <li> <p>opsworks.us-west-1.amazonaws.com</p> </li> <li> <p>opsworks.us-west-2.amazonaws.com</p> </li> <li> <p>opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS console)</p> </li> <li> <p>opsworks.eu-west-1.amazonaws.com</p> </li> <li> <p>opsworks.eu-west-2.amazonaws.com</p> </li> <li> <p>opsworks.eu-west-3.amazonaws.com</p> </li> <li> <p>opsworks.eu-central-1.amazonaws.com</p> </li> <li> <p>opsworks.ap-northeast-1.amazonaws.com</p> </li> <li> <p>opsworks.ap-northeast-2.amazonaws.com</p> </li> <li> <p>opsworks.ap-south-1.amazonaws.com</p> </li> <li> <p>opsworks.ap-southeast-1.amazonaws.com</p> </li> <li> <p>opsworks.ap-southeast-2.amazonaws.com</p> </li> <li> <p>opsworks.sa-east-1.amazonaws.com</p> </li> </ul> <p> <b>Chef Versions</b> </p> <p>When you call <a>CreateStack</a>, <a>CloneStack</a>, or <a>UpdateStack</a> we recommend you use the <code>ConfigurationManager</code> parameter to specify the Chef version. The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, see <a href=\"http://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook-chef11.html\">Chef Versions</a>.</p> <note> <p>You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.</p> </note>"
}

0
botocore/data/rds/2014-10-31/examples-1.json Executable file → Normal file
View file

107
botocore/data/rds/2014-10-31/waiters-2.json
View file

@ -41,18 +41,6 @@
"matcher": "pathAny",
"state": "failure",
"argument": "DBInstances[].DBInstanceStatus"
},
{
"expected": "incompatible-parameters",
"matcher": "pathAny",
"state": "failure",
"argument": "DBInstances[].DBInstanceStatus"
},
{
"expected": "incompatible-restore",
"matcher": "pathAny",
"state": "failure",
"argument": "DBInstances[].DBInstanceStatus"
}
]
},
@ -61,17 +49,17 @@
"operation": "DescribeDBInstances",
"maxAttempts": 60,
"acceptors": [
{
"expected": "DBInstanceNotFound",
"matcher": "error",
"state": "success"
},
{
"expected": "deleted",
"matcher": "pathAll",
"state": "success",
"argument": "DBInstances[].DBInstanceStatus"
},
{
"expected": "DBInstanceNotFound",
"matcher": "error",
"state": "success"
},
{
"expected": "creating",
"matcher": "pathAny",
@ -98,6 +86,91 @@
}
]
},
"DBSnapshotAvailable": {
"delay": 30,
"operation": "DescribeDBSnapshots",
"maxAttempts": 60,
"acceptors": [
{
"expected": "available",
"matcher": "pathAll",
"state": "success",
"argument": "DBSnapshots[].Status"
},
{
"expected": "deleted",
"matcher": "pathAny",
"state": "failure",
"argument": "DBSnapshots[].Status"
},
{
"expected": "deleting",
"matcher": "pathAny",
"state": "failure",
"argument": "DBSnapshots[].Status"
},
{
"expected": "failed",
"matcher": "pathAny",
"state": "failure",
"argument": "DBSnapshots[].Status"
},
{
"expected": "incompatible-restore",
"matcher": "pathAny",
"state": "failure",
"argument": "DBSnapshots[].Status"
},
{
"expected": "incompatible-parameters",
"matcher": "pathAny",
"state": "failure",
"argument": "DBSnapshots[].Status"
}
]
},
"DBSnapshotDeleted": {
"delay": 30,
"operation": "DescribeDBSnapshots",
"maxAttempts": 60,
"acceptors": [
{
"expected": "deleted",
"matcher": "pathAll",
"state": "success",
"argument": "DBSnapshots[].Status"
},
{
"expected": "DBSnapshotNotFound",
"matcher": "error",
"state": "success"
},
{
"expected": "creating",
"matcher": "pathAny",
"state": "failure",
"argument": "DBSnapshots[].Status"
},
{
"expected": "modifying",
"matcher": "pathAny",
"state": "failure",
"argument": "DBSnapshots[].Status"
},
{
"expected": "rebooting",
"matcher": "pathAny",
"state": "failure",
"argument": "DBSnapshots[].Status"
},
{
"expected": "resetting-master-credentials",
"matcher": "pathAny",
"state": "failure",
"argument": "DBSnapshots[].Status"
}
]
},
"DBSnapshotCompleted": {
"delay": 15,
"operation": "DescribeDBSnapshots",

21
botocore/data/redshift/2012-12-01/waiters-2.json
View file

@ -42,13 +42,32 @@
"argument": "Clusters[].ClusterStatus"
},
{
"expected": "rebooting",
"expected": "modifying",
"matcher": "pathAny",
"state": "failure",
"argument": "Clusters[].ClusterStatus"
}
]
},
"ClusterRestored": {
"operation": "DescribeClusters",
"maxAttempts": 30,
"delay": 60,
"acceptors": [
{
"state": "success",
"matcher": "pathAll",
"argument": "Clusters[].RestoreStatus.Status",
"expected": "completed"
},
{
"state": "failure",
"matcher": "pathAny",
"argument": "Clusters[].ClusterStatus",
"expected": "deleting"
}
]
},
"SnapshotAvailable": {
"delay": 15,
"operation": "DescribeClusterSnapshots",

10
botocore/data/s3/2006-03-01/waiters-2.json
View file

@ -11,6 +11,16 @@
"matcher": "status",
"state": "success"
},
{
"expected": 301,
"matcher": "status",
"state": "success"
},
{
"expected": 403,
"matcher": "status",
"state": "success"
},
{
"expected": 404,
"matcher": "status",

763
botocore/data/servicecatalog/2015-12-10/service-2.json
View file

@ -6,6 +6,7 @@
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"AWS Service Catalog",
"serviceId":"Service Catalog",
"signatureVersion":"v4",
"targetPrefix":"AWS242ServiceCatalogService",
"uid":"servicecatalog-2015-12-10"
@ -149,6 +150,21 @@
],
"documentation":"<p>Creates a product.</p>"
},
"CreateProvisionedProductPlan":{
"name":"CreateProvisionedProductPlan",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateProvisionedProductPlanInput"},
"output":{"shape":"CreateProvisionedProductPlanOutput"},
"errors":[
{"shape":"InvalidParametersException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidStateException"}
],
"documentation":"<p>Creates a plan. A plan includes the list of resources that will be created (when provisioning a new product) or modified (when updating a provisioned product) when the plan is executed.</p> <p>You can create one plan per provisioned product. To create a plan for an existing provisioned product, it's status must be AVAILBLE or TAINTED.</p> <p>To view the resource changes in the change set, use <a>DescribeProvisionedProductPlan</a>. To create or modify the provisioned product, use <a>ExecuteProvisionedProductPlan</a>.</p>"
},
"CreateProvisioningArtifact":{
"name":"CreateProvisioningArtifact",
"http":{
@ -238,6 +254,20 @@
],
"documentation":"<p>Deletes the specified product.</p> <p>You cannot delete a product if it was shared with you or is associated with a portfolio.</p>"
},
"DeleteProvisionedProductPlan":{
"name":"DeleteProvisionedProductPlan",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteProvisionedProductPlanInput"},
"output":{"shape":"DeleteProvisionedProductPlanOutput"},
"errors":[
{"shape":"InvalidParametersException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deletes the specified plan.</p>"
},
"DeleteProvisioningArtifact":{
"name":"DeleteProvisioningArtifact",
"http":{
@ -346,6 +376,20 @@
],
"documentation":"<p>Gets information about the specified provisioned product.</p>"
},
"DescribeProvisionedProductPlan":{
"name":"DescribeProvisionedProductPlan",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeProvisionedProductPlanInput"},
"output":{"shape":"DescribeProvisionedProductPlanOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParametersException"}
],
"documentation":"<p>Gets information about the resource changes for the specified plan.</p>"
},
"DescribeProvisioningArtifact":{
"name":"DescribeProvisioningArtifact",
"http":{
@ -371,7 +415,7 @@
{"shape":"InvalidParametersException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Gets information about the configuration required to provision the specified product using the specified provisioning artifact.</p> <p>If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to <a>ProvisionProduct</a>, do not include conflicted TagOption keys as tags, or this will cause the error \"Parameter validation failed: Missing required parameter in Tags[<i>N</i>]:<i>Value</i>\" and tag the provisioned product with the value <code>sc-tagoption-conflict-portfolioId-productId</code>.</p>"
"documentation":"<p>Gets information about the configuration required to provision the specified product using the specified provisioning artifact.</p> <p>If the output contains a TagOption key with an empty list of values, there is a TagOption conflict for that key. The end user cannot take action to fix the conflict, and launch is not blocked. In subsequent calls to <a>ProvisionProduct</a>, do not include conflicted TagOption keys as tags, or this causes the error \"Parameter validation failed: Missing required parameter in Tags[<i>N</i>]:<i>Value</i>\". Tag the provisioned product with the value <code>sc-tagoption-conflict-portfolioId-productId</code>.</p>"
},
"DescribeRecord":{
"name":"DescribeRecord",
@ -443,6 +487,21 @@
],
"documentation":"<p>Disassociates the specified TagOption from the specified resource.</p>"
},
"ExecuteProvisionedProductPlan":{
"name":"ExecuteProvisionedProductPlan",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ExecuteProvisionedProductPlanInput"},
"output":{"shape":"ExecuteProvisionedProductPlanOutput"},
"errors":[
{"shape":"InvalidParametersException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidStateException"}
],
"documentation":"<p>Provisions or modifies a product based on the resource changes for the specified plan.</p>"
},
"ListAcceptedPortfolioShares":{
"name":"ListAcceptedPortfolioShares",
"http":{
@ -538,6 +597,20 @@
],
"documentation":"<p>Lists all principal ARNs associated with the specified portfolio.</p>"
},
"ListProvisionedProductPlans":{
"name":"ListProvisionedProductPlans",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListProvisionedProductPlansInput"},
"output":{"shape":"ListProvisionedProductPlansOutput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParametersException"}
],
"documentation":"<p>Lists the plans for the specified provisioned product or all plans the user has access to.</p>"
},
"ListProvisioningArtifacts":{
"name":"ListProvisioningArtifacts",
"http":{
@ -607,7 +680,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"DuplicateResourceException"}
],
"documentation":"<p>Provisions the specified product.</p> <p>A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources. You can check the status of this request using <a>DescribeRecord</a>.</p> <p>If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this will cause the error \"Parameter validation failed: Missing required parameter in Tags[<i>N</i>]:<i>Value</i>\".</p>"
"documentation":"<p>Provisions the specified product.</p> <p>A provisioned product is a resourced instance of a product. For example, provisioning a product based on a CloudFormation template launches a CloudFormation stack and its underlying resources. You can check the status of this request using <a>DescribeRecord</a>.</p> <p>If the request contains a tag key with an empty list of values, there is a tag conflict for that key. Do not include conflicted keys as tags, or this causes the error \"Parameter validation failed: Missing required parameter in Tags[<i>N</i>]:<i>Value</i>\".</p>"
},
"RejectPortfolioShare":{
"name":"RejectPortfolioShare",
@ -633,7 +706,7 @@
"errors":[
{"shape":"InvalidParametersException"}
],
"documentation":"<p>Lists the provisioned products that are available (not terminated).</p>"
"documentation":"<p>Lists the provisioned products that are available (not terminated).</p> <p>To use additional filtering, see <a>SearchProvisionedProducts</a>.</p>"
},
"SearchProducts":{
"name":"SearchProducts",
@ -662,6 +735,19 @@
],
"documentation":"<p>Gets information about the products for the specified portfolio or all products.</p>"
},
"SearchProvisionedProducts":{
"name":"SearchProvisionedProducts",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"SearchProvisionedProductsInput"},
"output":{"shape":"SearchProvisionedProductsOutput"},
"errors":[
{"shape":"InvalidParametersException"}
],
"documentation":"<p>Gets information about the provisioned products that meet the specified criteria.</p>"
},
"TerminateProvisionedProduct":{
"name":"TerminateProvisionedProduct",
"http":{
@ -912,6 +998,30 @@
}
},
"AttributeValue":{"type":"string"},
"CausingEntity":{"type":"string"},
"ChangeAction":{
"type":"string",
"enum":[
"ADD",
"MODIFY",
"REMOVE"
]
},
"CloudWatchDashboard":{
"type":"structure",
"members":{
"Name":{
"shape":"CloudWatchDashboardName",
"documentation":"<p>The name of the CloudWatch dashboard.</p>"
}
},
"documentation":"<p>Information about a CloudWatch dashboard.</p>"
},
"CloudWatchDashboardName":{"type":"string"},
"CloudWatchDashboards":{
"type":"list",
"member":{"shape":"CloudWatchDashboard"}
},
"ConstraintDescription":{
"type":"string",
"max":2000
@ -1113,7 +1223,7 @@
},
"Tags":{
"shape":"AddTags",
"documentation":"<p>The tags to associate with the portfolio.</p>"
"documentation":"<p>One or more tags.</p>"
},
"IdempotencyToken":{
"shape":"IdempotencyToken",
@ -1209,7 +1319,7 @@
},
"Tags":{
"shape":"AddTags",
"documentation":"<p>The tags to associate with the product.</p>"
"documentation":"<p>One or more tags.</p>"
},
"ProvisioningArtifactParameters":{
"shape":"ProvisioningArtifactProperties",
@ -1239,6 +1349,89 @@
}
}
},
"CreateProvisionedProductPlanInput":{
"type":"structure",
"required":[
"PlanName",
"PlanType",
"ProductId",
"ProvisionedProductName",
"ProvisioningArtifactId",
"IdempotencyToken"
],
"members":{
"AcceptLanguage":{
"shape":"AcceptLanguage",
"documentation":"<p>The language code.</p> <ul> <li> <p> <code>en</code> - English (default)</p> </li> <li> <p> <code>jp</code> - Japanese</p> </li> <li> <p> <code>zh</code> - Chinese</p> </li> </ul>"
},
"PlanName":{
"shape":"ProvisionedProductPlanName",
"documentation":"<p>The name of the plan.</p>"
},
"PlanType":{
"shape":"ProvisionedProductPlanType",
"documentation":"<p>The plan type.</p>"
},
"NotificationArns":{
"shape":"NotificationArns",
"documentation":"<p>Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.</p>"
},
"PathId":{
"shape":"Id",
"documentation":"<p>The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use <a>ListLaunchPaths</a>.</p>"
},
"ProductId":{
"shape":"Id",
"documentation":"<p>The product identifier.</p>"
},
"ProvisionedProductName":{
"shape":"ProvisionedProductName",
"documentation":"<p>A user-friendly name for the provisioned product. This value must be unique for the AWS account and cannot be updated after the product is provisioned.</p>"
},
"ProvisioningArtifactId":{
"shape":"Id",
"documentation":"<p>The identifier of the provisioning artifact.</p>"
},
"ProvisioningParameters":{
"shape":"UpdateProvisioningParameters",
"documentation":"<p>Parameters specified by the administrator that are required for provisioning the product.</p>"
},
"IdempotencyToken":{
"shape":"IdempotencyToken",
"documentation":"<p>A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.</p>",
"idempotencyToken":true
},
"Tags":{
"shape":"Tags",
"documentation":"<p>One or more tags.</p>"
}
}
},
"CreateProvisionedProductPlanOutput":{
"type":"structure",
"members":{
"PlanName":{
"shape":"ProvisionedProductPlanName",
"documentation":"<p>The name of the plan.</p>"
},
"PlanId":{
"shape":"Id",
"documentation":"<p>The plan identifier.</p>"
},
"ProvisionProductId":{
"shape":"Id",
"documentation":"<p>The product identifier.</p>"
},
"ProvisionedProductName":{
"shape":"ProvisionedProductName",
"documentation":"<p>The user-friendly name of the provisioned product.</p>"
},
"ProvisioningArtifactId":{
"shape":"Id",
"documentation":"<p>The identifier of the provisioning artifact.</p>"
}
}
},
"CreateProvisioningArtifactInput":{
"type":"structure",
"required":[
@ -1395,6 +1588,29 @@
"members":{
}
},
"DeleteProvisionedProductPlanInput":{
"type":"structure",
"required":["PlanId"],
"members":{
"AcceptLanguage":{
"shape":"AcceptLanguage",
"documentation":"<p>The language code.</p> <ul> <li> <p> <code>en</code> - English (default)</p> </li> <li> <p> <code>jp</code> - Japanese</p> </li> <li> <p> <code>zh</code> - Chinese</p> </li> </ul>"
},
"PlanId":{
"shape":"Id",
"documentation":"<p>The plan identifier.</p>"
},
"IgnoreErrors":{
"shape":"IgnoreErrors",
"documentation":"<p>If set to true, AWS Service Catalog stops managing the specified provisioned product even if it cannot delete the underlying resources.</p>"
}
}
},
"DeleteProvisionedProductPlanOutput":{
"type":"structure",
"members":{
}
},
"DeleteProvisioningArtifactInput":{
"type":"structure",
"required":[
@ -1623,6 +1839,49 @@
"ProvisionedProductDetail":{
"shape":"ProvisionedProductDetail",
"documentation":"<p>Information about the provisioned product.</p>"
},
"CloudWatchDashboards":{
"shape":"CloudWatchDashboards",
"documentation":"<p>Any CloudWatch dashboards that were created when provisioning the product.</p>"
}
}
},
"DescribeProvisionedProductPlanInput":{
"type":"structure",
"required":["PlanId"],
"members":{
"AcceptLanguage":{
"shape":"AcceptLanguage",
"documentation":"<p>The language code.</p> <ul> <li> <p> <code>en</code> - English (default)</p> </li> <li> <p> <code>jp</code> - Japanese</p> </li> <li> <p> <code>zh</code> - Chinese</p> </li> </ul>"
},
"PlanId":{
"shape":"Id",
"documentation":"<p>The plan identifier.</p>"
},
"PageSize":{
"shape":"PageSize",
"documentation":"<p>The maximum number of items to return with this call.</p>"
},
"PageToken":{
"shape":"PageToken",
"documentation":"<p>The page token for the next set of results. To retrieve the first set of results, use null.</p>"
}
}
},
"DescribeProvisionedProductPlanOutput":{
"type":"structure",
"members":{
"ProvisionedProductPlanDetails":{
"shape":"ProvisionedProductPlanDetails",
"documentation":"<p>Information about the plan.</p>"
},
"ResourceChanges":{
"shape":"ResourceChanges",
"documentation":"<p>Information about the resources changes that will occur when the plan is executed.</p>"
},
"NextPageToken":{
"shape":"PageToken",
"documentation":"<p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>"
}
}
},
@ -1856,6 +2115,44 @@
},
"ErrorCode":{"type":"string"},
"ErrorDescription":{"type":"string"},
"EvaluationType":{
"type":"string",
"enum":[
"STATIC",
"DYNAMIC"
]
},
"ExecuteProvisionedProductPlanInput":{
"type":"structure",
"required":[
"PlanId",
"IdempotencyToken"
],
"members":{
"AcceptLanguage":{
"shape":"AcceptLanguage",
"documentation":"<p>The language code.</p> <ul> <li> <p> <code>en</code> - English (default)</p> </li> <li> <p> <code>jp</code> - Japanese</p> </li> <li> <p> <code>zh</code> - Chinese</p> </li> </ul>"
},
"PlanId":{
"shape":"Id",
"documentation":"<p>The plan identifier.</p>"
},
"IdempotencyToken":{
"shape":"IdempotencyToken",
"documentation":"<p>A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.</p>",
"idempotencyToken":true
}
}
},
"ExecuteProvisionedProductPlanOutput":{
"type":"structure",
"members":{
"RecordDetail":{
"shape":"RecordDetail",
"documentation":"<p>Information about the result of provisioning the product.</p>"
}
}
},
"HasDefaultPath":{"type":"boolean"},
"Id":{
"type":"string",
@ -2150,6 +2447,44 @@
}
}
},
"ListProvisionedProductPlansInput":{
"type":"structure",
"members":{
"AcceptLanguage":{
"shape":"AcceptLanguage",
"documentation":"<p>The language code.</p> <ul> <li> <p> <code>en</code> - English (default)</p> </li> <li> <p> <code>jp</code> - Japanese</p> </li> <li> <p> <code>zh</code> - Chinese</p> </li> </ul>"
},
"ProvisionProductId":{
"shape":"Id",
"documentation":"<p>The product identifier.</p>"
},
"PageSize":{
"shape":"PageSize",
"documentation":"<p>The maximum number of items to return with this call.</p>"
},
"PageToken":{
"shape":"PageToken",
"documentation":"<p>The page token for the next set of results. To retrieve the first set of results, use null.</p>"
},
"AccessLevelFilter":{
"shape":"AccessLevelFilter",
"documentation":"<p>The access level to use to obtain results. The default is <code>User</code>.</p>"
}
}
},
"ListProvisionedProductPlansOutput":{
"type":"structure",
"members":{
"ProvisionedProductPlans":{
"shape":"ProvisionedProductPlans",
"documentation":"<p>Information about the plans.</p>"
},
"NextPageToken":{
"shape":"PageToken",
"documentation":"<p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>"
}
}
},
"ListProvisioningArtifactsInput":{
"type":"structure",
"required":["ProductId"],
@ -2312,6 +2647,7 @@
}
}
},
"LogicalResourceId":{"type":"string"},
"NoEcho":{"type":"boolean"},
"NotificationArn":{
"type":"string",
@ -2355,6 +2691,13 @@
"type":"string",
"max":4096
},
"PhysicalId":{"type":"string"},
"PhysicalResourceId":{"type":"string"},
"PlanResourceType":{
"type":"string",
"max":256,
"min":1
},
"PortfolioDescription":{
"type":"string",
"max":2000
@ -2380,7 +2723,7 @@
},
"CreatedTime":{
"shape":"CreationTime",
"documentation":"<p>The UTC timestamp of the creation time.</p>"
"documentation":"<p>The UTC time stamp of the creation time.</p>"
},
"ProviderName":{
"shape":"ProviderName",
@ -2484,7 +2827,7 @@
},
"CreatedTime":{
"shape":"CreatedTime",
"documentation":"<p>The UTC timestamp of the creation time.</p>"
"documentation":"<p>The UTC time stamp of the creation time.</p>"
}
},
"documentation":"<p>Information about a product view.</p>"
@ -2578,9 +2921,10 @@
},
"documentation":"<p>Summary information about a product view.</p>"
},
"PropertyName":{"type":"string"},
"ProviderName":{
"type":"string",
"max":20,
"max":50,
"min":1
},
"ProvisionProductInput":{
@ -2618,7 +2962,7 @@
},
"Tags":{
"shape":"Tags",
"documentation":"<p>The tags to use as provisioning options.</p>"
"documentation":"<p>One or more tags.</p>"
},
"NotificationArns":{
"shape":"NotificationArns",
@ -2636,10 +2980,80 @@
"members":{
"RecordDetail":{
"shape":"RecordDetail",
"documentation":"<p>Information about the result of <a>ProvisionProduct</a>.</p>"
"documentation":"<p>Information about the result of provisioning the product.</p>"
}
}
},
"ProvisionedProductAttribute":{
"type":"structure",
"members":{
"Name":{
"shape":"ProvisionedProductNameOrArn",
"documentation":"<p>The user-friendly name of the provisioned product.</p>"
},
"Arn":{
"shape":"ProvisionedProductNameOrArn",
"documentation":"<p>The ARN of the provisioned product.</p>"
},
"Type":{
"shape":"ProvisionedProductType",
"documentation":"<p>The type of provisioned product. The supported value is <code>CFN_STACK</code>.</p>"
},
"Id":{
"shape":"Id",
"documentation":"<p>The identifier of the provisioned product.</p>"
},
"Status":{
"shape":"ProvisionedProductStatus",
"documentation":"<p>The current status of the provisioned product.</p> <ul> <li> <p> <code>AVAILABLE</code> - Stable state, ready to perform any operation. The most recent operation succeeded and completed.</p> </li> <li> <p> <code>UNDER_CHANGE</code> - Transitive state, operations performed might not have valid results. Wait for an <code>AVAILABLE</code> status before performing operations.</p> </li> <li> <p> <code>TAINTED</code> - Stable state, ready to perform any operation. The stack has completed the requested operation but is not exactly what was requested. For example, a request to update to a new version failed and the stack rolled back to the current version.</p> </li> <li> <p> <code>ERROR</code> - An unexpected error occurred, the provisioned product exists but the stack is not running. For example, CloudFormation received a parameter value that was not valid and could not launch the stack.</p> </li> </ul>"
},
"StatusMessage":{
"shape":"ProvisionedProductStatusMessage",
"documentation":"<p>The current status message of the provisioned product.</p>"
},
"CreatedTime":{
"shape":"CreatedTime",
"documentation":"<p>The UTC time stamp of the creation time.</p>"
},
"IdempotencyToken":{
"shape":"IdempotencyToken",
"documentation":"<p>A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token, the same response is returned for each repeated request.</p>"
},
"LastRecordId":{
"shape":"Id",
"documentation":"<p>The record identifier of the last request performed on this provisioned product.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>One or more tags.</p>"
},
"PhysicalId":{
"shape":"PhysicalId",
"documentation":"<p>The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.</p>"
},
"ProductId":{
"shape":"Id",
"documentation":"<p>The product identifier.</p>"
},
"ProvisioningArtifactId":{
"shape":"Id",
"documentation":"<p>The identifier of the provisioning artifact.</p>"
},
"UserArn":{
"shape":"UserArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM user.</p>"
},
"UserArnSession":{
"shape":"UserArnSession",
"documentation":"<p>The ARN of the IAM user in the session. This ARN might contain a session ID.</p>"
}
},
"documentation":"<p>Information about a provisioned product.</p>"
},
"ProvisionedProductAttributes":{
"type":"list",
"member":{"shape":"ProvisionedProductAttribute"}
},
"ProvisionedProductDetail":{
"type":"structure",
"members":{
@ -2669,7 +3083,7 @@
},
"CreatedTime":{
"shape":"CreatedTime",
"documentation":"<p>The UTC timestamp of the creation time.</p>"
"documentation":"<p>The UTC time stamp of the creation time.</p>"
},
"IdempotencyToken":{
"shape":"IdempotencyToken",
@ -2686,6 +3100,11 @@
"type":"list",
"member":{"shape":"ProvisionedProductDetail"}
},
"ProvisionedProductFilters":{
"type":"map",
"key":{"shape":"ProvisionedProductViewFilterBy"},
"value":{"shape":"ProvisionedProductViewFilterValues"}
},
"ProvisionedProductId":{"type":"string"},
"ProvisionedProductName":{
"type":"string",
@ -2699,17 +3118,143 @@
"min":1,
"pattern":"[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}|arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}"
},
"ProvisionedProductPlanDetails":{
"type":"structure",
"members":{
"CreatedTime":{
"shape":"CreatedTime",
"documentation":"<p>The UTC time stamp of the creation time.</p>"
},
"PathId":{
"shape":"Id",
"documentation":"<p>The path identifier of the product. This value is optional if the product has a default path, and required if the product has more than one path. To list the paths for a product, use <a>ListLaunchPaths</a>.</p>"
},
"ProductId":{
"shape":"Id",
"documentation":"<p>The product identifier.</p>"
},
"PlanName":{
"shape":"ProvisionedProductPlanName",
"documentation":"<p>The name of the plan.</p>"
},
"PlanId":{
"shape":"Id",
"documentation":"<p>The plan identifier.</p>"
},
"ProvisionProductId":{
"shape":"Id",
"documentation":"<p>The product identifier.</p>"
},
"ProvisionProductName":{
"shape":"ProvisionedProductName",
"documentation":"<p>The user-friendly name of the provisioned product.</p>"
},
"PlanType":{
"shape":"ProvisionedProductPlanType",
"documentation":"<p>The plan type.</p>"
},
"ProvisioningArtifactId":{
"shape":"Id",
"documentation":"<p>The identifier of the provisioning artifact.</p>"
},
"Status":{
"shape":"ProvisionedProductPlanStatus",
"documentation":"<p>The status.</p>"
},
"UpdatedTime":{
"shape":"UpdatedTime",
"documentation":"<p>The time when the plan was last updated.</p>"
},
"NotificationArns":{
"shape":"NotificationArns",
"documentation":"<p>Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related events.</p>"
},
"ProvisioningParameters":{
"shape":"UpdateProvisioningParameters",
"documentation":"<p>Parameters specified by the administrator that are required for provisioning the product.</p>"
},
"Tags":{
"shape":"Tags",
"documentation":"<p>One or more tags.</p>"
},
"StatusMessage":{
"shape":"StatusMessage",
"documentation":"<p>The status message.</p>"
}
},
"documentation":"<p>Information about a plan.</p>"
},
"ProvisionedProductPlanName":{"type":"string"},
"ProvisionedProductPlanStatus":{
"type":"string",
"enum":[
"CREATE_IN_PROGRESS",
"CREATE_SUCCESS",
"CREATE_FAILED",
"EXECUTE_IN_PROGRESS",
"EXECUTE_SUCCESS",
"EXECUTE_FAILED"
]
},
"ProvisionedProductPlanSummary":{
"type":"structure",
"members":{
"PlanName":{
"shape":"ProvisionedProductPlanName",
"documentation":"<p>The name of the plan.</p>"
},
"PlanId":{
"shape":"Id",
"documentation":"<p>The plan identifier.</p>"
},
"ProvisionProductId":{
"shape":"Id",
"documentation":"<p>The product identifier.</p>"
},
"ProvisionProductName":{
"shape":"ProvisionedProductName",
"documentation":"<p>The user-friendly name of the provisioned product.</p>"
},
"PlanType":{
"shape":"ProvisionedProductPlanType",
"documentation":"<p>The plan type.</p>"
},
"ProvisioningArtifactId":{
"shape":"Id",
"documentation":"<p>The identifier of the provisioning artifact.</p>"
}
},
"documentation":"<p>Summary information about a plan.</p>"
},
"ProvisionedProductPlanType":{
"type":"string",
"enum":["CLOUDFORMATION"]
},
"ProvisionedProductPlans":{
"type":"list",
"member":{"shape":"ProvisionedProductPlanSummary"}
},
"ProvisionedProductStatus":{
"type":"string",
"enum":[
"AVAILABLE",
"UNDER_CHANGE",
"TAINTED",
"ERROR"
"ERROR",
"PLAN_IN_PROGRESS"
]
},
"ProvisionedProductStatusMessage":{"type":"string"},
"ProvisionedProductType":{"type":"string"},
"ProvisionedProductViewFilterBy":{
"type":"string",
"enum":["SearchQuery"]
},
"ProvisionedProductViewFilterValue":{"type":"string"},
"ProvisionedProductViewFilterValues":{
"type":"list",
"member":{"shape":"ProvisionedProductViewFilterValue"}
},
"ProvisioningArtifact":{
"type":"structure",
"members":{
@ -2727,7 +3272,7 @@
},
"CreatedTime":{
"shape":"ProvisioningArtifactCreatedTime",
"documentation":"<p>The UTC timestamp of the creation time.</p>"
"documentation":"<p>The UTC time stamp of the creation time.</p>"
}
},
"documentation":"<p>Information about a provisioning artifact. A provisioning artifact is also known as a product version.</p>"
@ -2756,7 +3301,7 @@
},
"CreatedTime":{
"shape":"CreationTime",
"documentation":"<p>The UTC timestamp of the creation time.</p>"
"documentation":"<p>The UTC time stamp of the creation time.</p>"
},
"Active":{
"shape":"ProvisioningArtifactActive",
@ -2862,7 +3407,7 @@
},
"CreatedTime":{
"shape":"ProvisioningArtifactCreatedTime",
"documentation":"<p>The UTC timestamp of the creation time.</p>"
"documentation":"<p>The UTC time stamp of the creation time.</p>"
},
"ProvisioningArtifactMetadata":{
"shape":"ProvisioningArtifactInfo",
@ -2918,7 +3463,7 @@
},
"CreatedTime":{
"shape":"CreatedTime",
"documentation":"<p>The UTC timestamp of the creation time.</p>"
"documentation":"<p>The UTC time stamp of the creation time.</p>"
},
"UpdatedTime":{
"shape":"UpdatedTime",
@ -2930,7 +3475,7 @@
},
"RecordType":{
"shape":"RecordType",
"documentation":"<p>The record type for this record.</p> <ul> <li> <p> <code>PROVISION_PRODUCT</code> </p> </li> <li> <p> <code>UPDATE_PROVISIONED_PRODUCT</code> </p> </li> <li> <p> <code>TERMINATE_PROVISIONED_PRODUCT</code> </p> </li> </ul>"
"documentation":"<p>The record type.</p> <ul> <li> <p> <code>PROVISION_PRODUCT</code> </p> </li> <li> <p> <code>UPDATE_PROVISIONED_PRODUCT</code> </p> </li> <li> <p> <code>TERMINATE_PROVISIONED_PRODUCT</code> </p> </li> </ul>"
},
"ProvisionedProductId":{
"shape":"Id",
@ -2950,11 +3495,11 @@
},
"RecordErrors":{
"shape":"RecordErrors",
"documentation":"<p>The errors that occurred while processing the request.</p>"
"documentation":"<p>The errors that occurred.</p>"
},
"RecordTags":{
"shape":"RecordTags",
"documentation":"<p>The tags associated with this record.</p>"
"documentation":"<p>One or more tags.</p>"
}
},
"documentation":"<p>Information about a request operation.</p>"
@ -3025,7 +3570,7 @@
"documentation":"<p>The value for this tag.</p>"
}
},
"documentation":"<p>A tag associated with the record, stored as a key-value pair.</p>"
"documentation":"<p>Information about a tag, which is a key-value pair.</p>"
},
"RecordTagKey":{
"type":"string",
@ -3064,11 +3609,98 @@
"members":{
}
},
"Replacement":{
"type":"string",
"enum":[
"TRUE",
"FALSE",
"CONDITIONAL"
]
},
"RequiresRecreation":{
"type":"string",
"enum":[
"NEVER",
"CONDITIONALLY",
"ALWAYS"
]
},
"ResourceARN":{
"type":"string",
"max":150,
"min":1
},
"ResourceAttribute":{
"type":"string",
"enum":[
"PROPERTIES",
"METADATA",
"CREATIONPOLICY",
"UPDATEPOLICY",
"DELETIONPOLICY",
"TAGS"
]
},
"ResourceChange":{
"type":"structure",
"members":{
"Action":{
"shape":"ChangeAction",
"documentation":"<p>The change action.</p>"
},
"LogicalResourceId":{
"shape":"LogicalResourceId",
"documentation":"<p>The ID of the resource, as defined in the CloudFormation template.</p>"
},
"PhysicalResourceId":{
"shape":"PhysicalResourceId",
"documentation":"<p>The ID of the resource, if it was already created.</p>"
},
"ResourceType":{
"shape":"PlanResourceType",
"documentation":"<p>The type of resource.</p>"
},
"Replacement":{
"shape":"Replacement",
"documentation":"<p>If the change type is <code>Modify</code>, indicates whether the existing resource is deleted and replaced with a new one.</p>"
},
"Scope":{
"shape":"Scope",
"documentation":"<p>The change scope.</p>"
},
"Details":{
"shape":"ResourceChangeDetails",
"documentation":"<p>Information about the resource changes.</p>"
}
},
"documentation":"<p>Information about a resource change that will occur when a plan is executed.</p>"
},
"ResourceChangeDetail":{
"type":"structure",
"members":{
"Target":{
"shape":"ResourceTargetDefinition",
"documentation":"<p>Information about the resource attribute that will be modified.</p>"
},
"Evaluation":{
"shape":"EvaluationType",
"documentation":"<p>For static evaluations, the value the resource attribute will change and the new value is known. For dynamic evaluations, the value might change, and any new value will be determined when the plan is updated.</p>"
},
"CausingEntity":{
"shape":"CausingEntity",
"documentation":"<p>The ID of the entity that caused the change.</p>"
}
},
"documentation":"<p>Information about a change to a resource attribute.</p>"
},
"ResourceChangeDetails":{
"type":"list",
"member":{"shape":"ResourceChangeDetail"}
},
"ResourceChanges":{
"type":"list",
"member":{"shape":"ResourceChange"}
},
"ResourceDetail":{
"type":"structure",
"members":{
@ -3109,7 +3741,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>A resource that is currently in use. Ensure the resource is not in use and retry the operation.</p>",
"documentation":"<p>A resource that is currently in use. Ensure that the resource is not in use and retry the operation.</p>",
"exception":true
},
"ResourceNotFoundException":{
@ -3119,6 +3751,24 @@
"documentation":"<p>The specified resource was not found.</p>",
"exception":true
},
"ResourceTargetDefinition":{
"type":"structure",
"members":{
"Attribute":{
"shape":"ResourceAttribute",
"documentation":"<p>The attribute that will change.</p>"
},
"Name":{
"shape":"PropertyName",
"documentation":"<p>If the attribute is <code>Properties</code>, the value is the name of the property. Otherwise, the value is null.</p>"
},
"RequiresRecreation":{
"shape":"RequiresRecreation",
"documentation":"<p>If the attribute is <code>Properties</code>, indicates whether a change to this property causes the resource to be recreated.</p>"
}
},
"documentation":"<p>Information about a change to a resource attribute.</p>"
},
"ResourceType":{"type":"string"},
"ScanProvisionedProductsInput":{
"type":"structure",
@ -3154,6 +3804,10 @@
}
}
},
"Scope":{
"type":"list",
"member":{"shape":"ResourceAttribute"}
},
"SearchFilterKey":{"type":"string"},
"SearchFilterValue":{"type":"string"},
"SearchProductsAsAdminInput":{
@ -3252,6 +3906,62 @@
}
}
},
"SearchProvisionedProductsInput":{
"type":"structure",
"members":{
"AcceptLanguage":{
"shape":"AcceptLanguage",
"documentation":"<p>The language code.</p> <ul> <li> <p> <code>en</code> - English (default)</p> </li> <li> <p> <code>jp</code> - Japanese</p> </li> <li> <p> <code>zh</code> - Chinese</p> </li> </ul>"
},
"AccessLevelFilter":{
"shape":"AccessLevelFilter",
"documentation":"<p>The access level to use to obtain results. The default is <code>User</code>.</p>"
},
"Filters":{
"shape":"ProvisionedProductFilters",
"documentation":"<p>The search filters.</p> <p>When the key is <code>SearchQuery</code>, the searchable fields are <code>arn</code>, <code>createdTime</code>, <code>id</code>, <code>lastRecordId</code>, <code>idempotencyToken</code>, <code>name</code>, <code>physicalId</code>, <code>productId</code>, <code>provisioningArtifact</code>, <code>type</code>, <code>status</code>, <code>tags</code>, <code>userArn</code>, and <code>userArnSession</code>.</p> <p>Example: <code>\"SearchQuery\":[\"status:AVAILABLE\"]</code> </p>"
},
"SortBy":{
"shape":"SortField",
"documentation":"<p>The sort field. If no value is specified, the results are not sorted. The valid values are <code>arn</code>, <code>id</code>, <code>name</code>, and <code>lastRecordId</code>.</p>"
},
"SortOrder":{
"shape":"SortOrder",
"documentation":"<p>The sort order. If no value is specified, the results are not sorted.</p>"
},
"PageSize":{
"shape":"SearchProvisionedProductsPageSize",
"documentation":"<p>The maximum number of items to return with this call.</p>"
},
"PageToken":{
"shape":"PageToken",
"documentation":"<p>The page token for the next set of results. To retrieve the first set of results, use null.</p>"
}
}
},
"SearchProvisionedProductsOutput":{
"type":"structure",
"members":{
"ProvisionedProducts":{
"shape":"ProvisionedProductAttributes",
"documentation":"<p>Information about the provisioned products.</p>"
},
"TotalResultsCount":{
"shape":"TotalResultsCount",
"documentation":"<p>The number of provisioned products found.</p>"
},
"NextPageToken":{
"shape":"PageToken",
"documentation":"<p>The page token to use to retrieve the next set of results. If there are no additional results, this value is null.</p>"
}
}
},
"SearchProvisionedProductsPageSize":{
"type":"integer",
"max":100,
"min":0
},
"SortField":{"type":"string"},
"SortOrder":{
"type":"string",
"enum":[
@ -3277,6 +3987,10 @@
]
},
"StatusDetail":{"type":"string"},
"StatusMessage":{
"type":"string",
"pattern":"[\\u0009\\u000a\\u000d\\u0020-\\uD7FF\\uE000-\\uFFFD]*"
},
"SupportDescription":{"type":"string"},
"SupportEmail":{"type":"string"},
"SupportUrl":{"type":"string"},
@ -3296,7 +4010,7 @@
"documentation":"<p>The value for this key.</p>"
}
},
"documentation":"<p>Information about a tag. A tag is a key-value pair. Tags are entirely discretionary and are propagated to the resources created when provisioning a product.</p>"
"documentation":"<p>Information about a tag. A tag is a key-value pair. Tags are propagated to the resources created when provisioning a product.</p>"
},
"TagKey":{
"type":"string",
@ -3428,6 +4142,7 @@
}
}
},
"TotalResultsCount":{"type":"integer"},
"UpdateConstraintInput":{
"type":"structure",
"required":["Id"],
@ -3607,7 +4322,7 @@
},
"UpdateToken":{
"shape":"IdempotencyToken",
"documentation":"<p>The idempotency token that uniquely identifies the provisioning update rquest.</p>",
"documentation":"<p>The idempotency token that uniquely identifies the provisioning update request.</p>",
"idempotencyToken":true
}
}
@ -3740,6 +4455,8 @@
"member":{"shape":"UsageInstruction"}
},
"UsePreviousValue":{"type":"boolean"},
"UserArn":{"type":"string"},
"UserArnSession":{"type":"string"},
"Verbose":{"type":"boolean"}
},
"documentation":"<fullname>AWS Service Catalog</fullname> <p> <a href=\"https://aws.amazon.com/servicecatalog/\">AWS Service Catalog</a> enables organizations to create and manage catalogs of IT services that are approved for use on AWS. To get the most out of this documentation, you should be familiar with the terminology discussed in <a href=\"http://docs.aws.amazon.com/servicecatalog/latest/adminguide/what-is_concepts.html\">AWS Service Catalog Concepts</a>.</p>"

168
botocore/data/servicediscovery/2017-03-14/service-2.json
View file

@ -59,7 +59,7 @@
{"shape":"NamespaceNotFound"},
{"shape":"ServiceAlreadyExists"}
],
"documentation":"<p>Creates a service, which defines a template for the following entities:</p> <ul> <li> <p>One to five resource record sets</p> </li> <li> <p>Optionally, a health check</p> </li> </ul> <p>After you create the service, you can submit a <a>RegisterInstance</a> request, and Amazon Route 53 uses the values in the template to create the specified entities. </p>"
"documentation":"<p>Creates a service, which defines the configuration for the following entities:</p> <ul> <li> <p>Up to three records (A, AAAA, and SRV) or one CNAME record</p> </li> <li> <p>Optionally, a health check</p> </li> </ul> <p>After you create the service, you can submit a <a>RegisterInstance</a> request, and Amazon Route 53 uses the values in the configuration to create the specified entities. </p>"
},
"DeleteNamespace":{
"name":"DeleteNamespace",
@ -107,7 +107,7 @@
{"shape":"ResourceInUse"},
{"shape":"ServiceNotFound"}
],
"documentation":"<p>Deletes the resource record sets and the health check, if any, that Amazon Route 53 created for the specified instance.</p>"
"documentation":"<p>Deletes the records and the health check, if any, that Amazon Route 53 created for the specified instance.</p>"
},
"GetInstance":{
"name":"GetInstance",
@ -137,7 +137,7 @@
{"shape":"InvalidInput"},
{"shape":"ServiceNotFound"}
],
"documentation":"<p>Gets the current health status (<code>Healthy</code>, <code>Unhealthy</code>, or <code>Unknown</code>) of one or more instances that are associated with a specified service.</p>"
"documentation":"<p>Gets the current health status (<code>Healthy</code>, <code>Unhealthy</code>, or <code>Unknown</code>) of one or more instances that are associated with a specified service.</p> <note> <p>There is a brief delay between when you register an instance and when the health status for the instance is available. </p> </note>"
},
"GetNamespace":{
"name":"GetNamespace",
@ -164,7 +164,7 @@
"errors":[
{"shape":"OperationNotFound"}
],
"documentation":"<p>Gets information about any operation that returns an operation ID in the response, such as a <code>CreateService</code> request. To get a list of operations that match specified criteria, see <a>ListOperations</a>.</p>"
"documentation":"<p>Gets information about any operation that returns an operation ID in the response, such as a <code>CreateService</code> request.</p> <note> <p>To get a list of operations that match specified criteria, see <a>ListOperations</a>.</p> </note>"
},
"GetService":{
"name":"GetService",
@ -192,7 +192,7 @@
{"shape":"ServiceNotFound"},
{"shape":"InvalidInput"}
],
"documentation":"<p>Gets summary information about the instances that you created by using a specified service.</p>"
"documentation":"<p>Lists summary information about the instances that you registered by using a specified service.</p>"
},
"ListNamespaces":{
"name":"ListNamespaces",
@ -205,7 +205,7 @@
"errors":[
{"shape":"InvalidInput"}
],
"documentation":"<p>Gets information about the namespaces that were created by the current AWS account.</p>"
"documentation":"<p>Lists summary information about the namespaces that were created by the current AWS account.</p>"
},
"ListOperations":{
"name":"ListOperations",
@ -228,7 +228,10 @@
},
"input":{"shape":"ListServicesRequest"},
"output":{"shape":"ListServicesResponse"},
"documentation":"<p>Gets settings for all the services that are associated with one or more specified namespaces.</p>"
"errors":[
{"shape":"InvalidInput"}
],
"documentation":"<p>Lists summary information for all the services that are associated with one or more specified namespaces.</p>"
},
"RegisterInstance":{
"name":"RegisterInstance",
@ -245,7 +248,7 @@
{"shape":"ResourceLimitExceeded"},
{"shape":"ServiceNotFound"}
],
"documentation":"<p>Creates one or more resource record sets and optionally a health check based on the settings in a specified service. When you submit a <code>RegisterInstance</code> request, Amazon Route 53 does the following:</p> <ul> <li> <p>Creates a resource record set for each resource record set template in the service</p> </li> <li> <p>Creates a health check based on the settings in the health check template in the service, if any</p> </li> <li> <p>Associates the health check, if any, with each of the resource record sets</p> </li> </ul> <important> <p>One <code>RegisterInstance</code> request must complete before you can submit another request and specify the same service and instance ID.</p> </important> <p>For more information, see <a>CreateService</a>.</p> <p>When Amazon Route 53 receives a DNS query for the specified DNS name, it returns the applicable value:</p> <ul> <li> <p> <b>If the health check is healthy</b>: returns all the resource record sets</p> </li> <li> <p> <b>If the health check is unhealthy</b>: returns the IP address of the last healthy instance</p> </li> <li> <p> <b>If you didn't specify a health check template</b>: returns all the resource record sets</p> </li> </ul>"
"documentation":"<p>Creates or updates one or more records and optionally a health check based on the settings in a specified service. When you submit a <code>RegisterInstance</code> request, Amazon Route 53 does the following:</p> <ul> <li> <p>For each DNS record that you define in the service specified by <code>ServiceId</code>, creates or updates a record in the hosted zone that is associated with the corresponding namespace</p> </li> <li> <p>Creates or updates a health check based on the settings in the health check configuration, if any, for the service</p> </li> <li> <p>Associates the health check, if any, with each of the records</p> </li> </ul> <important> <p>One <code>RegisterInstance</code> request must complete before you can submit another request and specify the same service ID and instance ID.</p> </important> <p>For more information, see <a>CreateService</a>.</p> <p>When Route 53 receives a DNS query for the specified DNS name, it returns the applicable value:</p> <ul> <li> <p> <b>If the health check is healthy</b>: returns all the records</p> </li> <li> <p> <b>If the health check is unhealthy</b>: returns the IP address of the last healthy instance</p> </li> <li> <p> <b>If you didn't specify a health check configuration</b>: returns all the records</p> </li> </ul>"
},
"UpdateService":{
"name":"UpdateService",
@ -260,7 +263,7 @@
{"shape":"InvalidInput"},
{"shape":"ServiceNotFound"}
],
"documentation":"<p>Updates the TTL setting for a specified service. You must specify all the resource record set templates (and, optionally, a health check template) that you want to appear in the updated service. Any current resource record set templates (or health check template) that don't appear in an <code>UpdateService</code> request are deleted.</p> <p>When you update the TTL setting for a service, Amazon Route 53 also updates the corresponding settings in all the resource record sets and health checks that were created by using the specified service.</p>"
"documentation":"<p>Submits a request to perform the following operations:</p> <ul> <li> <p>Add or delete <code>DnsRecords</code> configurations</p> </li> <li> <p>Update the TTL setting for existing <code>DnsRecords</code> configurations</p> </li> <li> <p>Add, update, or delete <code>HealthCheckConfig</code> for a specified service</p> </li> <li> <p/> </li> </ul> <p>You must specify all <code>DnsRecords</code> configurations (and, optionally, <code>HealthCheckConfig</code>) that you want to appear in the updated service. Any current configurations that don't appear in an <code>UpdateService</code> request are deleted.</p> <p>When you update the TTL setting for a service, Amazon Route 53 also updates the corresponding settings in all the records and health checks that were created by using the specified service.</p>"
}
},
"shapes":{
@ -295,7 +298,7 @@
},
"CreatorRequestId":{
"shape":"ResourceId",
"documentation":"<p>An optional parameter that you can use to resolve concurrent creation requests. <code>CreatorRequestId</code> helps to determine if a specific client owns the namespace.</p>",
"documentation":"<p>A unique string that identifies the request and that allows failed <code>CreatePrivateDnsNamespace</code> requests to be retried without the risk of executing the operation twice. <code>CreatorRequestId</code> can be any unique string, for example, a date/time stamp.</p>",
"idempotencyToken":true
},
"Description":{
@ -327,7 +330,7 @@
},
"CreatorRequestId":{
"shape":"ResourceId",
"documentation":"<p>An optional parameter that you can use to resolve concurrent creation requests. <code>CreatorRequestId</code> helps to determine if a specific client owns the namespace.</p>",
"documentation":"<p>A unique string that identifies the request and that allows failed <code>CreatePublicDnsNamespace</code> requests to be retried without the risk of executing the operation twice. <code>CreatorRequestId</code> can be any unique string, for example, a date/time stamp.</p>",
"idempotencyToken":true
},
"Description":{
@ -358,7 +361,7 @@
},
"CreatorRequestId":{
"shape":"ResourceId",
"documentation":"<p>An optional parameter that you can use to resolve concurrent creation requests. <code>CreatorRequestId</code> helps to determine if a specific client owns the namespace.</p>",
"documentation":"<p>A unique string that identifies the request and that allows failed <code>CreateService</code> requests to be retried without the risk of executing the operation twice. <code>CreatorRequestId</code> can be any unique string, for example, a date/time stamp.</p>",
"idempotencyToken":true
},
"Description":{
@ -367,11 +370,11 @@
},
"DnsConfig":{
"shape":"DnsConfig",
"documentation":"<p>A complex type that contains information about the resource record sets that you want Amazon Route 53 to create when you register an instance. </p>"
"documentation":"<p>A complex type that contains information about the records that you want Route 53 to create when you register an instance. </p>"
},
"HealthCheckConfig":{
"shape":"HealthCheckConfig",
"documentation":"<p> <i>Public DNS namespaces only.</i> A complex type that contains settings for an optional health check. If you specify settings for a health check, Amazon Route 53 associates the health check with all the resource record sets that you specify in <code>DnsConfig</code>.</p> <note> <p>The health check uses 30 seconds as the request interval. This is the number of seconds between the time that each Amazon Route 53 health checker gets a response from your endpoint and the time that it sends the next health check request. A health checker in each data center around the world sends your endpoint a health check request every 30 seconds. On average, your endpoint receives a health check request about every two seconds. Health checkers in different data centers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all.</p> </note> <p>For information about the charges for health checks, see <a href=\"http://aws.amazon.com/route53/pricing\">Amazon Route 53 Pricing</a>.</p>"
"documentation":"<p> <i>Public DNS namespaces only.</i> A complex type that contains settings for an optional health check. If you specify settings for a health check, Route 53 associates the health check with all the records that you specify in <code>DnsConfig</code>.</p> <p>For information about the charges for health checks, see <a href=\"http://aws.amazon.com/route53/pricing\">Route 53 Pricing</a>.</p>"
}
}
},
@ -455,12 +458,16 @@
"shape":"ResourceId",
"documentation":"<p>The ID of the namespace to use for DNS configuration.</p>"
},
"RoutingPolicy":{
"shape":"RoutingPolicy",
"documentation":"<p>The routing policy that you want to apply to all records that Route 53 creates when you register an instance and specify this service.</p> <note> <p>If you want to use this service to register instances that create alias records, specify <code>WEIGHTED</code> for the routing policy.</p> </note> <p>You can specify the following values:</p> <p> <b>MULTIVALUE</b> </p> <p>If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.</p> <p>For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.</p> <p>If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.</p> <p>For more information about the multivalue routing policy, see <a href=\"http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-multivalue\">Multivalue Answer Routing</a> in the <i>Route 53 Developer Guide</i>.</p> <p> <b>WEIGHTED</b> </p> <p>Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.</p> <p>For example, suppose the service includes configurations for one A record and a health check, and you use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.</p> <p>If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.</p> <p>For more information about the weighted routing policy, see <a href=\"http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-policy.html#routing-policy-weighted\">Weighted Routing</a> in the <i>Route 53 Developer Guide</i>.</p>"
},
"DnsRecords":{
"shape":"DnsRecordList",
"documentation":"<p>An array that contains one <code>DnsRecord</code> object for each resource record set that you want Amazon Route 53 to create when you register an instance.</p>"
"documentation":"<p>An array that contains one <code>DnsRecord</code> object for each record that you want Route 53 to create when you register an instance.</p>"
}
},
"documentation":"<p>A complex type that contains information about the resource record sets that you want Amazon Route 53 to create when you register an instance.</p>"
"documentation":"<p>A complex type that contains information about the records that you want Amazon Route 53 to create when you register an instance.</p>"
},
"DnsConfigChange":{
"type":"structure",
@ -468,20 +475,20 @@
"members":{
"DnsRecords":{
"shape":"DnsRecordList",
"documentation":"<p>An array that contains one <code>DnsRecord</code> object for each resource record set that you want Amazon Route 53 to create when you register an instance.</p>"
"documentation":"<p>An array that contains one <code>DnsRecord</code> object for each record that you want Route 53 to create when you register an instance.</p>"
}
},
"documentation":"<p>A complex type that contains information about changes to the resource record sets that Amazon Route 53 creates when you register an instance.</p>"
"documentation":"<p>A complex type that contains information about changes to the records that Route 53 creates when you register an instance.</p>"
},
"DnsProperties":{
"type":"structure",
"members":{
"HostedZoneId":{
"shape":"ResourceId",
"documentation":"<p>The ID for the hosted zone that Amazon Route 53 creates when you create a namespace.</p>"
"documentation":"<p>The ID for the hosted zone that Route 53 creates when you create a namespace.</p>"
}
},
"documentation":"<p>A complex type that contains the ID for the hosted zone that Amazon Route 53 creates when you create a namespace.</p>"
"documentation":"<p>A complex type that contains the ID for the hosted zone that Route 53 creates when you create a namespace.</p>"
},
"DnsRecord":{
"type":"structure",
@ -492,14 +499,14 @@
"members":{
"Type":{
"shape":"RecordType",
"documentation":"<p>The type of the resource, which indicates the value that Amazon Route 53 returns in response to DNS queries. The following values are supported:</p> <ul> <li> <p> <b>A</b>: Amazon Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.</p> </li> <li> <p> <b>AAAA</b>: Amazon Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.</p> </li> <li> <p> <b>SRV</b>: Amazon Route 53 returns the value for an SRV record. The value for an SRV record uses the following template, which can't be changed:</p> <p> <code>priority weight port resource-record-set-name</code> </p> <p>The values of <code>priority</code> and <code>weight</code> are both set to 1. The value of port comes from the value that you specify for <code>Port</code> when you submit a <a>RegisterInstance</a> request.</p> </li> </ul>"
"documentation":"<p>The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries.</p> <p>Note the following:</p> <ul> <li> <p> <b>A, AAAA, and SRV records: You can specify settings for a maximum of one A, one AAAA, and one SRV record. You can specify them in any combination.</b> </p> </li> <li> <p> <b>CNAME records:</b> If you specify <code>CNAME</code> for <code>Type</code>, you can't define any other records. This is a limitation of DNS—you can't create a CNAME record and any other type of record that has the same name as a CNAME record.</p> </li> <li> <p> <b>Alias records:</b> If you want Route 53 to create an alias record when you register an instance, specify <code>A</code> or <code>AAAA</code> for <code>Type</code>.</p> </li> <li> <p> <b>All records:</b> You specify settings other than <code>TTL</code> and <code>Type</code> when you register an instance.</p> </li> </ul> <p>The following values are supported:</p> <p> <b>A</b> </p> <p>Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.</p> <p> <b>AAAA</b> </p> <p>Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.</p> <p> <b>CNAME</b> </p> <p>Route 53 returns the domain name of the resource, such as www.example.com. Note the following:</p> <ul> <li> <p>You specify the domain name that you want to route traffic to when you register an instance. For more information, see <a>RegisterInstanceRequest$Attributes</a>.</p> </li> <li> <p>You must specify <code>WEIGHTED</code> for the value of <code>RoutingPolicy</code>.</p> </li> <li> <p>You can't specify both <code>CNAME</code> for <code>Type</code> and settings for <code>HealthCheckConfig</code>. If you do, the request will fail with an <code>InvalidInput</code> error.</p> </li> </ul> <p> <b>SRV</b> </p> <p>Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:</p> <p> <code>priority weight port service-hostname</code> </p> <p>Note the following about the values:</p> <ul> <li> <p>The values of <code>priority</code> and <code>weight</code> are both set to <code>1</code> and can't be changed. </p> </li> <li> <p>The value of <code>port</code> comes from the value that you specify for the <code>AWS_INSTANCE_PORT</code> attribute when you submit a <a>RegisterInstance</a> request. </p> </li> <li> <p>The value of <code>service-hostname</code> is a concatenation of the following values:</p> <ul> <li> <p>The value that you specify for <code>InstanceId</code> when you register an instance.</p> </li> <li> <p>The name of the service.</p> </li> <li> <p>The name of the namespace. </p> </li> </ul> <p>For example, if the value of <code>InstanceId</code> is <code>test</code>, the name of the service is <code>backend</code>, and the name of the namespace is <code>example.com</code>, the value of <code>service-hostname</code> is:</p> <p> <code>test.backend.example.com</code> </p> </li> </ul> <p>If you specify settings for an SRV record and if you specify values for <code>AWS_INSTANCE_IPV4</code>, <code>AWS_INSTANCE_IPV6</code>, or both in the <code>RegisterInstance</code> request, Route 53 automatically creates <code>A</code> and/or <code>AAAA</code> records that have the same name as the value of <code>service-hostname</code> in the SRV record. You can ignore these records.</p>"
},
"TTL":{
"shape":"RecordTTL",
"documentation":"<p>The amount of time, in seconds, that you want DNS resolvers to cache the settings for this resource record set.</p>"
"documentation":"<p>The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.</p> <note> <p>Alias records don't include a TTL because Route 53 uses the TTL for the AWS resource that an alias record routes traffic to. If you include the <code>AWS_ALIAS_DNS_NAME</code> attribute when you submit a <a>RegisterInstance</a> request, the <code>TTL</code> value is ignored. Always specify a TTL for the service; you can use a service to register instances that create either alias or non-alias records.</p> </note>"
}
},
"documentation":"<p>A complex type that contains information about the resource record sets that you want Amazon Route 53 to create when you register an instance.</p>"
"documentation":"<p>A complex type that contains information about the records that you want Route 53 to create when you register an instance.</p>"
},
"DnsRecordList":{
"type":"list",
@ -510,7 +517,7 @@
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>This request tried to create an object that already exists.</p>",
"documentation":"<p>The operation is already in progress.</p>",
"exception":true
},
"ErrorMessage":{"type":"string"},
@ -572,11 +579,11 @@
},
"Instances":{
"shape":"InstanceIdList",
"documentation":"<p>An array that contains the IDs of all the instances that you want to get the health status for. To get the IDs for the instances that you've created by using a specified service, submit a <a>ListInstances</a> request.</p> <p>If you omit <code>Instances</code>, Amazon Route 53 returns the health status for all the instances that are associated with the specified service.</p>"
"documentation":"<p>An array that contains the IDs of all the instances that you want to get the health status for.</p> <p>If you omit <code>Instances</code>, Amazon Route 53 returns the health status for all the instances that are associated with the specified service.</p> <note> <p>To get the IDs for the instances that you've registered by using a specified service, submit a <a>ListInstances</a> request.</p> </note>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of instances that you want Amazon Route 53 to return in the response to a <code>GetInstancesHealthStatus</code> request. If you don't specify a value for <code>MaxResults</code>, Amazon Route 53 returns up to 100 instances.</p>"
"documentation":"<p>The maximum number of instances that you want Route 53 to return in the response to a <code>GetInstancesHealthStatus</code> request. If you don't specify a value for <code>MaxResults</code>, Route 53 returns up to 100 instances.</p>"
},
"NextToken":{
"shape":"NextToken",
@ -656,21 +663,22 @@
},
"HealthCheckConfig":{
"type":"structure",
"required":["Type"],
"members":{
"Type":{
"shape":"HealthCheckType",
"documentation":"<p>The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.</p> <important> <p>You can't change the value of <code>Type</code> after you create a health check.</p> </important> <p>You can create the following types of health checks:</p> <ul> <li> <p> <b>HTTP</b>: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.</p> </li> <li> <p> <b>HTTPS</b>: Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.</p> <important> <p>If you specify HTTPS for the value of <code>Type</code>, the endpoint must support TLS v1.0 or later.</p> </important> </li> <li> <p> <b>TCP</b>: Amazon Route 53 tries to establish a TCP connection.</p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html\">How Amazon Route 53 Determines Whether an Endpoint Is Healthy</a> in the <i>Amazon Route 53 Developer Guide</i>.</p>"
"documentation":"<p>The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.</p> <important> <p>You can't change the value of <code>Type</code> after you create a health check.</p> </important> <p>You can create the following types of health checks:</p> <ul> <li> <p> <b>HTTP</b>: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.</p> </li> <li> <p> <b>HTTPS</b>: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.</p> <important> <p>If you specify HTTPS for the value of <code>Type</code>, the endpoint must support TLS v1.0 or later.</p> </important> </li> <li> <p> <b>TCP</b>: Route 53 tries to establish a TCP connection.</p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html\">How Route 53 Determines Whether an Endpoint Is Healthy</a> in the <i>Route 53 Developer Guide</i>.</p>"
},
"ResourcePath":{
"shape":"ResourcePath",
"documentation":"<p>The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file <code>/docs/route53-health-check.html</code>. Amazon Route 53 automatically adds the DNS name for the service and a leading forward slash (<code>/</code>) character. </p>"
"documentation":"<p>The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file <code>/docs/route53-health-check.html</code>. Route 53 automatically adds the DNS name for the service and a leading forward slash (<code>/</code>) character. </p>"
},
"FailureThreshold":{
"shape":"FailureThreshold",
"documentation":"<p>The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see <a href=\"http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html\">How Amazon Route 53 Determines Whether an Endpoint Is Healthy</a> in the <i>Amazon Route 53 Developer Guide</i>.</p>"
"documentation":"<p>The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see <a href=\"http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-failover-determining-health-of-endpoints.html\">How Route 53 Determines Whether an Endpoint Is Healthy</a> in the <i>Route 53 Developer Guide</i>.</p>"
}
},
"documentation":"<p> <i>Public DNS namespaces only.</i> A complex type that contains settings for an optional health check. If you specify settings for a health check, Amazon Route 53 associates the health check with all the resource record sets that you specify in <code>DnsConfig</code>.</p> <note> <p>The health check uses 30 seconds as the request interval. This is the number of seconds between the time that each Amazon Route 53 health checker gets a response from your endpoint and the time that it sends the next health check request. A health checker in each data center around the world sends your endpoint a health check request every 30 seconds. On average, your endpoint receives a health check request about every two seconds. Health checkers in different data centers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all.</p> </note> <p>For information about the charges for health checks, see <a href=\"http://aws.amazon.com/route53/pricing\">Amazon Route 53 Pricing</a>.</p>"
"documentation":"<p> <i>Public DNS namespaces only.</i> A complex type that contains settings for an optional health check. If you specify settings for a health check, Amazon Route 53 associates the health check with all the records that you specify in <code>DnsConfig</code>.</p> <p> <b>A and AAAA records</b> </p> <p>If <code>DnsConfig</code> includes configurations for both A and AAAA records, Route 53 creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint that is specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy. </p> <p> <b>CNAME records</b> </p> <p>You can't specify settings for <code>HealthCheckConfig</code> when the <code>DNSConfig</code> includes <code>CNAME</code> for the value of <code>Type</code>. If you do, the <code>CreateService</code> request will fail with an <code>InvalidInput</code> error.</p> <p> <b>Request interval</b> </p> <p>The health check uses 30 seconds as the request interval. This is the number of seconds between the time that each Route 53 health checker gets a response from your endpoint and the time that it sends the next health check request. A health checker in each data center around the world sends your endpoint a health check request every 30 seconds. On average, your endpoint receives a health check request about every two seconds. Health checkers in different data centers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all.</p> <p> <b>Health checking regions</b> </p> <p>Health checkers perform checks from all Route 53 health-checking regions. For a list of the current regions, see <a href=\"http://docs.aws.amazon.com/Route53/latest/APIReference/API_HealthCheckConfig.html#Route53-Type-HealthCheckConfig-Regions\">Regions</a>.</p> <p> <b>Alias records</b> </p> <p>When you register an instance, if you include the <code>AWS_ALIAS_DNS_NAME</code> attribute, Route 53 creates an alias record. Note the following:</p> <ul> <li> <p>Route 53 automatically sets <code>EvaluateTargetHealth</code> to true for alias records. When <code>EvaluateTargetHealth</code> is true, the alias record inherits the health of the referenced AWS resource. such as an ELB load balancer. For more information, see <a href=\"http://docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html#Route53-Type-AliasTarget-EvaluateTargetHealth\">EvaluateTargetHealth</a>.</p> </li> <li> <p>If you include <code>HealthCheckConfig</code> and then use the service to register an instance that creates an alias record, Route 53 doesn't create the health check.</p> </li> </ul> <p>For information about the charges for health checks, see <a href=\"http://aws.amazon.com/route53/pricing\">Route 53 Pricing</a>.</p>"
},
"HealthCheckType":{
"type":"string",
@ -694,15 +702,15 @@
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"<p>An identifier that you want to associate with the instance. Note the following:</p> <ul> <li> <p>You can use this value to update an existing instance.</p> </li> <li> <p>To associate a new instance, you must specify a value that is unique among instances that you associate by using the same service.</p> </li> </ul>"
"documentation":"<p>An identifier that you want to associate with the instance. Note the following:</p> <ul> <li> <p>If the service that is specified by <code>ServiceId</code> includes settings for an SRV record, the value of <code>InstanceId</code> is automatically included as part of the value for the SRV record. For more information, see <a>DnsRecord$Type</a>.</p> </li> <li> <p>You can use this value to update an existing instance.</p> </li> <li> <p>To register a new instance, you must specify a value that is unique among instances that you register by using the same service. </p> </li> <li> <p>If you specify an existing <code>InstanceId</code> and <code>ServiceId</code>, Route 53 updates the existing records. If there's also an existing health check, Route 53 deletes the old health check and creates a new one. </p> <note> <p>The health check isn't deleted immediately, so it will still appear for a while if you submit a <code>ListHealthChecks</code> request, for example.</p> </note> </li> </ul>"
},
"CreatorRequestId":{
"shape":"ResourceId",
"documentation":"<p>An optional parameter that you can use to resolve concurrent creation requests. <code>CreatorRequestId</code> helps to determine if a specific client owns the namespace.</p>"
"documentation":"<p>A unique string that identifies the request and that allows failed <code>RegisterInstance</code> requests to be retried without the risk of executing the operation twice. You must use a unique <code>CreatorRequestId</code> string every time you submit a <code>RegisterInstance</code> request if you're registering additional instances for the same namespace and service. <code>CreatorRequestId</code> can be any unique string, for example, a date/time stamp.</p>"
},
"Attributes":{
"shape":"Attributes",
"documentation":"<p>A string map that contains attribute keys and values. Supported attribute keys include the following:</p> <ul> <li> <p> <code>AWS_INSTANCE_PORT</code>: The port on the endpoint that you want Amazon Route 53 to perform health checks on. This value is also used for the port value in an SRV record if the service that you specify includes an SRV record. For more information, see <a>CreateService</a>.</p> </li> <li> <p> <code>AWS_INSTANCE_IP</code>: If the service that you specify contains a resource record set template for an A or AAAA record, the IP address that you want Amazon Route 53 to use for the value of the A record.</p> </li> <li> <p> <code>AWS_INSTANCE_WEIGHT</code>: The weight value in an SRV record if the service that you specify includes an SRV record. You can also specify a default weight that is applied to all instances in the <code>Service</code> configuration. For more information, see <a>CreateService</a>.</p> </li> <li> <p> <code>AWS_INSTANCE_PRIORITY</code>: The priority value in an SRV record if the service that you specify includes an SRV record.</p> </li> </ul>"
"documentation":"<p>A string map that contains the following information for the service that you specify in <code>ServiceId</code>:</p> <ul> <li> <p>The attributes that apply to the records that are defined in the service. </p> </li> <li> <p>For each attribute, the applicable value.</p> </li> </ul> <p>Supported attribute keys include the following:</p> <ul> <li> <p> <code>AWS_ALIAS_DNS_NAME</code>: If you want Route 53 to create an alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see \"DNSName\" in the topic <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html\">AliasTarget</a>.</p> <p>Note the following:</p> <ul> <li> <p>The configuration for the service that is specified by <code>ServiceId</code> must include settings for an A record, an AAAA record, or both.</p> </li> <li> <p>In the service that is specified by <code>ServiceId</code>, the value of <code>RoutingPolicy</code> must be <code>WEIGHTED</code>.</p> </li> <li> <p>If the service that is specified by <code>ServiceId</code> includes <code>HealthCheckConfig</code> settings, Route 53 will create the health check, but it won't associate the health check with the alias record.</p> </li> <li> <p>Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers.</p> </li> <li> <p>If you specify a value for <code>AWS_ALIAS_DNS_NAME</code>, don't specify values for any of the <code>AWS_INSTANCE</code> attributes.</p> </li> </ul> </li> <li> <p> <code>AWS_INSTANCE_CNAME</code>: If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries, for example, <code>example.com</code>.</p> <p>This value is required if the service specified by <code>ServiceId</code> includes settings for an CNAME record.</p> </li> <li> <p> <code>AWS_INSTANCE_IPV4</code>: If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to DNS queries, for example, <code>192.0.2.44</code>.</p> <p>This value is required if the service specified by <code>ServiceId</code> includes settings for an A record. Either <code>AWS_INSTANCE_IPV4</code> or <code>AWS_INSTANCE_IPV6</code> is required if the service includes settings for an SRV record.</p> </li> <li> <p> <code>AWS_INSTANCE_IPV6</code>: If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response to DNS queries, for example, <code>2001:0db8:85a3:0000:0000:abcd:0001:2345</code>.</p> <p>This value is required if the service specified by <code>ServiceId</code> includes settings for an AAAA record. Either <code>AWS_INSTANCE_IPV4</code> or <code>AWS_INSTANCE_IPV6</code> is required if the service includes settings for an SRV record.</p> </li> <li> <p> <code>AWS_INSTANCE_PORT</code>: If the service includes an SRV record, the value that you want Route 53 to return for the port. In addition, if the service includes <code>HealthCheckConfig</code>, the port on the endpoint that you want Route 53 to send requests to. For more information, see <a>CreateService</a>.</p> <p>This value is required if you specified settings for an SRV record when you created the service.</p> </li> </ul>"
}
},
"documentation":"<p>A complex type that contains information about an instance that Amazon Route 53 creates when you submit a <code>RegisterInstance</code> request.</p>"
@ -722,7 +730,7 @@
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>No instance exists with the specified ID.</p>",
"documentation":"<p>No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.</p>",
"exception":true
},
"InstanceSummary":{
@ -734,10 +742,10 @@
},
"Attributes":{
"shape":"Attributes",
"documentation":"<p>A string map that contain attribute keys and values for an instance. Supported attribute keys include the following:</p> <ul> <li> <p> <code>AWS_INSTANCE_PORT</code>: The port on the endpoint that you want Amazon Route 53 to perform health checks on. This value is also used for the port value in an SRV record if the service that you specify includes an SRV record. For more information, see <a>CreateService</a>.</p> </li> <li> <p> <code>AWS_INSTANCE_IP</code>: If the service that you specify contains a resource record set template for an A or AAAA record, the IP address that you want Amazon Route 53 to use for the value of the A record.</p> </li> </ul>"
"documentation":"<p>A string map that contains the following information:</p> <ul> <li> <p>The attributes that are associate with the instance. </p> </li> <li> <p>For each attribute, the applicable value.</p> </li> </ul> <p>Supported attribute keys include the following:</p> <ul> <li> <p> <code>AWS_ALIAS_DNS_NAME</code>: For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that is associated with the load balancer. </p> </li> <li> <p> <code>AWS_INSTANCE_CNAME</code>: For a CNAME record, the domain name that Route 53 returns in response to DNS queries, for example, <code>example.com</code>.</p> </li> <li> <p> <code>AWS_INSTANCE_IPV4</code>: For an A record, the IPv4 address that Route 53 returns in response to DNS queries, for example, <code>192.0.2.44</code>.</p> </li> <li> <p> <code>AWS_INSTANCE_IPV6</code>: For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries, for example, <code>2001:0db8:85a3:0000:0000:abcd:0001:2345</code>.</p> </li> <li> <p> <code>AWS_INSTANCE_PORT</code>: For an SRV record, the value that Route 53 returns for the port. In addition, if the service includes <code>HealthCheckConfig</code>, the port on the endpoint that Route 53 sends requests to.</p> </li> </ul>"
}
},
"documentation":"<p>A complex type that contains information about the instances that you created by using a specified service.</p>"
"documentation":"<p>A complex type that contains information about the instances that you registered by using a specified service.</p>"
},
"InstanceSummaryList":{
"type":"list",
@ -765,7 +773,7 @@
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of instances that you want Amazon Route 53 to return in the response to a <code>ListInstances</code> request. If you don't specify a value for <code>MaxResults</code>, Amazon Route 53 returns up to 100 instances.</p>"
"documentation":"<p>The maximum number of instances that you want Amazon Route 53 to return in the response to a <code>ListInstances</code> request. If you don't specify a value for <code>MaxResults</code>, Route 53 returns up to 100 instances.</p>"
}
}
},
@ -787,15 +795,15 @@
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>For the first <code>ListNamespaces</code> request, omit this value.</p> <p>If more than <code>MaxResults</code> namespaces match the specified criteria, you can submit another <code>ListNamespaces</code> request to get the next group of results. Specify the value of <code>NextToken</code> from the previous response in the next request.</p>"
"documentation":"<p>For the first <code>ListNamespaces</code> request, omit this value.</p> <p>If the response contains <code>NextToken</code>, submit another <code>ListNamespaces</code> request to get the next group of results. Specify the value of <code>NextToken</code> from the previous response in the next request.</p> <note> <p>Route 53 gets <code>MaxResults</code> namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the first <code>MaxResults</code> namespaces matched the specified criteria but that subsequent groups of <code>MaxResults</code> namespaces do contain namespaces that match the criteria.</p> </note>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of namespaces that you want Amazon Route 53 to return in the response to a <code>ListNamespaces</code> request. If you don't specify a value for <code>MaxResults</code>, Amazon Route 53 returns up to 100 namespaces.</p>"
"documentation":"<p>The maximum number of namespaces that you want Amazon Route 53 to return in the response to a <code>ListNamespaces</code> request. If you don't specify a value for <code>MaxResults</code>, Route 53 returns up to 100 namespaces.</p>"
},
"Filters":{
"shape":"NamespaceFilters",
"documentation":"<p>A complex type that contains specifications for the namespaces that you want to list.</p> <p>If you specify more than one filter, an operation must match all filters to be returned by ListNamespaces.</p>"
"documentation":"<p>A complex type that contains specifications for the namespaces that you want to list.</p> <p>If you specify more than one filter, a namespace must match all filters to be returned by <code>ListNamespaces</code>.</p>"
}
}
},
@ -808,7 +816,7 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If more than <code>MaxResults</code> namespaces match the specified criteria, you can submit another <code>ListNamespaces</code> request to get the next group of results. Specify the value of <code>NextToken</code> from the previous response in the next request.</p>"
"documentation":"<p>If the response contains <code>NextToken</code>, submit another <code>ListNamespaces</code> request to get the next group of results. Specify the value of <code>NextToken</code> from the previous response in the next request.</p> <note> <p>Route 53 gets <code>MaxResults</code> namespaces and then filters them based on the specified criteria. It's possible that no namespaces in the first <code>MaxResults</code> namespaces matched the specified criteria but that subsequent groups of <code>MaxResults</code> namespaces do contain namespaces that match the criteria.</p> </note>"
}
}
},
@ -817,11 +825,11 @@
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>For the first <code>ListOperations</code> request, omit this value.</p> <p>If more than <code>MaxResults</code> operations match the specified criteria, you can submit another <code>ListOperations</code> request to get the next group of results. Specify the value of <code>NextToken</code> from the previous response in the next request.</p>"
"documentation":"<p>For the first <code>ListOperations</code> request, omit this value.</p> <p>If the response contains <code>NextToken</code>, submit another <code>ListOperations</code> request to get the next group of results. Specify the value of <code>NextToken</code> from the previous response in the next request.</p> <note> <p>Route 53 gets <code>MaxResults</code> operations and then filters them based on the specified criteria. It's possible that no operations in the first <code>MaxResults</code> operations matched the specified criteria but that subsequent groups of <code>MaxResults</code> operations do contain operations that match the criteria.</p> </note>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of items that you want Amazon Route 53 to return in the response to a <code>ListOperations</code> request. If you don't specify a value for <code>MaxResults</code>, Amazon Route 53 returns up to 100 operations.</p>"
"documentation":"<p>The maximum number of items that you want Amazon Route 53 to return in the response to a <code>ListOperations</code> request. If you don't specify a value for <code>MaxResults</code>, Route 53 returns up to 100 operations.</p>"
},
"Filters":{
"shape":"OperationFilters",
@ -838,7 +846,7 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If more than <code>MaxResults</code> operations match the specified criteria, you can submit another <code>ListOperations</code> request to get the next group of results. Specify the value of <code>NextToken</code> from the previous response in the next request.</p>"
"documentation":"<p>If the response contains <code>NextToken</code>, submit another <code>ListOperations</code> request to get the next group of results. Specify the value of <code>NextToken</code> from the previous response in the next request.</p> <note> <p>Route 53 gets <code>MaxResults</code> operations and then filters them based on the specified criteria. It's possible that no operations in the first <code>MaxResults</code> operations matched the specified criteria but that subsequent groups of <code>MaxResults</code> operations do contain operations that match the criteria.</p> </note>"
}
}
},
@ -847,11 +855,11 @@
"members":{
"NextToken":{
"shape":"NextToken",
"documentation":"<p>For the first <code>ListServices</code> request, omit this value.</p> <p>If more than <code>MaxResults</code> services match the specified criteria, you can submit another <code>ListServices</code> request to get the next group of results. Specify the value of <code>NextToken</code> from the previous response in the next request.</p>"
"documentation":"<p>For the first <code>ListServices</code> request, omit this value.</p> <p>If the response contains <code>NextToken</code>, submit another <code>ListServices</code> request to get the next group of results. Specify the value of <code>NextToken</code> from the previous response in the next request.</p> <note> <p>Route 53 gets <code>MaxResults</code> services and then filters them based on the specified criteria. It's possible that no services in the first <code>MaxResults</code> services matched the specified criteria but that subsequent groups of <code>MaxResults</code> services do contain services that match the criteria.</p> </note>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of services that you want Amazon Route 53 to return in the response to a <code>ListServices</code> request. If you don't specify a value for <code>MaxResults</code>, Amazon Route 53 returns up to 100 services.</p>"
"documentation":"<p>The maximum number of services that you want Amazon Route 53 to return in the response to a <code>ListServices</code> request. If you don't specify a value for <code>MaxResults</code>, Route 53 returns up to 100 services.</p>"
},
"Filters":{
"shape":"ServiceFilters",
@ -868,7 +876,7 @@
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>If more than <code>MaxResults</code> operations match the specified criteria, the value of <code>NextToken</code> is the first service in the next group of services that were created by the current AWS account. To get the next group, specify the value of <code>NextToken</code> from the previous response in the next request.</p>"
"documentation":"<p>If the response contains <code>NextToken</code>, submit another <code>ListServices</code> request to get the next group of results. Specify the value of <code>NextToken</code> from the previous response in the next request.</p> <note> <p>Route 53 gets <code>MaxResults</code> services and then filters them based on the specified criteria. It's possible that no services in the first <code>MaxResults</code> services matched the specified criteria but that subsequent groups of <code>MaxResults</code> services do contain services that match the criteria.</p> </note>"
}
}
},
@ -887,7 +895,7 @@
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that Amazon Route 53 assigns to the namespace when you create it.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) that Route 53 assigns to the namespace when you create it.</p>"
},
"Name":{
"shape":"NamespaceName",
@ -911,11 +919,11 @@
},
"CreateDate":{
"shape":"Timestamp",
"documentation":"<p>The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC).</p>"
"documentation":"<p>The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For example, the value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"CreatorRequestId":{
"shape":"ResourceId",
"documentation":"<p>An optional parameter that you can use to resolve concurrent creation requests. <code>CreatorRequestId</code> helps to determine if a specific client owns the namespace.</p>"
"documentation":"<p>A unique string that identifies the request and that allows failed requests to be retried without the risk of executing an operation twice. </p>"
}
},
"documentation":"<p>A complex type that contains information about a specified namespace.</p>"
@ -953,7 +961,7 @@
},
"Condition":{
"shape":"FilterCondition",
"documentation":"<p>The operator that you want to use to determine whether <code>ListNamespaces</code> returns a namespace. Valid values for <code>condition</code> include:</p> <ul> <li> <p> <code>EQ</code>: When you specify <code>EQ</code> for the condition, you can choose to list only public namespaces or private namespaces, but not both. <code>EQ</code> is the default condition and can be omitted.</p> </li> <li> <p> <code>IN</code>: When you specify <code>IN</code> for the condition, you can choose to list public namespaces, private namespaces, or both. </p> </li> </ul>"
"documentation":"<p>The operator that you want to use to determine whether <code>ListNamespaces</code> returns a namespace. Valid values for <code>condition</code> include:</p> <ul> <li> <p> <code>EQ</code>: When you specify <code>EQ</code> for the condition, you can choose to list only public namespaces or private namespaces, but not both. <code>EQ</code> is the default condition and can be omitted.</p> </li> <li> <p> <code>IN</code>: When you specify <code>IN</code> for the condition, you can choose to list public namespaces, private namespaces, or both. </p> </li> <li> <p> <code>BETWEEN</code>: Not applicable</p> </li> </ul>"
}
},
"documentation":"<p>A complex type that identifies the namespaces that you want to list. You can choose to list public or private namespaces.</p>"
@ -983,7 +991,7 @@
"members":{
"DnsProperties":{
"shape":"DnsProperties",
"documentation":"<p>A complex type that contains the ID for the hosted zone that Amazon Route 53 creates when you create a namespace.</p>"
"documentation":"<p>A complex type that contains the ID for the hosted zone that Route 53 creates when you create a namespace.</p>"
}
},
"documentation":"<p>A complex type that contains information that is specific to the namespace type.</p>"
@ -1001,11 +1009,11 @@
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that Amazon Route 53 assigns to the namespace when you create it.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) that Route 53 assigns to the namespace when you create it.</p>"
},
"Name":{
"shape":"NamespaceName",
"documentation":"<p>The name of the namespace. When you create a namespace, Amazon Route 53 automatically creates a hosted zone that has the same name as the namespace.</p>"
"documentation":"<p>The name of the namespace. When you create a namespace, Route 53 automatically creates a hosted zone that has the same name as the namespace.</p>"
},
"Type":{
"shape":"NamespaceType",
@ -1038,7 +1046,7 @@
},
"Status":{
"shape":"OperationStatus",
"documentation":"<p>The status of the operation. Values include the following:</p> <ul> <li> <p> <b>SUBMITTED</b>: This is the initial state immediately after you submit a request.</p> </li> <li> <p> <b>PENDING</b>: Amazon Route 53 is performing the operation.</p> </li> <li> <p> <b>SUCCESS</b>: The operation succeeded.</p> </li> <li> <p> <b>FAIL</b>: The operation failed. For the failure reason, see <code>ErrorMessage</code>.</p> </li> </ul>"
"documentation":"<p>The status of the operation. Values include the following:</p> <ul> <li> <p> <b>SUBMITTED</b>: This is the initial state immediately after you submit a request.</p> </li> <li> <p> <b>PENDING</b>: Route 53 is performing the operation.</p> </li> <li> <p> <b>SUCCESS</b>: The operation succeeded.</p> </li> <li> <p> <b>FAIL</b>: The operation failed. For the failure reason, see <code>ErrorMessage</code>.</p> </li> </ul>"
},
"ErrorMessage":{
"shape":"Message",
@ -1046,15 +1054,15 @@
},
"ErrorCode":{
"shape":"Code",
"documentation":"<p>The code associated with <code>ErrorMessage</code>.</p>"
"documentation":"<p>The code associated with <code>ErrorMessage</code>. Values for <code>ErrorCode</code> include the following:</p> <ul> <li> <p> <code>ACCESS_DENIED</code> </p> </li> <li> <p> <code>CANNOT_CREATE_HOSTED_ZONE</code> </p> </li> <li> <p> <code>EXPIRED_TOKEN</code> </p> </li> <li> <p> <code>HOSTED_ZONE_NOT_FOUND</code> </p> </li> <li> <p> <code>INTERNAL_FAILURE</code> </p> </li> <li> <p> <code>INVALID_CHANGE_BATCH</code> </p> </li> <li> <p> <code>THROTTLED_REQUEST</code> </p> </li> </ul>"
},
"CreateDate":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC).</p>"
"documentation":"<p>The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For example, the value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"UpdateDate":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the value of <code>Status</code> changed to the current value, in Unix date/time format and Coordinated Universal Time (UTC).</p>"
"documentation":"<p>The date and time that the value of <code>Status</code> changed to the current value, in Unix date/time format and Coordinated Universal Time (UTC). The value of <code>UpdateDate</code> is accurate to milliseconds. For example, the value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"Targets":{
"shape":"OperationTargetsMap",
@ -1080,7 +1088,7 @@
},
"Condition":{
"shape":"FilterCondition",
"documentation":"<p>The operator that you want to use to determine whether an operation matches the specified value. Valid values for condition include:</p> <ul> <li> <p> <code>EQ</code>: When you specify <code>EQ</code> for the condition, you can specify only one value. <code>EQ</code> is supported for <code>NAMESPACE_ID</code>, <code>SERVICE_ID</code>, <code>STATUS</code>, and <code>TYPE</code>. <code>EQ</code> is the default condition and can be omitted.</p> </li> <li> <p> <code>IN</code>: When you specify <code>IN</code> for the condition, you can specify a list of one or more values. <code>IN</code> is supported for <code>STATUS</code> and <code>TYPE</code>. An operation must match one of the specified values to be returned in the response.</p> </li> <li> <p> <code>BETWEEN</code>: Specify two values, a start date and an end date. The start date must be the first value. <code>BETWEEN</code> is supported for <code>U</code>. </p> </li> </ul>"
"documentation":"<p>The operator that you want to use to determine whether an operation matches the specified value. Valid values for condition include:</p> <ul> <li> <p> <code>EQ</code>: When you specify <code>EQ</code> for the condition, you can specify only one value. <code>EQ</code> is supported for <code>NAMESPACE_ID</code>, <code>SERVICE_ID</code>, <code>STATUS</code>, and <code>TYPE</code>. <code>EQ</code> is the default condition and can be omitted.</p> </li> <li> <p> <code>IN</code>: When you specify <code>IN</code> for the condition, you can specify a list of one or more values. <code>IN</code> is supported for <code>STATUS</code> and <code>TYPE</code>. An operation must match one of the specified values to be returned in the response.</p> </li> <li> <p> <code>BETWEEN</code>: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value. <code>BETWEEN</code> is supported for <code>UPDATE_DATE</code>. </p> </li> </ul>"
}
},
"documentation":"<p>A complex type that lets you select the operations that you want to list.</p>"
@ -1129,7 +1137,7 @@
},
"Status":{
"shape":"OperationStatus",
"documentation":"<p>The status of the operation. Values include the following:</p> <ul> <li> <p> <b>SUBMITTED</b>: This is the initial state immediately after you submit a request.</p> </li> <li> <p> <b>PENDING</b>: Amazon Route 53 is performing the operation.</p> </li> <li> <p> <b>SUCCESS</b>: The operation succeeded.</p> </li> <li> <p> <b>FAIL</b>: The operation failed. For the failure reason, see <code>ErrorMessage</code>.</p> </li> </ul>"
"documentation":"<p>The status of the operation. Values include the following:</p> <ul> <li> <p> <b>SUBMITTED</b>: This is the initial state immediately after you submit a request.</p> </li> <li> <p> <b>PENDING</b>: Route 53 is performing the operation.</p> </li> <li> <p> <b>SUCCESS</b>: The operation succeeded.</p> </li> <li> <p> <b>FAIL</b>: The operation failed. For the failure reason, see <code>ErrorMessage</code>.</p> </li> </ul>"
}
},
"documentation":"<p>A complex type that contains information about an operation that matches the criteria that you specified in a <a>ListOperations</a> request.</p>"
@ -1171,7 +1179,8 @@
"enum":[
"SRV",
"A",
"AAAA"
"AAAA",
"CNAME"
]
},
"RegisterInstanceRequest":{
@ -1184,20 +1193,20 @@
"members":{
"ServiceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the service that you want to use for settings for the resource record sets and health check that Amazon Route 53 will create.</p>"
"documentation":"<p>The ID of the service that you want to use for settings for the records and health check that Route 53 will create.</p>"
},
"InstanceId":{
"shape":"ResourceId",
"documentation":"<p>An identifier that you want to associate with the instance. Note the following:</p> <ul> <li> <p>You can use this value to update an existing instance.</p> </li> <li> <p>To register a new instance, you must specify a value that is unique among instances that you register by using the same service.</p> </li> </ul>"
"documentation":"<p>An identifier that you want to associate with the instance. Note the following:</p> <ul> <li> <p>If the service that is specified by <code>ServiceId</code> includes settings for an SRV record, the value of <code>InstanceId</code> is automatically included as part of the value for the SRV record. For more information, see <a>DnsRecord$Type</a>.</p> </li> <li> <p>You can use this value to update an existing instance.</p> </li> <li> <p>To register a new instance, you must specify a value that is unique among instances that you register by using the same service. </p> </li> <li> <p>If you specify an existing <code>InstanceId</code> and <code>ServiceId</code>, Route 53 updates the existing records. If there's also an existing health check, Route 53 deletes the old health check and creates a new one. </p> <note> <p>The health check isn't deleted immediately, so it will still appear for a while if you submit a <code>ListHealthChecks</code> request, for example.</p> </note> </li> </ul>"
},
"CreatorRequestId":{
"shape":"ResourceId",
"documentation":"<p>An optional parameter that you can use to resolve concurrent creation requests. <code>CreatorRequestId</code> helps to determine if a specific client owns the namespace.</p>",
"documentation":"<p>A unique string that identifies the request and that allows failed <code>RegisterInstance</code> requests to be retried without the risk of executing the operation twice. You must use a unique <code>CreatorRequestId</code> string every time you submit a <code>RegisterInstance</code> request if you're registering additional instances for the same namespace and service. <code>CreatorRequestId</code> can be any unique string, for example, a date/time stamp.</p>",
"idempotencyToken":true
},
"Attributes":{
"shape":"Attributes",
"documentation":"<p>A string map that contain attribute keys and values. Supported attribute keys include the following:</p> <ul> <li> <p> <code>AWS_INSTANCE_PORT</code>: The port on the endpoint that you want Amazon Route 53 to perform health checks on. This value is also used for the port value in an SRV record if the service that you specify includes an SRV record. For more information, see <a>CreateService</a>.</p> </li> <li> <p> <code>AWS_INSTANCE_IPV4</code>: If the service that you specify contains a resource record set template for an A record, the IPv4 address that you want Amazon Route 53 to use for the value of the A record.</p> </li> <li> <p> <code>AWS_INSTANCE_IPV6</code>: If the service that you specify contains a resource record set template for an AAAA record, the IPv6 address that you want Amazon Route 53 to use for the value of the AAAA record.</p> </li> </ul>"
"documentation":"<p>A string map that contains the following information for the service that you specify in <code>ServiceId</code>:</p> <ul> <li> <p>The attributes that apply to the records that are defined in the service. </p> </li> <li> <p>For each attribute, the applicable value.</p> </li> </ul> <p>Supported attribute keys include the following:</p> <p> <b>AWS_ALIAS_DNS_NAME</b> </p> <p> <b/> </p> <p>If you want Route 53 to create an alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see \"DNSName\" in the topic <a href=\"http://docs.aws.amazon.com/http:/docs.aws.amazon.com/Route53/latest/APIReference/API_AliasTarget.html\">AliasTarget</a>.</p> <p>Note the following:</p> <ul> <li> <p>The configuration for the service that is specified by <code>ServiceId</code> must include settings for an A record, an AAAA record, or both.</p> </li> <li> <p>In the service that is specified by <code>ServiceId</code>, the value of <code>RoutingPolicy</code> must be <code>WEIGHTED</code>.</p> </li> <li> <p>If the service that is specified by <code>ServiceId</code> includes <code>HealthCheckConfig</code> settings, Route 53 will create the health check, but it won't associate the health check with the alias record.</p> </li> <li> <p>Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers.</p> </li> <li> <p>If you specify a value for <code>AWS_ALIAS_DNS_NAME</code>, don't specify values for any of the <code>AWS_INSTANCE</code> attributes.</p> </li> </ul> <p> <b>AWS_INSTANCE_CNAME</b> </p> <p>If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries, for example, <code>example.com</code>.</p> <p>This value is required if the service specified by <code>ServiceId</code> includes settings for an CNAME record.</p> <p> <b>AWS_INSTANCE_IPV4</b> </p> <p>If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to DNS queries, for example, <code>192.0.2.44</code>.</p> <p>This value is required if the service specified by <code>ServiceId</code> includes settings for an A record. Either <code>AWS_INSTANCE_IPV4</code> or <code>AWS_INSTANCE_IPV6</code> is required if the service includes settings for an SRV record.</p> <p> <b>AWS_INSTANCE_IPV6</b> </p> <p>If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response to DNS queries, for example, <code>2001:0db8:85a3:0000:0000:abcd:0001:2345</code>.</p> <p>This value is required if the service specified by <code>ServiceId</code> includes settings for an AAAA record. Either <code>AWS_INSTANCE_IPV4</code> or <code>AWS_INSTANCE_IPV6</code> is required if the service includes settings for an SRV record.</p> <p> <b>AWS_INSTANCE_PORT</b> </p> <p>If the service includes an SRV record, the value that you want Route 53 to return for the port.</p> <p>If the service includes <code>HealthCheckConfig</code>, the port on the endpoint that you want Route 53 to send requests to. </p> <p>This value is required if you specified settings for an SRV record when you created the service.</p>"
}
}
},
@ -1239,16 +1248,23 @@
"type":"string",
"max":255
},
"RoutingPolicy":{
"type":"string",
"enum":[
"MULTIVALUE",
"WEIGHTED"
]
},
"Service":{
"type":"structure",
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"<p>The ID that Amazon Route 53 assigned to the service when you created it.</p>"
"documentation":"<p>The ID that Route 53 assigned to the service when you created it.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that Amazon Route 53 assigns to the service when you create it.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) that Route 53 assigns to the service when you create it.</p>"
},
"Name":{
"shape":"ServiceName",
@ -1264,19 +1280,19 @@
},
"DnsConfig":{
"shape":"DnsConfig",
"documentation":"<p>A complex type that contains information about the resource record sets that you want Amazon Route 53 to create when you register an instance.</p>"
"documentation":"<p>A complex type that contains information about the records that you want Route 53 to create when you register an instance.</p>"
},
"HealthCheckConfig":{
"shape":"HealthCheckConfig",
"documentation":"<p> <i>Public DNS namespaces only.</i> A complex type that contains settings for an optional health check. If you specify settings for a health check, Amazon Route 53 associates the health check with all the resource record sets that you specify in <code>DnsConfig</code>.</p> <note> <p>The health check uses 30 seconds as the request interval. This is the number of seconds between the time that each Amazon Route 53 health checker gets a response from your endpoint and the time that it sends the next health check request. A health checker in each data center around the world sends your endpoint a health check request every 30 seconds. On average, your endpoint receives a health check request about every two seconds. Health checkers in different data centers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all.</p> </note> <p>For information about the charges for health checks, see <a href=\"http://aws.amazon.com/route53/pricing\">Amazon Route 53 Pricing</a>.</p>"
"documentation":"<p> <i>Public DNS namespaces only.</i> A complex type that contains settings for an optional health check. If you specify settings for a health check, Route 53 associates the health check with all the records that you specify in <code>DnsConfig</code>.</p> <p>For information about the charges for health checks, see <a href=\"http://aws.amazon.com/route53/pricing\">Route 53 Pricing</a>.</p>"
},
"CreateDate":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC).</p>"
"documentation":"<p>The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value of <code>CreateDate</code> is accurate to milliseconds. For example, the value <code>1516925490.087</code> represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
},
"CreatorRequestId":{
"shape":"ResourceId",
"documentation":"<p>An optional parameter that you can use to resolve concurrent creation requests. <code>CreatorRequestId</code> helps to determine if a specific client owns the namespace.</p>"
"documentation":"<p>A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. <code>CreatorRequestId</code> can be any unique string, for example, a date/time stamp.</p>"
}
},
"documentation":"<p>A complex type that contains information about the specified service.</p>"
@ -1307,7 +1323,7 @@
},
"DnsConfig":{
"shape":"DnsConfigChange",
"documentation":"<p>A complex type that contains information about the resource record sets that you want Amazon Route 53 to create when you register an instance.</p>"
"documentation":"<p>A complex type that contains information about the records that you want Route 53 to create when you register an instance.</p>"
},
"HealthCheckConfig":{"shape":"HealthCheckConfig"}
},
@ -1330,7 +1346,7 @@
},
"Condition":{
"shape":"FilterCondition",
"documentation":"<p>The operator that you want to use to determine whether a service is returned by <code>ListServices</code>. Valid values for <code>Condition</code> include the following:</p> <ul> <li> <p> <code>EQ</code>: When you specify <code>EQ</code>, specify one namespace ID for <code>Values</code>. <code>EQ</code> is the default condition and can be omitted.</p> </li> <li> <p> <code>IN</code>: When you specify <code>IN</code>, specify a list of the IDs for the namespaces that you want <code>ListServices</code> to return a list of services for.</p> </li> </ul>"
"documentation":"<p>The operator that you want to use to determine whether a service is returned by <code>ListServices</code>. Valid values for <code>Condition</code> include the following:</p> <ul> <li> <p> <code>EQ</code>: When you specify <code>EQ</code>, specify one namespace ID for <code>Values</code>. <code>EQ</code> is the default condition and can be omitted.</p> </li> <li> <p> <code>IN</code>: When you specify <code>IN</code>, specify a list of the IDs for the namespaces that you want <code>ListServices</code> to return a list of services for.</p> </li> <li> <p> <code>BETWEEN</code>: Not applicable.</p> </li> </ul>"
}
},
"documentation":"<p>A complex type that lets you specify the namespaces that you want to list services for.</p>"
@ -1364,11 +1380,11 @@
"members":{
"Id":{
"shape":"ResourceId",
"documentation":"<p>The ID that Amazon Route 53 assigned to the service when you created it.</p>"
"documentation":"<p>The ID that Route 53 assigned to the service when you created it.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that Amazon Route 53 assigns to the service when you create it.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) that Route 53 assigns to the service when you create it.</p>"
},
"Name":{
"shape":"ServiceName",
@ -1413,5 +1429,5 @@
}
}
},
"documentation":"<p>Amazon Route 53 autonaming lets you configure public or private namespaces that your microservice applications run in. When instances of the service become available, you can call the autonaming API to register the instance, and Amazon Route 53 automatically creates up to five DNS records and an optional health check. Clients that submit DNS queries for the service receive an answer that contains up to eight healthy records.</p>"
"documentation":"<p>Amazon Route 53 auto naming lets you configure public or private namespaces that your microservice applications run in. When instances of the service become available, you can call the auto naming API to register the instance, and Route 53 automatically creates up to five DNS records and an optional health check. Clients that submit DNS queries for the service receive an answer that contains up to eight healthy records.</p>"
}

0
botocore/data/snowball/2016-06-30/examples-1.json Executable file → Normal file
View file

0
botocore/data/sns/2010-03-31/examples-1.json Executable file → Normal file
View file

0
botocore/data/sns/2010-03-31/service-2.json Executable file → Normal file
View file

8
botocore/data/ssm/2014-11-06/paginators-1.json
View file

@ -43,18 +43,12 @@
"result_key": "Parameters"
},
"GetParametersByPath": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "Parameters"
},
"GetParameterHistory": {
"result_key": "Parameters",
"output_token": "NextToken",
"input_token": "NextToken",
"limit_key": "MaxResults"
},
"GetParametersByPath": {
"GetParameterHistory": {
"result_key": "Parameters",
"output_token": "NextToken",
"input_token": "NextToken",

105
botocore/data/ssm/2014-11-06/service-2.json
View file

File diff suppressed because one or more lines are too long

0
botocore/data/support/2013-04-15/examples-1.json Executable file → Normal file
View file

2
docs/source/conf.py
View file

@ -54,7 +54,7 @@ copyright = u'2013, Mitch Garnaat'
# The short X.Y version.
version = '1.8.'
# The full version, including alpha/beta/rc tags.
release = '1.8.36'
release = '1.8.40'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

1
requirements.txt
View file

@ -6,3 +6,4 @@ wheel==0.24.0
docutils>=0.10
behave==1.2.5
-e git://github.com/boto/jmespath.git@develop#egg=jmespath
jsonschema==2.5.1

89
tests/functional/test_waiter_config.py
View file

@ -11,16 +11,94 @@
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.
import jmespath
from jsonschema import Draft4Validator
import botocore.session
from botocore.exceptions import UnknownServiceError
from botocore.utils import ArgumentGenerator
WAITER_SCHEMA = {
"type": "object",
"properties": {
"version": {"type": "number"},
"waiters": {
"type": "object",
"additionalProperties": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": ["api"]
},
"operation": {"type": "string"},
"description": {"type": "string"},
"delay": {
"type": "number",
"minimum": 0,
},
"maxAttempts": {
"type": "integer",
"minimum": 1
},
"acceptors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"state": {
"type": "string",
"enum": ["success", "retry", "failure"]
},
"matcher": {
"type": "string",
"enum": [
"path", "pathAll", "pathAny",
"status", "error"
]
},
"argument": {"type": "string"},
"expected": {
"oneOf": [
{"type": "string"},
{"type": "number"},
{"type": "boolean"}
]
}
},
"required": [
"state", "matcher", "expected"
],
"additionalProperties": False
}
}
},
"required": ["operation", "delay", "maxAttempts", "acceptors"],
"additionalProperties": False
}
}
},
"additionalProperties": False
}
def test_lint_waiter_configs():
session = botocore.session.get_session()
validator = Draft4Validator(WAITER_SCHEMA)
for service_name in session.get_available_services():
client = session.create_client(service_name, 'us-east-1')
service_model = client.meta.service_model
try:
# We use the loader directly here because we need the entire
# json document, not just the portions exposed (either
# internally or externally) by the WaiterModel class.
loader = session.get_component('data_loader')
waiter_model = loader.load_service_model(
service_name, 'waiters-2')
except UnknownServiceError:
# The service doesn't have waiters
continue
yield _validate_schema, validator, waiter_model
for waiter_name in client.waiter_names:
yield _lint_single_waiter, client, waiter_name, service_model
@ -52,6 +130,17 @@ def _lint_single_waiter(client, waiter_name, service_model):
for acceptor in acceptors:
_validate_acceptor(acceptor, op_model, waiter.name)
if not waiter.name.isalnum():
raise AssertionError(
"Waiter name %s is not alphanumeric." % waiter_name
)
def _validate_schema(validator, waiter_json):
errors = list(e.message for e in validator.iter_errors(waiter_json))
if errors:
raise AssertionError('\n'.join(errors))
def _validate_acceptor(acceptor, op_model, waiter_name):
if acceptor.matcher.startswith('path'):