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

Update upstream source from tag 'upstream/1.20.35+repack'

Browse source 
Update to upstream version '1.20.35+repack'
with Debian dir 0e60ba630b
This commit is contained in:
Noah Meyerhans 2021-03-23 16:16:26 -07:00
parent 5188fa4cae e34454e86c
commit 4a8fd85913
119 changed files with 18565 additions and 3103 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
PKG-INFO
View file

@ -1,6 +1,6 @@
Metadata-Version: 1.2
Metadata-Version: 2.1
Name: botocore
Version: 1.20.0
Version: 1.20.35
Summary: Low-level, data-driven core of boto 3.
Home-page: https://github.com/boto/botocore
Author: Amazon Web Services
@ -128,3 +128,4 @@ Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >= 2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*
Provides-Extra: crt

2
botocore/__init__.py
View file

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

10
botocore/credentials.py
View file

@ -283,8 +283,14 @@ class JSONFileCache(object):
CACHE_DIR = os.path.expanduser(os.path.join('~', '.aws', 'boto', 'cache'))
def __init__(self, working_dir=CACHE_DIR):
def __init__(self, working_dir=CACHE_DIR, dumps_func=None):
self._working_dir = working_dir
if dumps_func is None:
dumps_func = self._default_dumps
self._dumps = dumps_func
def _default_dumps(self, obj):
return json.dumps(obj, default=_serialize_if_needed)
def __contains__(self, cache_key):
actual_key = self._convert_cache_key(cache_key)
@ -302,7 +308,7 @@ class JSONFileCache(object):
def __setitem__(self, cache_key, value):
full_key = self._convert_cache_key(cache_key)
try:
file_content = json.dumps(value, default=_serialize_if_needed)
file_content = self._dumps(value)
except (TypeError, ValueError):
raise ValueError("Value cannot be cached, must be "
"JSON serializable: %s" % value)

18
botocore/data/accessanalyzer/2019-11-01/paginators-1.json
View file

@ -23,6 +23,24 @@
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "findings"
},
"ListAccessPreviewFindings": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "findings"
},
"ListAccessPreviews": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "accessPreviews"
},
"ValidatePolicy": {
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "findings"
}
}
}

1004
botocore/data/accessanalyzer/2019-11-01/service-2.json
View file

@ -30,6 +30,27 @@
"documentation":"<p>Retroactively applies the archive rule to existing findings that meet the archive rule criteria.</p>",
"idempotent":true
},
"CreateAccessPreview":{
"name":"CreateAccessPreview",
"http":{
"method":"PUT",
"requestUri":"/access-preview",
"responseCode":200
},
"input":{"shape":"CreateAccessPreviewRequest"},
"output":{"shape":"CreateAccessPreviewResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ValidationException"},
{"shape":"InternalServerException"},
{"shape":"ServiceQuotaExceededException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Creates an access preview that allows you to preview Access Analyzer findings for your resource before deploying resource permissions.</p>",
"idempotent":true
},
"CreateAnalyzer":{
"name":"CreateAnalyzer",
"http":{
@ -67,7 +88,7 @@
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Creates an archive rule for the specified analyzer. Archive rules automatically archive new findings that meet the criteria you define when you create the rule.</p>",
"documentation":"<p>Creates an archive rule for the specified analyzer. Archive rules automatically archive new findings that meet the criteria you define when you create the rule.</p> <p>To learn about filter keys that you can use to create an archive rule, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html\">Access Analyzer filter keys</a> in the <b>IAM User Guide</b>.</p>",
"idempotent":true
},
"DeleteAnalyzer":{
@ -106,6 +127,24 @@
"documentation":"<p>Deletes the specified archive rule.</p>",
"idempotent":true
},
"GetAccessPreview":{
"name":"GetAccessPreview",
"http":{
"method":"GET",
"requestUri":"/access-preview/{accessPreviewId}",
"responseCode":200
},
"input":{"shape":"GetAccessPreviewRequest"},
"output":{"shape":"GetAccessPreviewResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"},
{"shape":"InternalServerException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves information about an access preview for the specified analyzer.</p>"
},
"GetAnalyzedResource":{
"name":"GetAnalyzedResource",
"http":{
@ -178,6 +217,43 @@
],
"documentation":"<p>Retrieves information about the specified finding.</p>"
},
"ListAccessPreviewFindings":{
"name":"ListAccessPreviewFindings",
"http":{
"method":"POST",
"requestUri":"/access-preview/{accessPreviewId}",
"responseCode":200
},
"input":{"shape":"ListAccessPreviewFindingsRequest"},
"output":{"shape":"ListAccessPreviewFindingsResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ValidationException"},
{"shape":"InternalServerException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves a list of access preview findings generated by the specified access preview.</p>"
},
"ListAccessPreviews":{
"name":"ListAccessPreviews",
"http":{
"method":"GET",
"requestUri":"/access-preview",
"responseCode":200
},
"input":{"shape":"ListAccessPreviewsRequest"},
"output":{"shape":"ListAccessPreviewsResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"},
{"shape":"InternalServerException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves a list of access previews for the specified analyzer.</p>"
},
"ListAnalyzedResources":{
"name":"ListAnalyzedResources",
"http":{
@ -246,7 +322,7 @@
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Retrieves a list of findings generated by the specified analyzer.</p> <p>To learn about filter keys that you can use to create an archive rule, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html\">Access Analyzer filter keys</a> in the <b>IAM User Guide</b>.</p>"
"documentation":"<p>Retrieves a list of findings generated by the specified analyzer.</p> <p>To learn about filter keys that you can use to retrieve a list of findings, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-reference-filter-keys.html\">Access Analyzer filter keys</a> in the <b>IAM User Guide</b>.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
@ -356,6 +432,23 @@
],
"documentation":"<p>Updates the status for the specified findings.</p>",
"idempotent":true
},
"ValidatePolicy":{
"name":"ValidatePolicy",
"http":{
"method":"POST",
"requestUri":"/policy/validation",
"responseCode":200
},
"input":{"shape":"ValidatePolicyRequest"},
"output":{"shape":"ValidatePolicyResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"InternalServerException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Requests the validation of a policy and returns a list of findings. The findings help you identify issues and provide actionable recommendations to resolve the issue and enable you to author functional policies that meet security best practices. </p>"
}
},
"shapes":{
@ -372,6 +465,217 @@
},
"exception":true
},
"AccessPointArn":{
"type":"string",
"pattern":"arn:[^:]*:s3:[^:]*:[^:]*:accesspoint/.*$"
},
"AccessPointPolicy":{"type":"string"},
"AccessPreview":{
"type":"structure",
"required":[
"analyzerArn",
"configurations",
"createdAt",
"id",
"status"
],
"members":{
"analyzerArn":{
"shape":"AnalyzerArn",
"documentation":"<p>The ARN of the analyzer used to generate the access preview.</p>"
},
"configurations":{
"shape":"ConfigurationsMap",
"documentation":"<p>A map of resource ARNs for the proposed resource configuration.</p>"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"<p>The time at which the access preview was created.</p>"
},
"id":{
"shape":"AccessPreviewId",
"documentation":"<p>The unique ID for the access preview.</p>"
},
"status":{
"shape":"AccessPreviewStatus",
"documentation":"<p>The status of the access preview.</p> <ul> <li> <p> <code>Creating</code> - The access preview creation is in progress.</p> </li> <li> <p> <code>Completed</code> - The access preview is complete. You can preview findings for external access to the resource.</p> </li> <li> <p> <code>Failed</code> - The access preview creation has failed.</p> </li> </ul>"
},
"statusReason":{
"shape":"AccessPreviewStatusReason",
"documentation":"<p>Provides more details about the current status of the access preview.</p> <p>For example, if the creation of the access preview fails, a <code>Failed</code> status is returned. This failure can be due to an internal issue with the analysis or due to an invalid resource configuration.</p>"
}
},
"documentation":"<p>Contains information about an access preview.</p>"
},
"AccessPreviewFinding":{
"type":"structure",
"required":[
"changeType",
"createdAt",
"id",
"resourceOwnerAccount",
"resourceType",
"status"
],
"members":{
"action":{
"shape":"ActionList",
"documentation":"<p>The action in the analyzed policy statement that an external principal has permission to perform.</p>"
},
"changeType":{
"shape":"FindingChangeType",
"documentation":"<p>Provides context on how the access preview finding compares to existing access identified in Access Analyzer.</p> <ul> <li> <p> <code>New</code> - The finding is for newly-introduced access.</p> </li> <li> <p> <code>Unchanged</code> - The preview finding is an existing finding that would remain unchanged.</p> </li> <li> <p> <code>Changed</code> - The preview finding is an existing finding with a change in status.</p> </li> </ul> <p>For example, a <code>Changed</code> finding with preview status <code>Resolved</code> and existing status <code>Active</code> indicates the existing <code>Active</code> finding would become <code>Resolved</code> as a result of the proposed permissions change.</p>"
},
"condition":{
"shape":"ConditionKeyMap",
"documentation":"<p>The condition in the analyzed policy statement that resulted in a finding.</p>"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"<p>The time at which the access preview finding was created.</p>"
},
"error":{
"shape":"String",
"documentation":"<p>An error.</p>"
},
"existingFindingId":{
"shape":"FindingId",
"documentation":"<p>The existing ID of the finding in Access Analyzer, provided only for existing findings.</p>"
},
"existingFindingStatus":{
"shape":"FindingStatus",
"documentation":"<p>The existing status of the finding, provided only for existing findings.</p>"
},
"id":{
"shape":"AccessPreviewFindingId",
"documentation":"<p>The ID of the access preview finding. This ID uniquely identifies the element in the list of access preview findings and is not related to the finding ID in Access Analyzer.</p>"
},
"isPublic":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the policy that generated the finding allows public access to the resource.</p>"
},
"principal":{
"shape":"PrincipalMap",
"documentation":"<p>The external principal that has access to a resource within the zone of trust.</p>"
},
"resource":{
"shape":"String",
"documentation":"<p>The resource that an external principal has access to. This is the resource associated with the access preview.</p>"
},
"resourceOwnerAccount":{
"shape":"String",
"documentation":"<p>The AWS account ID that owns the resource. For most AWS resources, the owning account is the account in which the resource was created.</p>"
},
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of the resource that can be accessed in the finding.</p>"
},
"sources":{
"shape":"FindingSourceList",
"documentation":"<p>The sources of the finding. This indicates how the access that generated the finding is granted. It is populated for Amazon S3 bucket findings.</p>"
},
"status":{
"shape":"FindingStatus",
"documentation":"<p>The preview status of the finding. This is what the status of the finding would be after permissions deployment. For example, a <code>Changed</code> finding with preview status <code>Resolved</code> and existing status <code>Active</code> indicates the existing <code>Active</code> finding would become <code>Resolved</code> as a result of the proposed permissions change.</p>"
}
},
"documentation":"<p>An access preview finding generated by the access preview.</p>"
},
"AccessPreviewFindingId":{"type":"string"},
"AccessPreviewFindingsList":{
"type":"list",
"member":{"shape":"AccessPreviewFinding"}
},
"AccessPreviewId":{
"type":"string",
"pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$"
},
"AccessPreviewStatus":{
"type":"string",
"enum":[
"COMPLETED",
"CREATING",
"FAILED"
]
},
"AccessPreviewStatusReason":{
"type":"structure",
"required":["code"],
"members":{
"code":{
"shape":"AccessPreviewStatusReasonCode",
"documentation":"<p>The reason code for the current status of the access preview.</p>"
}
},
"documentation":"<p>Provides more details about the current status of the access preview. For example, if the creation of the access preview fails, a <code>Failed</code> status is returned. This failure can be due to an internal issue with the analysis or due to an invalid proposed resource configuration.</p>"
},
"AccessPreviewStatusReasonCode":{
"type":"string",
"enum":[
"INTERNAL_ERROR",
"INVALID_CONFIGURATION"
]
},
"AccessPreviewSummary":{
"type":"structure",
"required":[
"analyzerArn",
"createdAt",
"id",
"status"
],
"members":{
"analyzerArn":{
"shape":"AnalyzerArn",
"documentation":"<p>The ARN of the analyzer used to generate the access preview.</p>"
},
"createdAt":{
"shape":"Timestamp",
"documentation":"<p>The time at which the access preview was created.</p>"
},
"id":{
"shape":"AccessPreviewId",
"documentation":"<p>The unique ID for the access preview.</p>"
},
"status":{
"shape":"AccessPreviewStatus",
"documentation":"<p>The status of the access preview.</p> <ul> <li> <p> <code>Creating</code> - The access preview creation is in progress.</p> </li> <li> <p> <code>Completed</code> - The access preview is complete and previews the findings for external access to the resource.</p> </li> <li> <p> <code>Failed</code> - The access preview creation has failed.</p> </li> </ul>"
},
"statusReason":{"shape":"AccessPreviewStatusReason"}
},
"documentation":"<p>Contains a summary of information about an access preview.</p>"
},
"AccessPreviewsList":{
"type":"list",
"member":{"shape":"AccessPreviewSummary"}
},
"AclCanonicalId":{"type":"string"},
"AclGrantee":{
"type":"structure",
"members":{
"id":{
"shape":"AclCanonicalId",
"documentation":"<p>The value specified is the canonical user ID of an AWS account.</p>"
},
"uri":{
"shape":"AclUri",
"documentation":"<p>Used for granting permissions to a predefined group.</p>"
}
},
"documentation":"<p>You specify each grantee as a type-value pair using one of these types. You can specify only one type of grantee. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAcl.html\">PutBucketAcl</a>.</p>",
"union":true
},
"AclPermission":{
"type":"string",
"enum":[
"READ",
"WRITE",
"READ_ACP",
"WRITE_ACP",
"FULL_CONTROL"
]
},
"AclUri":{"type":"string"},
"ActionList":{
"type":"list",
"member":{"shape":"String"}
@ -511,7 +815,7 @@
},
"statusReason":{
"shape":"StatusReason",
"documentation":"<p>The <code>statusReason</code> provides more details about the current status of the analyzer. For example, if the creation for the analyzer fails, a <code>Failed</code> status is displayed. For an analyzer with organization as the type, this failure can be due to an issue with creating the service-linked roles required in the member accounts of the AWS organization.</p>"
"documentation":"<p>The <code>statusReason</code> provides more details about the current status of the analyzer. For example, if the creation for the analyzer fails, a <code>Failed</code> status is returned. For an analyzer with organization as the type, this failure can be due to an issue with creating the service-linked roles required in the member accounts of the AWS organization.</p>"
},
"tags":{
"shape":"TagsMap",
@ -592,6 +896,39 @@
"key":{"shape":"String"},
"value":{"shape":"String"}
},
"Configuration":{
"type":"structure",
"members":{
"iamRole":{
"shape":"IamRoleConfiguration",
"documentation":"<p>The access control configuration is for an IAM role. </p>"
},
"kmsKey":{
"shape":"KmsKeyConfiguration",
"documentation":"<p>The access control configuration is for a KMS key. </p>"
},
"s3Bucket":{
"shape":"S3BucketConfiguration",
"documentation":"<p>The access control configuration is for an Amazon S3 Bucket. </p>"
},
"secretsManagerSecret":{
"shape":"SecretsManagerSecretConfiguration",
"documentation":"<p>The access control configuration is for a Secrets Manager secret.</p>"
},
"sqsQueue":{
"shape":"SqsQueueConfiguration",
"documentation":"<p>The access control configuration is for an SQS queue. </p>"
}
},
"documentation":"<p>Access control configuration structures for your resource. You specify the configuration as a type-value pair. You can specify only one type of access control configuration.</p>",
"union":true
},
"ConfigurationsMap":{
"type":"map",
"key":{"shape":"ConfigurationsMapKey"},
"value":{"shape":"Configuration"}
},
"ConfigurationsMapKey":{"type":"string"},
"ConflictException":{
"type":"structure",
"required":[
@ -617,6 +954,38 @@
},
"exception":true
},
"CreateAccessPreviewRequest":{
"type":"structure",
"required":[
"analyzerArn",
"configurations"
],
"members":{
"analyzerArn":{
"shape":"AnalyzerArn",
"documentation":"<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of the account analyzer</a> used to generate the access preview. You can only create an access preview for analyzers with an <code>Account</code> type and <code>Active</code> status.</p>"
},
"clientToken":{
"shape":"String",
"documentation":"<p>A client token.</p>",
"idempotencyToken":true
},
"configurations":{
"shape":"ConfigurationsMap",
"documentation":"<p>Access control configuration for your resource that is used to generate the access preview. The access preview includes findings for external access allowed to the resource with the proposed access control configuration. The configuration must contain exactly one element.</p>"
}
}
},
"CreateAccessPreviewResponse":{
"type":"structure",
"required":["id"],
"members":{
"id":{
"shape":"AccessPreviewId",
"documentation":"<p>The unique ID for the access preview.</p>"
}
}
},
"CreateAnalyzerRequest":{
"type":"structure",
"required":[
@ -819,7 +1188,7 @@
},
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of the resource reported in the finding.</p>"
"documentation":"<p>The type of the resource identified in the finding.</p>"
},
"sources":{
"shape":"FindingSourceList",
@ -836,6 +1205,14 @@
},
"documentation":"<p>Contains information about a finding.</p>"
},
"FindingChangeType":{
"type":"string",
"enum":[
"CHANGED",
"NEW",
"UNCHANGED"
]
},
"FindingId":{"type":"string"},
"FindingIdList":{
"type":"list",
@ -969,6 +1346,37 @@
"type":"list",
"member":{"shape":"FindingSummary"}
},
"GetAccessPreviewRequest":{
"type":"structure",
"required":[
"accessPreviewId",
"analyzerArn"
],
"members":{
"accessPreviewId":{
"shape":"AccessPreviewId",
"documentation":"<p>The unique ID for the access preview.</p>",
"location":"uri",
"locationName":"accessPreviewId"
},
"analyzerArn":{
"shape":"AnalyzerArn",
"documentation":"<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of the analyzer</a> used to generate the access preview.</p>",
"location":"querystring",
"locationName":"analyzerArn"
}
}
},
"GetAccessPreviewResponse":{
"type":"structure",
"required":["accessPreview"],
"members":{
"accessPreview":{
"shape":"AccessPreview",
"documentation":"<p>An object that contains information about the access preview.</p>"
}
}
},
"GetAnalyzedResourceRequest":{
"type":"structure",
"required":[
@ -978,7 +1386,7 @@
"members":{
"analyzerArn":{
"shape":"AnalyzerArn",
"documentation":"<p>The ARN of the analyzer to retrieve information from.</p>",
"documentation":"<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of the analyzer</a> to retrieve information from.</p>",
"location":"querystring",
"locationName":"analyzerArn"
},
@ -996,7 +1404,7 @@
"members":{
"resource":{
"shape":"AnalyzedResource",
"documentation":"<p>An <code>AnalyedResource</code> object that contains information that Access Analyzer found when it analyzed the resource.</p>"
"documentation":"<p>An <code>AnalyzedResource</code> object that contains information that Access Analyzer found when it analyzed the resource.</p>"
}
},
"documentation":"<p>The response to the request.</p>"
@ -1064,7 +1472,7 @@
"members":{
"analyzerArn":{
"shape":"AnalyzerArn",
"documentation":"<p>The ARN of the analyzer that generated the finding.</p>",
"documentation":"<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of the analyzer</a> that generated the finding.</p>",
"location":"querystring",
"locationName":"analyzerArn"
},
@ -1087,6 +1495,18 @@
},
"documentation":"<p>The response to the request.</p>"
},
"GranteePrincipal":{"type":"string"},
"IamRoleConfiguration":{
"type":"structure",
"members":{
"trustPolicy":{
"shape":"IamTrustPolicy",
"documentation":"<p>The proposed trust policy for the IAM role.</p>"
}
},
"documentation":"<p>The proposed access control configuration for an IAM role. You can propose a configuration for a new IAM role or an existing IAM role that you own by specifying the trust policy. If the configuration is for a new IAM role, you must specify the trust policy. If the configuration is for an existing IAM role that you own and you do not propose the trust policy, the access preview uses the existing trust policy for the role. The proposed trust policy cannot be an empty string. For more information about role trust policy limits, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html\">IAM and STS quotas</a>.</p>"
},
"IamTrustPolicy":{"type":"string"},
"InlineArchiveRule":{
"type":"structure",
"required":[
@ -1131,13 +1551,204 @@
"fault":true,
"retryable":{"throttling":false}
},
"InternetConfiguration":{
"type":"structure",
"members":{
},
"documentation":"<p>This configuration sets the Amazon S3 access point network origin to <code>Internet</code>.</p>"
},
"IssueCode":{"type":"string"},
"IssuingAccount":{"type":"string"},
"KmsConstraintsKey":{"type":"string"},
"KmsConstraintsMap":{
"type":"map",
"key":{"shape":"KmsConstraintsKey"},
"value":{"shape":"KmsConstraintsValue"}
},
"KmsConstraintsValue":{"type":"string"},
"KmsGrantConfiguration":{
"type":"structure",
"required":[
"granteePrincipal",
"issuingAccount",
"operations"
],
"members":{
"constraints":{
"shape":"KmsGrantConstraints",
"documentation":"<p>Use this structure to propose allowing <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations\">cryptographic operations</a> in the grant only when the operation request includes the specified <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context\">encryption context</a>.</p>"
},
"granteePrincipal":{
"shape":"GranteePrincipal",
"documentation":"<p>The principal that is given permission to perform the operations that the grant permits.</p>"
},
"issuingAccount":{
"shape":"IssuingAccount",
"documentation":"<p> The AWS account under which the grant was issued. The account is used to propose KMS grants issued by accounts other than the owner of the key.</p>"
},
"operations":{
"shape":"KmsGrantOperationsList",
"documentation":"<p>A list of operations that the grant permits.</p>"
},
"retiringPrincipal":{
"shape":"RetiringPrincipal",
"documentation":"<p>The principal that is given permission to retire the grant by using <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_RetireGrant.html\">RetireGrant</a> operation.</p>"
}
},
"documentation":"<p>A proposed grant configuration for a KMS key. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html\">CreateGrant</a>.</p>"
},
"KmsGrantConfigurationsList":{
"type":"list",
"member":{"shape":"KmsGrantConfiguration"}
},
"KmsGrantConstraints":{
"type":"structure",
"members":{
"encryptionContextEquals":{
"shape":"KmsConstraintsMap",
"documentation":"<p>A list of key-value pairs that must match the encryption context in the <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations\">cryptographic operation</a> request. The grant allows the operation only when the encryption context in the request is the same as the encryption context specified in this constraint.</p>"
},
"encryptionContextSubset":{
"shape":"KmsConstraintsMap",
"documentation":"<p>A list of key-value pairs that must be included in the encryption context of the <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations\">cryptographic operation</a> request. The grant allows the cryptographic operation only when the encryption context in the request includes the key-value pairs specified in this constraint, although it can include additional key-value pairs.</p>"
}
},
"documentation":"<p>Use this structure to propose allowing <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations\">cryptographic operations</a> in the grant only when the operation request includes the specified <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#encrypt_context\">encryption context</a>. You can specify only one type of encryption context. An empty map is treated as not specified. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/APIReference/API_GrantConstraints.html\">GrantConstraints</a>.</p>"
},
"KmsGrantOperation":{
"type":"string",
"enum":[
"CreateGrant",
"Decrypt",
"DescribeKey",
"Encrypt",
"GenerateDataKey",
"GenerateDataKeyPair",
"GenerateDataKeyPairWithoutPlaintext",
"GenerateDataKeyWithoutPlaintext",
"GetPublicKey",
"ReEncryptFrom",
"ReEncryptTo",
"RetireGrant",
"Sign",
"Verify"
]
},
"KmsGrantOperationsList":{
"type":"list",
"member":{"shape":"KmsGrantOperation"}
},
"KmsKeyConfiguration":{
"type":"structure",
"members":{
"grants":{
"shape":"KmsGrantConfigurationsList",
"documentation":"<p>A list of proposed grant configurations for the KMS key. If the proposed grant configuration is for an existing key, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the key.</p>"
},
"keyPolicies":{
"shape":"KmsKeyPoliciesMap",
"documentation":"<p>Resource policy configuration for the KMS key. The only valid value for the name of the key policy is <code>default</code>. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default\">Default key policy</a>.</p>"
}
},
"documentation":"<p>Proposed access control configuration for a KMS key. You can propose a configuration for a new KMS key or an existing KMS key that you own by specifying the key policy and KMS grant configuration. If the configuration is for an existing key and you do not specify the key policy, the access preview uses the existing policy for the key. If the access preview is for a new resource and you do not specify the key policy, then the access preview uses the default key policy. The proposed key policy cannot be an empty string. For more information, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/key-policies.html#key-policy-default\">Default key policy</a>. For more information about key policy limits, see <a href=\"https://docs.aws.amazon.com/kms/latest/developerguide/resource-limits.html\">Resource quotas</a>.</p> <p/>"
},
"KmsKeyPoliciesMap":{
"type":"map",
"key":{"shape":"PolicyName"},
"value":{"shape":"KmsKeyPolicy"}
},
"KmsKeyPolicy":{"type":"string"},
"LearnMoreLink":{"type":"string"},
"ListAccessPreviewFindingsRequest":{
"type":"structure",
"required":[
"accessPreviewId",
"analyzerArn"
],
"members":{
"accessPreviewId":{
"shape":"AccessPreviewId",
"documentation":"<p>The unique ID for the access preview.</p>",
"location":"uri",
"locationName":"accessPreviewId"
},
"analyzerArn":{
"shape":"AnalyzerArn",
"documentation":"<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of the analyzer</a> used to generate the access.</p>"
},
"filter":{
"shape":"FilterCriteriaMap",
"documentation":"<p>Criteria to filter the returned findings.</p>"
},
"maxResults":{
"shape":"Integer",
"documentation":"<p>The maximum number of results to return in the response.</p>"
},
"nextToken":{
"shape":"Token",
"documentation":"<p>A token used for pagination of results returned.</p>"
}
}
},
"ListAccessPreviewFindingsResponse":{
"type":"structure",
"required":["findings"],
"members":{
"findings":{
"shape":"AccessPreviewFindingsList",
"documentation":"<p>A list of access preview findings that match the specified filter criteria.</p>"
},
"nextToken":{
"shape":"Token",
"documentation":"<p>A token used for pagination of results returned.</p>"
}
}
},
"ListAccessPreviewsRequest":{
"type":"structure",
"required":["analyzerArn"],
"members":{
"analyzerArn":{
"shape":"AnalyzerArn",
"documentation":"<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of the analyzer</a> used to generate the access preview.</p>",
"location":"querystring",
"locationName":"analyzerArn"
},
"maxResults":{
"shape":"Integer",
"documentation":"<p>The maximum number of results to return in the response.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"Token",
"documentation":"<p>A token used for pagination of results returned.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListAccessPreviewsResponse":{
"type":"structure",
"required":["accessPreviews"],
"members":{
"accessPreviews":{
"shape":"AccessPreviewsList",
"documentation":"<p>A list of access previews retrieved for the analyzer.</p>"
},
"nextToken":{
"shape":"Token",
"documentation":"<p>A token used for pagination of results returned.</p>"
}
}
},
"ListAnalyzedResourcesRequest":{
"type":"structure",
"required":["analyzerArn"],
"members":{
"analyzerArn":{
"shape":"AnalyzerArn",
"documentation":"<p>The ARN of the analyzer to retrieve a list of analyzed resources from.</p>"
"documentation":"<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of the analyzer</a> to retrieve a list of analyzed resources from.</p>"
},
"maxResults":{
"shape":"Integer",
@ -1254,7 +1865,7 @@
"members":{
"analyzerArn":{
"shape":"AnalyzerArn",
"documentation":"<p>The ARN of the analyzer to retrieve findings from.</p>"
"documentation":"<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of the analyzer</a> to retrieve findings from.</p>"
},
"filter":{
"shape":"FilterCriteriaMap",
@ -1313,12 +1924,61 @@
},
"documentation":"<p>The response to the request.</p>"
},
"Locale":{
"type":"string",
"enum":[
"DE",
"EN",
"ES",
"FR",
"IT",
"JA",
"KO",
"PT_BR",
"ZH_CN",
"ZH_TW"
]
},
"Location":{
"type":"structure",
"required":[
"path",
"span"
],
"members":{
"path":{
"shape":"PathElementList",
"documentation":"<p>A path in a policy, represented as a sequence of path elements.</p>"
},
"span":{
"shape":"Span",
"documentation":"<p>A span in a policy.</p>"
}
},
"documentation":"<p>A location in a policy that is represented as a path through the JSON representation and a corresponding span.</p>"
},
"LocationList":{
"type":"list",
"member":{"shape":"Location"}
},
"Name":{
"type":"string",
"max":255,
"min":1,
"pattern":"^[A-Za-z][A-Za-z0-9_.-]*$"
},
"NetworkOriginConfiguration":{
"type":"structure",
"members":{
"internetConfiguration":{
"shape":"InternetConfiguration",
"documentation":"<p>The configuration for the Amazon S3 access point with an <code>Internet</code> origin.</p>"
},
"vpcConfiguration":{"shape":"VpcConfiguration"}
},
"documentation":"<p>The proposed <code>InternetConfiguration</code> or <code>VpcConfiguration</code> to apply to the Amazon S3 Access point. You can make the access point accessible from the internet, or you can specify that all requests made through that access point must originate from a specific virtual private cloud (VPC). You can specify only one type of network configuration. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/creating-access-points.html\">Creating access points</a>.</p>",
"union":true
},
"OrderBy":{
"type":"string",
"enum":[
@ -1326,6 +1986,66 @@
"DESC"
]
},
"PathElement":{
"type":"structure",
"members":{
"index":{
"shape":"Integer",
"documentation":"<p>Refers to an index in a JSON array.</p>"
},
"key":{
"shape":"String",
"documentation":"<p>Refers to a key in a JSON object.</p>"
},
"substring":{
"shape":"Substring",
"documentation":"<p>Refers to a substring of a literal string in a JSON object.</p>"
},
"value":{
"shape":"String",
"documentation":"<p>Refers to the value associated with a given key in a JSON object.</p>"
}
},
"documentation":"<p>A single element in a path through the JSON representation of a policy.</p>",
"union":true
},
"PathElementList":{
"type":"list",
"member":{"shape":"PathElement"}
},
"PolicyDocument":{"type":"string"},
"PolicyName":{"type":"string"},
"PolicyType":{
"type":"string",
"enum":[
"IDENTITY_POLICY",
"RESOURCE_POLICY",
"SERVICE_CONTROL_POLICY"
]
},
"Position":{
"type":"structure",
"required":[
"column",
"line",
"offset"
],
"members":{
"column":{
"shape":"Integer",
"documentation":"<p>The column of the position, starting from 0.</p>"
},
"line":{
"shape":"Integer",
"documentation":"<p>The line of the position, starting from 1.</p>"
},
"offset":{
"shape":"Integer",
"documentation":"<p>The offset within the policy that corresponds to the position, starting from 0.</p>"
}
},
"documentation":"<p>A position in a policy.</p>"
},
"PrincipalMap":{
"type":"map",
"key":{"shape":"String"},
@ -1381,6 +2101,109 @@
"AWS::SecretsManager::Secret"
]
},
"RetiringPrincipal":{"type":"string"},
"S3AccessPointConfiguration":{
"type":"structure",
"members":{
"accessPointPolicy":{
"shape":"AccessPointPolicy",
"documentation":"<p>The access point policy.</p>"
},
"networkOrigin":{
"shape":"NetworkOriginConfiguration",
"documentation":"<p>The proposed <code>Internet</code> and <code>VpcConfiguration</code> to apply to this Amazon S3 access point. If the access preview is for a new resource and neither is specified, the access preview uses <code>Internet</code> for the network origin. If the access preview is for an existing resource and neither is specified, the access preview uses the exiting network origin.</p>"
},
"publicAccessBlock":{
"shape":"S3PublicAccessBlockConfiguration",
"documentation":"<p>The proposed <code>S3PublicAccessBlock</code> configuration to apply to this Amazon S3 Access Point.</p>"
}
},
"documentation":"<p>The configuration for an Amazon S3 access point for the bucket. You can propose up to 10 access points per bucket. If the proposed Amazon S3 access point configuration is for an existing bucket, the access preview uses the proposed access point configuration in place of the existing access points. To propose an access point without a policy, you can provide an empty string as the access point policy. For more information, see <a href=\"https://docs.aws.amazon.com/https:/docs.aws.amazon.com/AmazonS3/latest/dev/creating-access-points.html\">Creating access points</a>. For more information about access point policy limits, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points-restrictions-limitations.html\">Access points restrictions and limitations</a>.</p>"
},
"S3AccessPointConfigurationsMap":{
"type":"map",
"key":{"shape":"AccessPointArn"},
"value":{"shape":"S3AccessPointConfiguration"}
},
"S3BucketAclGrantConfiguration":{
"type":"structure",
"required":[
"grantee",
"permission"
],
"members":{
"grantee":{
"shape":"AclGrantee",
"documentation":"<p>The grantee to whom you’re assigning access rights.</p>"
},
"permission":{
"shape":"AclPermission",
"documentation":"<p>The permissions being granted.</p>"
}
},
"documentation":"<p>A proposed access control list grant configuration for an Amazon S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#setting-acls\">How to Specify an ACL</a>.</p>"
},
"S3BucketAclGrantConfigurationsList":{
"type":"list",
"member":{"shape":"S3BucketAclGrantConfiguration"}
},
"S3BucketConfiguration":{
"type":"structure",
"members":{
"accessPoints":{
"shape":"S3AccessPointConfigurationsMap",
"documentation":"<p>The configuration of Amazon S3 access points for the bucket.</p>"
},
"bucketAclGrants":{
"shape":"S3BucketAclGrantConfigurationsList",
"documentation":"<p>The proposed list of ACL grants for the Amazon S3 bucket. You can propose up to 100 ACL grants per bucket. If the proposed grant configuration is for an existing bucket, the access preview uses the proposed list of grant configurations in place of the existing grants. Otherwise, the access preview uses the existing grants for the bucket.</p>"
},
"bucketPolicy":{
"shape":"S3BucketPolicy",
"documentation":"<p>The proposed bucket policy for the Amazon S3 bucket.</p>"
},
"bucketPublicAccessBlock":{
"shape":"S3PublicAccessBlockConfiguration",
"documentation":"<p>The proposed block public access configuration for the Amazon S3 bucket.</p>"
}
},
"documentation":"<p>Proposed access control configuration for an Amazon S3 bucket. You can propose a configuration for a new Amazon S3 bucket or an existing Amazon S3 bucket that you own by specifying the Amazon S3 bucket policy, bucket ACLs, bucket BPA settings, and Amazon S3 access points attached to the bucket. If the configuration is for an existing Amazon S3 bucket and you do not specify the Amazon S3 bucket policy, the access preview uses the existing policy attached to the bucket. If the access preview is for a new resource and you do not specify the Amazon S3 bucket policy, the access preview assumes a bucket without a policy. To propose deletion of an existing bucket policy, you can specify an empty string. For more information about bucket policy limits, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html\">Bucket Policy Examples</a>.</p>"
},
"S3BucketPolicy":{"type":"string"},
"S3PublicAccessBlockConfiguration":{
"type":"structure",
"required":[
"ignorePublicAcls",
"restrictPublicBuckets"
],
"members":{
"ignorePublicAcls":{
"shape":"Boolean",
"documentation":"<p> Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. </p>"
},
"restrictPublicBuckets":{
"shape":"Boolean",
"documentation":"<p> Specifies whether Amazon S3 should restrict public bucket policies for this bucket. </p>"
}
},
"documentation":"<p>The <code>PublicAccessBlock</code> configuration to apply to this Amazon S3 bucket. If the proposed configuration is for an existing Amazon S3 bucket and the configuration is not specified, the access preview uses the existing setting. If the proposed configuration is for a new bucket and the configuration is not specified, the access preview uses <code>false</code>. If the proposed configuration is for a new access point and the access point BPA configuration is not specified, the access preview uses <code>true</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-publicaccessblockconfiguration.html\">PublicAccessBlockConfiguration</a>. </p>"
},
"SecretsManagerSecretConfiguration":{
"type":"structure",
"members":{
"kmsKeyId":{
"shape":"SecretsManagerSecretKmsId",
"documentation":"<p>The proposed ARN, key ID, or alias of the AWS KMS customer master key (CMK).</p>"
},
"secretPolicy":{
"shape":"SecretsManagerSecretPolicy",
"documentation":"<p>The proposed resource policy defining who can access or manage the secret.</p>"
}
},
"documentation":"<p>The configuration for a Secrets Manager secret. For more information, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/apireference/API_CreateSecret.html\">CreateSecret</a>.</p> <p>You can propose a configuration for a new secret or an existing secret that you own by specifying the secret policy and optional KMS encryption key. If the configuration is for an existing secret and you do not specify the secret policy, the access preview uses the existing policy for the secret. If the access preview is for a new resource and you do not specify the policy, the access preview assumes a secret without a policy. To propose deletion of an existing policy, you can specify an empty string. If the proposed configuration is for a new secret and you do not specify the KMS key ID, the access preview uses the default CMK of the AWS account. If you specify an empty string for the KMS key ID, the access preview uses the default CMK of the AWS account. For more information about secret policy limits, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_limits.html\">Quotas for AWS Secrets Manager.</a>.</p>"
},
"SecretsManagerSecretKmsId":{"type":"string"},
"SecretsManagerSecretPolicy":{"type":"string"},
"ServiceQuotaExceededException":{
"type":"structure",
"required":[
@ -1424,6 +2247,35 @@
},
"documentation":"<p>The criteria used to sort.</p>"
},
"Span":{
"type":"structure",
"required":[
"end",
"start"
],
"members":{
"end":{
"shape":"Position",
"documentation":"<p>The end position of the span (exclusive).</p>"
},
"start":{
"shape":"Position",
"documentation":"<p>The start position of the span (inclusive).</p>"
}
},
"documentation":"<p>A span in a policy. The span consists of a start position (inclusive) and end position (exclusive).</p>"
},
"SqsQueueConfiguration":{
"type":"structure",
"members":{
"queuePolicy":{
"shape":"SqsQueuePolicy",
"documentation":"<p> The proposed resource policy for the SQS queue. </p>"
}
},
"documentation":"<p>The proposed access control configuration for an SQS queue. You can propose a configuration for a new SQS queue or an existing SQS queue that you own by specifying the SQS policy. If the configuration is for an existing SQS queue and you do not specify the SQS policy, the access preview uses the existing SQS policy for the queue. If the access preview is for a new resource and you do not specify the policy, the access preview assumes an SQS queue without a policy. To propose deletion of an existing SQS queue policy, you can specify an empty string for the SQS policy. For more information about SQS policy limits, see <a href=\"https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/quotas-policies.html\">Quotas related to policies</a>.</p>"
},
"SqsQueuePolicy":{"type":"string"},
"StartResourceScanRequest":{
"type":"structure",
"required":[
@ -1433,7 +2285,7 @@
"members":{
"analyzerArn":{
"shape":"AnalyzerArn",
"documentation":"<p>The ARN of the analyzer to use to scan the policies applied to the specified resource.</p>"
"documentation":"<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of the analyzer</a> to use to scan the policies applied to the specified resource.</p>"
},
"resourceArn":{
"shape":"ResourceArn",
@ -1451,9 +2303,27 @@
"documentation":"<p>The reason code for the current status of the analyzer.</p>"
}
},
"documentation":"<p>Provides more details about the current status of the analyzer. For example, if the creation for the analyzer fails, a <code>Failed</code> status is displayed. For an analyzer with organization as the type, this failure can be due to an issue with creating the service-linked roles required in the member accounts of the AWS organization.</p>"
"documentation":"<p>Provides more details about the current status of the analyzer. For example, if the creation for the analyzer fails, a <code>Failed</code> status is returned. For an analyzer with organization as the type, this failure can be due to an issue with creating the service-linked roles required in the member accounts of the AWS organization.</p>"
},
"String":{"type":"string"},
"Substring":{
"type":"structure",
"required":[
"length",
"start"
],
"members":{
"length":{
"shape":"Integer",
"documentation":"<p>The length of the substring.</p>"
},
"start":{
"shape":"Integer",
"documentation":"<p>The start index of the substring, starting from 0.</p>"
}
},
"documentation":"<p>A reference to a substring of a literal string in a JSON document.</p>"
},
"TagKeys":{
"type":"list",
"member":{"shape":"String"}
@ -1590,7 +2460,7 @@
"members":{
"analyzerArn":{
"shape":"AnalyzerArn",
"documentation":"<p>The ARN of the analyzer that generated the findings to update.</p>"
"documentation":"<p>The <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/access-analyzer-getting-started.html#permission-resources\">ARN of the analyzer</a> that generated the findings to update.</p>"
},
"clientToken":{
"shape":"String",
@ -1612,6 +2482,99 @@
},
"documentation":"<p>Updates findings with the new values provided in the request.</p>"
},
"ValidatePolicyFinding":{
"type":"structure",
"required":[
"findingDetails",
"findingType",
"issueCode",
"learnMoreLink",
"locations"
],
"members":{
"findingDetails":{
"shape":"String",
"documentation":"<p>A localized message that explains the finding and provides guidance on how to address it.</p>"
},
"findingType":{
"shape":"ValidatePolicyFindingType",
"documentation":"<p>The impact of the finding.</p> <p>Security warnings report when the policy allows access that we consider overly permissive.</p> <p>Errors report when a part of the policy is not functional.</p> <p>Warnings report non-security issues when a policy does not conform to policy writing best practices.</p> <p>Suggestions recommend stylistic improvements in the policy that do not impact access.</p>"
},
"issueCode":{
"shape":"IssueCode",
"documentation":"<p>The issue code provides an identifier of the issue associated with this finding.</p>"
},
"learnMoreLink":{
"shape":"LearnMoreLink",
"documentation":"<p>A link to additional documentation about the type of finding.</p>"
},
"locations":{
"shape":"LocationList",
"documentation":"<p>The list of locations in the policy document that are related to the finding. The issue code provides a summary of an issue identified by the finding.</p>"
}
},
"documentation":"<p>A finding in a policy. Each finding is an actionable recommendation that can be used to improve the policy.</p>"
},
"ValidatePolicyFindingList":{
"type":"list",
"member":{"shape":"ValidatePolicyFinding"}
},
"ValidatePolicyFindingType":{
"type":"string",
"enum":[
"ERROR",
"SECURITY_WARNING",
"SUGGESTION",
"WARNING"
]
},
"ValidatePolicyRequest":{
"type":"structure",
"required":[
"policyDocument",
"policyType"
],
"members":{
"locale":{
"shape":"Locale",
"documentation":"<p>The locale to use for localizing the findings.</p>"
},
"maxResults":{
"shape":"Integer",
"documentation":"<p>The maximum number of results to return in the response.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"Token",
"documentation":"<p>A token used for pagination of results returned.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"policyDocument":{
"shape":"PolicyDocument",
"documentation":"<p>The JSON policy document to use as the content for the policy.</p>"
},
"policyType":{
"shape":"PolicyType",
"documentation":"<p>The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include managed and inline policies for IAM roles, users, and groups. They also include service-control policies (SCPs) that are attached to an AWS organization, organizational unit (OU), or an account.</p> <p>Resource policies grant permissions on AWS resources. Resource policies include trust policies for IAM roles and bucket policies for S3 buckets. You can provide a generic input such as identity policy or resource policy or a specific input such as managed policy or S3 bucket policy. </p>"
}
}
},
"ValidatePolicyResponse":{
"type":"structure",
"required":["findings"],
"members":{
"findings":{
"shape":"ValidatePolicyFindingList",
"documentation":"<p>The list of findings in a policy returned by Access Analyzer based on its suite of policy checks.</p>"
},
"nextToken":{
"shape":"Token",
"documentation":"<p>A token used for pagination of results returned.</p>"
}
}
},
"ValidationException":{
"type":"structure",
"required":[
@ -1672,7 +2635,22 @@
"member":{"shape":"String"},
"max":20,
"min":1
},
"VpcConfiguration":{
"type":"structure",
"required":["vpcId"],
"members":{
"vpcId":{
"shape":"VpcId",
"documentation":"<p> If this field is specified, this access point will only allow connections from the specified VPC ID. </p>"
}
},
"documentation":"<p> The proposed virtual private cloud (VPC) configuration for the Amazon S3 access point. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_VpcConfiguration.html\">VpcConfiguration</a>. </p>"
},
"VpcId":{
"type":"string",
"pattern":"^vpc-([0-9a-f]){8}(([0-9a-f]){9})?$"
}
},
"documentation":"<p>AWS IAM Access Analyzer helps identify potential resource-access risks by enabling you to identify any policies that grant access to an external principal. It does this by using logic-based reasoning to analyze resource-based policies in your AWS environment. An external principal can be another AWS account, a root user, an IAM user or role, a federated user, an AWS service, or an anonymous user. This guide describes the AWS IAM Access Analyzer operations that you can call programmatically. For general information about Access Analyzer, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html\">AWS IAM Access Analyzer</a> in the <b>IAM User Guide</b>.</p> <p>To start using Access Analyzer, you first need to create an analyzer.</p>"
"documentation":"<p>AWS IAM Access Analyzer helps identify potential resource-access risks by enabling you to identify any policies that grant access to an external principal. It does this by using logic-based reasoning to analyze resource-based policies in your AWS environment. An external principal can be another AWS account, a root user, an IAM user or role, a federated user, an AWS service, or an anonymous user. You can also use Access Analyzer to preview and validate public and cross-account access to your resources before deploying permissions changes. This guide describes the AWS IAM Access Analyzer operations that you can call programmatically. For general information about Access Analyzer, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html\">AWS IAM Access Analyzer</a> in the <b>IAM User Guide</b>.</p> <p>To start using Access Analyzer, you first need to create an analyzer.</p>"
}

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

@ -26,7 +26,8 @@
{"shape":"InvalidTagException"},
{"shape":"TooManyTagsException"},
{"shape":"TagPolicyException"},
{"shape":"InvalidParameterException"}
{"shape":"InvalidParameterException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify and organize your AWS resources. Each tag consists of a <code>key</code> and an optional <code>value</code>. You specify the certificate on input by its Amazon Resource Name (ARN). You specify the tag by using a key-value pair. </p> <p>You can apply a tag to just one certificate if you want to identify a specific characteristic of that certificate, or you can apply the same tag to multiple certificates if you want to filter for a common relationship among those certificates. Similarly, you can apply the same tag to multiple resources if you want to specify a relationship among those resources. For example, you can add the same tag to an ACM certificate and an Elastic Load Balancing load balancer to indicate that they are both used by the same website. For more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/tags.html\">Tagging ACM certificates</a>. </p> <p>To remove one or more tags, use the <a>RemoveTagsFromCertificate</a> action. To view all of the tags that have been applied to the certificate, use the <a>ListTagsForCertificate</a> action. </p>"
},
@ -73,6 +74,19 @@
],
"documentation":"<p>Exports a private certificate issued by a private certificate authority (CA) for use anywhere. The exported file contains the certificate, the certificate chain, and the encrypted private 2048-bit RSA key associated with the public key that is embedded in the certificate. For security, you must assign a passphrase for the private key when exporting it. </p> <p>For information about exporting and formatting a certificate using the ACM console or CLI, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-export-private.html\">Export a Private Certificate</a>.</p>"
},
"GetAccountConfiguration":{
"name":"GetAccountConfiguration",
"http":{
"method":"POST",
"requestUri":"/"
},
"output":{"shape":"GetAccountConfigurationResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Returns the account configuration options associated with an AWS account.</p>"
},
"GetCertificate":{
"name":"GetCertificate",
"http":{
@ -102,9 +116,10 @@
{"shape":"InvalidTagException"},
{"shape":"TooManyTagsException"},
{"shape":"TagPolicyException"},
{"shape":"InvalidParameterException"}
{"shape":"InvalidParameterException"},
{"shape":"InvalidArnException"}
],
"documentation":"<p>Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-services.html\">integrated services</a> allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>. </p> <note> <p>ACM does not provide <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html\">managed renewal</a> for certificates that you import.</p> </note> <p>Note the following guidelines when importing third party certificates:</p> <ul> <li> <p>You must enter the private key that matches the certificate you are importing.</p> </li> <li> <p>The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.</p> </li> <li> <p>If the certificate you are importing is not self-signed, you must enter its certificate chain.</p> </li> <li> <p>If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.</p> </li> <li> <p>The certificate, private key, and certificate chain must be PEM-encoded.</p> </li> <li> <p>The current time must be between the <code>Not Before</code> and <code>Not After</code> certificate fields.</p> </li> <li> <p>The <code>Issuer</code> field must not be empty.</p> </li> <li> <p>The OCSP authority URL, if present, must not exceed 1000 characters.</p> </li> <li> <p>To import a new certificate, omit the <code>CertificateArn</code> argument. Include this argument only when you want to replace a previously imported certifica</p> </li> <li> <p>When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by <code>file://</code>. For example, you can specify a certificate saved in the <code>C:\\temp</code> folder as <code>file://C:\\temp\\certificate_to_import.pem</code>. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. </p> </li> <li> <p>When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using. </p> </li> <li> <p>The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA.</p> </li> </ul> <p>This operation returns the <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>"
"documentation":"<p>Imports a certificate into AWS Certificate Manager (ACM) to use with services that are integrated with ACM. Note that <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-services.html\">integrated services</a> allow only certificate types and keys they support to be associated with their resources. Further, their support differs depending on whether the certificate is imported into IAM or into ACM. For more information, see the documentation for each service. For more information about importing certificates into ACM, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html\">Importing Certificates</a> in the <i>AWS Certificate Manager User Guide</i>. </p> <note> <p>ACM does not provide <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html\">managed renewal</a> for certificates that you import.</p> </note> <p>Note the following guidelines when importing third party certificates:</p> <ul> <li> <p>You must enter the private key that matches the certificate you are importing.</p> </li> <li> <p>The private key must be unencrypted. You cannot import a private key that is protected by a password or a passphrase.</p> </li> <li> <p>The private key must be no larger than 5 KB (5,120 bytes).</p> </li> <li> <p>If the certificate you are importing is not self-signed, you must enter its certificate chain.</p> </li> <li> <p>If a certificate chain is included, the issuer must be the subject of one of the certificates in the chain.</p> </li> <li> <p>The certificate, private key, and certificate chain must be PEM-encoded.</p> </li> <li> <p>The current time must be between the <code>Not Before</code> and <code>Not After</code> certificate fields.</p> </li> <li> <p>The <code>Issuer</code> field must not be empty.</p> </li> <li> <p>The OCSP authority URL, if present, must not exceed 1000 characters.</p> </li> <li> <p>To import a new certificate, omit the <code>CertificateArn</code> argument. Include this argument only when you want to replace a previously imported certificate.</p> </li> <li> <p>When you import a certificate by using the CLI, you must specify the certificate, the certificate chain, and the private key by their file names preceded by <code>fileb://</code>. For example, you can specify a certificate saved in the <code>C:\\temp</code> folder as <code>fileb://C:\\temp\\certificate_to_import.pem</code>. If you are making an HTTP or HTTPS Query request, include these arguments as BLOBs. </p> </li> <li> <p>When you import a certificate by using an SDK, you must specify the certificate, the certificate chain, and the private key files in the manner required by the programming language you're using. </p> </li> <li> <p>The cryptographic algorithm of an imported certificate must match the algorithm of the signing CA. For example, if the signing CA key type is RSA, then the certificate key type must also be RSA.</p> </li> </ul> <p>This operation returns the <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Name (ARN)</a> of the imported certificate.</p>"
},
"ListCertificates":{
"name":"ListCertificates",
@ -133,6 +148,21 @@
],
"documentation":"<p>Lists the tags that have been applied to the ACM certificate. Use the certificate's Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, use the <a>AddTagsToCertificate</a> action. To delete a tag, use the <a>RemoveTagsFromCertificate</a> action. </p>"
},
"PutAccountConfiguration":{
"name":"PutAccountConfiguration",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"PutAccountConfigurationRequest"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"}
],
"documentation":"<p>Adds or modifies account-level configurations in ACM. </p> <p>The supported configuration option is <code>DaysBeforeExpiry</code>. This option specifies the number of days prior to certificate expiration when ACM starts generating <code>EventBridge</code> events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration.</p>"
},
"RemoveTagsFromCertificate":{
"name":"RemoveTagsFromCertificate",
"http":{
@ -145,7 +175,8 @@
{"shape":"InvalidArnException"},
{"shape":"InvalidTagException"},
{"shape":"TagPolicyException"},
{"shape":"InvalidParameterException"}
{"shape":"InvalidParameterException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. If you do not specify the value portion of the tag when calling this function, the tag will be removed regardless of value. If you specify a value, the tag is removed only if it is associated with the specified value. </p> <p>To add tags to a certificate, use the <a>AddTagsToCertificate</a> action. To view all of the tags that have been applied to a specific ACM certificate, use the <a>ListTagsForCertificate</a> action. </p>"
},
@ -160,7 +191,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidArnException"}
],
"documentation":"<p>Renews an eligable ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your ACM PCA certificates with ACM, you must first <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaPermissions.html\">grant the ACM service principal permission to do so</a>. For more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/manual-renewal.html\">Testing Managed Renewal</a> in the ACM User Guide.</p>"
"documentation":"<p>Renews an eligible ACM certificate. At this time, only exported private certificates can be renewed with this operation. In order to renew your ACM PCA certificates with ACM, you must first <a href=\"https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaPermissions.html\">grant the ACM service principal permission to do so</a>. For more information, see <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/manual-renewal.html\">Testing Managed Renewal</a> in the ACM User Guide.</p>"
},
"RequestCertificate":{
"name":"RequestCertificate",
@ -213,6 +244,15 @@
}
},
"shapes":{
"AccessDeniedException":{
"type":"structure",
"members":{
"Message":{"shape":"ServiceErrorMessage"}
},
"documentation":"<p>You do not have access required to perform this action.</p>",
"exception":true,
"synthetic":true
},
"AddTagsToCertificateRequest":{
"type":"structure",
"required":[
@ -222,7 +262,7 @@
"members":{
"CertificateArn":{
"shape":"Arn",
"documentation":"<p>String that contains the ARN of the ACM certificate to which the tag is to be applied. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </p>"
"documentation":"<p>String that contains the ARN of the ACM certificate to which the tag is to be applied. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a>.</p>"
},
"Tags":{
"shape":"TagList",
@ -236,6 +276,7 @@
"min":20,
"pattern":"arn:[\\w+=/,.@-]+:[\\w+=/,.@-]+:[\\w+=/,.@-]*:[0-9]+:[\\w+=,.@-]+(/[\\w+=,.@-]+)*"
},
"AvailabilityErrorMessage":{"type":"string"},
"CertificateBody":{
"type":"string",
"max":32768,
@ -263,7 +304,7 @@
"members":{
"CertificateArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a> in the <i>AWS General Reference</i>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a> in the <i>AWS General Reference</i>.</p>"
},
"DomainName":{
"shape":"DomainNameString",
@ -291,7 +332,7 @@
},
"CreatedAt":{
"shape":"TStamp",
"documentation":"<p>The time at which the certificate was requested. This value exists only when the certificate type is <code>AMAZON_ISSUED</code>. </p>"
"documentation":"<p>The time at which the certificate was requested.</p>"
},
"IssuedAt":{
"shape":"TStamp",
@ -399,7 +440,7 @@
"members":{
"CertificateArn":{
"shape":"Arn",
"documentation":"<p>Amazon Resource Name (ARN) of the certificate. This is of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </p>"
"documentation":"<p>Amazon Resource Name (ARN) of the certificate. This is of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a>.</p>"
},
"DomainName":{
"shape":"DomainNameString",
@ -427,13 +468,21 @@
"PRIVATE"
]
},
"ConflictException":{
"type":"structure",
"members":{
"message":{"shape":"String"}
},
"documentation":"<p>You are trying to update a resource or configuration that is already being created or updated. Wait for the previous operation to finish and try again.</p>",
"exception":true
},
"DeleteCertificateRequest":{
"type":"structure",
"required":["CertificateArn"],
"members":{
"CertificateArn":{
"shape":"Arn",
"documentation":"<p>String that contains the ARN of the ACM certificate to be deleted. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
"documentation":"<p>String that contains the ARN of the ACM certificate to be deleted. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a>.</p>"
}
}
},
@ -443,7 +492,7 @@
"members":{
"CertificateArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have the following form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a>.</p>"
}
}
},
@ -537,6 +586,16 @@
"max":100,
"min":1
},
"ExpiryEventsConfiguration":{
"type":"structure",
"members":{
"DaysBeforeExpiry":{
"shape":"PositiveInteger",
"documentation":"<p>Specifies the number of days prior to certificate expiration when ACM starts generating <code>EventBridge</code> events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration.</p>"
}
},
"documentation":"<p>Object containing expiration events options associated with an AWS account.</p>"
},
"ExportCertificateRequest":{
"type":"structure",
"required":[
@ -645,18 +704,27 @@
},
"keyTypes":{
"shape":"KeyAlgorithmList",
"documentation":"<p>Specify one or more algorithms that can be used to generate key pairs.</p> <p>Default filtering returns only <code>RSA_2048</code> certificates. To return other certificate types, provide the desired type signatures in a comma-separated list. For example, <code>\"keyTypes\": [\"RSA_2048,RSA_4096\"]</code> returns both <code>RSA_2048</code> and <code>RSA_4096</code> certificates.</p>"
"documentation":"<p>Specify one or more algorithms that can be used to generate key pairs.</p> <p>Default filtering returns only <code>RSA_1024</code> and <code>RSA_2048</code> certificates that have at least one domain. To return other certificate types, provide the desired type signatures in a comma-separated list. For example, <code>\"keyTypes\": [\"RSA_2048,RSA_4096\"]</code> returns both <code>RSA_2048</code> and <code>RSA_4096</code> certificates.</p>"
}
},
"documentation":"<p>This structure can be used in the <a>ListCertificates</a> action to filter the output of the certificate list. </p>"
},
"GetAccountConfigurationResponse":{
"type":"structure",
"members":{
"ExpiryEvents":{
"shape":"ExpiryEventsConfiguration",
"documentation":"<p>Expiration events configuration options associated with the AWS account.</p>"
}
}
},
"GetCertificateRequest":{
"type":"structure",
"required":["CertificateArn"],
"members":{
"CertificateArn":{
"shape":"Arn",
"documentation":"<p>String that contains a certificate ARN in the following format:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
"documentation":"<p>String that contains a certificate ARN in the following format:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a>.</p>"
}
}
},
@ -866,7 +934,7 @@
"members":{
"CertificateArn":{
"shape":"Arn",
"documentation":"<p>String that contains the ARN of the ACM certificate for which you want to list the tags. This must have the following form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </p>"
"documentation":"<p>String that contains the ARN of the ACM certificate for which you want to list the tags. This must have the following form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a>.</p>"
}
}
},
@ -896,6 +964,10 @@
"min":4,
"sensitive":true
},
"PositiveInteger":{
"type":"integer",
"min":1
},
"PrivateKey":{
"type":"string",
"max":524288,
@ -909,6 +981,20 @@
"min":1,
"sensitive":true
},
"PutAccountConfigurationRequest":{
"type":"structure",
"required":["IdempotencyToken"],
"members":{
"ExpiryEvents":{
"shape":"ExpiryEventsConfiguration",
"documentation":"<p>Specifies expiration events associated with an account.</p>"
},
"IdempotencyToken":{
"shape":"IdempotencyToken",
"documentation":"<p>Customer-chosen string used to distinguish between calls to <code>PutAccountConfiguration</code>. Idempotency tokens time out after one hour. If you call <code>PutAccountConfiguration</code> multiple times with the same unexpired idempotency token, ACM treats it as the same request and returns the original result. If you change the idempotency token for each call, ACM treats each call as a new request.</p>"
}
}
},
"RecordType":{
"type":"string",
"enum":["CNAME"]
@ -922,7 +1008,7 @@
"members":{
"CertificateArn":{
"shape":"Arn",
"documentation":"<p>String that contains the ARN of the ACM Certificate with one or more tags that you want to remove. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>. </p>"
"documentation":"<p>String that contains the ARN of the ACM Certificate with one or more tags that you want to remove. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a>.</p>"
},
"Tags":{
"shape":"TagList",
@ -936,7 +1022,7 @@
"members":{
"CertificateArn":{
"shape":"Arn",
"documentation":"<p>String that contains the ARN of the ACM certificate to be renewed. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs) and AWS Service Namespaces</a>.</p>"
"documentation":"<p>String that contains the ARN of the ACM certificate to be renewed. This must be of the form:</p> <p> <code>arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012</code> </p> <p>For more information about ARNs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html\">Amazon Resource Names (ARNs)</a>.</p>"
}
}
},
@ -1114,6 +1200,7 @@
"A_A_COMPROMISE"
]
},
"ServiceErrorMessage":{"type":"string"},
"String":{"type":"string"},
"TStamp":{"type":"timestamp"},
"Tag":{
@ -1157,6 +1244,15 @@
"min":0,
"pattern":"[\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@]*"
},
"ThrottlingException":{
"type":"structure",
"members":{
"message":{"shape":"AvailabilityErrorMessage"}
},
"documentation":"<p>The request was denied because it exceeded a quota.</p>",
"exception":true,
"synthetic":true
},
"TooManyTagsException":{
"type":"structure",
"members":{
@ -1186,6 +1282,16 @@
"type":"list",
"member":{"shape":"String"}
},
"ValidationException":{
"type":"structure",
"members":{
"message":{"shape":"ValidationExceptionMessage"}
},
"documentation":"<p>The supplied input failed to satisfy constraints of an AWS service.</p>",
"exception":true,
"synthetic":true
},
"ValidationExceptionMessage":{"type":"string"},
"ValidationMethod":{
"type":"string",
"enum":[
@ -1194,5 +1300,5 @@
]
}
},
"documentation":"<fullname>AWS Certificate Manager</fullname> <p>Welcome to the AWS Certificate Manager (ACM) API documentation.</p> <p>You can use ACM to manage SSL/TLS certificates for your AWS-based websites and applications. For general information about using ACM, see the <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/\"> <i>AWS Certificate Manager User Guide</i> </a>.</p>"
"documentation":"<fullname>AWS Certificate Manager</fullname> <p>You can use AWS Certificate Manager (ACM) to manage SSL/TLS certificates for your AWS-based websites and applications. For more information about using ACM, see the <a href=\"https://docs.aws.amazon.com/acm/latest/userguide/\">AWS Certificate Manager User Guide</a>.</p>"
}

28
botocore/data/alexaforbusiness/2017-11-09/service-2.json
View file

@ -904,7 +904,7 @@
"errors":[
{"shape":"NotFoundException"}
],
"documentation":"<p>Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.</p>"
"documentation":"<p>Determines the details for the room from which a skill request was invoked. This operation is used by skill developers.</p> <p>To query ResolveRoom from an Alexa skill, the skill ID needs to be authorized. When the skill is using an AWS Lambda function, the skill is automatically authorized when you publish your skill as a private skill to your AWS account. Skills that are hosted using a custom web service must be manually authorized. To get your skill authorized, contact AWS Support with your AWS account ID that queries the ResolveRoom API and skill ID. </p>"
},
"RevokeInvitation":{
"name":"RevokeInvitation",
@ -1872,6 +1872,10 @@
"shape":"ClientRequestToken",
"documentation":"<p>A unique, user-specified identifier for the request that ensures idempotency.</p>",
"idempotencyToken":true
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be added to the specified resource. Do not provide system tags.</p>"
}
}
},
@ -1967,6 +1971,10 @@
"shape":"ClientRequestToken",
"documentation":"<p>The request token of the client.</p>",
"idempotencyToken":true
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be added to the specified resource. Do not provide system tags.</p>"
}
}
},
@ -2011,6 +2019,10 @@
"shape":"ClientRequestToken",
"documentation":"<p>A unique, user-specified identifier for this request that ensures idempotency.</p>",
"idempotencyToken":true
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be added to the specified resource. Do not provide system tags.</p>"
}
}
},
@ -2065,6 +2077,10 @@
"shape":"ClientRequestToken",
"documentation":"<p> A unique, user-specified identifier for the request that ensures idempotency.</p>",
"idempotencyToken":true
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be added to the specified resource. Do not provide system tags.</p>"
}
}
},
@ -2162,6 +2178,10 @@
"ClientRequestToken":{
"shape":"ClientRequestToken",
"idempotencyToken":true
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be added to the specified resource. Do not provide system tags. </p>"
}
}
},
@ -4448,7 +4468,11 @@
},
"RoomArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the room with which to associate your AVS device.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the room with which to associate your AVS device.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to be added to the specified resource. Do not provide system tags.</p>"
}
}
},

141
botocore/data/appflow/2020-08-23/service-2.json
View file

@ -643,6 +643,14 @@
"Upsolver":{
"shape":"UpsolverMetadata",
"documentation":"<p> The connector metadata specific to Upsolver. </p>"
},
"CustomerProfiles":{
"shape":"CustomerProfilesMetadata",
"documentation":"<p> The connector metadata specific to Amazon Connect Customer Profiles. </p>"
},
"Honeycode":{
"shape":"HoneycodeMetadata",
"documentation":"<p> The connector metadata specific to Amazon Honeycode. </p>"
}
},
"documentation":"<p> A structure to specify connector-specific metadata such as <code>oAuthScopes</code>, <code>supportedRegions</code>, <code>privateLinkServiceUrl</code>, and so on. </p>"
@ -803,6 +811,10 @@
"shape":"GoogleAnalyticsConnectorProfileCredentials",
"documentation":"<p> The connector-specific credentials required when using Google Analytics. </p>"
},
"Honeycode":{
"shape":"HoneycodeConnectorProfileCredentials",
"documentation":"<p> The connector-specific credentials required when using Amazon Honeycode. </p>"
},
"InforNexus":{
"shape":"InforNexusConnectorProfileCredentials",
"documentation":"<p> The connector-specific credentials required when using Infor Nexus. </p>"
@ -884,6 +896,10 @@
"shape":"GoogleAnalyticsConnectorProfileProperties",
"documentation":"<p> The connector-specific properties required Google Analytics. </p>"
},
"Honeycode":{
"shape":"HoneycodeConnectorProfileProperties",
"documentation":"<p> The connector-specific properties required by Amazon Honeycode. </p>"
},
"InforNexus":{
"shape":"InforNexusConnectorProfileProperties",
"documentation":"<p> The connector-specific properties required by Infor Nexus. </p>"
@ -960,7 +976,10 @@
"Amplitude",
"Veeva",
"EventBridge",
"Upsolver"
"LookoutMetrics",
"Upsolver",
"Honeycode",
"CustomerProfiles"
]
},
"ConnectorTypeList":{
@ -1071,6 +1090,27 @@
"max":256,
"pattern":"\\S+"
},
"CustomerProfilesDestinationProperties":{
"type":"structure",
"required":["domainName"],
"members":{
"domainName":{
"shape":"DomainName",
"documentation":"<p> The unique name of the Amazon Connect Customer Profiles domain. </p>"
},
"objectTypeName":{
"shape":"ObjectTypeName",
"documentation":"<p> The object specified in the Amazon Connect Customer Profiles flow destination. </p>"
}
},
"documentation":"<p> The properties that are applied when Amazon Connect Customer Profiles is used as a destination. </p>"
},
"CustomerProfilesMetadata":{
"type":"structure",
"members":{
},
"documentation":"<p> The connector metadata specific to Amazon Connect Customer Profiles. </p>"
},
"DataPullMode":{
"type":"string",
"enum":[
@ -1419,9 +1459,21 @@
"shape":"EventBridgeDestinationProperties",
"documentation":"<p> The properties required to query Amazon EventBridge. </p>"
},
"LookoutMetrics":{
"shape":"LookoutMetricsDestinationProperties",
"documentation":"<p> The properties required to query Amazon Lookout for Metrics. </p>"
},
"Upsolver":{
"shape":"UpsolverDestinationProperties",
"documentation":"<p> The properties required to query Upsolver. </p>"
},
"Honeycode":{
"shape":"HoneycodeDestinationProperties",
"documentation":"<p> The properties required to query Amazon Honeycode. </p>"
},
"CustomerProfiles":{
"shape":"CustomerProfilesDestinationProperties",
"documentation":"<p> The properties required to query Amazon Connect Customer Profiles. </p>"
}
},
"documentation":"<p> This stores the information that is required to query a particular connector. </p>"
@ -1483,6 +1535,11 @@
"type":"list",
"member":{"shape":"DestinationFlowConfig"}
},
"DomainName":{
"type":"string",
"max":64,
"pattern":"\\S+"
},
"DynatraceConnectorOperator":{
"type":"string",
"enum":[
@ -1652,6 +1709,14 @@
"lastUpdatedAt":{
"shape":"Date",
"documentation":"<p> Specifies the time of the most recent update. </p>"
},
"dataPullStartTime":{
"shape":"Date",
"documentation":"<p> The timestamp that determines the first new or updated record to be transferred in the flow run. </p>"
},
"dataPullEndTime":{
"shape":"Date",
"documentation":"<p> The timestamp that indicates the last new or updated record to be transferred in the flow run. </p>"
}
},
"documentation":"<p> Specifies information about the past flow run instances for a given flow. </p>"
@ -1887,6 +1952,49 @@
"max":128,
"pattern":"\\S+"
},
"HoneycodeConnectorProfileCredentials":{
"type":"structure",
"members":{
"accessToken":{
"shape":"AccessToken",
"documentation":"<p> The credentials used to access protected Amazon Honeycode resources. </p>"
},
"refreshToken":{
"shape":"RefreshToken",
"documentation":"<p> The credentials used to acquire new access tokens. </p>"
},
"oAuthRequest":{"shape":"ConnectorOAuthRequest"}
},
"documentation":"<p> The connector-specific credentials required when using Amazon Honeycode. </p>"
},
"HoneycodeConnectorProfileProperties":{
"type":"structure",
"members":{
},
"documentation":"<p> The connector-specific properties required when using Amazon Honeycode. </p>"
},
"HoneycodeDestinationProperties":{
"type":"structure",
"required":["object"],
"members":{
"object":{
"shape":"Object",
"documentation":"<p> The object specified in the Amazon Honeycode flow destination. </p>"
},
"errorHandlingConfig":{"shape":"ErrorHandlingConfig"}
},
"documentation":"<p> The properties that are applied when Amazon Honeycode is used as a destination. </p>"
},
"HoneycodeMetadata":{
"type":"structure",
"members":{
"oAuthScopes":{
"shape":"OAuthScopeList",
"documentation":"<p> The desired authorization scope for the Amazon Honeycode account. </p>"
}
},
"documentation":"<p> The connector metadata specific to Amazon Honeycode. </p>"
},
"IdFieldNameList":{
"type":"list",
"member":{"shape":"Name"},
@ -2090,6 +2198,12 @@
}
},
"Long":{"type":"long"},
"LookoutMetricsDestinationProperties":{
"type":"structure",
"members":{
},
"documentation":"<p> The properties that are applied when Amazon Lookout for Metrics is used as a destination. </p>"
},
"MarketoConnectorOperator":{
"type":"string",
"enum":[
@ -2199,6 +2313,11 @@
"max":512,
"pattern":"\\S+"
},
"ObjectTypeName":{
"type":"string",
"max":255,
"pattern":"\\S+"
},
"Operator":{
"type":"string",
"enum":[
@ -2255,11 +2374,11 @@
"members":{
"prefixType":{
"shape":"PrefixType",
"documentation":"<p> Determines the level of granularity that's included in the prefix. </p>"
"documentation":"<p> Determines the format of the prefix, and whether it applies to the file name, file path, or both. </p>"
},
"prefixFormat":{
"shape":"PrefixFormat",
"documentation":"<p> Determines the format of the prefix, and whether it applies to the file name, file path, or both. </p>"
"documentation":"<p> Determines the level of granularity that's included in the prefix. </p>"
}
},
"documentation":"<p> Determines the prefix that Amazon AppFlow applies to the destination folder name. You can name your destination folders according to the flow frequency and date. </p>"
@ -2609,6 +2728,11 @@
"ONCE"
]
},
"ScheduleOffset":{
"type":"long",
"max":36000,
"min":0
},
"ScheduledTriggerProperties":{
"type":"structure",
"required":["scheduleExpression"],
@ -2631,7 +2755,16 @@
},
"timezone":{
"shape":"Timezone",
"documentation":"<p> Specifies the time zone used when referring to the date and time of a scheduled-triggered flow. </p>"
"documentation":"<p> Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as <code>America/New_York</code>. </p>"
},
"scheduleOffset":{
"shape":"ScheduleOffset",
"documentation":"<p> Specifies the optional offset that is added to the time interval for a schedule-triggered flow. </p>",
"box":true
},
"firstExecutionFrom":{
"shape":"Date",
"documentation":"<p> Specifies the date range for the records to import from the connector in the first flow run. </p>"
}
},
"documentation":"<p> Specifies the configuration details of a schedule-triggered flow as defined by the user. Currently, these settings only apply to the <code>Scheduled</code> trigger type. </p>"

9
botocore/data/appsync/2017-07-25/service-2.json
View file

@ -1148,7 +1148,8 @@
"functionVersion":{
"shape":"String",
"documentation":"<p>The <code>version</code> of the request mapping template. Currently the supported value is 2018-05-29. </p>"
}
},
"syncConfig":{"shape":"SyncConfig"}
}
},
"CreateFunctionResponse":{
@ -1675,7 +1676,8 @@
"functionVersion":{
"shape":"String",
"documentation":"<p>The version of the request mapping template. Currently only the 2018-05-29 version of the template is supported.</p>"
}
},
"syncConfig":{"shape":"SyncConfig"}
},
"documentation":"<p>A function is a reusable entity. Multiple functions can be used to compose the resolver logic.</p>"
},
@ -2920,7 +2922,8 @@
"functionVersion":{
"shape":"String",
"documentation":"<p>The <code>version</code> of the request mapping template. Currently the supported value is 2018-05-29. </p>"
}
},
"syncConfig":{"shape":"SyncConfig"}
}
},
"UpdateFunctionResponse":{

372
botocore/data/athena/2017-05-18/service-2.json
View file

@ -69,6 +69,20 @@
"documentation":"<p>Creates a named query in the specified workgroup. Requires that you have access to the workgroup.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"idempotent":true
},
"CreatePreparedStatement":{
"name":"CreatePreparedStatement",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreatePreparedStatementInput"},
"output":{"shape":"CreatePreparedStatementOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Creates a prepared statement for use with SQL queries in Athena.</p>"
},
"CreateWorkGroup":{
"name":"CreateWorkGroup",
"http":{
@ -112,6 +126,21 @@
"documentation":"<p>Deletes the named query if you have access to the workgroup in which the query was saved.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
"idempotent":true
},
"DeletePreparedStatement":{
"name":"DeletePreparedStatement",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeletePreparedStatementInput"},
"output":{"shape":"DeletePreparedStatementOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deletes the prepared statement with the specified name from the specified workgroup.</p>"
},
"DeleteWorkGroup":{
"name":"DeleteWorkGroup",
"http":{
@ -154,7 +183,7 @@
{"shape":"InvalidRequestException"},
{"shape":"MetadataException"}
],
"documentation":"<p>Returns a database object for the specfied database and data catalog.</p>"
"documentation":"<p>Returns a database object for the specified database and data catalog.</p>"
},
"GetNamedQuery":{
"name":"GetNamedQuery",
@ -170,6 +199,21 @@
],
"documentation":"<p>Returns information about a single query. Requires that you have access to the workgroup in which the query was saved.</p>"
},
"GetPreparedStatement":{
"name":"GetPreparedStatement",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetPreparedStatementInput"},
"output":{"shape":"GetPreparedStatementOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Retrieves the prepared statement with the specified name from the specified workgroup.</p>"
},
"GetQueryExecution":{
"name":"GetQueryExecution",
"http":{
@ -256,6 +300,20 @@
],
"documentation":"<p>Lists the databases in the specified data catalog.</p>"
},
"ListEngineVersions":{
"name":"ListEngineVersions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListEngineVersionsInput"},
"output":{"shape":"ListEngineVersionsOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Returns a list of engine versions that are available to choose from, including the Auto option.</p>"
},
"ListNamedQueries":{
"name":"ListNamedQueries",
"http":{
@ -270,6 +328,20 @@
],
"documentation":"<p>Provides a list of available query IDs only for queries saved in the specified workgroup. Requires that you have access to the specified workgroup. If a workgroup is not specified, lists the saved queries for the primary workgroup.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>"
},
"ListPreparedStatements":{
"name":"ListPreparedStatements",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListPreparedStatementsInput"},
"output":{"shape":"ListPreparedStatementsOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Lists the prepared statements in the specfied workgroup.</p>"
},
"ListQueryExecutions":{
"name":"ListQueryExecutions",
"http":{
@ -403,6 +475,21 @@
],
"documentation":"<p>Updates the data catalog that has the specified name.</p>"
},
"UpdatePreparedStatement":{
"name":"UpdatePreparedStatement",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdatePreparedStatementInput"},
"output":{"shape":"UpdatePreparedStatementOutput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Updates a prepared statement.</p>"
},
"UpdateWorkGroup":{
"name":"UpdateWorkGroup",
"http":{
@ -586,7 +673,7 @@
},
"Type":{
"shape":"DataCatalogType",
"documentation":"<p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog, <code>GLUE</code> for AWS Glue Catalog, or <code>HIVE</code> for an external hive metastore.</p>"
"documentation":"<p>The type of data catalog to create: <code>LAMBDA</code> for a federated catalog or <code>HIVE</code> for an external hive metastore.</p> <note> <p>Do not use the <code>GLUE</code> type. This refers to the <code>AwsDataCatalog</code> that already exists in your account, of which you can have only one. Specifying the <code>GLUE</code> type will result in an <code>INVALID_INPUT</code> error.</p> </note>"
},
"Description":{
"shape":"DescriptionString",
@ -594,7 +681,7 @@
},
"Parameters":{
"shape":"ParametersMap",
"documentation":"<p>Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type. </p> <ul> <li> <p>For the <code>HIVE</code> data catalog type, use the following syntax. The <code>metadata-function</code> parameter is required. <code>The sdk-version</code> parameter is optional and defaults to the currently supported version.</p> <p> <code>metadata-function=<i>lambda_arn</i>, sdk-version=<i>version_number</i> </code> </p> </li> <li> <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets of required parameters, but not both.</p> <ul> <li> <p>If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.</p> <p> <code>metadata-function=<i>lambda_arn</i>, record-function=<i>lambda_arn</i> </code> </p> </li> <li> <p> If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.</p> <p> <code>function=<i>lambda_arn</i> </code> </p> </li> </ul> </li> <li> <p>The <code>GLUE</code> type has no parameters.</p> </li> </ul>"
"documentation":"<p>Specifies the Lambda function or functions to use for creating the data catalog. This is a mapping whose values depend on the catalog type. </p> <ul> <li> <p>For the <code>HIVE</code> data catalog type, use the following syntax. The <code>metadata-function</code> parameter is required. <code>The sdk-version</code> parameter is optional and defaults to the currently supported version.</p> <p> <code>metadata-function=<i>lambda_arn</i>, sdk-version=<i>version_number</i> </code> </p> </li> <li> <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets of required parameters, but not both.</p> <ul> <li> <p>If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.</p> <p> <code>metadata-function=<i>lambda_arn</i>, record-function=<i>lambda_arn</i> </code> </p> </li> <li> <p> If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.</p> <p> <code>function=<i>lambda_arn</i> </code> </p> </li> </ul> </li> </ul>"
},
"Tags":{
"shape":"TagList",
@ -651,6 +738,37 @@
}
}
},
"CreatePreparedStatementInput":{
"type":"structure",
"required":[
"StatementName",
"WorkGroup",
"QueryStatement"
],
"members":{
"StatementName":{
"shape":"StatementName",
"documentation":"<p>The name of the prepared statement.</p>"
},
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup to which the prepared statement belongs.</p>"
},
"QueryStatement":{
"shape":"QueryString",
"documentation":"<p>The query string for the prepared statement.</p>"
},
"Description":{
"shape":"DescriptionString",
"documentation":"<p>The description of the prepared statement.</p>"
}
}
},
"CreatePreparedStatementOutput":{
"type":"structure",
"members":{
}
},
"CreateWorkGroupInput":{
"type":"structure",
"required":["Name"],
@ -695,11 +813,11 @@
},
"Type":{
"shape":"DataCatalogType",
"documentation":"<p>The type of data catalog: <code>LAMBDA</code> for a federated catalog, <code>GLUE</code> for AWS Glue Catalog, or <code>HIVE</code> for an external hive metastore.</p>"
"documentation":"<p>The type of data catalog: <code>LAMBDA</code> for a federated catalog or <code>HIVE</code> for an external hive metastore. <code>GLUE</code> refers to the <code>AwsDataCatalog</code> that already exists in your account, of which you can have only one.</p>"
},
"Parameters":{
"shape":"ParametersMap",
"documentation":"<p>Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values depend on the catalog type. </p> <ul> <li> <p>For the <code>HIVE</code> data catalog type, use the following syntax. The <code>metadata-function</code> parameter is required. <code>The sdk-version</code> parameter is optional and defaults to the currently supported version.</p> <p> <code>metadata-function=<i>lambda_arn</i>, sdk-version=<i>version_number</i> </code> </p> </li> <li> <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets of required parameters, but not both.</p> <ul> <li> <p>If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.</p> <p> <code>metadata-function=<i>lambda_arn</i>, record-function=<i>lambda_arn</i> </code> </p> </li> <li> <p> If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.</p> <p> <code>function=<i>lambda_arn</i> </code> </p> </li> </ul> </li> <li> <p>The <code>GLUE</code> type has no parameters.</p> </li> </ul>"
"documentation":"<p>Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values depend on the catalog type. </p> <ul> <li> <p>For the <code>HIVE</code> data catalog type, use the following syntax. The <code>metadata-function</code> parameter is required. <code>The sdk-version</code> parameter is optional and defaults to the currently supported version.</p> <p> <code>metadata-function=<i>lambda_arn</i>, sdk-version=<i>version_number</i> </code> </p> </li> <li> <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets of required parameters, but not both.</p> <ul> <li> <p>If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.</p> <p> <code>metadata-function=<i>lambda_arn</i>, record-function=<i>lambda_arn</i> </code> </p> </li> <li> <p> If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.</p> <p> <code>function=<i>lambda_arn</i> </code> </p> </li> </ul> </li> </ul>"
}
},
"documentation":"<p>Contains information about a data catalog in an AWS account.</p>"
@ -800,6 +918,28 @@
"members":{
}
},
"DeletePreparedStatementInput":{
"type":"structure",
"required":[
"StatementName",
"WorkGroup"
],
"members":{
"StatementName":{
"shape":"StatementName",
"documentation":"<p>The name of the prepared statement to delete.</p>"
},
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The workgroup to which the statement to be deleted belongs.</p>"
}
}
},
"DeletePreparedStatementOutput":{
"type":"structure",
"members":{
}
},
"DeleteWorkGroupInput":{
"type":"structure",
"required":["WorkGroup"],
@ -810,7 +950,7 @@
},
"RecursiveDeleteOption":{
"shape":"BoxedBoolean",
"documentation":"<p>The option to delete the workgroup and its contents even if the workgroup contains any named queries.</p>"
"documentation":"<p>The option to delete the workgroup and its contents even if the workgroup contains any named queries or query executions.</p>"
}
}
},
@ -847,6 +987,26 @@
"CSE_KMS"
]
},
"EngineVersion":{
"type":"structure",
"members":{
"SelectedEngineVersion":{
"shape":"NameString",
"documentation":"<p>The engine version requested by the user. Possible values are determined by the output of <code>ListEngineVersions</code>, including Auto. The default is Auto.</p>"
},
"EffectiveEngineVersion":{
"shape":"NameString",
"documentation":"<p>Read only. The engine version on which the query runs. If the user requests a valid engine version other than Auto, the effective engine version is the same as the engine version that the user requested. If the user requests Auto, the effective engine version is chosen by Athena. When a request to update the engine version is made by a <code>CreateWorkGroup</code> or <code>UpdateWorkGroup</code> operation, the <code>EffectiveEngineVersion</code> field is ignored.</p>"
}
},
"documentation":"<p>The Athena engine version for running queries.</p>"
},
"EngineVersionsList":{
"type":"list",
"member":{"shape":"EngineVersion"},
"max":10,
"min":0
},
"ErrorCode":{
"type":"string",
"documentation":"<p>The error code returned when the query execution failed to process, or when the processing request for the named query failed.</p>",
@ -923,6 +1083,32 @@
}
}
},
"GetPreparedStatementInput":{
"type":"structure",
"required":[
"StatementName",
"WorkGroup"
],
"members":{
"StatementName":{
"shape":"StatementName",
"documentation":"<p>The name of the prepared statement to retrieve.</p>"
},
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The workgroup to which the statement to be retrieved belongs.</p>"
}
}
},
"GetPreparedStatementOutput":{
"type":"structure",
"members":{
"PreparedStatement":{
"shape":"PreparedStatement",
"documentation":"<p>The name of the prepared statement that was retrieved.</p>"
}
}
},
"GetQueryExecutionInput":{
"type":"structure",
"required":["QueryExecutionId"],
@ -1114,6 +1300,32 @@
}
}
},
"ListEngineVersionsInput":{
"type":"structure",
"members":{
"NextToken":{
"shape":"Token",
"documentation":"<p>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <code>NextToken</code> from the response object of the previous page call.</p>"
},
"MaxResults":{
"shape":"MaxEngineVersionsCount",
"documentation":"<p>The maximum number of engine versions to return in this request.</p>"
}
}
},
"ListEngineVersionsOutput":{
"type":"structure",
"members":{
"EngineVersions":{
"shape":"EngineVersionsList",
"documentation":"<p>A list of engine versions that are available to choose from.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <code>NextToken</code> from the response object of the previous page call.</p>"
}
}
},
"ListNamedQueriesInput":{
"type":"structure",
"members":{
@ -1144,6 +1356,37 @@
}
}
},
"ListPreparedStatementsInput":{
"type":"structure",
"required":["WorkGroup"],
"members":{
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The workgroup to list the prepared statements for.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <code>NextToken</code> from the response object of the previous page call.</p>"
},
"MaxResults":{
"shape":"MaxPreparedStatementsCount",
"documentation":"<p>The maximum number of results to return in this request.</p>"
}
}
},
"ListPreparedStatementsOutput":{
"type":"structure",
"members":{
"PreparedStatements":{
"shape":"PreparedStatementsList",
"documentation":"<p>The list of prepared statements for the workgroup.</p>"
},
"NextToken":{
"shape":"Token",
"documentation":"<p>A token generated by the Athena service that specifies where to continue pagination if a previous request was truncated. To obtain the next set of pages, pass in the <code>NextToken</code> from the response object of the previous page call.</p>"
}
}
},
"ListQueryExecutionsInput":{
"type":"structure",
"members":{
@ -1265,7 +1508,7 @@
"members":{
"WorkGroups":{
"shape":"WorkGroupsList",
"documentation":"<p>The list of workgroups, including their names, descriptions, creation times, and states.</p>"
"documentation":"<p>A list of <a>WorkGroupSummary</a> objects that include the names, descriptions, creation times, and states for each workgroup.</p>"
},
"NextToken":{
"shape":"Token",
@ -1286,12 +1529,24 @@
"max":50,
"min":1
},
"MaxEngineVersionsCount":{
"type":"integer",
"box":true,
"max":10,
"min":1
},
"MaxNamedQueriesCount":{
"type":"integer",
"box":true,
"max":50,
"min":0
},
"MaxPreparedStatementsCount":{
"type":"integer",
"box":true,
"max":50,
"min":1
},
"MaxQueryExecutionsCount":{
"type":"integer",
"box":true,
@ -1389,6 +1644,52 @@
"type":"string",
"max":51200
},
"PreparedStatement":{
"type":"structure",
"members":{
"StatementName":{
"shape":"StatementName",
"documentation":"<p>The name of the prepared statement.</p>"
},
"QueryStatement":{
"shape":"QueryString",
"documentation":"<p>The query string for the prepared statement.</p>"
},
"WorkGroupName":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup to which the prepared statement belongs.</p>"
},
"Description":{
"shape":"DescriptionString",
"documentation":"<p>The description of the prepared statement.</p>"
},
"LastModifiedTime":{
"shape":"Date",
"documentation":"<p>The last modified time of the prepared statement.</p>"
}
},
"documentation":"<p>A prepared SQL statement for use with Athena.</p>"
},
"PreparedStatementSummary":{
"type":"structure",
"members":{
"StatementName":{
"shape":"StatementName",
"documentation":"<p>The name of the prepared statement.</p>"
},
"LastModifiedTime":{
"shape":"Date",
"documentation":"<p>The last modified time of the prepared statement.</p>"
}
},
"documentation":"<p>The name and last modified time of the prepared statement.</p>"
},
"PreparedStatementsList":{
"type":"list",
"member":{"shape":"PreparedStatementSummary"},
"max":50,
"min":0
},
"QueryExecution":{
"type":"structure",
"members":{
@ -1423,6 +1724,10 @@
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The name of the workgroup in which the query ran.</p>"
},
"EngineVersion":{
"shape":"EngineVersion",
"documentation":"<p>The engine version that executed the query.</p>"
}
},
"documentation":"<p>Information about a single instance of a query execution.</p>"
@ -1642,6 +1947,12 @@
}
}
},
"StatementName":{
"type":"string",
"max":256,
"min":1,
"pattern":"[a-zA-Z_][a-zA-Z0-9_@:]{1,256}"
},
"StatementType":{
"type":"string",
"enum":[
@ -1869,7 +2180,7 @@
},
"Type":{
"shape":"DataCatalogType",
"documentation":"<p>Specifies the type of data catalog to update. Specify <code>LAMBDA</code> for a federated catalog, <code>GLUE</code> for AWS Glue Catalog, or <code>HIVE</code> for an external hive metastore.</p>"
"documentation":"<p>Specifies the type of data catalog to update. Specify <code>LAMBDA</code> for a federated catalog or <code>HIVE</code> for an external hive metastore.</p> <note> <p>Do not use the <code>GLUE</code> type. This refers to the <code>AwsDataCatalog</code> that already exists in your account, of which you can have only one. Specifying the <code>GLUE</code> type will result in an <code>INVALID_INPUT</code> error.</p> </note>"
},
"Description":{
"shape":"DescriptionString",
@ -1877,7 +2188,7 @@
},
"Parameters":{
"shape":"ParametersMap",
"documentation":"<p>Specifies the Lambda function or functions to use for updating the data catalog. This is a mapping whose values depend on the catalog type. </p> <ul> <li> <p>For the <code>HIVE</code> data catalog type, use the following syntax. The <code>metadata-function</code> parameter is required. <code>The sdk-version</code> parameter is optional and defaults to the currently supported version.</p> <p> <code>metadata-function=<i>lambda_arn</i>, sdk-version=<i>version_number</i> </code> </p> </li> <li> <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets of required parameters, but not both.</p> <ul> <li> <p>If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.</p> <p> <code>metadata-function=<i>lambda_arn</i>, record-function=<i>lambda_arn</i> </code> </p> </li> <li> <p> If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.</p> <p> <code>function=<i>lambda_arn</i> </code> </p> </li> </ul> </li> <li> <p>The <code>GLUE</code> type has no parameters.</p> </li> </ul>"
"documentation":"<p>Specifies the Lambda function or functions to use for updating the data catalog. This is a mapping whose values depend on the catalog type. </p> <ul> <li> <p>For the <code>HIVE</code> data catalog type, use the following syntax. The <code>metadata-function</code> parameter is required. <code>The sdk-version</code> parameter is optional and defaults to the currently supported version.</p> <p> <code>metadata-function=<i>lambda_arn</i>, sdk-version=<i>version_number</i> </code> </p> </li> <li> <p>For the <code>LAMBDA</code> data catalog type, use one of the following sets of required parameters, but not both.</p> <ul> <li> <p>If you have one Lambda function that processes metadata and another for reading the actual data, use the following syntax. Both parameters are required.</p> <p> <code>metadata-function=<i>lambda_arn</i>, record-function=<i>lambda_arn</i> </code> </p> </li> <li> <p> If you have a composite Lambda function that processes both metadata and data, use the following syntax to specify your Lambda function.</p> <p> <code>function=<i>lambda_arn</i> </code> </p> </li> </ul> </li> </ul>"
}
}
},
@ -1886,6 +2197,37 @@
"members":{
}
},
"UpdatePreparedStatementInput":{
"type":"structure",
"required":[
"StatementName",
"WorkGroup",
"QueryStatement"
],
"members":{
"StatementName":{
"shape":"StatementName",
"documentation":"<p>The name of the prepared statement.</p>"
},
"WorkGroup":{
"shape":"WorkGroupName",
"documentation":"<p>The workgroup for the prepared statement.</p>"
},
"QueryStatement":{
"shape":"QueryString",
"documentation":"<p>The query string for the prepared statement.</p>"
},
"Description":{
"shape":"DescriptionString",
"documentation":"<p>The description of the prepared statement.</p>"
}
}
},
"UpdatePreparedStatementOutput":{
"type":"structure",
"members":{
}
},
"UpdateWorkGroupInput":{
"type":"structure",
"required":["WorkGroup"],
@ -1962,6 +2304,10 @@
"RequesterPaysEnabled":{
"shape":"BoxedBoolean",
"documentation":"<p>If set to <code>true</code>, allows members assigned to a workgroup to reference Amazon S3 Requester Pays buckets in queries. If set to <code>false</code>, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is <code>false</code>. For more information about Requester Pays buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html\">Requester Pays Buckets</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
},
"EngineVersion":{
"shape":"EngineVersion",
"documentation":"<p>The engine version that all queries running on the workgroup use. Queries on the <code>AmazonAthenaPreviewFunctionality</code> workgroup run on the preview engine regardless of this setting.</p>"
}
},
"documentation":"<p>The configuration of the workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup and whether workgroup settings override query settings, and the data usage limits for the amount of data scanned per query or per workgroup. The workgroup settings override is specified in EnforceWorkGroupConfiguration (true/false) in the WorkGroupConfiguration. See <a>WorkGroupConfiguration$EnforceWorkGroupConfiguration</a>. </p>"
@ -1992,6 +2338,10 @@
"RequesterPaysEnabled":{
"shape":"BoxedBoolean",
"documentation":"<p>If set to <code>true</code>, allows members assigned to a workgroup to specify Amazon S3 Requester Pays buckets in queries. If set to <code>false</code>, workgroup members cannot query data from Requester Pays buckets, and queries that retrieve data from Requester Pays buckets cause an error. The default is <code>false</code>. For more information about Requester Pays buckets, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html\">Requester Pays Buckets</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
},
"EngineVersion":{
"shape":"EngineVersion",
"documentation":"<p>The engine version requested when a workgroup is updated. After the update, all queries on the workgroup run on the requested engine version. If no value was previously set, the default is Auto. Queries on the <code>AmazonAthenaPreviewFunctionality</code> workgroup run on the preview engine regardless of this setting.</p>"
}
},
"documentation":"<p>The configuration information that will be updated for this workgroup, which includes the location in Amazon S3 where query results are stored, the encryption option, if any, used for query results, whether the Amazon CloudWatch Metrics are enabled for the workgroup, whether the workgroup settings override the client-side settings, and the data usage limit for the amount of bytes scanned per query, if it is specified.</p>"
@ -2030,6 +2380,10 @@
"CreationTime":{
"shape":"Date",
"documentation":"<p>The workgroup creation date and time.</p>"
},
"EngineVersion":{
"shape":"EngineVersion",
"documentation":"<p>The engine version setting for all queries on the workgroup. Queries on the <code>AmazonAthenaPreviewFunctionality</code> workgroup run on the preview engine regardless of this setting.</p>"
}
},
"documentation":"<p>The summary information for the workgroup, which includes its name, state, description, and the date and time it was created.</p>"

1
botocore/data/auditmanager/2017-07-25/service-2.json
View file

@ -497,6 +497,7 @@
"input":{"shape":"GetServicesInScopeRequest"},
"output":{"shape":"GetServicesInScopeResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ValidationException"},
{"shape":"InternalServerException"}
],

92
botocore/data/autoscaling/2011-01-01/service-2.json
View file

@ -90,7 +90,7 @@
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Creates or updates one or more scheduled scaling actions for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.</p>"
"documentation":"<p>Creates or updates one or more scheduled scaling actions for an Auto Scaling group.</p>"
},
"CancelInstanceRefresh":{
"name":"CancelInstanceRefresh",
@ -108,7 +108,7 @@
{"shape":"ResourceContentionFault"},
{"shape":"ActiveInstanceRefreshNotFoundFault"}
],
"documentation":"<p>Cancels an instance refresh operation in progress. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html\">Replacing Auto Scaling Instances Based on an Instance Refresh</a>.</p>"
"documentation":"<p>Cancels an instance refresh operation in progress. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html\">Replacing Auto Scaling instances based on an instance refresh</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"CompleteLifecycleAction":{
"name":"CompleteLifecycleAction",
@ -357,7 +357,7 @@
{"shape":"InvalidNextToken"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes one or more instance refreshes.</p> <p>You can determine the status of a request by looking at the <code>Status</code> parameter. The following are the possible statuses: </p> <ul> <li> <p> <code>Pending</code> - The request was created, but the operation has not started.</p> </li> <li> <p> <code>InProgress</code> - The operation is in progress.</p> </li> <li> <p> <code>Successful</code> - The operation completed successfully.</p> </li> <li> <p> <code>Failed</code> - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities. </p> </li> <li> <p> <code>Cancelling</code> - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started. </p> </li> <li> <p> <code>Cancelled</code> - The operation is cancelled. </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html\">Replacing Auto Scaling Instances Based on an Instance Refresh</a>.</p>"
"documentation":"<p>Describes one or more instance refreshes.</p> <p>You can determine the status of a request by looking at the <code>Status</code> parameter. The following are the possible statuses: </p> <ul> <li> <p> <code>Pending</code> - The request was created, but the operation has not started.</p> </li> <li> <p> <code>InProgress</code> - The operation is in progress.</p> </li> <li> <p> <code>Successful</code> - The operation completed successfully.</p> </li> <li> <p> <code>Failed</code> - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities. </p> </li> <li> <p> <code>Cancelling</code> - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started. </p> </li> <li> <p> <code>Cancelled</code> - The operation is cancelled. </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html\">Replacing Auto Scaling instances based on an instance refresh</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"DescribeLaunchConfigurations":{
"name":"DescribeLaunchConfigurations",
@ -504,7 +504,7 @@
{"shape":"InvalidNextToken"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Describes one or more scaling activities for the specified Auto Scaling group.</p>"
"documentation":"<p>Describes one or more scaling activities for the specified Auto Scaling group.</p> <p>To view the scaling activities from the Amazon EC2 Auto Scaling console, choose the <b>Activity</b> tab of the Auto Scaling group. When scaling events occur, you see scaling activity messages in the <b>Activity history</b>. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-verify-scaling-activity.html\">Verifying a scaling activity for an Auto Scaling group</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"DescribeScalingProcessTypes":{
"name":"DescribeScalingProcessTypes",
@ -748,7 +748,7 @@
{"shape":"LimitExceededFault"},
{"shape":"ResourceContentionFault"}
],
"documentation":"<p>Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a parameter unspecified when updating a scheduled scaling action, the corresponding value remains unchanged.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html\">Scheduled scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
"documentation":"<p>Creates or updates a scheduled scaling action for an Auto Scaling group.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/schedule_time.html\">Scheduled scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"RecordLifecycleActionHeartbeat":{
"name":"RecordLifecycleActionHeartbeat",
@ -837,7 +837,7 @@
{"shape":"ResourceContentionFault"},
{"shape":"InstanceRefreshInProgressFault"}
],
"documentation":"<p>Starts a new instance refresh operation, which triggers a rolling replacement of all previously launched instances in the Auto Scaling group with a new group of instances.</p> <p>If successful, this call creates a new instance refresh request with a unique ID that you can use to track its progress. To query its status, call the <a>DescribeInstanceRefreshes</a> API. To describe the instance refreshes that have already run, call the <a>DescribeInstanceRefreshes</a> API. To cancel an instance refresh operation in progress, use the <a>CancelInstanceRefresh</a> API. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html\">Replacing Auto Scaling Instances Based on an Instance Refresh</a>.</p>"
"documentation":"<p>Starts a new instance refresh operation, which triggers a rolling replacement of all previously launched instances in the Auto Scaling group with a new group of instances.</p> <p>If successful, this call creates a new instance refresh request with a unique ID that you can use to track its progress. To query its status, call the <a>DescribeInstanceRefreshes</a> API. To describe the instance refreshes that have already run, call the <a>DescribeInstanceRefreshes</a> API. To cancel an instance refresh operation in progress, use the <a>CancelInstanceRefresh</a> API. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-refresh.html\">Replacing Auto Scaling instances based on an instance refresh</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"SuspendProcesses":{
"name":"SuspendProcesses",
@ -965,6 +965,14 @@
"Details":{
"shape":"XmlString",
"documentation":"<p>The details about the activity.</p>"
},
"AutoScalingGroupState":{
"shape":"AutoScalingGroupState",
"documentation":"<p>The state of the Auto Scaling group, which is either <code>InService</code> or <code>Deleted</code>.</p>"
},
"AutoScalingGroupARN":{
"shape":"ResourceName",
"documentation":"<p>The Amazon Resource Name (ARN) of the Auto Scaling group.</p>"
}
},
"documentation":"<p>Describes scaling activity, which is a long-running process that represents a change to your Auto Scaling group, such as changing its size or replacing an instance.</p>"
@ -1243,6 +1251,11 @@
}
}
},
"AutoScalingGroupState":{
"type":"string",
"max":32,
"min":1
},
"AutoScalingGroups":{
"type":"list",
"member":{"shape":"AutoScalingGroup"}
@ -1456,6 +1469,15 @@
}
},
"CapacityRebalanceEnabled":{"type":"boolean"},
"CheckpointDelay":{
"type":"integer",
"max":172800,
"min":0
},
"CheckpointPercentages":{
"type":"list",
"member":{"shape":"NonZeroIntPercent"}
},
"ClassicLinkVPCSecurityGroups":{
"type":"list",
"member":{"shape":"XmlStringMaxLen255"}
@ -1518,7 +1540,7 @@
},
"MixedInstancesPolicy":{
"shape":"MixedInstancesPolicy",
"documentation":"<p>An embedded object that specifies a mixed instances policy. The required parameters must be specified. If optional parameters are unspecified, their default values are used.</p> <p>The policy includes parameters that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the parameters that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html\">Auto Scaling groups with multiple instance types and purchase options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
"documentation":"<p>An embedded object that specifies a mixed instances policy. The required properties must be specified. If optional properties are unspecified, their default values are used.</p> <p>The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html\">Auto Scaling groups with multiple instance types and purchase options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"InstanceId":{
"shape":"XmlStringMaxLen19",
@ -2080,6 +2102,10 @@
"shape":"XmlStringMaxLen255",
"documentation":"<p>The name of the Auto Scaling group.</p>"
},
"IncludeDeletedGroups":{
"shape":"IncludeDeletedGroups",
"documentation":"<p>Indicates whether to include scaling activity from deleted Auto Scaling groups.</p>"
},
"MaxRecords":{
"shape":"MaxRecords",
"documentation":"<p>The maximum number of items to return with this call. The default value is <code>100</code> and the maximum value is <code>100</code>.</p>"
@ -2430,6 +2456,7 @@
"HealthCheckGracePeriod":{"type":"integer"},
"HeartbeatTimeout":{"type":"integer"},
"HonorCooldown":{"type":"boolean"},
"IncludeDeletedGroups":{"type":"boolean"},
"Instance":{
"type":"structure",
"required":[
@ -2610,7 +2637,7 @@
"members":{
"OnDemandAllocationStrategy":{
"shape":"XmlString",
"documentation":"<p>Indicates how to allocate instance types to fulfill On-Demand capacity. The only valid value is <code>prioritized</code>, which is also the default value. This strategy uses the order of instance types in the overrides to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.</p>"
"documentation":"<p>Indicates how to allocate instance types to fulfill On-Demand capacity. The only valid value is <code>prioritized</code>, which is also the default value. This strategy uses the order of instance types in the <code>LaunchTemplateOverrides</code> to define the launch priority of each instance type. The first instance type in the array is prioritized higher than the last. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then the Auto Scaling groups launches the remaining capacity using the second priority instance type, and so on.</p>"
},
"OnDemandBaseCapacity":{
"shape":"OnDemandBaseCapacity",
@ -2622,7 +2649,7 @@
},
"SpotAllocationStrategy":{
"shape":"XmlString",
"documentation":"<p>Indicates how to allocate instances across Spot Instance pools. If the allocation strategy is <code>capacity-optimized</code> (recommended), the Auto Scaling group launches instances using Spot pools that are optimally chosen based on the available Spot capacity. If the allocation strategy is <code>lowest-price</code>, the Auto Scaling group launches instances using the Spot pools with the lowest price, and evenly allocates your instances across the number of Spot pools that you specify. Defaults to <code>lowest-price</code> if not specified.</p>"
"documentation":"<p>Indicates how to allocate instances across Spot Instance pools. </p> <p>If the allocation strategy is <code>lowest-price</code>, the Auto Scaling group launches instances using the Spot pools with the lowest price, and evenly allocates your instances across the number of Spot pools that you specify. Defaults to <code>lowest-price</code> if not specified.</p> <p>If the allocation strategy is <code>capacity-optimized</code> (recommended), the Auto Scaling group launches instances using Spot pools that are optimally chosen based on the available Spot capacity. Alternatively, you can use <code>capacity-optimized-prioritized</code> and set the order of instance types in the list of launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best-effort basis but optimizes for capacity first. </p>"
},
"SpotInstancePools":{
"shape":"SpotInstancePools",
@ -2810,10 +2837,10 @@
},
"Overrides":{
"shape":"Overrides",
"documentation":"<p>Any parameters that you specify override the same parameters in the launch template. If not provided, Amazon EC2 Auto Scaling uses the instance type specified in the launch template when it launches an instance. </p>"
"documentation":"<p>Any properties that you specify override the same properties in the launch template. If not provided, Amazon EC2 Auto Scaling uses the instance type specified in the launch template when it launches an instance. </p>"
}
},
"documentation":"<p>Describes a launch template and overrides. </p> <p>You specify these parameters as part of a mixed instances policy. </p> <p>When you update the launch template or overrides, existing Amazon EC2 instances continue to run. When scale out occurs, Amazon EC2 Auto Scaling launches instances to match the new settings. When scale in occurs, Amazon EC2 Auto Scaling terminates instances according to the group's termination policies.</p>"
"documentation":"<p>Describes a launch template and overrides. </p> <p>You specify these properties as part of a mixed instances policy. </p> <p>When you update the launch template or overrides, existing Amazon EC2 instances continue to run. When scale out occurs, Amazon EC2 Auto Scaling launches instances to match the new settings. When scale in occurs, Amazon EC2 Auto Scaling terminates instances according to the group's termination policies.</p>"
},
"LaunchTemplateName":{
"type":"string",
@ -3133,13 +3160,18 @@
},
"InstancesDistribution":{
"shape":"InstancesDistribution",
"documentation":"<p>Specifies the instances distribution. If not provided, the value for each parameter in <code>InstancesDistribution</code> uses a default value.</p>"
"documentation":"<p>Specifies the instances distribution. If not provided, the value for each property in <code>InstancesDistribution</code> uses a default value.</p>"
}
},
"documentation":"<p>Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling group can provision a combination of On-Demand Instances and Spot Instances across multiple instance types. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html\">Auto Scaling groups with multiple instance types and purchase options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>You can create a mixed instances policy for a new Auto Scaling group, or you can create it for an existing group by updating the group to specify <code>MixedInstancesPolicy</code> as the top-level parameter instead of a launch configuration or launch template.</p>"
"documentation":"<p>Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling group can provision a combination of On-Demand Instances and Spot Instances across multiple instance types. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html\">Auto Scaling groups with multiple instance types and purchase options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>You can create a mixed instances policy for a new Auto Scaling group, or you can create it for an existing group by updating the group to specify <code>MixedInstancesPolicy</code> as the top-level property instead of a launch configuration or launch template.</p>"
},
"MonitoringEnabled":{"type":"boolean"},
"NoDevice":{"type":"boolean"},
"NonZeroIntPercent":{
"type":"integer",
"max":100,
"min":1
},
"NotificationConfiguration":{
"type":"structure",
"members":{
@ -3412,11 +3444,11 @@
},
"EndTime":{
"shape":"TimestampType",
"documentation":"<p>The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.</p>"
"documentation":"<p>The date and time for the recurring schedule to end, in UTC.</p>"
},
"Recurrence":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The recurring schedule for this action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, <code>\"30 0 1 1,6,12 *\"</code>). For more information about this format, see <a href=\"http://crontab.org\">Crontab</a>.</p> <p>When <code>StartTime</code> and <code>EndTime</code> are specified with <code>Recurrence</code>, they form the boundaries of when the recurring action starts and stops.</p>"
"documentation":"<p>The recurring schedule for this action. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, <code>\"30 0 1 1,6,12 *\"</code>). For more information about this format, see <a href=\"http://crontab.org\">Crontab</a>.</p> <p>When <code>StartTime</code> and <code>EndTime</code> are specified with <code>Recurrence</code>, they form the boundaries of when the recurring action starts and stops.</p> <p>Cron expressions use Universal Coordinated Time (UTC) by default.</p>"
},
"MinSize":{
"shape":"AutoScalingGroupMinSize",
@ -3429,6 +3461,10 @@
"DesiredCapacity":{
"shape":"AutoScalingGroupDesiredCapacity",
"documentation":"<p>The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. It can scale beyond this capacity if you add more scaling conditions. </p>"
},
"TimeZone":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default. </p> <p>Valid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database (such as <code>Etc/GMT+9</code> or <code>Pacific/Tahiti</code>). For more information, see <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\">https://en.wikipedia.org/wiki/List_of_tz_database_time_zones</a>.</p>"
}
}
},
@ -3476,9 +3512,17 @@
"InstanceWarmup":{
"shape":"RefreshInstanceWarmup",
"documentation":"<p>The number of seconds until a newly launched instance is configured and ready to use. During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. The default is to use the value for the health check grace period defined for the group.</p>"
},
"CheckpointPercentages":{
"shape":"CheckpointPercentages",
"documentation":"<p>Threshold values for each checkpoint in ascending order. Each number must be unique. To replace all instances in the Auto Scaling group, the last number in the array must be <code>100</code>.</p> <p>For usage examples, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-adding-checkpoints-instance-refresh.html\">Adding checkpoints to an instance refresh</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"CheckpointDelay":{
"shape":"CheckpointDelay",
"documentation":"<p>The amount of time, in seconds, to wait after a checkpoint before continuing. This property is optional, but if you specify a value for it, you must also specify a value for <code>CheckpointPercentages</code>. If you specify a value for <code>CheckpointPercentages</code> and not for <code>CheckpointDelay</code>, the <code>CheckpointDelay</code> defaults to <code>3600</code> (1 hour). </p>"
}
},
"documentation":"<p>Describes information used to start an instance refresh. </p>"
"documentation":"<p>Describes information used to start an instance refresh. </p> <p>All properties are optional. However, if you specify a value for <code>CheckpointDelay</code>, you must also provide a value for <code>CheckpointPercentages</code>. </p>"
},
"RefreshStrategy":{
"type":"string",
@ -3699,6 +3743,10 @@
"DesiredCapacity":{
"shape":"AutoScalingGroupDesiredCapacity",
"documentation":"<p>The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.</p>"
},
"TimeZone":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The time zone for the cron expression.</p>"
}
},
"documentation":"<p>Describes a scheduled scaling action.</p>"
@ -3717,11 +3765,11 @@
},
"EndTime":{
"shape":"TimestampType",
"documentation":"<p>The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.</p>"
"documentation":"<p>The date and time for the recurring schedule to end, in UTC.</p>"
},
"Recurrence":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, <code>\"30 0 1 1,6,12 *\"</code>). For more information about this format, see <a href=\"http://crontab.org\">Crontab</a>.</p> <p>When <code>StartTime</code> and <code>EndTime</code> are specified with <code>Recurrence</code>, they form the boundaries of when the recurring action starts and stops.</p>"
"documentation":"<p>The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, <code>\"30 0 1 1,6,12 *\"</code>). For more information about this format, see <a href=\"http://crontab.org\">Crontab</a>.</p> <p>When <code>StartTime</code> and <code>EndTime</code> are specified with <code>Recurrence</code>, they form the boundaries of when the recurring action starts and stops.</p> <p>Cron expressions use Universal Coordinated Time (UTC) by default.</p>"
},
"MinSize":{
"shape":"AutoScalingGroupMinSize",
@ -3734,9 +3782,13 @@
"DesiredCapacity":{
"shape":"AutoScalingGroupDesiredCapacity",
"documentation":"<p>The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.</p>"
},
"TimeZone":{
"shape":"XmlStringMaxLen255",
"documentation":"<p>Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default. </p> <p>Valid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database (such as <code>Etc/GMT+9</code> or <code>Pacific/Tahiti</code>). For more information, see <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\">https://en.wikipedia.org/wiki/List_of_tz_database_time_zones</a>.</p>"
}
},
"documentation":"<p>Describes information used for one or more scheduled scaling action updates in a <a>BatchPutScheduledUpdateGroupAction</a> operation.</p> <p>When updating a scheduled scaling action, all optional parameters are left unchanged if not specified.</p>"
"documentation":"<p>Describes information used for one or more scheduled scaling action updates in a <a>BatchPutScheduledUpdateGroupAction</a> operation.</p>"
},
"ScheduledUpdateGroupActionRequests":{
"type":"list",
@ -4061,7 +4113,7 @@
},
"MixedInstancesPolicy":{
"shape":"MixedInstancesPolicy",
"documentation":"<p>An embedded object that specifies a mixed instances policy. When you make changes to an existing policy, all optional parameters are left unchanged if not specified. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html\">Auto Scaling groups with multiple instance types and purchase options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
"documentation":"<p>An embedded object that specifies a mixed instances policy. When you make changes to an existing policy, all optional properties are left unchanged if not specified. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-purchase-options.html\">Auto Scaling groups with multiple instance types and purchase options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
},
"MinSize":{
"shape":"AutoScalingGroupMinSize",

84
botocore/data/backup/2018-11-15/service-2.json
View file

@ -156,10 +156,11 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"InvalidResourceStateException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Deletes the recovery point specified by a recovery point ID.</p>",
"documentation":"<p>Deletes the recovery point specified by a recovery point ID.</p> <p>If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup.</p>",
"idempotent":true
},
"DescribeBackupJob":{
@ -223,6 +224,7 @@
"input":{"shape":"DescribeGlobalSettingsInput"},
"output":{"shape":"DescribeGlobalSettingsOutput"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Describes the global settings of the AWS account, including whether it is opted in to cross-account backup.</p>"
@ -292,6 +294,23 @@
"documentation":"<p>Returns metadata associated with a restore job that is specified by a job ID.</p>",
"idempotent":true
},
"DisassociateRecoveryPoint":{
"name":"DisassociateRecoveryPoint",
"http":{
"method":"POST",
"requestUri":"/backup-vaults/{backupVaultName}/recovery-points/{recoveryPointArn}/disassociate"
},
"input":{"shape":"DisassociateRecoveryPointInput"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"InvalidResourceStateException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Deletes the specified continuous backup recovery point from AWS Backup and releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the lifecycle that you specified in your original backup plan.</p> <p>Does not support snapshot backup recovery points.</p>"
},
"ExportBackupPlanTemplate":{
"name":"ExportBackupPlanTemplate",
"http":{
@ -322,7 +341,7 @@
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns <code>BackupPlan</code> details for the specified <code>BackupPlanId</code>. Returns the body of a backup plan in JSON format, in addition to plan metadata.</p>",
"documentation":"<p>Returns <code>BackupPlan</code> details for the specified <code>BackupPlanId</code>. The details are the body of a backup plan in JSON format, in addition to plan metadata.</p>",
"idempotent":true
},
"GetBackupPlanFromJSON":{
@ -450,7 +469,7 @@
{"shape":"InvalidParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns a list of existing backup jobs for an authenticated account.</p>",
"documentation":"<p>Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html\">monitoring tools</a>.</p>",
"idempotent":true
},
"ListBackupPlanTemplates":{
@ -698,9 +717,10 @@
{"shape":"InvalidParameterValueException"},
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"},
{"shape":"LimitExceededException"}
{"shape":"LimitExceededException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Starts a job to create a one-time copy of the specified resource.</p>",
"documentation":"<p>Starts a job to create a one-time copy of the specified resource.</p> <p>Does not support continuous backups.</p>",
"idempotent":true
},
"StartRestoreJob":{
@ -717,7 +737,7 @@
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Recovers the saved resource identified by an Amazon Resource Name (ARN). </p>",
"documentation":"<p>Recovers the saved resource identified by an Amazon Resource Name (ARN).</p>",
"idempotent":true
},
"StopBackupJob":{
@ -815,7 +835,7 @@
{"shape":"MissingParameterValueException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Sets the transition lifecycle of a recovery point.</p> <p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. </p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. </p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>",
"documentation":"<p>Sets the transition lifecycle of a recovery point.</p> <p>The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.</p> <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.</p> <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p> <p>Does not support continuous backups.</p>",
"idempotent":true
},
"UpdateRegionSettings":{
@ -1153,6 +1173,10 @@
"CopyActions":{
"shape":"CopyActions",
"documentation":"<p>An array of <code>CopyAction</code> objects, which contains the details of the copy operation.</p>"
},
"EnableContinuousBackup":{
"shape":"Boolean",
"documentation":"<p>Specifies whether AWS Backup creates continuous backups. True causes AWS Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes AWS Backup to create snapshot backups.</p>"
}
},
"documentation":"<p>Specifies a scheduled task used to back up a selection of resources.</p>"
@ -1195,6 +1219,10 @@
"CopyActions":{
"shape":"CopyActions",
"documentation":"<p>An array of <code>CopyAction</code> objects, which contains the details of the copy operation.</p>"
},
"EnableContinuousBackup":{
"shape":"Boolean",
"documentation":"<p>Specifies whether AWS Backup creates continuous backups. True causes AWS Backup to create continuous backups capable of point-in-time restore (PITR). False (or not specified) causes AWS Backup to create snapshot backups.</p>"
}
},
"documentation":"<p>Specifies a scheduled task used to back up a selection of resources.</p>"
@ -1455,7 +1483,7 @@
"CreatedBy":{"shape":"RecoveryPointCreator"},
"ResourceType":{
"shape":"ResourceType",
"documentation":"<p>The type of AWS resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. </p>"
"documentation":"<p>The type of AWS resource to be copied; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.</p>"
}
},
"documentation":"<p>Contains detailed information about a copy job.</p>"
@ -2114,6 +2142,27 @@
}
}
},
"DisassociateRecoveryPointInput":{
"type":"structure",
"required":[
"BackupVaultName",
"RecoveryPointArn"
],
"members":{
"BackupVaultName":{
"shape":"BackupVaultName",
"documentation":"<p>The unique name of an AWS Backup vault. Required.</p>",
"location":"uri",
"locationName":"backupVaultName"
},
"RecoveryPointArn":{
"shape":"ARN",
"documentation":"<p>An Amazon Resource Name (ARN) that uniquely identifies an AWS Backup recovery point. Required.</p>",
"location":"uri",
"locationName":"recoveryPointArn"
}
}
},
"ExportBackupPlanTemplateInput":{
"type":"structure",
"required":["BackupPlanId"],
@ -2432,6 +2481,23 @@
"documentation":"<p>Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.</p>",
"exception":true
},
"InvalidResourceStateException":{
"type":"structure",
"members":{
"Code":{"shape":"string"},
"Message":{"shape":"string"},
"Type":{
"shape":"string",
"documentation":"<p/>"
},
"Context":{
"shape":"string",
"documentation":"<p/>"
}
},
"documentation":"<p>AWS Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.</p>",
"exception":true
},
"IsEnabled":{"type":"boolean"},
"Lifecycle":{
"type":"structure",
@ -3556,7 +3622,7 @@
},
"Tags":{
"shape":"Tags",
"documentation":"<p>Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create. </p>"
"documentation":"<p>Key-value pairs that are used to help organize your resources. You can assign your own metadata to the resources you create.</p>"
}
}
},

97
botocore/data/batch/2016-08-10/service-2.json
View file

@ -24,7 +24,7 @@
{"shape":"ClientException"},
{"shape":"ServerException"}
],
"documentation":"<p>Cancels a job in an AWS Batch job queue. Jobs that are in the <code>SUBMITTED</code>, <code>PENDING</code>, or <code>RUNNABLE</code> state are canceled. Jobs that have progressed to <code>STARTING</code> or <code>RUNNING</code> are not canceled (but the API operation still succeeds, even if no job is canceled); these jobs must be terminated with the <a>TerminateJob</a> operation.</p>"
"documentation":"<p>Cancels a job in an AWS Batch job queue. Jobs that are in the <code>SUBMITTED</code>, <code>PENDING</code>, or <code>RUNNABLE</code> state are canceled. Jobs that have progressed to <code>STARTING</code> or <code>RUNNING</code> aren't canceled, but the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the <a>TerminateJob</a> operation.</p>"
},
"CreateComputeEnvironment":{
"name":"CreateComputeEnvironment",
@ -38,7 +38,7 @@
{"shape":"ClientException"},
{"shape":"ServerException"}
],
"documentation":"<p>Creates an AWS Batch compute environment. You can create <code>MANAGED</code> or <code>UNMANAGED</code> compute environments. <code>MANAGED</code> compute environments can use Amazon EC2 or AWS Fargate resources. <code>UNMANAGED</code> compute environments can only use EC2 resources.</p> <p>In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html\">launch template</a> that you specify when you create the compute environment. You can choose either to use EC2 On-Demand Instances and EC2 Spot Instances, or to use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price.</p> <note> <p>Multi-node parallel jobs are not supported on Spot Instances.</p> </note> <p>In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility with how you configure your compute resources. For example, you can use custom AMI. However, you need to verify that your AMI meets the Amazon ECS container instance AMI specification. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html\">container instance AMIs</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. After you have created your unmanaged compute environment, you can use the <a>DescribeComputeEnvironments</a> operation to find the Amazon ECS cluster that's associated with it. Then, manually launch your container instances into that Amazon ECS cluster. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html\">Launching an Amazon ECS container instance</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>AWS Batch doesn't upgrade the AMIs in a compute environment after it's created. For example, it doesn't update the AMIs when a newer version of the Amazon ECS-optimized AMI is available. Therefore, you're responsible for the management of the guest operating system (including updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs, complete these steps:</p> <ol> <li> <p>Create a new compute environment with the new AMI.</p> </li> <li> <p>Add the compute environment to an existing job queue.</p> </li> <li> <p>Remove the earlier compute environment from your job queue.</p> </li> <li> <p>Delete the earlier compute environment.</p> </li> </ol> </note>"
"documentation":"<p>Creates an AWS Batch compute environment. You can create <code>MANAGED</code> or <code>UNMANAGED</code> compute environments. <code>MANAGED</code> compute environments can use Amazon EC2 or AWS Fargate resources. <code>UNMANAGED</code> compute environments can only use EC2 resources.</p> <p>In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html\">launch template</a> that you specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price.</p> <note> <p>Multi-node parallel jobs aren't supported on Spot Instances.</p> </note> <p>In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html\">container instance AMIs</a> in the <i>Amazon Elastic Container Service Developer Guide</i>. After you created your unmanaged compute environment, you can use the <a>DescribeComputeEnvironments</a> operation to find the Amazon ECS cluster that's associated with it. Then, launch your container instances into that Amazon ECS cluster. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html\">Launching an Amazon ECS container instance</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>AWS Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible for managing the guest operating system (including its updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs, complete these steps:</p> <ol> <li> <p>Create a new compute environment with the new AMI.</p> </li> <li> <p>Add the compute environment to an existing job queue.</p> </li> <li> <p>Remove the earlier compute environment from your job queue.</p> </li> <li> <p>Delete the earlier compute environment.</p> </li> </ol> </note>"
},
"CreateJobQueue":{
"name":"CreateJobQueue",
@ -52,7 +52,7 @@
{"shape":"ClientException"},
{"shape":"ServerException"}
],
"documentation":"<p>Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.</p> <p>You also set a priority to the job queue that determines the order in which the AWS Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.</p>"
"documentation":"<p>Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.</p> <p>You also set a priority to the job queue that determines the order that the AWS Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.</p>"
},
"DeleteComputeEnvironment":{
"name":"DeleteComputeEnvironment",
@ -66,7 +66,7 @@
{"shape":"ClientException"},
{"shape":"ServerException"}
],
"documentation":"<p>Deletes an AWS Batch compute environment.</p> <p>Before you can delete a compute environment, you must set its state to <code>DISABLED</code> with the <a>UpdateComputeEnvironment</a> API operation and disassociate it from any job queues with the <a>UpdateJobQueue</a> API operation. Compute environments that use AWS Fargate resources must terminate all active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute environment will end up in an invalid state.</p>"
"documentation":"<p>Deletes an AWS Batch compute environment.</p> <p>Before you can delete a compute environment, you must set its state to <code>DISABLED</code> with the <a>UpdateComputeEnvironment</a> API operation and disassociate it from any job queues with the <a>UpdateJobQueue</a> API operation. Compute environments that use AWS Fargate resources must terminate all active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute environment enters an invalid state.</p>"
},
"DeleteJobQueue":{
"name":"DeleteJobQueue",
@ -164,7 +164,7 @@
{"shape":"ClientException"},
{"shape":"ServerException"}
],
"documentation":"<p>Returns a list of AWS Batch jobs.</p> <p>You must specify only one of the following items:</p> <ul> <li> <p>A job queue ID to return a list of jobs in that job queue</p> </li> <li> <p>A multi-node parallel job ID to return a list of that job's nodes</p> </li> <li> <p>An array job ID to return a list of that job's children</p> </li> </ul> <p>You can filter the results by job status with the <code>jobStatus</code> parameter. If you don't specify a status, only <code>RUNNING</code> jobs are returned.</p>"
"documentation":"<p>Returns a list of AWS Batch jobs.</p> <p>You must specify only one of the following items:</p> <ul> <li> <p>A job queue ID to return a list of jobs in that job queue</p> </li> <li> <p>A multi-node parallel job ID to return a list of nodes for that job</p> </li> <li> <p>An array job ID to return a list of the children for that job</p> </li> </ul> <p>You can filter the results by job status with the <code>jobStatus</code> parameter. If you don't specify a status, only <code>RUNNING</code> jobs are returned.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
@ -206,7 +206,7 @@
{"shape":"ClientException"},
{"shape":"ServerException"}
],
"documentation":"<p>Submits an AWS Batch job from a job definition. Parameters specified during <a>SubmitJob</a> override parameters defined in the job definition.</p> <important> <p>Jobs run on Fargate resources don't run for more than 14 days. After 14 days, the Fargate resources might no longer be available and the job is terminated.</p> </important>"
"documentation":"<p>Submits an AWS Batch job from a job definition. Parameters that are specified during <a>SubmitJob</a> override parameters defined in the job definition. vCPU and memory requirements that are specified in the <code>ResourceRequirements</code> objects in the job definition are the exception. They can't be overridden this way using the <code>memory</code> and <code>vcpus</code> parameters. Rather, you must specify updates to job definition parameters in a <code>ResourceRequirements</code> object that's included in the <code>containerOverrides</code> parameter.</p> <important> <p>Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.</p> </important>"
},
"TagResource":{
"name":"TagResource",
@ -563,7 +563,7 @@
},
"allocationStrategy":{
"shape":"CRAllocationStrategy",
"documentation":"<p>The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html\">Amazon EC2 service limits</a>. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html\">Allocation Strategies</a> in the <i>AWS Batch User Guide</i>.</p> <note> <p>This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.</p> </note> <dl> <dt>BEST_FIT (default)</dt> <dd> <p>AWS Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost instance type. If additional instances of the selected instance type aren't available, AWS Batch will wait for the additional instances to be available. If there are not enough instances available, or if the user is hitting <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html\">Amazon EC2 service limits</a> then additional jobs aren't run until currently running jobs have completed. This allocation strategy keeps costs lower but can limit scaling. If you are using Spot Fleets with <code>BEST_FIT</code> then the Spot Fleet IAM Role must be specified.</p> </dd> <dt>BEST_FIT_PROGRESSIVE</dt> <dd> <p>AWS Batch will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types.</p> </dd> <dt>SPOT_CAPACITY_OPTIMIZED</dt> <dd> <p>AWS Batch will select one or more instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.</p> </dd> </dl> <p>With both <code>BEST_FIT_PROGRESSIVE</code> and <code>SPOT_CAPACITY_OPTIMIZED</code> strategies, AWS Batch might need to go above <code>maxvCpus</code> to meet your capacity requirements. In this event, AWS Batch never exceeds <code>maxvCpus</code> by more than a single instance.</p>"
"documentation":"<p>The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html\">Amazon EC2 service limits</a>. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/allocation-strategies.html\">Allocation Strategies</a> in the <i>AWS Batch User Guide</i>.</p> <note> <p>This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.</p> </note> <dl> <dt>BEST_FIT (default)</dt> <dd> <p>AWS Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost instance type. If additional instances of the selected instance type aren't available, AWS Batch waits for the additional instances to be available. If there aren't enough instances available, or if the user is hitting <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html\">Amazon EC2 service limits</a> then additional jobs aren't run until the currently running jobs have completed. This allocation strategy keeps costs lower but can limit scaling. If you are using Spot Fleets with <code>BEST_FIT</code> then the Spot Fleet IAM Role must be specified.</p> </dd> <dt>BEST_FIT_PROGRESSIVE</dt> <dd> <p>AWS Batch will select additional instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types with a lower cost per unit vCPU. If additional instances of the previously selected instance types aren't available, AWS Batch will select new instance types.</p> </dd> <dt>SPOT_CAPACITY_OPTIMIZED</dt> <dd> <p>AWS Batch will select one or more instance types that are large enough to meet the requirements of the jobs in the queue, with a preference for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.</p> </dd> </dl> <p>With both <code>BEST_FIT_PROGRESSIVE</code> and <code>SPOT_CAPACITY_OPTIMIZED</code> strategies, AWS Batch might need to go above <code>maxvCpus</code> to meet your capacity requirements. In this event, AWS Batch never exceeds <code>maxvCpus</code> by more than a single instance.</p>"
},
"minvCpus":{
"shape":"Integer",
@ -571,7 +571,7 @@
},
"maxvCpus":{
"shape":"Integer",
"documentation":"<p>The maximum number of Amazon EC2 vCPUs that a compute environment can reach.</p> <note> <p>With both <code>BEST_FIT_PROGRESSIVE</code> and <code>SPOT_CAPACITY_OPTIMIZED</code> allocation strategies, AWS Batch might need to go above <code>maxvCpus</code> to meet your capacity requirements. In this event, AWS Batch will never go above <code>maxvCpus</code> by more than a single instance (e.g., no more than a single instance from among those specified in your compute environment).</p> </note>"
"documentation":"<p>The maximum number of Amazon EC2 vCPUs that a compute environment can reach.</p> <note> <p>With both <code>BEST_FIT_PROGRESSIVE</code> and <code>SPOT_CAPACITY_OPTIMIZED</code> allocation strategies, AWS Batch might need to exceed <code>maxvCpus</code> to meet your capacity requirements. In this event, AWS Batch never exceeds <code>maxvCpus</code> by more than a single instance. For example, no more than a single instance from among those specified in your compute environment is allocated.</p> </note>"
},
"desiredvCpus":{
"shape":"Integer",
@ -579,7 +579,7 @@
},
"instanceTypes":{
"shape":"StringList",
"documentation":"<p>The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example, <code>c5</code> or <code>p3</code>), or you can specify specific sizes within a family (such as <code>c5.8xlarge</code>). You can also choose <code>optimal</code> to select instance types (from the C4, M4, and R4 instance families) on the fly that match the demand of your job queues.</p> <note> <p>This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.</p> </note> <note> <p>When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.</p> </note> <note> <p>Currently, <code>optimal</code> uses instance types from the C4, M4, and R4 instance families. In Regions that don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families are used.</p> </note>"
"documentation":"<p>The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example, <code>c5</code> or <code>p3</code>), or you can specify specific sizes within a family (such as <code>c5.8xlarge</code>). You can also choose <code>optimal</code> to select instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues.</p> <note> <p>This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.</p> </note> <note> <p>When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.</p> </note> <note> <p>Currently, <code>optimal</code> uses instance types from the C4, M4, and R4 instance families. In Regions that don't have instance types from those instance families, instance types from the C5, M5. and R5 instance families are used.</p> </note>"
},
"imageId":{
"shape":"String",
@ -589,11 +589,11 @@
},
"subnets":{
"shape":"StringList",
"documentation":"<p>The VPC subnets into which the compute resources are launched. These subnets must be within the same VPC. This parameter is required for jobs running on Fargate resources, where it can contain up to 16 subnets. For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html\">VPCs and Subnets</a> in the <i>Amazon VPC User Guide</i>.</p>"
"documentation":"<p>The VPC subnets into which the compute resources are launched. These subnets must be within the same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html\">VPCs and Subnets</a> in the <i>Amazon VPC User Guide</i>.</p>"
},
"securityGroupIds":{
"shape":"StringList",
"documentation":"<p>The Amazon EC2 security groups associated with instances launched in the compute environment. One or more security groups must be specified, either in <code>securityGroupIds</code> or using a launch template referenced in <code>launchTemplate</code>. This parameter is required for jobs running on Fargate resources and must contain at least one security group. (Fargate does not support launch templates.) If security groups are specified using both <code>securityGroupIds</code> and <code>launchTemplate</code>, the values in <code>securityGroupIds</code> will be used.</p>"
"documentation":"<p>The Amazon EC2 security groups associated with instances launched in the compute environment. One or more security groups must be specified, either in <code>securityGroupIds</code> or using a launch template referenced in <code>launchTemplate</code>. This parameter is required for jobs running on Fargate resources and must contain at least one security group. Fargate doesn't support launch templates. If security groups are specified using both <code>securityGroupIds</code> and <code>launchTemplate</code>, the values in <code>securityGroupIds</code> is used.</p>"
},
"ec2KeyPair":{
"shape":"String",
@ -605,7 +605,7 @@
},
"tags":{
"shape":"TagsMap",
"documentation":"<p>Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For AWS Batch, these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value−for example, { \"Name\": \"AWS Batch Instance - C4OnDemand\" }. This is helpful for recognizing your AWS Batch instances in the Amazon EC2 console. These tags can't be updated or removed after the compute environment has been created; any changes require creating a new compute environment and removing the old compute environment. These tags are not seen when using the AWS Batch <code>ListTagsForResource</code> API operation.</p> <note> <p>This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.</p> </note>"
"documentation":"<p>Key-value pair tags to be applied to EC2 resources that are launched in the compute environment. For AWS Batch, these take the form of \"String1\": \"String2\", where String1 is the tag key and String2 is the tag value−for example, { \"Name\": \"AWS Batch Instance - C4OnDemand\" }. This is helpful for recognizing your AWS Batch instances in the Amazon EC2 console. These tags can't be updated or removed after the compute environment has been created; any changes require creating a new compute environment and removing the old compute environment. These tags aren't seen when using the AWS Batch <code>ListTagsForResource</code> API operation.</p> <note> <p>This parameter isn't applicable to jobs running on Fargate resources, and shouldn't be specified.</p> </note>"
},
"placementGroup":{
"shape":"String",
@ -639,7 +639,7 @@
},
"maxvCpus":{
"shape":"Integer",
"documentation":"<p>The maximum number of Amazon EC2 vCPUs that an environment can reach.</p> <note> <p>With both <code>BEST_FIT_PROGRESSIVE</code> and <code>SPOT_CAPACITY_OPTIMIZED</code> allocation strategies, AWS Batch might need to go above <code>maxvCpus</code> to meet your capacity requirements. In this event, AWS Batch will never go above <code>maxvCpus</code> by more than a single instance (e.g., no more than a single instance from among those specified in your compute environment).</p> </note>"
"documentation":"<p>The maximum number of Amazon EC2 vCPUs that an environment can reach.</p> <note> <p>With both <code>BEST_FIT_PROGRESSIVE</code> and <code>SPOT_CAPACITY_OPTIMIZED</code> allocation strategies, AWS Batch might need to exceed <code>maxvCpus</code> to meet your capacity requirements. In this event, AWS Batch never exceeds <code>maxvCpus</code> by more than a single instance. That is, no more than a single instance from among those specified in your compute environment.</p> </note>"
},
"desiredvCpus":{
"shape":"Integer",
@ -647,7 +647,7 @@
},
"subnets":{
"shape":"StringList",
"documentation":"<p>The VPC subnets that the compute resources are launched into. This parameter is required for jobs running on Fargate compute resources, where it can contain up to 16 subnets. For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html\">VPCs and Subnets</a> in the <i>Amazon VPC User Guide</i>. This can't be specified for EC2 compute resources. Providing an empty list will be handled as if this parameter wasn't specified and no change is made.</p>"
"documentation":"<p>The VPC subnets that the compute resources are launched into. Fargate compute resources can contain up to 16 subnets. Providing an empty list will be handled as if this parameter wasn't specified and no change is made. This can't be specified for EC2 compute resources. For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Subnets.html\">VPCs and Subnets</a> in the <i>Amazon VPC User Guide</i>.</p>"
},
"securityGroupIds":{
"shape":"StringList",
@ -665,7 +665,7 @@
},
"vcpus":{
"shape":"Integer",
"documentation":"<p>The number of vCPUs reserved for the container. Jobs running on EC2 resources can specify the vCPU requirement for the job using <code>resourceRequirements</code> but the vCPU requirements can't be specified both here and in the <code>resourceRequirement</code> object. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.</p> <note> <p>This parameter isn't applicable to jobs running on Fargate resources. Jobs running on Fargate resources must specify the vCPU requirement for the job using <code>resourceRequirements</code>.</p> </note>"
"documentation":"<p>The number of vCPUs reserved for the container. For jobs that run on EC2 resources, you can specify the vCPU requirement for the job using <code>resourceRequirements</code>, but you can't specify the vCPU requirements in both the <code>vcpus</code> and <code>resourceRequirement</code> object. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.</p> <note> <p>This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using <code>resourceRequirements</code>.</p> </note>"
},
"memory":{
"shape":"Integer",
@ -749,7 +749,7 @@
},
"logConfiguration":{
"shape":"LogConfiguration",
"documentation":"<p>The log configuration specification for the container.</p> <p>This parameter maps to <code>LogConfig</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--log-driver</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance. Or, alternatively, it must be configured on a different log server for remote logging options. For more information on the options for different supported log drivers, see <a href=\"https://docs.docker.com/engine/admin/logging/overview/\">Configure logging drivers</a> in the Docker documentation.</p> <note> <p>AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the <a>LogConfiguration</a> data type). Additional log drivers might be available in future releases of the Amazon ECS container agent.</p> </note> <p>This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p> <note> <p>The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the <code>ECS_AVAILABLE_LOGGING_DRIVERS</code> environment variable before containers placed on that instance can use these log configuration options. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </note>"
"documentation":"<p>The log configuration specification for the container.</p> <p>This parameter maps to <code>LogConfig</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--log-driver</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance. Or, alternatively, it must be configured on a different log server for remote logging options. For more information on the options for different supported log drivers, see <a href=\"https://docs.docker.com/engine/admin/logging/overview/\">Configure logging drivers</a> in the Docker documentation.</p> <note> <p>AWS Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the <a>LogConfiguration</a> data type). Additional log drivers might be available in future releases of the Amazon ECS container agent.</p> </note> <p>This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p> <note> <p>The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the <code>ECS_AVAILABLE_LOGGING_DRIVERS</code> environment variable before containers placed on that instance can use these log configuration options. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html\">Amazon ECS Container Agent Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </note>"
},
"secrets":{
"shape":"SecretList",
@ -771,13 +771,13 @@
"members":{
"vcpus":{
"shape":"Integer",
"documentation":"<p>This parameter is deprecated and not supported for jobs run on Fargate resources, see <code>resourceRequirement</code>. For jobs run on EC2 resources, the number of vCPUs to reserve for the container. This value overrides the value set in the job definition. Jobs run on EC2 resources can specify the vCPU requirement using <code>resourceRequirement</code> but the vCPU requirements can't be specified both here and in <code>resourceRequirement</code>. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.</p> <note> <p>This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided. Jobs running on Fargate resources must specify the vCPU requirement for the job using <code>resourceRequirements</code>.</p> </note>",
"documentation":"<p>This parameter indicates the number of vCPUs reserved for the container.It overrides the <code>vcpus</code> parameter that's set in the job definition, but doesn't override any vCPU requirement specified in the <code>resourceRequirement</code> structure in the job definition.</p> <p>This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For Fargate resources, you can only use <code>resourceRequirement</code>. For EC2 resources, you can use either this parameter or <code>resourceRequirement</code> but not both. </p> <p>This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.</p> <note> <p>This parameter isn't applicable to jobs that run on Fargate resources and shouldn't be provided. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using <code>resourceRequirements</code>.</p> </note>",
"deprecated":true,
"deprecatedMessage":"This field is deprecated, use resourceRequirements instead."
},
"memory":{
"shape":"Integer",
"documentation":"<p>This parameter is deprecated and not supported for jobs run on Fargate resources, use <code>ResourceRequirement</code>. For jobs run on EC2 resource, the number of MiB of memory reserved for the job. This value overrides the value set in the job definition.</p>",
"documentation":"<p>This parameter indicates the amount of memory (in MiB) that's reserved for the job. It overrides the <code>memory</code> parameter set in the job definition, but doesn't override any memory requirement specified in the <code>ResourceRequirement</code> structure in the job definition.</p> <p>This parameter is supported for jobs that run on EC2 resources, but isn't supported for jobs that run on Fargate resources. For these resources, use <code>resourceRequirement</code> instead.</p>",
"deprecated":true,
"deprecatedMessage":"This field is deprecated, use resourceRequirements instead."
},
@ -809,13 +809,13 @@
},
"vcpus":{
"shape":"Integer",
"documentation":"<p>This parameter is deprecated and not supported for jobs run on Fargate resources, see <code>resourceRequirement</code>. The number of vCPUs reserved for the container. Jobs running on EC2 resources can specify the vCPU requirement for the job using <code>resourceRequirements</code> but the vCPU requirements can't be specified both here and in the <code>resourceRequirement</code> structure. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.</p> <note> <p>This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided. Jobs running on Fargate resources must specify the vCPU requirement for the job using <code>resourceRequirements</code>.</p> </note>",
"documentation":"<p>The number of vCPUs reserved for the job. Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. The number of vCPUs must be specified but can be be specified in several places. You must specify it at least once for each node.</p> <p>This parameter is supported on EC2 resources but isn't supported for jobs that run on Fargate resources. For these resources, use <code>resourceRequirement</code> instead. You can use this parameter or <code>resourceRequirements</code> structure but not both.</p> <note> <p>This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using <code>resourceRequirements</code>.</p> </note>",
"deprecated":true,
"deprecatedMessage":"This field is deprecated, use resourceRequirements instead."
},
"memory":{
"shape":"Integer",
"documentation":"<p>This parameter is deprecated and not supported for jobs run on Fargate resources, use <code>ResourceRequirement</code>. For jobs run on EC2 resources can specify the memory requirement using the <code>ResourceRequirement</code> structure. The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places; it must be specified for each node at least once.</p> <note> <p>If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html\">Memory Management</a> in the <i>AWS Batch User Guide</i>.</p> </note>",
"documentation":"<p>This parameter indicates the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it is terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.</p> <p>This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>This parameter is supported on EC2 resources but isn't supported on Fargate resources. For Fargate resources, you should specify the memory requirement using <code>resourceRequirement</code>. You can do this for EC2 resources.</p> <note> <p>If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html\">Memory Management</a> in the <i>AWS Batch User Guide</i>.</p> </note>",
"deprecated":true,
"deprecatedMessage":"This field is deprecated, use resourceRequirements instead."
},
@ -829,7 +829,7 @@
},
"executionRoleArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. Jobs running on Fargate resources must provide an execution role. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html\">AWS Batch execution IAM role</a> in the <i>AWS Batch User Guide</i>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the execution role that AWS Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/execution-IAM-role.html\">AWS Batch execution IAM role</a> in the <i>AWS Batch User Guide</i>.</p>"
},
"volumes":{
"shape":"Volumes",
@ -861,7 +861,7 @@
},
"instanceType":{
"shape":"String",
"documentation":"<p>The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.</p> <note> <p>This parameter isn't applicable to single-node container jobs or for jobs running on Fargate resources and shouldn't be provided.</p> </note>"
"documentation":"<p>The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.</p> <note> <p>This parameter isn't applicable to single-node container jobs or for jobs that run on Fargate resources and shouldn't be provided.</p> </note>"
},
"resourceRequirements":{
"shape":"ResourceRequirements",
@ -908,8 +908,7 @@
"type":"structure",
"required":[
"computeEnvironmentName",
"type",
"serviceRole"
"type"
],
"members":{
"computeEnvironmentName":{
@ -930,7 +929,7 @@
},
"serviceRole":{
"shape":"String",
"documentation":"<p>The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html\">AWS Batch service IAM role</a> in the <i>AWS Batch User Guide</i>.</p> <p>If your specified role has a path other than <code>/</code>, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.</p> <note> <p>Depending on how you created your AWS Batch service role, its ARN might contain the <code>service-role</code> path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use the <code>service-role</code> path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.</p> </note>"
"documentation":"<p>The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html\">AWS Batch service IAM role</a> in the <i>AWS Batch User Guide</i>.</p> <important> <p>If your account has already created the AWS Batch service-linked role, that role is used by default for your compute environment unless you specify a role here. If the AWS Batch service-linked role does not exist in your account, and no role is specified here, the service will try to create the AWS Batch service-linked role in your account.</p> </important> <p>If your specified role has a path other than <code>/</code>, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name <code>bar</code> has a path of <code>/foo/</code> then you would specify <code>/foo/bar</code> as the role name. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names\">Friendly names and paths</a> in the <i>IAM User Guide</i>.</p> <note> <p>Depending on how you created your AWS Batch service role, its ARN might contain the <code>service-role</code> path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use the <code>service-role</code> path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.</p> </note>"
},
"tags":{
"shape":"TagrisTagsMap",
@ -1087,7 +1086,7 @@
},
"maxResults":{
"shape":"Integer",
"documentation":"<p>The maximum number of results returned by <code>DescribeJobDefinitions</code> in paginated output. When this parameter is used, <code>DescribeJobDefinitions</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeJobDefinitions</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>DescribeJobDefinitions</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>"
"documentation":"<p>The maximum number of results returned by <code>DescribeJobDefinitions</code> in paginated output. When this parameter is used, <code>DescribeJobDefinitions</code> only returns <code>maxResults</code> results in a single page and a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeJobDefinitions</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>DescribeJobDefinitions</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>"
},
"jobDefinitionName":{
"shape":"String",
@ -1126,7 +1125,7 @@
},
"maxResults":{
"shape":"Integer",
"documentation":"<p>The maximum number of results returned by <code>DescribeJobQueues</code> in paginated output. When this parameter is used, <code>DescribeJobQueues</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeJobQueues</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>DescribeJobQueues</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>"
"documentation":"<p>The maximum number of results returned by <code>DescribeJobQueues</code> in paginated output. When this parameter is used, <code>DescribeJobQueues</code> only returns <code>maxResults</code> results in a single page and a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>DescribeJobQueues</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>DescribeJobQueues</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>"
},
"nextToken":{
"shape":"String",
@ -1178,7 +1177,7 @@
},
"containerPath":{
"shape":"String",
"documentation":"<p>The path inside the container used to expose the host device. By default the <code>hostPath</code> value is used.</p>"
"documentation":"<p>The path inside the container used to expose the host device. By default, the <code>hostPath</code> value is used.</p>"
},
"permissions":{
"shape":"DeviceCgroupPermissions",
@ -1232,19 +1231,19 @@
"members":{
"onStatusReason":{
"shape":"String",
"documentation":"<p>Contains a glob pattern to match against the <code>StatusReason</code> returned for a job. The patten can be up to 512 characters long, can contain letters, numbers, periods (.), colons (:), and white space (spaces, tabs). and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.</p>"
"documentation":"<p>Contains a glob pattern to match against the <code>StatusReason</code> returned for a job. The pattern can be up to 512 characters long, and can contain letters, numbers, periods (.), colons (:), and white space (including spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.</p>"
},
"onReason":{
"shape":"String",
"documentation":"<p>Contains a glob pattern to match against the <code>Reason</code> returned for a job. The patten can be up to 512 characters long, can contain letters, numbers, periods (.), colons (:), and white space (spaces, tabs), and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.</p>"
"documentation":"<p>Contains a glob pattern to match against the <code>Reason</code> returned for a job. The pattern can be up to 512 characters long, and can contain letters, numbers, periods (.), colons (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.</p>"
},
"onExitCode":{
"shape":"String",
"documentation":"<p>Contains a glob pattern to match against the decimal representation of the <code>ExitCode</code> returned for a job. The patten can be up to 512 characters long, can contain only numbers, and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.</p>"
"documentation":"<p>Contains a glob pattern to match against the decimal representation of the <code>ExitCode</code> returned for a job. The pattern can be up to 512 characters long, can contain only numbers, and can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.</p>"
},
"action":{
"shape":"RetryAction",
"documentation":"<p>Specifies the action to take if all of the specified conditions (<code>onStatusReason</code>, <code>onReason</code>, and <code>onExitCode</code>) are met. The values are not case sensitive.</p>"
"documentation":"<p>Specifies the action to take if all of the specified conditions (<code>onStatusReason</code>, <code>onReason</code>, and <code>onExitCode</code>) are met. The values aren't case sensitive.</p>"
}
},
"documentation":"<p>Specifies a set of conditions to be met, and an action to take (<code>RETRY</code> or <code>EXIT</code>) if all conditions are met.</p>"
@ -1258,17 +1257,17 @@
"members":{
"platformVersion":{
"shape":"String",
"documentation":"<p>The AWS Fargate platform version on which the jobs are running. A platform version is specified only for jobs running on Fargate resources. If one isn't specified, the <code>LATEST</code> platform version is used by default. This will use a recent, approved version of the AWS Fargate platform for compute resources. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate platform versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
"documentation":"<p>The AWS Fargate platform version where the jobs are running. A platform version is specified only for jobs running on Fargate resources. If one isn't specified, the <code>LATEST</code> platform version is used by default. This uses a recent, approved version of the AWS Fargate platform for compute resources. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate platform versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"documentation":"<p>The platform configuration for jobs running on Fargate resources. Jobs running on EC2 resources must not specify this parameter.</p>"
"documentation":"<p>The platform configuration for jobs running on Fargate resources. For jobs that run on EC2 resources, you shouldn't specify this parameter.</p>"
},
"Host":{
"type":"structure",
"members":{
"sourcePath":{
"shape":"String",
"documentation":"<p>The path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location does not exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.</p> <note> <p>This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.</p> </note>"
"documentation":"<p>The path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.</p> <note> <p>This parameter isn't applicable to jobs that run on Fargate resources and shouldn't be provided.</p> </note>"
}
},
"documentation":"<p>Determine whether your data volume persists on the host container instance and where it is stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume, but the data isn't guaranteed to persist after the containers associated with it stop running.</p>"
@ -1488,7 +1487,7 @@
},
"propagateTags":{
"shape":"Boolean",
"documentation":"<p>Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the <code>FAILED</code> state.</p>"
"documentation":"<p>Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the <code>FAILED</code> state.</p>"
},
"platformCapabilities":{
"shape":"PlatformCapabilityList",
@ -1533,7 +1532,7 @@
},
"priority":{
"shape":"Integer",
"documentation":"<p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the <code>priority</code> parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of <code>10</code> is given scheduling preference over a job queue with a priority value of <code>1</code>. All of the compute environments must be either EC2 (<code>EC2</code> or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>); EC2 and Fargate compute environments cannot be mixed.</p>"
"documentation":"<p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the <code>priority</code> parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of <code>10</code> is given scheduling preference over a job queue with a priority value of <code>1</code>. All of the compute environments must be either EC2 (<code>EC2</code> or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>); EC2 and Fargate compute environments can't be mixed.</p>"
},
"computeEnvironmentOrder":{
"shape":"ComputeEnvironmentOrders",
@ -1687,7 +1686,7 @@
},
"swappiness":{
"shape":"Integer",
"documentation":"<p>This allows you to tune a container's memory swappiness behavior. A <code>swappiness</code> value of <code>0</code> causes swapping not to happen unless absolutely necessary. A <code>swappiness</code> value of <code>100</code> causes pages to be swapped very aggressively. Accepted values are whole numbers between <code>0</code> and <code>100</code>. If the <code>swappiness</code> parameter isn't specified, a default value of <code>60</code> is used. If a value isn't specified for <code>maxSwap</code> then this parameter is ignored. If <code>maxSwap</code> is set to 0, the container doesn't use swap. This parameter maps to the <code>--memory-swappiness</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>Consider the following when you use a per-container swap configuration.</p> <ul> <li> <p>Swap space must be enabled and allocated on the container instance for the containers to use.</p> <note> <p>The Amazon ECS optimized AMIs don't have swap enabled by default. You must enable swap on the instance to use this feature. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-store-swap-volumes.html\">Instance Store Swap Volumes</a> in the <i>Amazon EC2 User Guide for Linux Instances</i> or <a href=\"http://aws.amazon.com/premiumsupport/knowledge-center/ec2-memory-swap-file/\">How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?</a> </p> </note> </li> <li> <p>The swap space parameters are only supported for job definitions using EC2 resources.</p> </li> <li> <p>If the <code>maxSwap</code> and <code>swappiness</code> parameters are omitted from a job definition, each container will have a default <code>swappiness</code> value of 60 and the total swap usage will be limited to two times the memory reservation of the container.</p> </li> </ul> <note> <p>This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.</p> </note>"
"documentation":"<p>This allows you to tune a container's memory swappiness behavior. A <code>swappiness</code> value of <code>0</code> causes swapping not to happen unless absolutely necessary. A <code>swappiness</code> value of <code>100</code> causes pages to be swapped very aggressively. Accepted values are whole numbers between <code>0</code> and <code>100</code>. If the <code>swappiness</code> parameter isn't specified, a default value of <code>60</code> is used. If a value isn't specified for <code>maxSwap</code> then this parameter is ignored. If <code>maxSwap</code> is set to 0, the container doesn't use swap. This parameter maps to the <code>--memory-swappiness</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <p>Consider the following when you use a per-container swap configuration.</p> <ul> <li> <p>Swap space must be enabled and allocated on the container instance for the containers to use.</p> <note> <p>The Amazon ECS optimized AMIs don't have swap enabled by default. You must enable swap on the instance to use this feature. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-store-swap-volumes.html\">Instance Store Swap Volumes</a> in the <i>Amazon EC2 User Guide for Linux Instances</i> or <a href=\"http://aws.amazon.com/premiumsupport/knowledge-center/ec2-memory-swap-file/\">How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?</a> </p> </note> </li> <li> <p>The swap space parameters are only supported for job definitions using EC2 resources.</p> </li> <li> <p>If the <code>maxSwap</code> and <code>swappiness</code> parameters are omitted from a job definition, each container will have a default <code>swappiness</code> value of 60, and the total swap usage will be limited to two times the memory reservation of the container.</p> </li> </ul> <note> <p>This parameter isn't applicable to jobs running on Fargate resources and shouldn't be provided.</p> </note>"
}
},
"documentation":"<p>Linux-specific modifications that are applied to the container, such as details for device mappings.</p>"
@ -1713,7 +1712,7 @@
},
"maxResults":{
"shape":"Integer",
"documentation":"<p>The maximum number of results returned by <code>ListJobs</code> in paginated output. When this parameter is used, <code>ListJobs</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListJobs</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>ListJobs</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>"
"documentation":"<p>The maximum number of results returned by <code>ListJobs</code> in paginated output. When this parameter is used, <code>ListJobs</code> only returns <code>maxResults</code> results in a single page and a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListJobs</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter isn't used, then <code>ListJobs</code> returns up to 100 results and a <code>nextToken</code> value if applicable.</p>"
},
"nextToken":{
"shape":"String",
@ -1763,7 +1762,7 @@
"members":{
"logDriver":{
"shape":"LogDriver",
"documentation":"<p>The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.</p> <p>The supported log drivers are <code>awslogs</code>, <code>fluentd</code>, <code>gelf</code>, <code>json-file</code>, <code>journald</code>, <code>logentries</code>, <code>syslog</code>, and <code>splunk</code>.</p> <note> <p>Jobs running on Fargate resources are restricted to the <code>awslogs</code> and <code>splunk</code> log drivers.</p> </note> <dl> <dt>awslogs</dt> <dd> <p>Specifies the Amazon CloudWatch Logs logging driver. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/using_awslogs.html\">Using the awslogs Log Driver</a> in the <i>AWS Batch User Guide</i> and <a href=\"https://docs.docker.com/config/containers/logging/awslogs/\">Amazon CloudWatch Logs logging driver</a> in the Docker documentation.</p> </dd> <dt>fluentd</dt> <dd> <p>Specifies the Fluentd logging driver. For more information, including usage and options, see <a href=\"https://docs.docker.com/config/containers/logging/fluentd/\">Fluentd logging driver</a> in the Docker documentation.</p> </dd> <dt>gelf</dt> <dd> <p>Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and options, see <a href=\"https://docs.docker.com/config/containers/logging/gelf/\">Graylog Extended Format logging driver</a> in the Docker documentation.</p> </dd> <dt>journald</dt> <dd> <p>Specifies the journald logging driver. For more information, including usage and options, see <a href=\"https://docs.docker.com/config/containers/logging/journald/\">Journald logging driver</a> in the Docker documentation.</p> </dd> <dt>json-file</dt> <dd> <p>Specifies the JSON file logging driver. For more information, including usage and options, see <a href=\"https://docs.docker.com/config/containers/logging/json-file/\">JSON File logging driver</a> in the Docker documentation.</p> </dd> <dt>splunk</dt> <dd> <p>Specifies the Splunk logging driver. For more information, including usage and options, see <a href=\"https://docs.docker.com/config/containers/logging/splunk/\">Splunk logging driver</a> in the Docker documentation.</p> </dd> <dt>syslog</dt> <dd> <p>Specifies the syslog logging driver. For more information, including usage and options, see <a href=\"https://docs.docker.com/config/containers/logging/syslog/\">Syslog logging driver</a> in the Docker documentation.</p> </dd> </dl> <note> <p>If you have a custom driver that'sn't listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's <a href=\"https://github.com/aws/amazon-ecs-agent\">available on GitHub</a> and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.</p> </note> <p>This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p>"
"documentation":"<p>The log driver to use for the container. The valid values listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.</p> <p>The supported log drivers are <code>awslogs</code>, <code>fluentd</code>, <code>gelf</code>, <code>json-file</code>, <code>journald</code>, <code>logentries</code>, <code>syslog</code>, and <code>splunk</code>.</p> <note> <p>Jobs running on Fargate resources are restricted to the <code>awslogs</code> and <code>splunk</code> log drivers.</p> </note> <dl> <dt>awslogs</dt> <dd> <p>Specifies the Amazon CloudWatch Logs logging driver. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/using_awslogs.html\">Using the awslogs Log Driver</a> in the <i>AWS Batch User Guide</i> and <a href=\"https://docs.docker.com/config/containers/logging/awslogs/\">Amazon CloudWatch Logs logging driver</a> in the Docker documentation.</p> </dd> <dt>fluentd</dt> <dd> <p>Specifies the Fluentd logging driver. For more information, including usage and options, see <a href=\"https://docs.docker.com/config/containers/logging/fluentd/\">Fluentd logging driver</a> in the Docker documentation.</p> </dd> <dt>gelf</dt> <dd> <p>Specifies the Graylog Extended Format (GELF) logging driver. For more information, including usage and options, see <a href=\"https://docs.docker.com/config/containers/logging/gelf/\">Graylog Extended Format logging driver</a> in the Docker documentation.</p> </dd> <dt>journald</dt> <dd> <p>Specifies the journald logging driver. For more information, including usage and options, see <a href=\"https://docs.docker.com/config/containers/logging/journald/\">Journald logging driver</a> in the Docker documentation.</p> </dd> <dt>json-file</dt> <dd> <p>Specifies the JSON file logging driver. For more information, including usage and options, see <a href=\"https://docs.docker.com/config/containers/logging/json-file/\">JSON File logging driver</a> in the Docker documentation.</p> </dd> <dt>splunk</dt> <dd> <p>Specifies the Splunk logging driver. For more information, including usage and options, see <a href=\"https://docs.docker.com/config/containers/logging/splunk/\">Splunk logging driver</a> in the Docker documentation.</p> </dd> <dt>syslog</dt> <dd> <p>Specifies the syslog logging driver. For more information, including usage and options, see <a href=\"https://docs.docker.com/config/containers/logging/syslog/\">Syslog logging driver</a> in the Docker documentation.</p> </dd> </dl> <note> <p>If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's <a href=\"https://github.com/aws/amazon-ecs-agent\">available on GitHub</a> and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.</p> </note> <p>This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log into your container instance and run the following command: <code>sudo docker version | grep \"Server API version\"</code> </p>"
},
"options":{
"shape":"LogConfigurationOptionsMap",
@ -2052,7 +2051,7 @@
"members":{
"value":{
"shape":"String",
"documentation":"<p>The quantity of the specified resource to reserve for the container. The values vary based on the <code>type</code> specified.</p> <dl> <dt>type=\"GPU\"</dt> <dd> <p>The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.</p> <note> <p>GPUs are not available for jobs running on Fargate resources.</p> </note> </dd> <dt>type=\"MEMORY\"</dt> <dd> <p>For jobs running on EC2 resources, the hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html\">Memory Management</a> in the <i>AWS Batch User Guide</i>.</p> </note> <p>For jobs running on Fargate resources, then <code>value</code> is the hard limit (in MiB), and must match one of the supported values and the <code>VCPU</code> values must be one of the values supported for that memory value.</p> <dl> <dt>value = 512</dt> <dd> <p> <code>VCPU</code> = 0.25</p> </dd> <dt>value = 1024</dt> <dd> <p> <code>VCPU</code> = 0.25 or 0.5</p> </dd> <dt>value = 2048</dt> <dd> <p> <code>VCPU</code> = 0.25, 0.5, or 1</p> </dd> <dt>value = 3072</dt> <dd> <p> <code>VCPU</code> = 0.5, or 1</p> </dd> <dt>value = 4096</dt> <dd> <p> <code>VCPU</code> = 0.5, 1, or 2</p> </dd> <dt>value = 5120, 6144, or 7168</dt> <dd> <p> <code>VCPU</code> = 1 or 2</p> </dd> <dt>value = 8192</dt> <dd> <p> <code>VCPU</code> = 1, 2, or 4</p> </dd> <dt>value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384</dt> <dd> <p> <code>VCPU</code> = 2 or 4</p> </dd> <dt>value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720</dt> <dd> <p> <code>VCPU</code> = 4</p> </dd> </dl> </dd> <dt>type=\"VCPU\"</dt> <dd> <p>The number of vCPUs reserved for the container. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.</p> <p>For jobs running on Fargate resources, then <code>value</code> must match one of the supported values and the <code>MEMORY</code> values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4</p> <dl> <dt>value = 0.25</dt> <dd> <p> <code>MEMORY</code> = 512, 1024, or 2048</p> </dd> <dt>value = 0.5</dt> <dd> <p> <code>MEMORY</code> = 1024, 2048, 3072, or 4096</p> </dd> <dt>value = 1</dt> <dd> <p> <code>MEMORY</code> = 2048, 3072, 4096, 5120, 6144, 7168, or 8192</p> </dd> <dt>value = 2</dt> <dd> <p> <code>MEMORY</code> = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384</p> </dd> <dt>value = 4</dt> <dd> <p> <code>MEMORY</code> = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720</p> </dd> </dl> </dd> </dl>"
"documentation":"<p>The quantity of the specified resource to reserve for the container. The values vary based on the <code>type</code> specified.</p> <dl> <dt>type=\"GPU\"</dt> <dd> <p>The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job shouldn't exceed the number of available GPUs on the compute resource that the job is launched on.</p> <note> <p>GPUs are not available for jobs running on Fargate resources.</p> </note> </dd> <dt>type=\"MEMORY\"</dt> <dd> <p>The memory hard limit (in MiB) present to the container. This parameter is supported for jobs running on EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to <code>Memory</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--memory</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>.</p> <note> <p>If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/memory-management.html\">Memory Management</a> in the <i>AWS Batch User Guide</i>.</p> </note> <p>For jobs running on Fargate resources, then <code>value</code> is the hard limit (in MiB), and must match one of the supported values and the <code>VCPU</code> values must be one of the values supported for that memory value.</p> <dl> <dt>value = 512</dt> <dd> <p> <code>VCPU</code> = 0.25</p> </dd> <dt>value = 1024</dt> <dd> <p> <code>VCPU</code> = 0.25 or 0.5</p> </dd> <dt>value = 2048</dt> <dd> <p> <code>VCPU</code> = 0.25, 0.5, or 1</p> </dd> <dt>value = 3072</dt> <dd> <p> <code>VCPU</code> = 0.5, or 1</p> </dd> <dt>value = 4096</dt> <dd> <p> <code>VCPU</code> = 0.5, 1, or 2</p> </dd> <dt>value = 5120, 6144, or 7168</dt> <dd> <p> <code>VCPU</code> = 1 or 2</p> </dd> <dt>value = 8192</dt> <dd> <p> <code>VCPU</code> = 1, 2, or 4</p> </dd> <dt>value = 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384</dt> <dd> <p> <code>VCPU</code> = 2 or 4</p> </dd> <dt>value = 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720</dt> <dd> <p> <code>VCPU</code> = 4</p> </dd> </dl> </dd> <dt>type=\"VCPU\"</dt> <dd> <p>The number of vCPUs reserved for the container. This parameter maps to <code>CpuShares</code> in the <a href=\"https://docs.docker.com/engine/api/v1.23/#create-a-container\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.23/\">Docker Remote API</a> and the <code>--cpu-shares</code> option to <a href=\"https://docs.docker.com/engine/reference/run/\">docker run</a>. Each vCPU is equivalent to 1,024 CPU shares. For EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.</p> <p>For jobs running on Fargate resources, then <code>value</code> must match one of the supported values and the <code>MEMORY</code> values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, and 4</p> <dl> <dt>value = 0.25</dt> <dd> <p> <code>MEMORY</code> = 512, 1024, or 2048</p> </dd> <dt>value = 0.5</dt> <dd> <p> <code>MEMORY</code> = 1024, 2048, 3072, or 4096</p> </dd> <dt>value = 1</dt> <dd> <p> <code>MEMORY</code> = 2048, 3072, 4096, 5120, 6144, 7168, or 8192</p> </dd> <dt>value = 2</dt> <dd> <p> <code>MEMORY</code> = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384</p> </dd> <dt>value = 4</dt> <dd> <p> <code>MEMORY</code> = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720</p> </dd> </dl> </dd> </dl>"
},
"type":{
"shape":"ResourceType",
@ -2107,7 +2106,7 @@
},
"valueFrom":{
"shape":"String",
"documentation":"<p>The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.</p> <note> <p>If the AWS Systems Manager Parameter Store parameter exists in the same Region as the job you are launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.</p> </note>"
"documentation":"<p>The secret to expose to the container. The supported values are either the full ARN of the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.</p> <note> <p>If the AWS Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full ARN or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.</p> </note>"
}
},
"documentation":"<p>An object representing the secret to expose to your container. Secrets can be exposed to a container in the following ways:</p> <ul> <li> <p>To inject sensitive data into your containers as environment variables, use the <code>secrets</code> container definition parameter.</p> </li> <li> <p>To reference sensitive information in the log configuration of a container, use the <code>secretOptions</code> container definition parameter.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/specifying-sensitive-data.html\">Specifying sensitive data</a> in the <i>AWS Batch User Guide</i>.</p>"
@ -2145,7 +2144,7 @@
},
"jobQueue":{
"shape":"String",
"documentation":"<p>The job queue into which the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.</p>"
"documentation":"<p>The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.</p>"
},
"arrayProperties":{
"shape":"ArrayProperties",
@ -2165,7 +2164,7 @@
},
"containerOverrides":{
"shape":"ContainerOverrides",
"documentation":"<p>A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that's specified in the job definition or the Docker image) with a <code>command</code> override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an <code>environment</code> override.</p>"
"documentation":"<p>A list of container overrides in the JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container, which is specified in the job definition or the Docker image, with a <code>command</code> override. You can also override existing environment variables on a container or add new environment variables to it with an <code>environment</code> override.</p>"
},
"nodeOverrides":{
"shape":"NodeOverrides",
@ -2382,7 +2381,7 @@
},
"serviceRole":{
"shape":"String",
"documentation":"<p>The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html\">AWS Batch service IAM role</a> in the <i>AWS Batch User Guide</i>.</p> <p>If your specified role has a path other than <code>/</code>, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.</p> <note> <p>Depending on how you created your AWS Batch service role, its ARN might contain the <code>service-role</code> path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not use the <code>service-role</code> path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.</p> </note>"
"documentation":"<p>The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf. For more information, see <a href=\"https://docs.aws.amazon.com/batch/latest/userguide/service_IAM_role.html\">AWS Batch service IAM role</a> in the <i>AWS Batch User Guide</i>.</p> <p>If your specified role has a path other than <code>/</code>, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path.</p> <note> <p>Depending on how you created your AWS Batch service role, its ARN might contain the <code>service-role</code> path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN doesn't use the <code>service-role</code> path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.</p> </note>"
}
},
"documentation":"<p>Contains the parameters for <code>UpdateComputeEnvironment</code>.</p>"
@ -2410,15 +2409,15 @@
},
"state":{
"shape":"JQState",
"documentation":"<p>Describes the queue's ability to accept new jobs. If the job queue state is <code>ENABLED</code>, it is able to accept jobs. If the job queue state is <code>DISABLED</code>, new jobs cannot be added to the queue, but jobs already in the queue can finish.</p>"
"documentation":"<p>Describes the queue's ability to accept new jobs. If the job queue state is <code>ENABLED</code>, it can accept jobs. If the job queue state is <code>DISABLED</code>, new jobs can't be added to the queue, but jobs already in the queue can finish.</p>"
},
"priority":{
"shape":"Integer",
"documentation":"<p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the <code>priority</code> parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of <code>10</code> is given scheduling preference over a job queue with a priority value of <code>1</code>. All of the compute environments must be either EC2 (<code>EC2</code> or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>); EC2 and Fargate compute environments cannot be mixed.</p>"
"documentation":"<p>The priority of the job queue. Job queues with a higher priority (or a higher integer value for the <code>priority</code> parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order, for example, a job queue with a priority value of <code>10</code> is given scheduling preference over a job queue with a priority value of <code>1</code>. All of the compute environments must be either EC2 (<code>EC2</code> or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>). EC2 and Fargate compute environments can't be mixed.</p>"
},
"computeEnvironmentOrder":{
"shape":"ComputeEnvironmentOrders",
"documentation":"<p>Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment should run a given job. Compute environments must be in the <code>VALID</code> state before you can associate them with a job queue. All of the compute environments must be either EC2 (<code>EC2</code> or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>); EC2 and Fargate compute environments can't be mixed.</p> <note> <p>All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.</p> </note>"
"documentation":"<p>Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment should run a given job. Compute environments must be in the <code>VALID</code> state before you can associate them with a job queue. All of the compute environments must be either EC2 (<code>EC2</code> or <code>SPOT</code>) or Fargate (<code>FARGATE</code> or <code>FARGATE_SPOT</code>). EC2 and Fargate compute environments can't be mixed.</p> <note> <p>All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.</p> </note>"
}
},
"documentation":"<p>Contains the parameters for <code>UpdateJobQueue</code>.</p>"
@ -2455,5 +2454,5 @@
"member":{"shape":"Volume"}
}
},
"documentation":"<p>Using AWS Batch, you can run batch computing workloads on the AWS Cloud. Batch computing is a common means for developers, scientists, and engineers to access large amounts of compute resources. AWS Batch utilizes the advantages of this computing workload to remove the undifferentiated heavy lifting of configuring and managing required infrastructure, while also adopting a familiar batch computing software approach. Given these advantages, AWS Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively helping to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly.</p> <p>As a fully managed service, AWS Batch can run batch computing workloads of any scale. AWS Batch automatically provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific workloads. With AWS Batch, there's no need to install or manage batch computing software. This means that you can focus your time and energy on analyzing results and solving your specific problems. </p>"
"documentation":"<p>Using AWS Batch, you can run batch computing workloads on the AWS Cloud. Batch computing is a common means for developers, scientists, and engineers to access large amounts of compute resources. AWS Batch uses the advantages of this computing workload to remove the undifferentiated heavy lifting of configuring and managing required infrastructure. At the same time, it also adopts a familiar batch computing software approach. Given these advantages, AWS Batch can help you to efficiently provision resources in response to jobs submitted, thus effectively helping you to eliminate capacity constraints, reduce compute costs, and deliver your results more quickly.</p> <p>As a fully managed service, AWS Batch can run batch computing workloads of any scale. AWS Batch automatically provisions compute resources and optimizes workload distribution based on the quantity and scale of your specific workloads. With AWS Batch, there's no need to install or manage batch computing software. This means that you can focus your time and energy on analyzing results and solving your specific problems. </p>"
}

68
botocore/data/ce/2017-10-25/service-2.json
View file

@ -720,10 +720,32 @@
"ProcessingStatus":{
"shape":"CostCategoryProcessingStatusList",
"documentation":"<p> The list of processing statuses for Cost Management products for a specific cost category. </p>"
}
},
"DefaultValue":{"shape":"CostCategoryValue"}
},
"documentation":"<p>The structure of Cost Categories. This includes detailed metadata and the set of rules for the <code>CostCategory</code> object.</p>"
},
"CostCategoryInheritedValueDimension":{
"type":"structure",
"members":{
"DimensionName":{
"shape":"CostCategoryInheritedValueDimensionName",
"documentation":"<p>The name of dimension for which to group costs.</p> <p>If you specify <code>LINKED_ACCOUNT_NAME</code>, the cost category value will be based on account name. If you specify <code>TAG</code>, the cost category value will be based on the value of the specified tag key.</p>"
},
"DimensionKey":{
"shape":"GenericString",
"documentation":"<p>The key to extract cost category values.</p>"
}
},
"documentation":"<p>When creating or updating a cost category, you can define the <code>CostCategoryRule</code> rule type as <code>INHERITED_VALUE</code>. This rule type adds the flexibility of defining a rule that dynamically inherits the cost category value from the dimension value defined by <code>CostCategoryInheritedValueDimension</code>. For example, if you wanted to dynamically group costs based on the value of a specific tag key, you would first choose an inherited value rule type, then choose the tag dimension and specify the tag key to use.</p>"
},
"CostCategoryInheritedValueDimensionName":{
"type":"string",
"enum":[
"LINKED_ACCOUNT_NAME",
"TAG"
]
},
"CostCategoryMaxResults":{
"type":"integer",
"max":100,
@ -732,7 +754,7 @@
"CostCategoryName":{
"type":"string",
"documentation":"<p>The unique name of the Cost Category.</p>",
"max":255,
"max":50,
"min":1,
"pattern":"^(?! )[\\p{L}\\p{N}\\p{Z}-_]*(?<! )$"
},
@ -785,7 +807,8 @@
"Values":{
"shape":"CostCategoryValuesList",
"documentation":"<p> A list of unique cost category values in a specific cost category. </p>"
}
},
"DefaultValue":{"shape":"CostCategoryValue"}
},
"documentation":"<p>A reference to a Cost Category containing only enough information to identify the Cost Category.</p> <p>You can use this information to retrieve the full Cost Category information using <code>DescribeCostCategory</code>.</p>"
},
@ -795,19 +818,30 @@
},
"CostCategoryRule":{
"type":"structure",
"required":[
"Value",
"Rule"
],
"members":{
"Value":{"shape":"CostCategoryValue"},
"Rule":{
"shape":"Expression",
"documentation":"<p>An <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_Expression.html\">Expression</a> object used to categorize costs. This supports dimensions, tags, and nested expressions. Currently the only dimensions supported are <code>LINKED_ACCOUNT</code>, <code>SERVICE_CODE</code>, <code>RECORD_TYPE</code>, and <code>LINKED_ACCOUNT_NAME</code>.</p> <p>Root level <code>OR</code> is not supported. We recommend that you create a separate rule instead.</p> <p> <code>RECORD_TYPE</code> is a dimension used for Cost Explorer APIs, and is also supported for Cost Category expressions. This dimension uses different terms, depending on whether you're using the console or API/JSON editor. For a detailed comparison, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/manage-cost-categories.html#cost-categories-terms\">Term Comparisons</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p>"
},
"InheritedValue":{
"shape":"CostCategoryInheritedValueDimension",
"documentation":"<p>The value the line item will be categorized as, if the line item contains the matched dimension.</p>"
},
"Type":{
"shape":"CostCategoryRuleType",
"documentation":"<p>You can define the <code>CostCategoryRule</code> rule type as either <code>REGULAR</code> or <code>INHERITED_VALUE</code>. The <code>INHERITED_VALUE</code> rule type adds the flexibility of defining a rule that dynamically inherits the cost category value from the dimension value defined by <code>CostCategoryInheritedValueDimension</code>. For example, if you wanted to dynamically group costs based on the value of a specific tag key, you would first choose an inherited value rule type, then choose the tag dimension and specify the tag key to use.</p>"
}
},
"documentation":"<p>Rules are processed in order. If there are multiple rules that match the line item, then the first rule to match is used to determine that Cost Category value.</p>"
},
"CostCategoryRuleType":{
"type":"string",
"enum":[
"REGULAR",
"INHERITED_VALUE"
]
},
"CostCategoryRuleVersion":{
"type":"string",
"documentation":"<p>The rule schema version in this particular Cost Category.</p>",
@ -832,8 +866,8 @@
},
"CostCategoryValue":{
"type":"string",
"documentation":"<p>The value a line item will be categorized as, if it matches the rule.</p>",
"max":255,
"documentation":"<p>The default value for the cost category.</p>",
"max":50,
"min":1,
"pattern":"^(?! )[\\p{L}\\p{N}\\p{Z}-_]*(?<! )$"
},
@ -1005,7 +1039,8 @@
"Rules":{
"shape":"CostCategoryRulesList",
"documentation":"<p>The Cost Category rules used to categorize costs. For more information, see <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategoryRule.html\">CostCategoryRule</a>.</p>"
}
},
"DefaultValue":{"shape":"CostCategoryValue"}
}
},
"CreateCostCategoryDefinitionResponse":{
@ -1738,7 +1773,7 @@
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>This field is only used when <code>SortBy</code> is provided in the request.</p> <p>The maximum number of objects that to be returned for this request. If <code>MaxResults</code> is not specified with <code>SortBy</code>, the request will return 1000 results as the default value for this parameter.</p>"
"documentation":"<p>This field is only used when <code>SortBy</code> is provided in the request.</p> <p>The maximum number of objects that to be returned for this request. If <code>MaxResults</code> is not specified with <code>SortBy</code>, the request will return 1000 results as the default value for this parameter.</p> <p>For <code>GetCostCategories</code>, MaxResults has an upper limit of 1000.</p>"
},
"NextPageToken":{
"shape":"NextPageToken",
@ -1797,7 +1832,7 @@
},
"Filter":{
"shape":"Expression",
"documentation":"<p>The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.</p>"
"documentation":"<p>The filters that you want to use to filter your forecast. The <code>GetCostForecast</code> API supports filtering by the following dimensions:</p> <ul> <li> <p> <code>AZ</code> </p> </li> <li> <p> <code>INSTANCE_TYPE</code> </p> </li> <li> <p> <code>LINKED_ACCOUNT</code> </p> </li> <li> <p> <code>LINKED_ACCOUNT_NAME</code> </p> </li> <li> <p> <code>OPERATION</code> </p> </li> <li> <p> <code>PURCHASE_TYPE</code> </p> </li> <li> <p> <code>REGION</code> </p> </li> <li> <p> <code>SERVICE</code> </p> </li> <li> <p> <code>USAGE_TYPE</code> </p> </li> <li> <p> <code>USAGE_TYPE_GROUP</code> </p> </li> <li> <p> <code>RECORD_TYPE</code> </p> </li> <li> <p> <code>OPERATING_SYSTEM</code> </p> </li> <li> <p> <code>TENANCY</code> </p> </li> <li> <p> <code>SCOPE</code> </p> </li> <li> <p> <code>PLATFORM</code> </p> </li> <li> <p> <code>SUBSCRIPTION_ID</code> </p> </li> <li> <p> <code>LEGAL_ENTITY_NAME</code> </p> </li> <li> <p> <code>DEPLOYMENT_OPTION</code> </p> </li> <li> <p> <code>DATABASE_ENGINE</code> </p> </li> <li> <p> <code>INSTANCE_TYPE_FAMILY</code> </p> </li> <li> <p> <code>BILLING_ENTITY</code> </p> </li> <li> <p> <code>RESERVATION_ID</code> </p> </li> <li> <p> <code>SAVINGS_PLAN_ARN</code> </p> </li> </ul>"
},
"PredictionIntervalLevel":{
"shape":"PredictionIntervalLevel",
@ -1848,7 +1883,7 @@
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.</p>"
"documentation":"<p>This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.</p> <p>For <code>GetDimensionValues</code>, MaxResults has an upper limit of 1000.</p>"
},
"NextPageToken":{
"shape":"NextPageToken",
@ -2326,7 +2361,7 @@
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.</p>"
"documentation":"<p>This field is only used when SortBy is provided in the request. The maximum number of objects that to be returned for this request. If MaxResults is not specified with SortBy, the request will return 1000 results as the default value for this parameter.</p> <p>For <code>GetTags</code>, MaxResults has an upper limit of 1000.</p>"
},
"NextPageToken":{
"shape":"NextPageToken",
@ -2382,7 +2417,7 @@
},
"Filter":{
"shape":"Expression",
"documentation":"<p>The filters that you want to use to filter your forecast. Cost Explorer API supports all of the Cost Explorer filters.</p>"
"documentation":"<p>The filters that you want to use to filter your forecast. The <code>GetUsageForecast</code> API supports filtering by the following dimensions:</p> <ul> <li> <p> <code>AZ</code> </p> </li> <li> <p> <code>INSTANCE_TYPE</code> </p> </li> <li> <p> <code>LINKED_ACCOUNT</code> </p> </li> <li> <p> <code>LINKED_ACCOUNT_NAME</code> </p> </li> <li> <p> <code>OPERATION</code> </p> </li> <li> <p> <code>PURCHASE_TYPE</code> </p> </li> <li> <p> <code>REGION</code> </p> </li> <li> <p> <code>SERVICE</code> </p> </li> <li> <p> <code>USAGE_TYPE</code> </p> </li> <li> <p> <code>USAGE_TYPE_GROUP</code> </p> </li> <li> <p> <code>RECORD_TYPE</code> </p> </li> <li> <p> <code>OPERATING_SYSTEM</code> </p> </li> <li> <p> <code>TENANCY</code> </p> </li> <li> <p> <code>SCOPE</code> </p> </li> <li> <p> <code>PLATFORM</code> </p> </li> <li> <p> <code>SUBSCRIPTION_ID</code> </p> </li> <li> <p> <code>LEGAL_ENTITY_NAME</code> </p> </li> <li> <p> <code>DEPLOYMENT_OPTION</code> </p> </li> <li> <p> <code>DATABASE_ENGINE</code> </p> </li> <li> <p> <code>INSTANCE_TYPE_FAMILY</code> </p> </li> <li> <p> <code>BILLING_ENTITY</code> </p> </li> <li> <p> <code>RESERVATION_ID</code> </p> </li> <li> <p> <code>SAVINGS_PLAN_ARN</code> </p> </li> </ul>"
},
"PredictionIntervalLevel":{
"shape":"PredictionIntervalLevel",
@ -3981,7 +4016,8 @@
"Rules":{
"shape":"CostCategoryRulesList",
"documentation":"<p>The <code>Expression</code> object used to categorize costs. For more information, see <a href=\"https://docs.aws.amazon.com/aws-cost-management/latest/APIReference/API_CostCategoryRule.html\">CostCategoryRule </a>. </p>"
}
},
"DefaultValue":{"shape":"CostCategoryValue"}
}
},
"UpdateCostCategoryDefinitionResponse":{

255
botocore/data/cloudformation/2010-05-15/service-2.json
View file

@ -195,7 +195,7 @@
{"shape":"CFNRegistryException"},
{"shape":"TypeNotFoundException"}
],
"documentation":"<p>Removes a type or type version from active use in the CloudFormation registry. If a type or type version is deregistered, it cannot be used in CloudFormation operations.</p> <p>To deregister a type, you must individually deregister all registered versions of that type. If a type has only a single registered version, deregistering that version results in the type itself being deregistered. </p> <p>You cannot deregister the default version of a type, unless it is the only registered version of that type, in which case the type itself is deregistered as well. </p>",
"documentation":"<p>Marks an extension or extension version as <code>DEPRECATED</code> in the CloudFormation registry, removing it from active use. Deprecated extensions or extension versions cannot be used in CloudFormation operations.</p> <p>To deregister an entire extension, you must individually deregister all active versions of that extension. If an extension has only a single active version, deregistering that version results in the extension itself being deregistered and marked as deprecated in the registry. </p> <p>You cannot deregister the default version of an extension if there are other active version of that extension. If you do deregister the default version of an extension, the textensionype itself is deregistered as well and marked as deprecated. </p> <p>To view the deprecation status of an extension or extension version, use <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DescribeType.html\">DescribeType</a>.</p>",
"idempotent":true
},
"DescribeAccountLimits":{
@ -370,7 +370,7 @@
{"shape":"CFNRegistryException"},
{"shape":"TypeNotFoundException"}
],
"documentation":"<p>Returns detailed information about a type that has been registered.</p> <p>If you specify a <code>VersionId</code>, <code>DescribeType</code> returns information about that specific type version. Otherwise, it returns information about the default type version.</p>",
"documentation":"<p>Returns detailed information about an extension that has been registered.</p> <p>If you specify a <code>VersionId</code>, <code>DescribeType</code> returns information about that specific extension version. Otherwise, it returns information about the default extension version.</p>",
"idempotent":true
},
"DescribeTypeRegistration":{
@ -387,7 +387,7 @@
"errors":[
{"shape":"CFNRegistryException"}
],
"documentation":"<p>Returns information about a type's registration, including its current status and type and version identifiers.</p> <p>When you initiate a registration request using <code> <a>RegisterType</a> </code>, you can then use <code> <a>DescribeTypeRegistration</a> </code> to monitor the progress of that registration request.</p> <p>Once the registration request has completed, use <code> <a>DescribeType</a> </code> to return detailed informaiton about a type.</p>",
"documentation":"<p>Returns information about an extension's registration, including its current status and type and version identifiers.</p> <p>When you initiate a registration request using <code> <a>RegisterType</a> </code>, you can then use <code> <a>DescribeTypeRegistration</a> </code> to monitor the progress of that registration request.</p> <p>Once the registration request has completed, use <code> <a>DescribeType</a> </code> to return detailed information about an extension.</p>",
"idempotent":true
},
"DetectStackDrift":{
@ -432,7 +432,7 @@
{"shape":"OperationInProgressException"},
{"shape":"StackSetNotFoundException"}
],
"documentation":"<p>Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html\">How CloudFormation Performs Drift Detection on a Stack Set</a>.</p> <p> <code>DetectStackSetDrift</code> returns the <code>OperationId</code> of the stack set drift detection operation. Use this operation id with <code> <a>DescribeStackSetOperation</a> </code> to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, as well as the number of resources included in each stack.</p> <p>Once the operation has completed, use the following actions to return drift information:</p> <ul> <li> <p>Use <code> <a>DescribeStackSet</a> </code> to return detailed informaiton about the stack set, including detailed information about the last <i>completed</i> drift operation performed on the stack set. (Information about drift operations that are in progress is not included.)</p> </li> <li> <p>Use <code> <a>ListStackInstances</a> </code> to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.</p> </li> <li> <p>Use <code> <a>DescribeStackInstance</a> </code> to return detailed information about a specific stack instance, including its drift status and last drift time checked.</p> </li> </ul> <p>For more information on performing a drift detection operation on a stack set, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html\">Detecting Unmanaged Changes in Stack Sets</a>. </p> <p>You can only run a single drift detection operation on a given stack set at one time. </p> <p>To stop a drift detection stack set operation, use <code> <a>StopStackSetOperation</a> </code>.</p>"
"documentation":"<p>Detect drift on a stack set. When CloudFormation performs drift detection on a stack set, it performs drift detection on the stack associated with each stack instance in the stack set. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html\">How CloudFormation Performs Drift Detection on a Stack Set</a>.</p> <p> <code>DetectStackSetDrift</code> returns the <code>OperationId</code> of the stack set drift detection operation. Use this operation id with <code> <a>DescribeStackSetOperation</a> </code> to monitor the progress of the drift detection operation. The drift detection operation may take some time, depending on the number of stack instances included in the stack set, as well as the number of resources included in each stack.</p> <p>Once the operation has completed, use the following actions to return drift information:</p> <ul> <li> <p>Use <code> <a>DescribeStackSet</a> </code> to return detailed information about the stack set, including detailed information about the last <i>completed</i> drift operation performed on the stack set. (Information about drift operations that are in progress is not included.)</p> </li> <li> <p>Use <code> <a>ListStackInstances</a> </code> to return a list of stack instances belonging to the stack set, including the drift status and last drift time checked of each instance.</p> </li> <li> <p>Use <code> <a>DescribeStackInstance</a> </code> to return detailed information about a specific stack instance, including its drift status and last drift time checked.</p> </li> </ul> <p>For more information on performing a drift detection operation on a stack set, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-drift.html\">Detecting Unmanaged Changes in Stack Sets</a>. </p> <p>You can only run a single drift detection operation on a given stack set at one time. </p> <p>To stop a drift detection stack set operation, use <code> <a>StopStackSetOperation</a> </code>.</p>"
},
"EstimateTemplateCost":{
"name":"EstimateTemplateCost",
@ -623,7 +623,7 @@
"shape":"ListStackSetsOutput",
"resultWrapper":"ListStackSetsResult"
},
"documentation":"<p>Returns summary information about stack sets that are associated with the user.</p>"
"documentation":"<p>Returns summary information about stack sets that are associated with the user.</p> <ul> <li> <p>[Self-managed permissions] If you set the <code>CallAs</code> parameter to <code>SELF</code> while signed in to your AWS account, <code>ListStackSets</code> returns all self-managed stack sets in your AWS account.</p> </li> <li> <p>[Service-managed permissions] If you set the <code>CallAs</code> parameter to <code>SELF</code> while signed in to the organization's management account, <code>ListStackSets</code> returns all stack sets in the management account.</p> </li> <li> <p>[Service-managed permissions] If you set the <code>CallAs</code> parameter to <code>DELEGATED_ADMIN</code> while signed in to your member account, <code>ListStackSets</code> returns all stack sets with service-managed permissions in the management account.</p> </li> </ul>"
},
"ListStacks":{
"name":"ListStacks",
@ -652,7 +652,7 @@
"errors":[
{"shape":"CFNRegistryException"}
],
"documentation":"<p>Returns a list of registration tokens for the specified type(s).</p>",
"documentation":"<p>Returns a list of registration tokens for the specified extension(s).</p>",
"idempotent":true
},
"ListTypeVersions":{
@ -669,7 +669,7 @@
"errors":[
{"shape":"CFNRegistryException"}
],
"documentation":"<p>Returns summary information about the versions of a type.</p>",
"documentation":"<p>Returns summary information about the versions of an extension.</p>",
"idempotent":true
},
"ListTypes":{
@ -686,7 +686,7 @@
"errors":[
{"shape":"CFNRegistryException"}
],
"documentation":"<p>Returns summary information about types that have been registered with CloudFormation.</p>",
"documentation":"<p>Returns summary information about extension that have been registered with CloudFormation.</p>",
"idempotent":true
},
"RecordHandlerProgress":{
@ -721,7 +721,7 @@
"errors":[
{"shape":"CFNRegistryException"}
],
"documentation":"<p>Registers a type with the CloudFormation service. Registering a type makes it available for use in CloudFormation templates in your AWS account, and includes:</p> <ul> <li> <p>Validating the resource schema</p> </li> <li> <p>Determining which handlers have been specified for the resource</p> </li> <li> <p>Making the resource type available for use in your account</p> </li> </ul> <p>For more information on how to develop types and ready them for registeration, see <a href=\"https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html\">Creating Resource Providers</a> in the <i>CloudFormation CLI User Guide</i>.</p> <p>You can have a maximum of 50 resource type versions registered at a time. This maximum is per account and per region. Use <a href=\"AWSCloudFormation/latest/APIReference/API_DeregisterType.html\">DeregisterType</a> to deregister specific resource type versions if necessary.</p> <p>Once you have initiated a registration request using <code> <a>RegisterType</a> </code>, you can use <code> <a>DescribeTypeRegistration</a> </code> to monitor the progress of the registration request.</p>",
"documentation":"<p>Registers an extension with the CloudFormation service. Registering an extension makes it available for use in CloudFormation templates in your AWS account, and includes:</p> <ul> <li> <p>Validating the extension schema</p> </li> <li> <p>Determining which handlers, if any, have been specified for the extension</p> </li> <li> <p>Making the extension available for use in your account</p> </li> </ul> <p>For more information on how to develop extensions and ready them for registeration, see <a href=\"https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-types.html\">Creating Resource Providers</a> in the <i>CloudFormation CLI User Guide</i>.</p> <p>You can have a maximum of 50 resource extension versions registered at a time. This maximum is per account and per region. Use <a href=\"AWSCloudFormation/latest/APIReference/API_DeregisterType.html\">DeregisterType</a> to deregister specific extension versions if necessary.</p> <p>Once you have initiated a registration request using <code> <a>RegisterType</a> </code>, you can use <code> <a>DescribeTypeRegistration</a> </code> to monitor the progress of the registration request.</p>",
"idempotent":true
},
"SetStackPolicy":{
@ -748,7 +748,7 @@
{"shape":"CFNRegistryException"},
{"shape":"TypeNotFoundException"}
],
"documentation":"<p>Specify the default version of a type. The default version of a type will be used in CloudFormation operations.</p>",
"documentation":"<p>Specify the default version of an extension. The default version of an extension will be used in CloudFormation operations.</p>",
"idempotent":true
},
"SignalResource":{
@ -944,7 +944,7 @@
"documentation":"<p>If set to <code>true</code>, stack resources are retained when an account is removed from a target organization or OU. If set to <code>false</code>, stack resources are deleted. Specify only if <code>Enabled</code> is set to <code>True</code>.</p>"
}
},
"documentation":"<p>[<code>Service-managed</code> permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).</p>"
"documentation":"<p>[Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).</p>"
},
"AutoDeploymentNullable":{"type":"boolean"},
"BoxedInteger":{
@ -970,6 +970,13 @@
},
"exception":true
},
"CallAs":{
"type":"string",
"enum":[
"SELF",
"DELEGATED_ADMIN"
]
},
"CancelUpdateStackInput":{
"type":"structure",
"required":["StackName"],
@ -1207,7 +1214,7 @@
},
"TemplateURL":{
"shape":"TemplateURL",
"documentation":"<p>The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.</p> <p>Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>.</p>"
"documentation":"<p>The location of the file that contains the revised template. The URL must point to a template (max size: 460,800 bytes) that is located in an S3 bucket or a Systems Manager document. AWS CloudFormation generates the change set by comparing this template with the stack that you specified.</p> <p>Conditional: You must specify only <code>TemplateBody</code> or <code>TemplateURL</code>.</p>"
},
"UsePreviousTemplate":{
"shape":"UsePreviousTemplate",
@ -1296,7 +1303,7 @@
},
"TemplateURL":{
"shape":"TemplateURL",
"documentation":"<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>"
"documentation":"<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>"
},
"Parameters":{
"shape":"Parameters",
@ -1370,11 +1377,11 @@
},
"Accounts":{
"shape":"AccountList",
"documentation":"<p>[<code>Self-managed</code> permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
"documentation":"<p>[Self-managed permissions] The names of one or more AWS accounts that you want to create stack instances in the specified Region(s) for.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
},
"DeploymentTargets":{
"shape":"DeploymentTargets",
"documentation":"<p>[<code>Service-managed</code> permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
"documentation":"<p>[Service-managed permissions] The AWS Organizations accounts for which to create stack instances in the specified Regions.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
},
"Regions":{
"shape":"RegionList",
@ -1392,6 +1399,10 @@
"shape":"ClientRequestToken",
"documentation":"<p>The unique identifier for this stack set operation. </p> <p>The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.</p> <p>If you don't specify an operation ID, the SDK generates one automatically. </p> <p>Repeating this stack set operation with a new operation ID retries all stack instances whose status is <code>OUTDATED</code>. </p>",
"idempotencyToken":true
},
"CallAs":{
"shape":"CallAs",
"documentation":"<p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your AWS account must be registered as a delegated administrator in the management account. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html\">Register a delegated administrator</a> in the <i>AWS CloudFormation User Guide</i>.</p> </li> </ul>"
}
}
},
@ -1432,7 +1443,7 @@
},
"TemplateURL":{
"shape":"TemplateURL",
"documentation":"<p>The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.</p>"
"documentation":"<p>The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that's located in an Amazon S3 bucket or a Systems Manager document. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the TemplateBody or the TemplateURL parameter, but not both.</p>"
},
"Parameters":{
"shape":"Parameters",
@ -1462,6 +1473,10 @@
"shape":"AutoDeployment",
"documentation":"<p>Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to the target organization or organizational unit (OU). Specify only if <code>PermissionModel</code> is <code>SERVICE_MANAGED</code>.</p>"
},
"CallAs":{
"shape":"CallAs",
"documentation":"<p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p> <ul> <li> <p>To create a stack set with service-managed permissions while signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your AWS account must be registered as a delegated admin in the management account. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html\">Register a delegated administrator</a> in the <i>AWS CloudFormation User Guide</i>.</p> </li> </ul> <p>Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators.</p>"
},
"ClientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>A unique identifier for this <code>CreateStackSet</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create another stack set with the same name. You might retry <code>CreateStackSet</code> requests to ensure that AWS CloudFormation successfully received them.</p> <p>If you don't specify an operation ID, the SDK generates one automatically. </p>",
@ -1549,11 +1564,11 @@
},
"Accounts":{
"shape":"AccountList",
"documentation":"<p>[<code>Self-managed</code> permissions] The names of the AWS accounts that you want to delete stack instances for.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
"documentation":"<p>[Self-managed permissions] The names of the AWS accounts that you want to delete stack instances for.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
},
"DeploymentTargets":{
"shape":"DeploymentTargets",
"documentation":"<p>[<code>Service-managed</code> permissions] The AWS Organizations accounts from which to delete stack instances.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
"documentation":"<p>[Service-managed permissions] The AWS Organizations accounts from which to delete stack instances.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
},
"Regions":{
"shape":"RegionList",
@ -1571,6 +1586,10 @@
"shape":"ClientRequestToken",
"documentation":"<p>The unique identifier for this stack set operation. </p> <p>If you don't specify an operation ID, the SDK generates one automatically. </p> <p>The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You can retry stack set operation requests to ensure that AWS CloudFormation successfully received them.</p> <p>Repeating this stack set operation with a new operation ID retries all stack instances whose status is <code>OUTDATED</code>. </p>",
"idempotencyToken":true
},
"CallAs":{
"shape":"CallAs",
"documentation":"<p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your AWS account must be registered as a delegated administrator in the management account. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html\">Register a delegated administrator</a> in the <i>AWS CloudFormation User Guide</i>.</p> </li> </ul>"
}
}
},
@ -1590,6 +1609,10 @@
"StackSetName":{
"shape":"StackSetName",
"documentation":"<p>The name or unique ID of the stack set that you're deleting. You can obtain this value by running <a>ListStackSets</a>.</p>"
},
"CallAs":{
"shape":"CallAs",
"documentation":"<p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your AWS account must be registered as a delegated administrator in the management account. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html\">Register a delegated administrator</a> in the <i>AWS CloudFormation User Guide</i>.</p> </li> </ul>"
}
}
},
@ -1611,7 +1634,7 @@
"documentation":"<p>The organization root ID or organizational unit (OU) IDs to which StackSets deploys.</p>"
}
},
"documentation":"<p>[<code>Service-managed</code> permissions] The AWS Organizations accounts to which StackSets deploys. StackSets does not deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization.</p> <p>For update operations, you can specify either <code>Accounts</code> or <code>OrganizationalUnitIds</code>. For create and delete operations, specify <code>OrganizationalUnitIds</code>.</p>"
"documentation":"<p>[Service-managed permissions] The AWS Organizations accounts to which StackSets deploys. StackSets does not deploy stack instances to the organization management account, even if the organization management account is in your organization or in an OU in your organization.</p> <p>For update operations, you can specify either <code>Accounts</code> or <code>OrganizationalUnitIds</code>. For create and delete operations, specify <code>OrganizationalUnitIds</code>.</p>"
},
"DeprecatedStatus":{
"type":"string",
@ -1625,19 +1648,19 @@
"members":{
"Arn":{
"shape":"PrivateTypeArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the type.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
},
"Type":{
"shape":"RegistryType",
"documentation":"<p>The kind of type.</p> <p>Currently the only valid value is <code>RESOURCE</code>.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
"documentation":"<p>The kind of extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
},
"TypeName":{
"shape":"TypeName",
"documentation":"<p>The name of the type.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
"documentation":"<p>The name of the extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
},
"VersionId":{
"shape":"TypeVersionId",
"documentation":"<p>The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.</p>"
"documentation":"<p>The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.</p>"
}
}
},
@ -1867,6 +1890,10 @@
"StackInstanceRegion":{
"shape":"Region",
"documentation":"<p>The name of a Region that's associated with this stack instance.</p>"
},
"CallAs":{
"shape":"CallAs",
"documentation":"<p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your AWS account must be registered as a delegated administrator in the management account. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html\">Register a delegated administrator</a> in the <i>AWS CloudFormation User Guide</i>.</p> </li> </ul>"
}
}
},
@ -1978,6 +2005,10 @@
"StackSetName":{
"shape":"StackSetName",
"documentation":"<p>The name or unique ID of the stack set whose description you want.</p>"
},
"CallAs":{
"shape":"CallAs",
"documentation":"<p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your AWS account must be registered as a delegated administrator in the management account. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html\">Register a delegated administrator</a> in the <i>AWS CloudFormation User Guide</i>.</p> </li> </ul>"
}
}
},
@ -1995,6 +2026,10 @@
"OperationId":{
"shape":"ClientRequestToken",
"documentation":"<p>The unique ID of the stack set operation. </p>"
},
"CallAs":{
"shape":"CallAs",
"documentation":"<p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your AWS account must be registered as a delegated administrator in the management account. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html\">Register a delegated administrator</a> in the <i>AWS CloudFormation User Guide</i>.</p> </li> </ul>"
}
}
},
@ -2049,19 +2084,19 @@
"members":{
"Type":{
"shape":"RegistryType",
"documentation":"<p>The kind of type. </p> <p>Currently the only valid value is <code>RESOURCE</code>.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
"documentation":"<p>The kind of extension. </p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
},
"TypeName":{
"shape":"TypeName",
"documentation":"<p>The name of the type.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
"documentation":"<p>The name of the extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
},
"Arn":{
"shape":"TypeArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the type.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
},
"VersionId":{
"shape":"TypeVersionId",
"documentation":"<p>The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.</p> <p>If you specify a <code>VersionId</code>, <code>DescribeType</code> returns information about that specific type version. Otherwise, it returns information about the default type version.</p>"
"documentation":"<p>The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.</p> <p>If you specify a <code>VersionId</code>, <code>DescribeType</code> returns information about that specific extension version. Otherwise, it returns information about the default extension version.</p>"
}
}
},
@ -2070,67 +2105,67 @@
"members":{
"Arn":{
"shape":"TypeArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the type.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the extension.</p>"
},
"Type":{
"shape":"RegistryType",
"documentation":"<p>The kind of type. </p> <p>Currently the only valid value is <code>RESOURCE</code>.</p>"
"documentation":"<p>The kind of extension. </p>"
},
"TypeName":{
"shape":"TypeName",
"documentation":"<p>The name of the registered type.</p>"
"documentation":"<p>The name of the registered extension.</p>"
},
"DefaultVersionId":{
"shape":"TypeVersionId",
"documentation":"<p>The ID of the default version of the type. The default version is used when the type version is not specified.</p> <p>To set the default version of a type, use <code> <a>SetTypeDefaultVersion</a> </code>. </p>"
"documentation":"<p>The ID of the default version of the extension. The default version is used when the extension version is not specified.</p> <p>To set the default version of an extension, use <code> <a>SetTypeDefaultVersion</a> </code>. </p>"
},
"IsDefaultVersion":{
"shape":"IsDefaultVersion",
"documentation":"<p>Whether the specified type version is set as the default version.</p>"
"documentation":"<p>Whether the specified extension version is set as the default version.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>The description of the registered type.</p>"
"documentation":"<p>The description of the registered extension.</p>"
},
"Schema":{
"shape":"TypeSchema",
"documentation":"<p>The schema that defines the type.</p> <p>For more information on type schemas, see <a href=\"https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html\">Resource Provider Schema</a> in the <i>CloudFormation CLI User Guide</i>.</p>"
"documentation":"<p>The schema that defines the extension.</p> <p>For more information on extension schemas, see <a href=\"https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html\">Resource Provider Schema</a> in the <i>CloudFormation CLI User Guide</i>.</p>"
},
"ProvisioningType":{
"shape":"ProvisioningType",
"documentation":"<p>The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.</p> <p>Valid values include:</p> <ul> <li> <p> <code>FULLY_MUTABLE</code>: The type includes an update handler to process updates to the type during stack update operations.</p> </li> <li> <p> <code>IMMUTABLE</code>: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.</p> </li> <li> <p> <code>NON_PROVISIONABLE</code>: The type does not include all of the following handlers, and therefore cannot actually be provisioned.</p> <ul> <li> <p>create</p> </li> <li> <p>read</p> </li> <li> <p>delete</p> </li> </ul> </li> </ul>"
"documentation":"<p>The provisioning behavior of the extension. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.</p> <p>Valid values include:</p> <ul> <li> <p> <code>FULLY_MUTABLE</code>: The extension includes an update handler to process updates to the extension during stack update operations.</p> </li> <li> <p> <code>IMMUTABLE</code>: The extension does not include an update handler, so the extension cannot be updated and must instead be replaced during stack update operations.</p> </li> <li> <p> <code>NON_PROVISIONABLE</code>: The extension does not include all of the following handlers, and therefore cannot actually be provisioned.</p> <ul> <li> <p>create</p> </li> <li> <p>read</p> </li> <li> <p>delete</p> </li> </ul> </li> </ul>"
},
"DeprecatedStatus":{
"shape":"DeprecatedStatus",
"documentation":"<p>The deprecation status of the type.</p> <p>Valid values include:</p> <ul> <li> <p> <code>LIVE</code>: The type is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.</p> </li> <li> <p> <code>DEPRECATED</code>: The type has been deregistered and can no longer be used in CloudFormation operations. </p> </li> </ul>"
"documentation":"<p>The deprecation status of the extension version.</p> <p>Valid values include:</p> <ul> <li> <p> <code>LIVE</code>: The extension is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.</p> </li> <li> <p> <code>DEPRECATED</code>: The extension has been deregistered and can no longer be used in CloudFormation operations. </p> </li> </ul>"
},
"LoggingConfig":{
"shape":"LoggingConfig",
"documentation":"<p>Contains logging configuration information for a type.</p>"
"documentation":"<p>Contains logging configuration information for an extension.</p>"
},
"ExecutionRoleArn":{
"shape":"RoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM execution role used to register the type. If your resource type calls AWS APIs in any of its handlers, you must create an <i> <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html\">IAM execution role</a> </i> that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your resource type with the appropriate credentials.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM execution role used to register the extension. If your resource type calls AWS APIs in any of its handlers, you must create an <i> <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html\">IAM execution role</a> </i> that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. CloudFormation then assumes that execution role to provide your extension with the appropriate credentials.</p>"
},
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The scope at which the type is visible and usable in CloudFormation operations.</p> <p>Valid values include:</p> <ul> <li> <p> <code>PRIVATE</code>: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as <code>PRIVATE</code>.</p> </li> <li> <p> <code>PUBLIC</code>: The type is publically visible and usable within any Amazon account.</p> </li> </ul>"
"documentation":"<p>The scope at which the extension is visible and usable in CloudFormation operations.</p> <p>Valid values include:</p> <ul> <li> <p> <code>PRIVATE</code>: The extension is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you register as <code>PRIVATE</code>.</p> </li> <li> <p> <code>PUBLIC</code>: The extension is publically visible and usable within any Amazon account.</p> </li> </ul>"
},
"SourceUrl":{
"shape":"OptionalSecureUrl",
"documentation":"<p>The URL of the source code for the type.</p>"
"documentation":"<p>The URL of the source code for the extension.</p>"
},
"DocumentationUrl":{
"shape":"OptionalSecureUrl",
"documentation":"<p>The URL of a page providing detailed documentation for this type.</p>"
"documentation":"<p>The URL of a page providing detailed documentation for this extension.</p>"
},
"LastUpdated":{
"shape":"Timestamp",
"documentation":"<p>When the specified type version was registered.</p>"
"documentation":"<p>When the specified extension version was registered.</p>"
},
"TimeCreated":{
"shape":"Timestamp",
"documentation":"<p>When the specified type version was registered.</p>"
"documentation":"<p>When the specified extension version was registered.</p>"
}
}
},
@ -2149,19 +2184,19 @@
"members":{
"ProgressStatus":{
"shape":"RegistrationStatus",
"documentation":"<p>The current status of the type registration request.</p>"
"documentation":"<p>The current status of the extension registration request.</p>"
},
"Description":{
"shape":"Description",
"documentation":"<p>The description of the type registration request.</p>"
"documentation":"<p>The description of the extension registration request.</p>"
},
"TypeArn":{
"shape":"TypeArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the type being registered.</p> <p>For registration requests with a <code>ProgressStatus</code> of other than <code>COMPLETE</code>, this will be <code>null</code>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the extension being registered.</p> <p>For registration requests with a <code>ProgressStatus</code> of other than <code>COMPLETE</code>, this will be <code>null</code>.</p>"
},
"TypeVersionArn":{
"shape":"TypeArn",
"documentation":"<p>The Amazon Resource Name (ARN) of this specific version of the type being registered.</p> <p>For registration requests with a <code>ProgressStatus</code> of other than <code>COMPLETE</code>, this will be <code>null</code>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of this specific version of the extension being registered.</p> <p>For registration requests with a <code>ProgressStatus</code> of other than <code>COMPLETE</code>, this will be <code>null</code>.</p>"
}
}
},
@ -2234,6 +2269,10 @@
"shape":"ClientRequestToken",
"documentation":"<p> <i>The ID of the stack set operation.</i> </p>",
"idempotencyToken":true
},
"CallAs":{
"shape":"CallAs",
"documentation":"<p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your AWS account must be registered as a delegated administrator in the management account. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html\">Register a delegated administrator</a> in the <i>AWS CloudFormation User Guide</i>.</p> </li> </ul>"
}
}
},
@ -2274,7 +2313,7 @@
},
"TemplateURL":{
"shape":"TemplateURL",
"documentation":"<p>Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>"
"documentation":"<p>Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>"
},
"Parameters":{
"shape":"Parameters",
@ -2442,7 +2481,7 @@
},
"TemplateURL":{
"shape":"TemplateURL",
"documentation":"<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information about templates, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>"
"documentation":"<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>StackName</code>, <code>StackSetName</code>, <code>TemplateBody</code>, or <code>TemplateURL</code>.</p>"
},
"StackName":{
"shape":"StackNameOrId",
@ -2699,6 +2738,10 @@
"StackInstanceRegion":{
"shape":"Region",
"documentation":"<p>The name of the Region where you want to list stack instances. </p>"
},
"CallAs":{
"shape":"CallAs",
"documentation":"<p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your AWS account must be registered as a delegated administrator in the management account. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html\">Register a delegated administrator</a> in the <i>AWS CloudFormation User Guide</i>.</p> </li> </ul>"
}
}
},
@ -2766,6 +2809,10 @@
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>"
},
"CallAs":{
"shape":"CallAs",
"documentation":"<p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your AWS account must be registered as a delegated administrator in the management account. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html\">Register a delegated administrator</a> in the <i>AWS CloudFormation User Guide</i>.</p> </li> </ul>"
}
}
},
@ -2797,6 +2844,10 @@
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a <code>NextToken</code> value that you can assign to the <code>NextToken</code> request parameter to get the next set of results.</p>"
},
"CallAs":{
"shape":"CallAs",
"documentation":"<p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your AWS account must be registered as a delegated administrator in the management account. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html\">Register a delegated administrator</a> in the <i>AWS CloudFormation User Guide</i>.</p> </li> </ul>"
}
}
},
@ -2827,6 +2878,10 @@
"Status":{
"shape":"StackSetStatus",
"documentation":"<p>The status of the stack sets that you want to get summary information about.</p>"
},
"CallAs":{
"shape":"CallAs",
"documentation":"<p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your AWS account must be registered as a delegated administrator in the management account. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html\">Register a delegated administrator</a> in the <i>AWS CloudFormation User Guide</i>.</p> </li> </ul>"
}
}
},
@ -2876,19 +2931,19 @@
"members":{
"Type":{
"shape":"RegistryType",
"documentation":"<p>The kind of type.</p> <p>Currently the only valid value is <code>RESOURCE</code>.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
"documentation":"<p>The kind of extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
},
"TypeName":{
"shape":"TypeName",
"documentation":"<p>The name of the type.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
"documentation":"<p>The name of the extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
},
"TypeArn":{
"shape":"TypeArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the type.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
},
"RegistrationStatusFilter":{
"shape":"RegistrationStatus",
"documentation":"<p>The current status of the type registration request.</p> <p>The default is <code>IN_PROGRESS</code>.</p>"
"documentation":"<p>The current status of the extension registration request.</p> <p>The default is <code>IN_PROGRESS</code>.</p>"
},
"MaxResults":{
"shape":"MaxResults",
@ -2905,7 +2960,7 @@
"members":{
"RegistrationTokenList":{
"shape":"RegistrationTokenList",
"documentation":"<p> A list of type registration tokens.</p> <p>Use <code> <a>DescribeTypeRegistration</a> </code> to return detailed information about a type registration request.</p>"
"documentation":"<p> A list of extension registration tokens.</p> <p>Use <code> <a>DescribeTypeRegistration</a> </code> to return detailed information about a type registration request.</p>"
},
"NextToken":{
"shape":"NextToken",
@ -2918,15 +2973,15 @@
"members":{
"Type":{
"shape":"RegistryType",
"documentation":"<p>The kind of the type.</p> <p>Currently the only valid value is <code>RESOURCE</code>.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
"documentation":"<p>The kind of the extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
},
"TypeName":{
"shape":"TypeName",
"documentation":"<p>The name of the type for which you want version summary information.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
"documentation":"<p>The name of the extension for which you want version summary information.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
},
"Arn":{
"shape":"PrivateTypeArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the type for which you want version summary information.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the extension for which you want version summary information.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
},
"MaxResults":{
"shape":"MaxResults",
@ -2938,7 +2993,7 @@
},
"DeprecatedStatus":{
"shape":"DeprecatedStatus",
"documentation":"<p>The deprecation status of the type versions that you want to get summary information about.</p> <p>Valid values include:</p> <ul> <li> <p> <code>LIVE</code>: The type version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.</p> </li> <li> <p> <code>DEPRECATED</code>: The type version has been deregistered and can no longer be used in CloudFormation operations. </p> </li> </ul> <p>The default is <code>LIVE</code>.</p>"
"documentation":"<p>The deprecation status of the extension versions that you want to get summary information about.</p> <p>Valid values include:</p> <ul> <li> <p> <code>LIVE</code>: The extension version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.</p> </li> <li> <p> <code>DEPRECATED</code>: The extension version has been deregistered and can no longer be used in CloudFormation operations. </p> </li> </ul> <p>The default is <code>LIVE</code>.</p>"
}
}
},
@ -2947,7 +3002,7 @@
"members":{
"TypeVersionSummaries":{
"shape":"TypeVersionSummaries",
"documentation":"<p>A list of <code>TypeVersionSummary</code> structures that contain information about the specified type's versions.</p>"
"documentation":"<p>A list of <code>TypeVersionSummary</code> structures that contain information about the specified extension's versions.</p>"
},
"NextToken":{
"shape":"NextToken",
@ -2960,15 +3015,15 @@
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The scope at which the type is visible and usable in CloudFormation operations.</p> <p>Valid values include:</p> <ul> <li> <p> <code>PRIVATE</code>: The type is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any types you create as <code>PRIVATE</code>.</p> </li> <li> <p> <code>PUBLIC</code>: The type is publically visible and usable within any Amazon account.</p> </li> </ul> <p>The default is <code>PRIVATE</code>.</p>"
"documentation":"<p>The scope at which the extension is visible and usable in CloudFormation operations.</p> <p>Valid values include:</p> <ul> <li> <p> <code>PRIVATE</code>: The extension is only visible and usable within the account in which it is registered. Currently, AWS CloudFormation marks any extension you create as <code>PRIVATE</code>.</p> </li> <li> <p> <code>PUBLIC</code>: The extension is publically visible and usable within any Amazon account.</p> </li> </ul> <p>The default is <code>PRIVATE</code>.</p>"
},
"ProvisioningType":{
"shape":"ProvisioningType",
"documentation":"<p>The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.</p> <p>Valid values include:</p> <ul> <li> <p> <code>FULLY_MUTABLE</code>: The type includes an update handler to process updates to the type during stack update operations.</p> </li> <li> <p> <code>IMMUTABLE</code>: The type does not include an update handler, so the type cannot be updated and must instead be replaced during stack update operations.</p> </li> <li> <p> <code>NON_PROVISIONABLE</code>: The type does not include create, read, and delete handlers, and therefore cannot actually be provisioned.</p> </li> </ul>"
"documentation":"<p>The provisioning behavior of the type. AWS CloudFormation determines the provisioning type during registration, based on the types of handlers in the schema handler package submitted.</p> <p>Valid values include:</p> <ul> <li> <p> <code>FULLY_MUTABLE</code>: The extension includes an update handler to process updates to the extension during stack update operations.</p> </li> <li> <p> <code>IMMUTABLE</code>: The extension does not include an update handler, so the extension cannot be updated and must instead be replaced during stack update operations.</p> </li> <li> <p> <code>NON_PROVISIONABLE</code>: The extension does not include create, read, and delete handlers, and therefore cannot actually be provisioned.</p> </li> </ul>"
},
"DeprecatedStatus":{
"shape":"DeprecatedStatus",
"documentation":"<p>The deprecation status of the types that you want to get summary information about.</p> <p>Valid values include:</p> <ul> <li> <p> <code>LIVE</code>: The type is registered for use in CloudFormation operations.</p> </li> <li> <p> <code>DEPRECATED</code>: The type has been deregistered and can no longer be used in CloudFormation operations. </p> </li> </ul>"
"documentation":"<p>The deprecation status of the extension that you want to get summary information about.</p> <p>Valid values include:</p> <ul> <li> <p> <code>LIVE</code>: The extension is registered for use in CloudFormation operations.</p> </li> <li> <p> <code>DEPRECATED</code>: The extension has been deregistered and can no longer be used in CloudFormation operations. </p> </li> </ul>"
},
"Type":{
"shape":"RegistryType",
@ -2989,7 +3044,7 @@
"members":{
"TypeSummaries":{
"shape":"TypeSummaries",
"documentation":"<p>A list of <code>TypeSummary</code> structures that contain information about the specified types.</p>"
"documentation":"<p>A list of <code>TypeSummary</code> structures that contain information about the specified extensions.</p>"
},
"NextToken":{
"shape":"NextToken",
@ -3405,27 +3460,27 @@
"members":{
"Type":{
"shape":"RegistryType",
"documentation":"<p>The kind of type.</p> <p>Currently, the only valid value is <code>RESOURCE</code>.</p>"
"documentation":"<p>The kind of extension.</p>"
},
"TypeName":{
"shape":"TypeName",
"documentation":"<p>The name of the type being registered.</p> <p>We recommend that type names adhere to the following pattern: <i>company_or_organization</i>::<i>service</i>::<i>type</i>.</p> <note> <p>The following organization namespaces are reserved and cannot be used in your resource type names:</p> <ul> <li> <p> <code>Alexa</code> </p> </li> <li> <p> <code>AMZN</code> </p> </li> <li> <p> <code>Amazon</code> </p> </li> <li> <p> <code>AWS</code> </p> </li> <li> <p> <code>Custom</code> </p> </li> <li> <p> <code>Dev</code> </p> </li> </ul> </note>"
"documentation":"<p>The name of the extension being registered.</p> <p>We recommend that extension names adhere to the following pattern: <i>company_or_organization</i>::<i>service</i>::<i>type</i>.</p> <note> <p>The following organization namespaces are reserved and cannot be used in your extension names:</p> <ul> <li> <p> <code>Alexa</code> </p> </li> <li> <p> <code>AMZN</code> </p> </li> <li> <p> <code>Amazon</code> </p> </li> <li> <p> <code>AWS</code> </p> </li> <li> <p> <code>Custom</code> </p> </li> <li> <p> <code>Dev</code> </p> </li> </ul> </note>"
},
"SchemaHandlerPackage":{
"shape":"S3Url",
"documentation":"<p>A url to the S3 bucket containing the schema handler package that contains the schema, event handlers, and associated files for the type you want to register.</p> <p>For information on generating a schema handler package for the type you want to register, see <a href=\"https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html\">submit</a> in the <i>CloudFormation CLI User Guide</i>.</p> <note> <p>The user registering the resource provider type must be able to access the the schema handler package in the S3 bucket. That is, the user needs to have <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> permissions for the schema handler package. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html\">Actions, Resources, and Condition Keys for Amazon S3</a> in the <i>AWS Identity and Access Management User Guide</i>.</p> </note>"
"documentation":"<p>A url to the S3 bucket containing the extension project package that contains the neccessary files for the extension you want to register.</p> <p>For information on generating a schema handler package for the extension you want to register, see <a href=\"https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-cli-submit.html\">submit</a> in the <i>CloudFormation CLI User Guide</i>.</p> <note> <p>The user registering the extension must be able to access the package in the S3 bucket. That is, the user needs to have <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> permissions for the schema handler package. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/list_amazons3.html\">Actions, Resources, and Condition Keys for Amazon S3</a> in the <i>AWS Identity and Access Management User Guide</i>.</p> </note>"
},
"LoggingConfig":{
"shape":"LoggingConfig",
"documentation":"<p>Specifies logging configuration information for a type.</p>"
"documentation":"<p>Specifies logging configuration information for an extension.</p>"
},
"ExecutionRoleArn":{
"shape":"RoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the resource provider. If your resource type calls AWS APIs in any of its handlers, you must create an <i> <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html\">IAM execution role</a> </i> that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the resource provider handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the resource provider handler, thereby supplying your resource provider with the appropriate credentials.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role for CloudFormation to assume when invoking the extension. If your extension calls AWS APIs in any of its handlers, you must create an <i> <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html\">IAM execution role</a> </i> that includes the necessary permissions to call those AWS APIs, and provision that execution role in your account. When CloudFormation needs to invoke the extension handler, CloudFormation assumes this execution role to create a temporary session token, which it then passes to the extension handler, thereby supplying your extension with the appropriate credentials.</p>"
},
"ClientRequestToken":{
"shape":"RequestToken",
"documentation":"<p>A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of a type from the same registeration request, even if the request is submitted multiple times. </p>"
"documentation":"<p>A unique identifier that acts as an idempotency key for this registration request. Specifying a client request token prevents CloudFormation from generating more than one version of an extension from the same registeration request, even if the request is submitted multiple times. </p>"
}
}
},
@ -3434,7 +3489,7 @@
"members":{
"RegistrationToken":{
"shape":"RegistrationToken",
"documentation":"<p>The identifier for this registration request.</p> <p>Use this registration token when calling <code> <a>DescribeTypeRegistration</a> </code>, which returns information about the status and IDs of the type registration. </p>"
"documentation":"<p>The identifier for this registration request.</p> <p>Use this registration token when calling <code> <a>DescribeTypeRegistration</a> </code>, which returns information about the status and IDs of the extension registration. </p>"
}
}
},
@ -3798,19 +3853,19 @@
"members":{
"Arn":{
"shape":"PrivateTypeArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the type for which you want version summary information.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the extension for which you want version summary information.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
},
"Type":{
"shape":"RegistryType",
"documentation":"<p>The kind of type.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
"documentation":"<p>The kind of extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
},
"TypeName":{
"shape":"TypeName",
"documentation":"<p>The name of the type.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
"documentation":"<p>The name of the extension.</p> <p>Conditional: You must specify either <code>TypeName</code> and <code>Type</code>, or <code>Arn</code>.</p>"
},
"VersionId":{
"shape":"TypeVersionId",
"documentation":"<p>The ID of a specific version of the type. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the type version when it is registered.</p>"
"documentation":"<p>The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.</p>"
}
}
},
@ -4073,7 +4128,7 @@
},
"Account":{
"shape":"Account",
"documentation":"<p>[<code>Self-managed</code> permissions] The name of the AWS account that the stack instance is associated with.</p>"
"documentation":"<p>[Self-managed permissions] The name of the AWS account that the stack instance is associated with.</p>"
},
"StackId":{
"shape":"StackId",
@ -4097,7 +4152,7 @@
},
"OrganizationalUnitId":{
"shape":"OrganizationalUnitId",
"documentation":"<p>[<code>Service-managed</code> permissions] The organization root ID or organizational unit (OU) IDs that you specified for <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html\">DeploymentTargets</a>.</p>"
"documentation":"<p>[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html\">DeploymentTargets</a>.</p>"
},
"DriftStatus":{
"shape":"StackDriftStatus",
@ -4196,7 +4251,7 @@
},
"Account":{
"shape":"Account",
"documentation":"<p>[<code>Self-managed</code> permissions] The name of the AWS account that the stack instance is associated with.</p>"
"documentation":"<p>[Self-managed permissions] The name of the AWS account that the stack instance is associated with.</p>"
},
"StackId":{
"shape":"StackId",
@ -4216,7 +4271,7 @@
},
"OrganizationalUnitId":{
"shape":"OrganizationalUnitId",
"documentation":"<p>[<code>Service-managed</code> permissions] The organization root ID or organizational unit (OU) IDs that you specified for <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html\">DeploymentTargets</a>.</p>"
"documentation":"<p>[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html\">DeploymentTargets</a>.</p>"
},
"DriftStatus":{
"shape":"StackDriftStatus",
@ -4582,7 +4637,7 @@
},
"AutoDeployment":{
"shape":"AutoDeployment",
"documentation":"<p>[<code>Service-managed</code> permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).</p>"
"documentation":"<p>[Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).</p>"
},
"PermissionModel":{
"shape":"PermissionModels",
@ -4590,7 +4645,7 @@
},
"OrganizationalUnitIds":{
"shape":"OrganizationalUnitIdList",
"documentation":"<p>[<code>Service-managed</code> permissions] The organization root ID or organizational unit (OU) IDs that you specified for <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html\">DeploymentTargets</a>.</p>"
"documentation":"<p>[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html\">DeploymentTargets</a>.</p>"
}
},
"documentation":"<p>A structure that contains information about a stack set. A stack set enables you to provision stacks into AWS accounts and across Regions by using a single CloudFormation template. In the stack set, you specify the template to use, as well as any parameters and capabilities that the template requires. </p>"
@ -4699,7 +4754,7 @@
},
"Status":{
"shape":"StackSetOperationStatus",
"documentation":"<p>The status of the operation. </p> <ul> <li> <p> <code>FAILED</code>: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to <code>FAILED</code>. This in turn sets the status of the operation as a whole to <code>FAILED</code>, and AWS CloudFormation cancels the operation in any remaining Regions.</p> </li> <li> <p> <code>QUEUED</code>: [<code>Service-managed</code> permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes\">stack set operation status codes</a> in the AWS CloudFormation User Guide.</p> </li> <li> <p> <code>RUNNING</code>: The operation is currently being performed.</p> </li> <li> <p> <code>STOPPED</code>: The user has cancelled the operation.</p> </li> <li> <p> <code>STOPPING</code>: The operation is in the process of stopping, at user request. </p> </li> <li> <p> <code>SUCCEEDED</code>: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.</p> </li> </ul>"
"documentation":"<p>The status of the operation. </p> <ul> <li> <p> <code>FAILED</code>: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to <code>FAILED</code>. This in turn sets the status of the operation as a whole to <code>FAILED</code>, and AWS CloudFormation cancels the operation in any remaining Regions.</p> </li> <li> <p> <code>QUEUED</code>: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes\">stack set operation status codes</a> in the AWS CloudFormation User Guide.</p> </li> <li> <p> <code>RUNNING</code>: The operation is currently being performed.</p> </li> <li> <p> <code>STOPPED</code>: The user has cancelled the operation.</p> </li> <li> <p> <code>STOPPING</code>: The operation is in the process of stopping, at user request. </p> </li> <li> <p> <code>SUCCEEDED</code>: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.</p> </li> </ul>"
},
"OperationPreferences":{
"shape":"StackSetOperationPreferences",
@ -4727,7 +4782,7 @@
},
"DeploymentTargets":{
"shape":"DeploymentTargets",
"documentation":"<p>[<code>Service-managed</code> permissions] The AWS Organizations accounts affected by the stack operation.</p>"
"documentation":"<p>[Service-managed permissions] The AWS Organizations accounts affected by the stack operation.</p>"
},
"StackSetDriftDetectionDetails":{
"shape":"StackSetDriftDetectionDetails",
@ -4790,7 +4845,7 @@
"members":{
"Account":{
"shape":"Account",
"documentation":"<p>[<code>Self-managed</code> permissions] The name of the AWS account for this operation result.</p>"
"documentation":"<p>[Self-managed permissions] The name of the AWS account for this operation result.</p>"
},
"Region":{
"shape":"Region",
@ -4810,7 +4865,7 @@
},
"OrganizationalUnitId":{
"shape":"OrganizationalUnitId",
"documentation":"<p>[<code>Service-managed</code> permissions] The organization root ID or organizational unit (OU) IDs that you specified for <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html\">DeploymentTargets</a>.</p>"
"documentation":"<p>[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/APIReference/API_DeploymentTargets.html\">DeploymentTargets</a>.</p>"
}
},
"documentation":"<p>The structure that contains information about a specified operation's results for a given account in a given Region.</p>"
@ -4843,7 +4898,7 @@
},
"Status":{
"shape":"StackSetOperationStatus",
"documentation":"<p>The overall status of the operation.</p> <ul> <li> <p> <code>FAILED</code>: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to <code>FAILED</code>. This in turn sets the status of the operation as a whole to <code>FAILED</code>, and AWS CloudFormation cancels the operation in any remaining Regions.</p> </li> <li> <p> <code>QUEUED</code>: [<code>Service-managed</code> permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes\">stack set operation status codes</a> in the AWS CloudFormation User Guide.</p> </li> <li> <p> <code>RUNNING</code>: The operation is currently being performed.</p> </li> <li> <p> <code>STOPPED</code>: The user has cancelled the operation.</p> </li> <li> <p> <code>STOPPING</code>: The operation is in the process of stopping, at user request. </p> </li> <li> <p> <code>SUCCEEDED</code>: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.</p> </li> </ul>"
"documentation":"<p>The overall status of the operation.</p> <ul> <li> <p> <code>FAILED</code>: The operation exceeded the specified failure tolerance. The failure tolerance value that you've set for an operation is applied for each Region during stack create and update operations. If the number of failed stacks within a Region exceeds the failure tolerance, the status of the operation in the Region is set to <code>FAILED</code>. This in turn sets the status of the operation as a whole to <code>FAILED</code>, and AWS CloudFormation cancels the operation in any remaining Regions.</p> </li> <li> <p> <code>QUEUED</code>: [Service-managed permissions] For automatic deployments that require a sequence of operations, the operation is queued to be performed. For more information, see the <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-concepts.html#stackset-status-codes\">stack set operation status codes</a> in the AWS CloudFormation User Guide.</p> </li> <li> <p> <code>RUNNING</code>: The operation is currently being performed.</p> </li> <li> <p> <code>STOPPED</code>: The user has cancelled the operation.</p> </li> <li> <p> <code>STOPPING</code>: The operation is in the process of stopping, at user request. </p> </li> <li> <p> <code>SUCCEEDED</code>: The operation completed creating or updating all the specified stacks without exceeding the failure tolerance for the operation.</p> </li> </ul>"
},
"CreationTimestamp":{
"shape":"Timestamp",
@ -4888,7 +4943,7 @@
},
"AutoDeployment":{
"shape":"AutoDeployment",
"documentation":"<p>[<code>Service-managed</code> permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organizational unit (OU).</p>"
"documentation":"<p>[Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organizational unit (OU).</p>"
},
"PermissionModel":{
"shape":"PermissionModels",
@ -5034,6 +5089,10 @@
"OperationId":{
"shape":"ClientRequestToken",
"documentation":"<p>The ID of the stack operation. </p>"
},
"CallAs":{
"shape":"CallAs",
"documentation":"<p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your AWS account must be registered as a delegated administrator in the management account. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html\">Register a delegated administrator</a> in the <i>AWS CloudFormation User Guide</i>.</p> </li> </ul>"
}
}
},
@ -5266,7 +5325,7 @@
},
"TemplateURL":{
"shape":"TemplateURL",
"documentation":"<p>Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>, <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>"
"documentation":"<p>Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>, <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>"
},
"UsePreviousTemplate":{
"shape":"UsePreviousTemplate",
@ -5336,11 +5395,11 @@
},
"Accounts":{
"shape":"AccountList",
"documentation":"<p>[<code>Self-managed</code> permissions] The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
"documentation":"<p>[Self-managed permissions] The names of one or more AWS accounts for which you want to update parameter values for stack instances. The overridden parameter values will be applied to all stack instances in the specified accounts and Regions.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
},
"DeploymentTargets":{
"shape":"DeploymentTargets",
"documentation":"<p>[<code>Service-managed</code> permissions] The AWS Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
"documentation":"<p>[Service-managed permissions] The AWS Organizations accounts for which you want to update parameter values for stack instances. If your update targets OUs, the overridden parameter values only apply to the accounts that are currently in the target OUs and their child OUs. Accounts added to the target OUs and their child OUs in the future won't use the overridden values.</p> <p>You can specify <code>Accounts</code> or <code>DeploymentTargets</code>, but not both.</p>"
},
"Regions":{
"shape":"RegionList",
@ -5358,6 +5417,10 @@
"shape":"ClientRequestToken",
"documentation":"<p>The unique identifier for this stack set operation. </p> <p>The operation ID also functions as an idempotency token, to ensure that AWS CloudFormation performs the stack set operation only once, even if you retry the request multiple times. You might retry stack set operation requests to ensure that AWS CloudFormation successfully received them.</p> <p>If you don't specify an operation ID, the SDK generates one automatically. </p>",
"idempotencyToken":true
},
"CallAs":{
"shape":"CallAs",
"documentation":"<p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your AWS account must be registered as a delegated administrator in the management account. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html\">Register a delegated administrator</a> in the <i>AWS CloudFormation User Guide</i>.</p> </li> </ul>"
}
}
},
@ -5398,7 +5461,7 @@
},
"TemplateURL":{
"shape":"TemplateURL",
"documentation":"<p>The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true. </p>"
"documentation":"<p>The location of the file that contains the template body. The URL must point to a template (maximum size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code> or <code>TemplateURL</code>—or set <code>UsePreviousTemplate</code> to true. </p>"
},
"UsePreviousTemplate":{
"shape":"UsePreviousTemplate",
@ -5430,7 +5493,7 @@
},
"DeploymentTargets":{
"shape":"DeploymentTargets",
"documentation":"<p>[<code>Service-managed</code> permissions] The AWS Organizations accounts in which to update associated stack instances.</p> <p>To update all the stack instances associated with this stack set, do not specify <code>DeploymentTargets</code> or <code>Regions</code>.</p> <p>If the stack set update includes changes to the template (that is, if <code>TemplateBody</code> or <code>TemplateURL</code> is specified), or the <code>Parameters</code>, AWS CloudFormation marks all stack instances with a status of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.</p>"
"documentation":"<p>[Service-managed permissions] The AWS Organizations accounts in which to update associated stack instances.</p> <p>To update all the stack instances associated with this stack set, do not specify <code>DeploymentTargets</code> or <code>Regions</code>.</p> <p>If the stack set update includes changes to the template (that is, if <code>TemplateBody</code> or <code>TemplateURL</code> is specified), or the <code>Parameters</code>, AWS CloudFormation marks all stack instances with a status of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status.</p>"
},
"PermissionModel":{
"shape":"PermissionModels",
@ -5438,7 +5501,7 @@
},
"AutoDeployment":{
"shape":"AutoDeployment",
"documentation":"<p>[<code>Service-managed</code> permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).</p> <p>If you specify <code>AutoDeployment</code>, do not specify <code>DeploymentTargets</code> or <code>Regions</code>.</p>"
"documentation":"<p>[Service-managed permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).</p> <p>If you specify <code>AutoDeployment</code>, do not specify <code>DeploymentTargets</code> or <code>Regions</code>.</p>"
},
"OperationId":{
"shape":"ClientRequestToken",
@ -5447,11 +5510,15 @@
},
"Accounts":{
"shape":"AccountList",
"documentation":"<p>[<code>Self-managed</code> permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Regions in which to update stack set instances.</p> <p>To update <i>all</i> the stack instances associated with this stack set, do not specify the <code>Accounts</code> or <code>Regions</code> properties.</p> <p>If the stack set update includes changes to the template (that is, if the <code>TemplateBody</code> or <code>TemplateURL</code> properties are specified), or the <code>Parameters</code> property, AWS CloudFormation marks all stack instances with a status of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status. </p>"
"documentation":"<p>[Self-managed permissions] The accounts in which to update associated stack instances. If you specify accounts, you must also specify the Regions in which to update stack set instances.</p> <p>To update <i>all</i> the stack instances associated with this stack set, do not specify the <code>Accounts</code> or <code>Regions</code> properties.</p> <p>If the stack set update includes changes to the template (that is, if the <code>TemplateBody</code> or <code>TemplateURL</code> properties are specified), or the <code>Parameters</code> property, AWS CloudFormation marks all stack instances with a status of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status. </p>"
},
"Regions":{
"shape":"RegionList",
"documentation":"<p>The Regions in which to update associated stack instances. If you specify Regions, you must also specify accounts in which to update stack set instances.</p> <p>To update <i>all</i> the stack instances associated with this stack set, do not specify the <code>Accounts</code> or <code>Regions</code> properties.</p> <p>If the stack set update includes changes to the template (that is, if the <code>TemplateBody</code> or <code>TemplateURL</code> properties are specified), or the <code>Parameters</code> property, AWS CloudFormation marks all stack instances with a status of <code>OUTDATED</code> prior to updating the stack instances in the specified accounts and Regions. If the stack set update does not include changes to the template or parameters, AWS CloudFormation updates the stack instances in the specified accounts and Regions, while leaving all other stack instances with their existing stack instance status. </p>"
},
"CallAs":{
"shape":"CallAs",
"documentation":"<p>[Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account.</p> <p>By default, <code>SELF</code> is specified. Use <code>SELF</code> for stack sets with self-managed permissions.</p> <ul> <li> <p>If you are signed in to the management account, specify <code>SELF</code>.</p> </li> <li> <p>If you are signed in to a delegated administrator account, specify <code>DELEGATED_ADMIN</code>.</p> <p>Your AWS account must be registered as a delegated administrator in the management account. For more information, see <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html\">Register a delegated administrator</a> in the <i>AWS CloudFormation User Guide</i>.</p> </li> </ul>"
}
}
},
@ -5502,7 +5569,7 @@
},
"TemplateURL":{
"shape":"TemplateURL",
"documentation":"<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket. For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>"
"documentation":"<p>Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that is located in an Amazon S3 bucket or a Systems Manager document. For more information, go to <a href=\"https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must pass <code>TemplateURL</code> or <code>TemplateBody</code>. If both are passed, only <code>TemplateBody</code> is used.</p>"
}
},
"documentation":"<p>The input for <a>ValidateTemplate</a> action.</p>"

16
botocore/data/cloudtrail/2013-11-01/service-2.json
View file

@ -91,7 +91,8 @@
{"shape":"UnsupportedOperationException"},
{"shape":"OperationNotPermittedException"},
{"shape":"NotOrganizationMasterAccountException"},
{"shape":"InsufficientDependencyServiceAccessPermissionException"}
{"shape":"InsufficientDependencyServiceAccessPermissionException"},
{"shape":"ConflictException"}
],
"documentation":"<p>Deletes a trail. This operation must be called from the region in which the trail was created. <code>DeleteTrail</code> cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.</p>",
"idempotent":true
@ -289,6 +290,8 @@
{"shape":"InvalidInsightSelectorsException"},
{"shape":"InsufficientS3BucketPolicyException"},
{"shape":"InsufficientEncryptionPolicyException"},
{"shape":"S3BucketDoesNotExistException"},
{"shape":"KmsException"},
{"shape":"UnsupportedOperationException"},
{"shape":"OperationNotPermittedException"},
{"shape":"NotOrganizationMasterAccountException"}
@ -446,7 +449,7 @@
"members":{
"Field":{
"shape":"SelectorField",
"documentation":"<p> A field in an event record on which to filter events to be logged. Supported fields include <code>readOnly</code>, <code>eventCategory</code>, <code>eventSource</code> (for management events), <code>eventName</code>, <code>resources.type</code>, and <code>resources.ARN</code>. </p> <ul> <li> <p> <b> <code>readOnly</code> </b> - Optional. Can be set to <code>Equals</code> a value of <code>true</code> or <code>false</code>. A value of <code>false</code> logs both <code>read</code> and <code>write</code> events.</p> </li> <li> <p> <b> <code>eventSource</code> </b> - For filtering management events only. This can be set only to <code>NotEquals</code> <code>kms.amazonaws.com</code>.</p> </li> <li> <p> <b> <code>eventName</code> </b> - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as <code>PutBucket</code>. You can have multiple values for this field, separated by commas.</p> </li> <li> <p> <b> <code>eventCategory</code> </b> - This is required. It must be set to <code>Equals</code>, and the value must be <code>Management</code> or <code>Data</code>.</p> </li> <li> <p> <b> <code>resources.type</code> </b> - This field is required. <code>resources.type</code> can only use the <code>Equals</code> operator, and the value can be one of the following: <code>AWS::S3::Object</code> or <code>AWS::Lambda::Function</code>. You can have only one <code>resources.type</code> field per selector. To log data events on more than one resource type, add another selector.</p> </li> <li> <p> <b> <code>resources.ARN</code> </b> - You can use any operator with resources.ARN, but if you use <code>Equals</code> or <code>NotEquals</code>, the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals <code>AWS::S3::Object</code>, the ARN must be in one of the following formats. The trailing slash is intentional; do not exclude it.</p> <ul> <li> <p> <code>arn:partition:s3:::bucket_name/</code> </p> </li> <li> <p> <code>arn:partition:s3:::bucket_name/object_or_file_name/</code> </p> </li> </ul> <p>When resources.type equals <code>AWS::Lambda::Function</code>, and the operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the following format:</p> <ul> <li> <p> <code>arn:partition:lambda:region:account_ID:function:function_name</code> </p> </li> </ul> </li> </ul>"
"documentation":"<p> A field in an event record on which to filter events to be logged. Supported fields include <code>readOnly</code>, <code>eventCategory</code>, <code>eventSource</code> (for management events), <code>eventName</code>, <code>resources.type</code>, and <code>resources.ARN</code>. </p> <ul> <li> <p> <b> <code>readOnly</code> </b> - Optional. Can be set to <code>Equals</code> a value of <code>true</code> or <code>false</code>. A value of <code>false</code> logs both <code>read</code> and <code>write</code> events.</p> </li> <li> <p> <b> <code>eventSource</code> </b> - For filtering management events only. This can be set only to <code>NotEquals</code> <code>kms.amazonaws.com</code>.</p> </li> <li> <p> <b> <code>eventName</code> </b> - Can use any operator. You can use it to filter in or filter out any data event logged to CloudTrail, such as <code>PutBucket</code>. You can have multiple values for this field, separated by commas.</p> </li> <li> <p> <b> <code>eventCategory</code> </b> - This is required. It must be set to <code>Equals</code>, and the value must be <code>Management</code> or <code>Data</code>.</p> </li> <li> <p> <b> <code>resources.type</code> </b> - This field is required. <code>resources.type</code> can only use the <code>Equals</code> operator, and the value can be one of the following: <code>AWS::S3::Object</code>, <code>AWS::Lambda::Function</code>, or <code>AWS::S3Outposts::Object</code>. You can have only one <code>resources.type</code> field per selector. To log data events on more than one resource type, add another selector.</p> </li> <li> <p> <b> <code>resources.ARN</code> </b> - You can use any operator with resources.ARN, but if you use <code>Equals</code> or <code>NotEquals</code>, the value must exactly match the ARN of a valid resource of the type you've specified in the template as the value of resources.type. For example, if resources.type equals <code>AWS::S3::Object</code>, the ARN must be in one of the following formats. The trailing slash is intentional; do not exclude it.</p> <ul> <li> <p> <code>arn:partition:s3:::bucket_name/</code> </p> </li> <li> <p> <code>arn:partition:s3:::bucket_name/object_or_file_name/</code> </p> </li> </ul> <p>When resources.type equals <code>AWS::Lambda::Function</code>, and the operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the following format:</p> <ul> <li> <p> <code>arn:partition:lambda:region:account_ID:function:function_name</code> </p> </li> </ul> <p>When <code>resources.type</code> equals <code>AWS::S3Outposts::Object</code>, and the operator is set to <code>Equals</code> or <code>NotEquals</code>, the ARN must be in the following format:</p> <ul> <li> <p> <code>arn:partition:s3-outposts:region:&gt;account_ID:object_path</code> </p> </li> </ul> </li> </ul>"
},
"Equals":{
"shape":"Operator",
@ -510,6 +513,13 @@
"documentation":"<p>Cannot set a CloudWatch Logs delivery for this region.</p>",
"exception":true
},
"ConflictException":{
"type":"structure",
"members":{
},
"documentation":"<p>This exception is thrown when the specified resource is not ready for an operation. This can occur when you try to run an operation on a trail before CloudTrail has time to fully load the trail. If this exception occurs, wait a few minutes, and then try the operation again.</p>",
"exception":true
},
"CreateTrailRequest":{
"type":"structure",
"required":[
@ -629,7 +639,7 @@
"members":{
"Type":{
"shape":"String",
"documentation":"<p>The resource type in which you want to log data events. You can specify <code>AWS::S3::Object</code> or <code>AWS::Lambda::Function</code> resources.</p>"
"documentation":"<p>The resource type in which you want to log data events. You can specify <code>AWS::S3::Object</code> or <code>AWS::Lambda::Function</code> resources.</p> <p>The <code>AWS::S3Outposts::Object</code> resource type is not valid in basic event selectors. To log data events on this resource type, use advanced event selectors.</p>"
},
"Values":{
"shape":"DataResourceValues",

96
botocore/data/codeartifact/2018-09-22/service-2.json
View file

File diff suppressed because one or more lines are too long

162
botocore/data/codebuild/2016-10-06/service-2.json
View file

File diff suppressed because one or more lines are too long

56
botocore/data/codedeploy/2014-10-06/service-2.json
View file

@ -1535,6 +1535,10 @@
"shape":"AutoRollbackConfiguration",
"documentation":"<p>Configuration information for an automatic rollback that is added when a deployment group is created.</p>"
},
"outdatedInstancesStrategy":{
"shape":"OutdatedInstancesStrategy",
"documentation":"<p>Indicates what happens when new EC2 instances are launched mid-deployment and do not receive the deployed application revision.</p> <p>If this option is set to <code>UPDATE</code> or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new EC2 instances.</p> <p>If this option is set to <code>IGNORE</code>, CodeDeploy does not initiate a deployment to update the new EC2 instances. This may result in instances having different revisions.</p>"
},
"deploymentStyle":{
"shape":"DeploymentStyle",
"documentation":"<p>Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.</p>"
@ -1813,6 +1817,7 @@
"autoscaling",
"codeDeployRollback",
"CodeDeploy",
"CodeDeployAutoUpdate",
"CloudFormation",
"CloudFormationRollback"
]
@ -1894,6 +1899,10 @@
"shape":"DeploymentStyle",
"documentation":"<p>Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.</p>"
},
"outdatedInstancesStrategy":{
"shape":"OutdatedInstancesStrategy",
"documentation":"<p>Indicates what happens when new EC2 instances are launched mid-deployment and do not receive the deployed application revision.</p> <p>If this option is set to <code>UPDATE</code> or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new EC2 instances.</p> <p>If this option is set to <code>IGNORE</code>, CodeDeploy does not initiate a deployment to update the new EC2 instances. This may result in instances having different revisions.</p>"
},
"blueGreenDeploymentConfiguration":{
"shape":"BlueGreenDeploymentConfiguration",
"documentation":"<p>Information about blue/green deployment options for a deployment group.</p>"
@ -2021,7 +2030,7 @@
},
"creator":{
"shape":"DeploymentCreator",
"documentation":"<p>The means by which the deployment was created:</p> <ul> <li> <p> <code>user</code>: A user created the deployment.</p> </li> <li> <p> <code>autoscaling</code>: Amazon EC2 Auto Scaling created the deployment.</p> </li> <li> <p> <code>codeDeployRollback</code>: A rollback process created the deployment.</p> </li> </ul>"
"documentation":"<p>The means by which the deployment was created:</p> <ul> <li> <p> <code>user</code>: A user created the deployment.</p> </li> <li> <p> <code>autoscaling</code>: Amazon EC2 Auto Scaling created the deployment.</p> </li> <li> <p> <code>codeDeployRollback</code>: A rollback process created the deployment.</p> </li> <li> <p> <code>CodeDeployAutoUpdate</code>: An auto-update process created the deployment when it detected outdated EC2 instances.</p> </li> </ul>"
},
"ignoreApplicationStopFailures":{
"shape":"Boolean",
@ -2078,7 +2087,8 @@
"externalId":{
"shape":"ExternalId",
"documentation":"<p>The unique ID for an external resource (for example, a CloudFormation stack ID) that is linked to this deployment.</p>"
}
},
"relatedDeployments":{"shape":"RelatedDeployments"}
},
"documentation":"<p>Information about a deployment.</p>"
},
@ -3120,13 +3130,6 @@
"documentation":"<p>The deployed state filter was specified in an invalid format.</p>",
"exception":true
},
"InvalidDeploymentConfigIdException":{
"type":"structure",
"members":{
},
"documentation":"<p> The ID of the deployment configuration is invalid. </p>",
"exception":true
},
"InvalidDeploymentConfigNameException":{
"type":"structure",
"members":{
@ -3970,13 +3973,13 @@
"MinimumHealthyHosts":{
"type":"structure",
"members":{
"value":{
"shape":"MinimumHealthyHostsValue",
"documentation":"<p>The minimum healthy instance value.</p>"
},
"type":{
"shape":"MinimumHealthyHostsType",
"documentation":"<p>The minimum healthy instance type:</p> <ul> <li> <p> <code>HOST_COUNT</code>: The minimum number of healthy instances as an absolute value.</p> </li> <li> <p> <code>FLEET_PERCENT</code>: The minimum number of healthy instances as a percentage of the total number of instances in the deployment.</p> </li> </ul> <p>In an example of nine instances, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment is successful if six or more instances are deployed to successfully. Otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instances at a time. The deployment is successful if four or more instances are deployed to successfully. Otherwise, the deployment fails.</p> <note> <p>In a call to the <code>GetDeploymentConfig</code>, CodeDeployDefault.OneAtATime returns a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, AWS CodeDeploy attempts to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment is still successful.</p> </note> <p>For more information, see <a href=\"https://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html\">AWS CodeDeploy Instance Health</a> in the <i>AWS CodeDeploy User Guide</i>.</p>"
},
"value":{
"shape":"MinimumHealthyHostsValue",
"documentation":"<p>The minimum healthy instance value.</p>"
}
},
"documentation":"<p>Information about minimum healthy instance.</p>"
@ -4019,6 +4022,13 @@
"documentation":"<p>The API used does not support the deployment.</p>",
"exception":true
},
"OutdatedInstancesStrategy":{
"type":"string",
"enum":[
"UPDATE",
"IGNORE"
]
},
"Percentage":{"type":"integer"},
"PutLifecycleEventHookExecutionStatusInput":{
"type":"structure",
@ -4033,7 +4043,7 @@
},
"status":{
"shape":"LifecycleEventStatus",
"documentation":"<p>The result of a Lambda function that validates a deployment lifecycle event (<code>Succeeded</code> or <code>Failed</code>).</p>"
"documentation":"<p>The result of a Lambda function that validates a deployment lifecycle event. <code>Succeeded</code> and <code>Failed</code> are the only valid values for <code>status</code>.</p>"
}
}
},
@ -4112,6 +4122,20 @@
"Deregistered"
]
},
"RelatedDeployments":{
"type":"structure",
"members":{
"autoUpdateOutdatedInstancesRootDeploymentId":{
"shape":"DeploymentId",
"documentation":"<p>The deployment ID of the root deployment that triggered this deployment.</p>"
},
"autoUpdateOutdatedInstancesDeploymentIds":{
"shape":"DeploymentsList",
"documentation":"<p>The deployment IDs of 'auto-update outdated instances' deployments triggered by this deployment.</p>"
}
},
"documentation":"<p>Information about deployments related to the specified deployment.</p>"
},
"RemoveTagsFromOnPremisesInstancesInput":{
"type":"structure",
"required":[
@ -4742,6 +4766,10 @@
"shape":"AutoRollbackConfiguration",
"documentation":"<p>Information for an automatic rollback configuration that is added or changed when a deployment group is updated.</p>"
},
"outdatedInstancesStrategy":{
"shape":"OutdatedInstancesStrategy",
"documentation":"<p>Indicates what happens when new EC2 instances are launched mid-deployment and do not receive the deployed application revision.</p> <p>If this option is set to <code>UPDATE</code> or is unspecified, CodeDeploy initiates one or more 'auto-update outdated instances' deployments to apply the deployed application revision to the new EC2 instances.</p> <p>If this option is set to <code>IGNORE</code>, CodeDeploy does not initiate a deployment to update the new EC2 instances. This may result in instances having different revisions.</p>"
},
"deploymentStyle":{
"shape":"DeploymentStyle",
"documentation":"<p>Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.</p>"

50
botocore/data/codeguruprofiler/2019-07-18/service-2.json
View file

@ -63,7 +63,7 @@
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p> Used by profiler agents to report their current state and to receive remote configuration updates. For example, <code>ConfigureAgent</code> can be used to tell and agent whether to profile or not and for how long to return profiling data. </p>"
"documentation":"<p> Used by profiler agents to report their current state and to receive remote configuration updates. For example, <code>ConfigureAgent</code> can be used to tell an agent whether to profile or not and for how long to return profiling data. </p>"
},
"CreateProfilingGroup":{
"name":"CreateProfilingGroup",
@ -95,6 +95,7 @@
"output":{"shape":"DeleteProfilingGroupResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ConflictException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"}
@ -480,11 +481,11 @@
"AgentParameterField":{
"type":"string",
"enum":[
"MaxStackDepth",
"MemoryUsageLimitPercent",
"MinimumTimeForReportingInMilliseconds",
"SamplingIntervalInMilliseconds",
"ReportingIntervalInMilliseconds",
"SamplingIntervalInMilliseconds"
"MinimumTimeForReportingInMilliseconds",
"MemoryUsageLimitPercent",
"MaxStackDepth"
]
},
"AgentParameters":{
@ -511,9 +512,9 @@
"AggregationPeriod":{
"type":"string",
"enum":[
"P1D",
"PT5M",
"PT1H",
"PT5M"
"P1D"
]
},
"Anomalies":{
@ -705,8 +706,8 @@
"ComputePlatform":{
"type":"string",
"enum":[
"AWSLambda",
"Default"
"Default",
"AWSLambda"
]
},
"ConfigureAgentRequest":{
@ -861,8 +862,8 @@
"FeedbackType":{
"type":"string",
"enum":[
"Negative",
"Positive"
"Positive",
"Negative"
]
},
"FindingsReportId":{
@ -946,9 +947,13 @@
},
"documentation":"<p> Information about a frame metric and its values. </p>"
},
"FrameMetricValue":{
"type":"double",
"box":true
},
"FrameMetricValues":{
"type":"list",
"member":{"shape":"Double"}
"member":{"shape":"FrameMetricValue"}
},
"FrameMetrics":{
"type":"list",
@ -1199,7 +1204,8 @@
"documentation":"<p>The server encountered an internal error and is unable to complete the request.</p>",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true
"fault":true,
"retryable":{"throttling":false}
},
"ListFindingsReportsRequest":{
"type":"structure",
@ -1446,15 +1452,15 @@
"MetadataField":{
"type":"string",
"enum":[
"ComputePlatform",
"AgentId",
"AwsRequestId",
"ComputePlatform",
"ExecutionEnvironment",
"LambdaFunctionArn",
"LambdaMemoryLimitInMB",
"LambdaPreviousExecutionTimeInMilliseconds",
"LambdaRemainingTimeInMilliseconds",
"LambdaTimeGapBetweenInvokesInMilliseconds"
"LambdaTimeGapBetweenInvokesInMilliseconds",
"LambdaPreviousExecutionTimeInMilliseconds"
]
},
"Metric":{
@ -1497,8 +1503,8 @@
"OrderBy":{
"type":"string",
"enum":[
"TimestampAscending",
"TimestampDescending"
"TimestampDescending",
"TimestampAscending"
]
},
"PaginationToken":{
@ -1882,7 +1888,8 @@
"httpStatusCode":402,
"senderFault":true
},
"exception":true
"exception":true,
"retryable":{"throttling":false}
},
"String":{"type":"string"},
"Strings":{
@ -1982,7 +1989,8 @@
"httpStatusCode":429,
"senderFault":true
},
"exception":true
"exception":true,
"retryable":{"throttling":false}
},
"Timestamp":{
"type":"timestamp",
@ -2087,5 +2095,5 @@
"exception":true
}
},
"documentation":"<p>This section provides documentation for the Amazon CodeGuru Profiler API operations.</p> <pre><code> &lt;p&gt;Amazon CodeGuru Profiler collects runtime performance data from your live applications, and provides recommendations that can help you fine-tune your application performance. Using machine learning algorithms, CodeGuru Profiler can help you find your most expensive lines of code and suggest ways you can improve efficiency and remove CPU bottlenecks. &lt;/p&gt; &lt;p&gt;Amazon CodeGuru Profiler provides different visualizations of profiling data to help you identify what code is running on the CPU, see how much time is consumed, and suggest ways to reduce CPU utilization. &lt;/p&gt; &lt;note&gt; &lt;p&gt;Amazon CodeGuru Profiler currently supports applications written in all Java virtual machine (JVM) languages. While CodeGuru Profiler supports both visualizations and recommendations for applications written in Java, it can also generate visualizations and a subset of recommendations for applications written in other JVM languages.&lt;/p&gt; &lt;/note&gt; &lt;p&gt; For more information, see &lt;a href=&quot;https://docs.aws.amazon.com/codeguru/latest/profiler-ug/what-is-codeguru-profiler.html&quot;&gt;What is Amazon CodeGuru Profiler&lt;/a&gt; in the &lt;i&gt;Amazon CodeGuru Profiler User Guide&lt;/i&gt;. &lt;/p&gt; </code></pre>"
"documentation":"<p> This section provides documentation for the Amazon CodeGuru Profiler API operations. </p> <p> Amazon CodeGuru Profiler collects runtime performance data from your live applications, and provides recommendations that can help you fine-tune your application performance. Using machine learning algorithms, CodeGuru Profiler can help you find your most expensive lines of code and suggest ways you can improve efficiency and remove CPU bottlenecks. </p> <p> Amazon CodeGuru Profiler provides different visualizations of profiling data to help you identify what code is running on the CPU, see how much time is consumed, and suggest ways to reduce CPU utilization. </p> <note> <p>Amazon CodeGuru Profiler currently supports applications written in all Java virtual machine (JVM) languages and Python. While CodeGuru Profiler supports both visualizations and recommendations for applications written in Java, it can also generate visualizations and a subset of recommendations for applications written in other JVM languages and Python.</p> </note> <p> For more information, see <a href=\"https://docs.aws.amazon.com/codeguru/latest/profiler-ug/what-is-codeguru-profiler.html\">What is Amazon CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>. </p>"
}

3
botocore/data/codepipeline/2015-07-09/paginators-1.json
View file

@ -14,7 +14,8 @@
"ListPipelines": {
"input_token": "nextToken",
"output_token": "nextToken",
"result_key": "pipelines"
"result_key": "pipelines",
"limit_key": "maxResults"
},
"ListWebhooks": {
"input_token": "NextToken",

422
botocore/data/codepipeline/2015-07-09/service-2.json
View file

@ -165,6 +165,20 @@
],
"documentation":"<p>Enables artifacts in a pipeline to transition to a stage in a pipeline.</p>"
},
"GetActionType":{
"name":"GetActionType",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"GetActionTypeInput"},
"output":{"shape":"GetActionTypeOutput"},
"errors":[
{"shape":"ActionTypeNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model.</p>"
},
"GetJobDetails":{
"name":"GetJobDetails",
"http":{
@ -568,6 +582,20 @@
],
"documentation":"<p>Removes tags from an AWS resource.</p>"
},
"UpdateActionType":{
"name":"UpdateActionType",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateActionTypeInput"},
"errors":[
{"shape":"RequestFailedException"},
{"shape":"ValidationException"},
{"shape":"ActionTypeNotFoundException"}
],
"documentation":"<p>Updates an action type that was created with any supported integration model, where the action type is to be used by customers of the action type provider. Use a JSON file with the action definition and <code>UpdateActionType</code> to provide the full structure.</p>"
},
"UpdatePipeline":{
"name":"UpdatePipeline",
"http":{
@ -617,7 +645,10 @@
"documentation":"<p>Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the S3 bucket used to store artifact for the pipeline in AWS CodePipeline.</p>",
"sensitive":true
},
"AccessKeyId":{"type":"string"},
"AccessKeyId":{
"type":"string",
"sensitive":true
},
"AccountId":{
"type":"string",
"pattern":"[0-9]{12}"
@ -1051,7 +1082,7 @@
},
"ActionProvider":{
"type":"string",
"max":25,
"max":35,
"min":1,
"pattern":"[0-9A-Za-z_-]+"
},
@ -1144,6 +1175,106 @@
},
"documentation":"<p>Returns information about the details of an action type.</p>"
},
"ActionTypeAlreadyExistsException":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified action type already exists with a different definition.</p>",
"exception":true
},
"ActionTypeArtifactDetails":{
"type":"structure",
"required":[
"minimumCount",
"maximumCount"
],
"members":{
"minimumCount":{
"shape":"MinimumActionTypeArtifactCount",
"documentation":"<p>The minimum number of artifacts that can be used with the action type. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of <code>source</code>.</p>"
},
"maximumCount":{
"shape":"MaximumActionTypeArtifactCount",
"documentation":"<p>The maximum number of artifacts that can be used with the actiontype. For example, you should specify a minimum and maximum of zero input artifacts for an action type with a category of <code>source</code>.</p>"
}
},
"documentation":"<p>Information about parameters for artifacts associated with the action type, such as the minimum and maximum artifacts allowed.</p>"
},
"ActionTypeDeclaration":{
"type":"structure",
"required":[
"executor",
"id",
"inputArtifactDetails",
"outputArtifactDetails"
],
"members":{
"description":{
"shape":"ActionTypeDescription",
"documentation":"<p>The description for the action type to be updated.</p>"
},
"executor":{
"shape":"ActionTypeExecutor",
"documentation":"<p>Information about the executor for an action type that was created with any supported integration model.</p>"
},
"id":{
"shape":"ActionTypeIdentifier",
"documentation":"<p>The action category, owner, provider, and version of the action type to be updated.</p>"
},
"inputArtifactDetails":{
"shape":"ActionTypeArtifactDetails",
"documentation":"<p>Details for the artifacts, such as application files, to be worked on by the action. For example, the minimum and maximum number of input artifacts allowed.</p>"
},
"outputArtifactDetails":{
"shape":"ActionTypeArtifactDetails",
"documentation":"<p>Details for the output artifacts, such as a built application, that are the result of the action. For example, the minimum and maximum number of output artifacts allowed.</p>"
},
"permissions":{
"shape":"ActionTypePermissions",
"documentation":"<p>Details identifying the accounts with permissions to use the action type.</p>"
},
"properties":{
"shape":"ActionTypeProperties",
"documentation":"<p>The properties of the action type to be updated.</p>"
},
"urls":{
"shape":"ActionTypeUrls",
"documentation":"<p>The links associated with the action type to be updated.</p>"
}
},
"documentation":"<p>The parameters for the action type definition that are provided when the action type is created or updated.</p>"
},
"ActionTypeDescription":{
"type":"string",
"max":1024,
"min":1
},
"ActionTypeExecutor":{
"type":"structure",
"required":[
"configuration",
"type"
],
"members":{
"configuration":{
"shape":"ExecutorConfiguration",
"documentation":"<p>The action configuration properties for the action type. These properties are specified in the action definition when the action type is created.</p>"
},
"type":{
"shape":"ExecutorType",
"documentation":"<p>The integration model used to create and update the action type, <code>Lambda</code> or <code>JobWorker</code>. </p>"
},
"policyStatementsTemplate":{
"shape":"PolicyStatementsTemplate",
"documentation":"<p>The policy statement that specifies the permissions in the CodePipeline customer’s account that are needed to successfully run an action.</p> <p>To grant permission to another account, specify the account ID as the Principal, a domain-style identifier defined by the service, for example <code>codepipeline.amazonaws.com</code>.</p> <note> <p>The size of the passed JSON policy document cannot exceed 2048 characters.</p> </note>"
},
"jobTimeout":{
"shape":"JobTimeout",
"documentation":"<p>The timeout in seconds for the job. An action execution can have multiple jobs. This is the timeout for a single job, not the entire action execution.</p>"
}
},
"documentation":"<p>The action engine, or executor, for an action type created for a provider, where the action is to be used by customers of the provider. The action engine is associated with the model used to create and update the action, such as the Lambda integration model.</p>"
},
"ActionTypeId":{
"type":"structure",
"required":[
@ -1172,6 +1303,34 @@
},
"documentation":"<p>Represents information about an action type.</p>"
},
"ActionTypeIdentifier":{
"type":"structure",
"required":[
"category",
"owner",
"provider",
"version"
],
"members":{
"category":{
"shape":"ActionCategory",
"documentation":"<p>Defines what kind of action can be taken in the stage, one of the following:</p> <ul> <li> <p> <code>Source</code> </p> </li> <li> <p> <code>Build</code> </p> </li> <li> <p> <code>Test</code> </p> </li> <li> <p> <code>Deploy</code> </p> </li> <li> <p> <code>Approval</code> </p> </li> <li> <p> <code>Invoke</code> </p> </li> </ul>"
},
"owner":{
"shape":"ActionTypeOwner",
"documentation":"<p>The creator of the action type being called: <code>AWS</code> or <code>ThirdParty</code>.</p>"
},
"provider":{
"shape":"ActionProvider",
"documentation":"<p>The provider of the action type being called. The provider name is supplied when the action type is created.</p>"
},
"version":{
"shape":"Version",
"documentation":"<p>A string that describes the action type version.</p>"
}
},
"documentation":"<p>Specifies the category, owner, provider, and version of the action type.</p>"
},
"ActionTypeList":{
"type":"list",
"member":{"shape":"ActionType"}
@ -1183,6 +1342,62 @@
"documentation":"<p>The specified action type cannot be found.</p>",
"exception":true
},
"ActionTypeOwner":{
"type":"string",
"pattern":"AWS|ThirdParty"
},
"ActionTypePermissions":{
"type":"structure",
"required":["allowedAccounts"],
"members":{
"allowedAccounts":{
"shape":"AllowedAccounts",
"documentation":"<p>A list of AWS account IDs with access to use the action type in their pipelines.</p>"
}
},
"documentation":"<p>Details identifying the users with permissions to use the action type.</p>"
},
"ActionTypeProperties":{
"type":"list",
"member":{"shape":"ActionTypeProperty"},
"max":10
},
"ActionTypeProperty":{
"type":"structure",
"required":[
"name",
"optional",
"key",
"noEcho"
],
"members":{
"name":{
"shape":"ActionConfigurationKey",
"documentation":"<p>The property name that is displayed to users.</p>"
},
"optional":{
"shape":"Boolean",
"documentation":"<p>Whether the configuration property is an optional value.</p>"
},
"key":{
"shape":"Boolean",
"documentation":"<p>Whether the configuration property is a key.</p>"
},
"noEcho":{
"shape":"Boolean",
"documentation":"<p>Whether to omit the field value entered by the customer in the log. If <code>true</code>, the value is not saved in CloudTrail logs for the action execution.</p>"
},
"queryable":{
"shape":"Boolean",
"documentation":"<p>Indicates that the property is used with polling. An action type can have up to one queryable property. If it has one, that property must be both required and not secret.</p>"
},
"description":{
"shape":"PropertyDescription",
"documentation":"<p>The description of the property that is displayed to users.</p>"
}
},
"documentation":"<p>Represents information about each property specified in the action configuration, such as the description and key name that display for the customer using the action type.</p>"
},
"ActionTypeSettings":{
"type":"structure",
"members":{
@ -1205,6 +1420,38 @@
},
"documentation":"<p>Returns information about the settings for an action type.</p>"
},
"ActionTypeUrls":{
"type":"structure",
"members":{
"configurationUrl":{
"shape":"Url",
"documentation":"<p>The URL returned to the CodePipeline console that contains a link to the page where customers can configure the external action.</p>"
},
"entityUrlTemplate":{
"shape":"UrlTemplate",
"documentation":"<p>The URL returned to the CodePipeline console that provides a deep link to the resources of the external system, such as a status page. This link is provided as part of the action display in the pipeline.</p>"
},
"executionUrlTemplate":{
"shape":"UrlTemplate",
"documentation":"<p>The link to an execution page for the action type in progress. For example, for a CodeDeploy action, this link is shown on the pipeline view page in the CodePipeline console, and it links to a CodeDeploy status page.</p>"
},
"revisionUrlTemplate":{
"shape":"UrlTemplate",
"documentation":"<p>The URL returned to the CodePipeline console that contains a link to the page where customers can update or change the configuration of the external action.</p>"
}
},
"documentation":"<p>Returns information about URLs for web pages that display to customers as links on the pipeline view, such as an external configuration page for the action type.</p>"
},
"AllowedAccount":{
"type":"string",
"pattern":"[0-9]{12}|\\*"
},
"AllowedAccounts":{
"type":"list",
"member":{"shape":"AllowedAccount"},
"max":1000,
"min":1
},
"ApprovalAlreadyCompletedException":{
"type":"structure",
"members":{
@ -1796,6 +2043,27 @@
},
"documentation":"<p>The interaction or event that started a pipeline execution.</p>"
},
"ExecutorConfiguration":{
"type":"structure",
"members":{
"lambdaExecutorConfiguration":{
"shape":"LambdaExecutorConfiguration",
"documentation":"<p>Details about the <code>Lambda</code> executor of the action type.</p>"
},
"jobWorkerExecutorConfiguration":{
"shape":"JobWorkerExecutorConfiguration",
"documentation":"<p>Details about the <code>JobWorker</code> executor of the action type.</p>"
}
},
"documentation":"<p>The action engine, or executor, related to the supported integration model used to create and update the action type. The available executor types are <code>Lambda</code> and <code>JobWorker</code>.</p>"
},
"ExecutorType":{
"type":"string",
"enum":[
"JobWorker",
"Lambda"
]
},
"ExternalExecutionId":{"type":"string"},
"ExternalExecutionSummary":{"type":"string"},
"FailureDetails":{
@ -1831,6 +2099,42 @@
"SystemUnavailable"
]
},
"GetActionTypeInput":{
"type":"structure",
"required":[
"category",
"owner",
"provider",
"version"
],
"members":{
"category":{
"shape":"ActionCategory",
"documentation":"<p>Defines what kind of action can be taken in the stage. The following are the valid values:</p> <ul> <li> <p> <code>Source</code> </p> </li> <li> <p> <code>Build</code> </p> </li> <li> <p> <code>Test</code> </p> </li> <li> <p> <code>Deploy</code> </p> </li> <li> <p> <code>Approval</code> </p> </li> <li> <p> <code>Invoke</code> </p> </li> </ul>"
},
"owner":{
"shape":"ActionTypeOwner",
"documentation":"<p>The creator of an action type that was created with any supported integration model. There are two valid values: <code>AWS</code> and <code>ThirdParty</code>.</p>"
},
"provider":{
"shape":"ActionProvider",
"documentation":"<p>The provider of the action type being called. The provider name is specified when the action type is created.</p>"
},
"version":{
"shape":"Version",
"documentation":"<p>A string that describes the action type version.</p>"
}
}
},
"GetActionTypeOutput":{
"type":"structure",
"members":{
"actionType":{
"shape":"ActionTypeDeclaration",
"documentation":"<p>The action type information for the requested action type, such as the action type ID.</p>"
}
}
},
"GetJobDetailsInput":{
"type":"structure",
"required":["jobId"],
@ -2194,11 +2498,47 @@
"Failed"
]
},
"JobTimeout":{
"type":"integer",
"max":43200,
"min":60
},
"JobWorkerExecutorConfiguration":{
"type":"structure",
"members":{
"pollingAccounts":{
"shape":"PollingAccountList",
"documentation":"<p>The accounts in which the job worker is configured and might poll for jobs as part of the action execution.</p>"
},
"pollingServicePrincipals":{
"shape":"PollingServicePrincipalList",
"documentation":"<p>The service Principals in which the job worker is configured and might poll for jobs as part of the action execution.</p>"
}
},
"documentation":"<p>Details about the polling configuration for the <code>JobWorker</code> action engine, or executor.</p>"
},
"JsonPath":{
"type":"string",
"max":150,
"min":1
},
"LambdaExecutorConfiguration":{
"type":"structure",
"required":["lambdaFunctionArn"],
"members":{
"lambdaFunctionArn":{
"shape":"LambdaFunctionArn",
"documentation":"<p>The ARN of the Lambda function used by the action engine.</p>"
}
},
"documentation":"<p>Details about the configuration for the <code>Lambda</code> action engine, or executor.</p>"
},
"LambdaFunctionArn":{
"type":"string",
"max":140,
"min":1,
"pattern":"arn:aws(-[\\w]+)*:lambda:.+:[0-9]{12}:function:.+"
},
"LastChangedAt":{"type":"timestamp"},
"LastChangedBy":{"type":"string"},
"LastUpdatedBy":{"type":"string"},
@ -2254,6 +2594,10 @@
"nextToken":{
"shape":"NextToken",
"documentation":"<p>An identifier that was returned from the previous list action types call, which can be used to return the next set of action types in the list.</p>"
},
"regionFilter":{
"shape":"AWSRegionName",
"documentation":"<p>The Region to filter on for the list of action types.</p>"
}
},
"documentation":"<p>Represents the input of a <code>ListActionTypes</code> action.</p>"
@ -2312,6 +2656,10 @@
"nextToken":{
"shape":"NextToken",
"documentation":"<p>An identifier that was returned from the previous list pipelines call. It can be used to return the next set of pipelines in the list.</p>"
},
"maxResults":{
"shape":"MaxPipelines",
"documentation":"<p>The maximum number of pipelines to return in a single call. To retrieve the remaining pipelines, make another call with the returned nextToken value. The minimum value you can specify is 1. The maximum accepted value is 1000.</p>"
}
},
"documentation":"<p>Represents the input of a <code>ListPipelines</code> action.</p>"
@ -2434,11 +2782,21 @@
"type":"integer",
"min":1
},
"MaxPipelines":{
"type":"integer",
"max":1000,
"min":1
},
"MaxResults":{
"type":"integer",
"max":100,
"min":1
},
"MaximumActionTypeArtifactCount":{
"type":"integer",
"max":10,
"min":0
},
"MaximumArtifactCount":{
"type":"integer",
"max":5,
@ -2449,6 +2807,11 @@
"max":5000,
"min":1
},
"MinimumActionTypeArtifactCount":{
"type":"integer",
"max":10,
"min":0
},
"MinimumArtifactCount":{
"type":"integer",
"max":5,
@ -2753,6 +3116,11 @@
"documentation":"<p>The pipeline version was specified in an invalid format or cannot be found.</p>",
"exception":true
},
"PolicyStatementsTemplate":{
"type":"string",
"max":2048,
"min":1
},
"PollForJobsInput":{
"type":"structure",
"required":["actionTypeId"],
@ -2807,6 +3175,23 @@
},
"documentation":"<p>Represents the output of a <code>PollForThirdPartyJobs</code> action.</p>"
},
"PollingAccountList":{
"type":"list",
"member":{"shape":"AccountId"},
"max":1000,
"min":1
},
"PollingServicePrincipalList":{
"type":"list",
"member":{"shape":"ServicePrincipal"},
"max":10,
"min":1
},
"PropertyDescription":{
"type":"string",
"max":250,
"min":1
},
"PutActionRevisionInput":{
"type":"structure",
"required":[
@ -3034,6 +3419,14 @@
"members":{
}
},
"RequestFailedException":{
"type":"structure",
"members":{
"message":{"shape":"Message"}
},
"documentation":"<p>The request failed because of an unknown error, exception, or failure.</p>",
"exception":true
},
"ResolvedActionConfigurationMap":{
"type":"map",
"key":{"shape":"String"},
@ -3152,8 +3545,19 @@
"documentation":"<p>The Amazon S3 artifact location for an action's artifacts.</p>"
},
"S3ObjectKey":{"type":"string"},
"SecretAccessKey":{"type":"string"},
"SessionToken":{"type":"string"},
"SecretAccessKey":{
"type":"string",
"sensitive":true
},
"ServicePrincipal":{
"type":"string",
"max":128,
"min":1
},
"SessionToken":{
"type":"string",
"sensitive":true
},
"SourceRevision":{
"type":"structure",
"required":["actionName"],
@ -3590,6 +3994,16 @@
"members":{
}
},
"UpdateActionTypeInput":{
"type":"structure",
"required":["actionType"],
"members":{
"actionType":{
"shape":"ActionTypeDeclaration",
"documentation":"<p>The action type definition for the action type to be updated.</p>"
}
}
},
"UpdatePipelineInput":{
"type":"structure",
"required":["pipeline"],

64
botocore/data/comprehend/2017-11-27/service-2.json
View file

@ -113,6 +113,22 @@
],
"documentation":"<p>Creates a new document classification request to analyze a single document in real-time, using a previously created and trained custom model and an endpoint.</p>"
},
"ContainsPiiEntities":{
"name":"ContainsPiiEntities",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ContainsPiiEntitiesRequest"},
"output":{"shape":"ContainsPiiEntitiesResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"TextSizeLimitExceededException"},
{"shape":"UnsupportedLanguageException"},
{"shape":"InternalServerException"}
],
"documentation":"<p>Analyzes input text for the presence of personally identifiable information (PII) and returns the labels of identified PII entity types such as name, address, bank account number, or phone number.</p>"
},
"CreateDocumentClassifier":{
"name":"CreateDocumentClassifier",
"http":{
@ -1429,6 +1445,32 @@
"documentation":"<p>Concurrent modification of the tags associated with an Amazon Comprehend resource is not supported. </p>",
"exception":true
},
"ContainsPiiEntitiesRequest":{
"type":"structure",
"required":[
"Text",
"LanguageCode"
],
"members":{
"Text":{
"shape":"String",
"documentation":"<p>Creates a new document classification request to analyze a single document in real-time, returning personally identifiable information (PII) entity labels.</p>"
},
"LanguageCode":{
"shape":"LanguageCode",
"documentation":"<p>The language of the input documents.</p>"
}
}
},
"ContainsPiiEntitiesResponse":{
"type":"structure",
"members":{
"Labels":{
"shape":"ListOfEntityLabels",
"documentation":"<p>The labels used in the document being analyzed. Individual labels represent personally identifiable information (PII) entity types.</p>"
}
}
},
"CreateDocumentClassifierRequest":{
"type":"structure",
"required":[
@ -2538,6 +2580,20 @@
},
"documentation":"<p>Provides information about an entity. </p> <p> </p>"
},
"EntityLabel":{
"type":"structure",
"members":{
"Name":{
"shape":"PiiEntityType",
"documentation":"<p>The name of the label.</p>"
},
"Score":{
"shape":"Float",
"documentation":"<p>The level of confidence that Amazon Comprehend has in the accuracy of the detection.</p>"
}
},
"documentation":"<p>Specifies one of the label or labels that categorize the personally identifiable information (PII) entity being analyzed.</p>"
},
"EntityRecognizerAnnotations":{
"type":"structure",
"required":["S3Uri"],
@ -2783,7 +2839,7 @@
"EntityTypeName":{
"type":"string",
"max":64,
"pattern":"^(?:(?!\\\\n+|\\\\t+|\\\\r+|[\\r\\t\\n\\s,]).)+$"
"pattern":"^(?:(?!\\\\n+|\\\\t+|\\\\r+|[\\r\\t\\n,]).)+$"
},
"EntityTypesEvaluationMetrics":{
"type":"structure",
@ -3399,6 +3455,10 @@
"type":"list",
"member":{"shape":"Entity"}
},
"ListOfEntityLabels":{
"type":"list",
"member":{"shape":"EntityLabel"}
},
"ListOfKeyPhrases":{
"type":"list",
"member":{"shape":"KeyPhrase"}
@ -4800,7 +4860,7 @@
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>Amazon Comprehend can't process the language of the input text. For all custom entity recognition APIs (such as <code>CreateEntityRecognizer</code>), only English, Spanish, French, Italian, German, or Portuguese are accepted. For most other APIs, such as those for Custom Classification, Amazon Comprehend accepts text in all supported languages. For a list of supported languages, see <a>supported-languages</a>. </p>",
"documentation":"<p>Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, see <a>supported-languages</a>. </p>",
"exception":true
},
"UntagResourceRequest":{

32
botocore/data/compute-optimizer/2019-11-01/service-2.json
View file

@ -208,7 +208,7 @@
{"shape":"MissingAuthenticationToken"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Returns the optimization findings for an account.</p> <p>For example, it returns the number of Amazon EC2 instances in an account that are under-provisioned, over-provisioned, or optimized. It also returns the number of Auto Scaling groups in an account that are not optimized, or optimized.</p>"
"documentation":"<p>Returns the optimization findings for an account.</p> <p>It returns the number of:</p> <ul> <li> <p>Amazon EC2 instances in an account that are <code>Underprovisioned</code>, <code>Overprovisioned</code>, or <code>Optimized</code>.</p> </li> <li> <p>Auto Scaling groups in an account that are <code>NotOptimized</code>, or <code>Optimized</code>.</p> </li> <li> <p>Amazon EBS volumes in an account that are <code>NotOptimized</code>, or <code>Optimized</code>.</p> </li> <li> <p>Lambda functions in an account that are <code>NotOptimized</code>, or <code>Optimized</code>.</p> </li> </ul>"
},
"UpdateEnrollmentStatus":{
"name":"UpdateEnrollmentStatus",
@ -226,7 +226,7 @@
{"shape":"MissingAuthenticationToken"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Updates the enrollment (opt in) status of an account to the AWS Compute Optimizer service.</p> <p>If the account is a management account of an organization, this action can also be used to enroll member accounts within the organization.</p>"
"documentation":"<p>Updates the enrollment (opt in and opt out) status of an account to the AWS Compute Optimizer service.</p> <p>If the account is a management account of an organization, this action can also be used to enroll member accounts within the organization.</p> <p>You must have the appropriate permissions to opt in to Compute Optimizer, to view its recommendations, and to opt out. For more information, see <a href=\"https://docs.aws.amazon.com/compute-optimizer/ug/security-iam.html\">Controlling access with AWS Identity and Access Management</a> in the <i>Compute Optimizer User Guide</i>.</p> <p>When you opt in, Compute Optimizer automatically creates a Service-Linked Role in your account to access its data. For more information, see <a href=\"https://docs.aws.amazon.com/compute-optimizer/ug/using-service-linked-roles.html\">Using Service-Linked Roles for AWS Compute Optimizer</a> in the <i>Compute Optimizer User Guide</i>.</p>"
}
},
"shapes":{
@ -432,7 +432,7 @@
},
"statistic":{
"shape":"MetricStatistic",
"documentation":"<p>The statistic of the utilization metric.</p> <p>The following statistics are available:</p> <ul> <li> <p> <code>Average</code> - This is the value of Sum / SampleCount during the specified period, or the average value observed during the specified period.</p> </li> <li> <p> <code>Maximum</code> - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.</p> </li> </ul>"
"documentation":"<p>The statistic of the utilization metric.</p> <p>The Compute Optimizer API, AWS Command Line Interface (AWS CLI), and SDKs return utilization metrics using only the <code>Maximum</code> statistic, which is the highest value observed during the specified period.</p> <p>The Compute Optimizer console displays graphs for some utilization metrics using the <code>Average</code> statistic, which is the value of <code>Sum</code> / <code>SampleCount</code> during the specified period. For more information, see <a href=\"https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html\">Viewing resource recommendations</a> in the <i>AWS Compute Optimizer User Guide</i>. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html\">Amazon CloudWatch User Guide</a>.</p>"
},
"value":{
"shape":"MetricValue",
@ -452,7 +452,7 @@
"members":{
"accountIds":{
"shape":"AccountIds",
"documentation":"<p>The IDs of the AWS accounts for which to export Auto Scaling group recommendations.</p> <p>If your account is the management account of an organization, use this parameter to specify the member accounts for which you want to export recommendations.</p> <p>This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.</p> <p>Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.</p> <p>You can specify multiple account IDs per request.</p>"
"documentation":"<p>The IDs of the AWS accounts for which to export Auto Scaling group recommendations.</p> <p>If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.</p> <p>This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.</p> <p>Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.</p> <p>You can specify multiple account IDs per request.</p>"
},
"filters":{
"shape":"Filters",
@ -505,7 +505,7 @@
"members":{
"accountIds":{
"shape":"AccountIds",
"documentation":"<p>The IDs of the AWS accounts for which to export instance recommendations.</p> <p>If your account is the management account of an organization, use this parameter to specify the member accounts for which you want to export recommendations.</p> <p>This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.</p> <p>Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.</p> <p>You can specify multiple account IDs per request.</p>"
"documentation":"<p>The IDs of the AWS accounts for which to export instance recommendations.</p> <p>If your account is the management account of an organization, use this parameter to specify the member account for which you want to export recommendations.</p> <p>This parameter cannot be specified together with the include member accounts parameter. The parameters are mutually exclusive.</p> <p>Recommendations for member accounts are not included in the export if this parameter, or the include member accounts parameter, is omitted.</p> <p>You can specify multiple account IDs per request.</p>"
},
"filters":{
"shape":"Filters",
@ -692,7 +692,7 @@
"members":{
"accountIds":{
"shape":"AccountIds",
"documentation":"<p>The IDs of the AWS accounts for which to return Auto Scaling group recommendations.</p> <p>If your account is the management account of an organization, use this parameter to specify the member accounts for which you want to return Auto Scaling group recommendations.</p> <p>Only one account ID can be specified per request.</p>"
"documentation":"<p>The ID of the AWS account for which to return Auto Scaling group recommendations.</p> <p>If your account is the management account of an organization, use this parameter to specify the member account for which you want to return Auto Scaling group recommendations.</p> <p>Only one account ID can be specified per request.</p>"
},
"autoScalingGroupArns":{
"shape":"AutoScalingGroupArns",
@ -750,7 +750,7 @@
},
"accountIds":{
"shape":"AccountIds",
"documentation":"<p>The IDs of the AWS accounts for which to return volume recommendations.</p> <p>If your account is the management account of an organization, use this parameter to specify the member accounts for which you want to return volume recommendations.</p> <p>Only one account ID can be specified per request.</p>"
"documentation":"<p>The ID of the AWS account for which to return volume recommendations.</p> <p>If your account is the management account of an organization, use this parameter to specify the member account for which you want to return volume recommendations.</p> <p>Only one account ID can be specified per request.</p>"
}
}
},
@ -792,7 +792,7 @@
},
"accountIds":{
"shape":"AccountIds",
"documentation":"<p>The IDs of the AWS accounts for which to return instance recommendations.</p> <p>If your account is the management account of an organization, use this parameter to specify the member accounts for which you want to return instance recommendations.</p> <p>Only one account ID can be specified per request.</p>"
"documentation":"<p>The ID of the AWS account for which to return instance recommendations.</p> <p>If your account is the management account of an organization, use this parameter to specify the member account for which you want to return instance recommendations.</p> <p>Only one account ID can be specified per request.</p>"
}
}
},
@ -885,7 +885,7 @@
},
"accountIds":{
"shape":"AccountIds",
"documentation":"<p>The IDs of the AWS accounts for which to return function recommendations.</p> <p>If your account is the management account of an organization, use this parameter to specify the member accounts for which you want to return function recommendations.</p> <p>Only one account ID can be specified per request.</p>"
"documentation":"<p>The ID of the AWS account for which to return function recommendations.</p> <p>If your account is the management account of an organization, use this parameter to specify the member account for which you want to return function recommendations.</p> <p>Only one account ID can be specified per request.</p>"
},
"filters":{
"shape":"LambdaFunctionRecommendationFilters",
@ -941,7 +941,7 @@
"members":{
"accountIds":{
"shape":"AccountIds",
"documentation":"<p>The IDs of the AWS accounts for which to return recommendation summaries.</p> <p>If your account is the management account of an organization, use this parameter to specify the member accounts for which you want to return recommendation summaries.</p> <p>Only one account ID can be specified per request.</p>"
"documentation":"<p>The ID of the AWS account for which to return recommendation summaries.</p> <p>If your account is the management account of an organization, use this parameter to specify the member account for which you want to return recommendation summaries.</p> <p>Only one account ID can be specified per request.</p>"
},
"nextToken":{
"shape":"NextToken",
@ -1215,7 +1215,7 @@
},
"findingReasonCodes":{
"shape":"LambdaFunctionRecommendationFindingReasonCodes",
"documentation":"<p>The reason for the finding classification of the function.</p> <note> <p>Functions that have a finding classification of <code>Optimized</code> don't have a finding reason code.</p> </note> <p>Reason codes include:</p> <ul> <li> <p> <b> <code>MemoryOverprovisioned</code> </b> — The function is over-provisioned when its memory configuration can be sized down while still meeting the performance requirements of your workload. An over-provisioned function might lead to unnecessary infrastructure cost. This finding reason code is part of the <code>NotOptimized</code> finding classification.</p> </li> <li> <p> <b> <code>MemoryUnderprovisioned</code> </b> — The function is under-provisioned when its memory configuration doesn't meet the performance requirements of the workload. An under-provisioned function might lead to poor application performance. This finding reason code is part of the <code>NotOptimized</code> finding classification.</p> </li> <li> <p> <b> <code>InsufficientData</code> </b> — The function does not have sufficient metric data for Compute Optimizer to generate a recommendation. For more information, see the <a href=\"https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html\">Supported resources and requirements</a> in the <i>AWS Compute Optimizer User Guide</i>. This finding reason code is part of the <code>Unavailable</code> finding classification.</p> </li> <li> <p> <b> <code>Inconclusive</code> </b> — The function does not qualify for a recommendation, or there was an internal error. This finding reason code is part of the <code>Unavailable</code> finding classification.</p> </li> </ul>"
"documentation":"<p>The reason for the finding classification of the function.</p> <note> <p>Functions that have a finding classification of <code>Optimized</code> don't have a finding reason code.</p> </note> <p>Reason codes include:</p> <ul> <li> <p> <b> <code>MemoryOverprovisioned</code> </b> — The function is over-provisioned when its memory configuration can be sized down while still meeting the performance requirements of your workload. An over-provisioned function might lead to unnecessary infrastructure cost. This finding reason code is part of the <code>NotOptimized</code> finding classification.</p> </li> <li> <p> <b> <code>MemoryUnderprovisioned</code> </b> — The function is under-provisioned when its memory configuration doesn't meet the performance requirements of the workload. An under-provisioned function might lead to poor application performance. This finding reason code is part of the <code>NotOptimized</code> finding classification.</p> </li> <li> <p> <b> <code>InsufficientData</code> </b> — The function does not have sufficient metric data for Compute Optimizer to generate a recommendation. For more information, see the <a href=\"https://docs.aws.amazon.com/compute-optimizer/latest/ug/requirements.html\">Supported resources and requirements</a> in the <i>AWS Compute Optimizer User Guide</i>. This finding reason code is part of the <code>Unavailable</code> finding classification.</p> </li> <li> <p> <b> <code>Inconclusive</code> </b> — The function does not qualify for a recommendation because Compute Optimizer cannot generate a recommendation with a high degree of confidence. This finding reason code is part of the <code>Unavailable</code> finding classification.</p> </li> </ul>"
},
"memorySizeRecommendationOptions":{
"shape":"LambdaFunctionMemoryRecommendationOptions",
@ -1279,11 +1279,11 @@
"members":{
"name":{
"shape":"LambdaFunctionMetricName",
"documentation":"<p>The name of the utilization metric.</p>"
"documentation":"<p>The name of the utilization metric.</p> <p>The following utilization metrics are available:</p> <ul> <li> <p> <code>Duration</code> - The amount of time that your function code spends processing an event.</p> </li> <li> <p> <code>Memory</code> - The amount of memory used per invocation.</p> </li> </ul>"
},
"statistic":{
"shape":"LambdaFunctionMetricStatistic",
"documentation":"<p>The statistic of the utilization metric.</p>"
"documentation":"<p>The statistic of the utilization metric.</p> <p>The Compute Optimizer API, AWS Command Line Interface (AWS CLI), and SDKs return utilization metrics using only the <code>Maximum</code> statistic, which is the highest value observed during the specified period.</p> <p>The Compute Optimizer console displays graphs for some utilization metrics using the <code>Average</code> statistic, which is the value of <code>Sum</code> / <code>SampleCount</code> during the specified period. For more information, see <a href=\"https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html\">Viewing resource recommendations</a> in the <i>AWS Compute Optimizer User Guide</i>. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html\">Amazon CloudWatch User Guide</a>.</p>"
},
"value":{
"shape":"MetricValue",
@ -1638,11 +1638,11 @@
"members":{
"status":{
"shape":"Status",
"documentation":"<p>The new enrollment status of the account.</p> <p>Accepted options are <code>Active</code> or <code>Inactive</code>. You will get an error if <code>Pending</code> or <code>Failed</code> are specified.</p>"
"documentation":"<p>The new enrollment status of the account.</p> <p>The following status options are available:</p> <ul> <li> <p> <code>Active</code> - Opts in your account to the Compute Optimizer service. Compute Optimizer begins analyzing the configuration and utilization metrics of your AWS resources after you opt in. For more information, see <a href=\"https://docs.aws.amazon.com/compute-optimizer/ug/metrics.html\">Metrics analyzed by AWS Compute Optimizer</a> in the <i>Compute Optimizer User Guide</i>.</p> </li> <li> <p> <code>Inactive</code> - Opts out your account from the Compute Optimizer service. Your account's recommendations and related metrics data will be deleted from Compute Optimizer after you opt out.</p> </li> </ul> <note> <p>The <code>Pending</code> and <code>Failed</code> options cannot be used to update the enrollment status of an account. They are returned in the response of a request to update the enrollment status of an account.</p> </note>"
},
"includeMemberAccounts":{
"shape":"IncludeMemberAccounts",
"documentation":"<p>Indicates whether to enroll member accounts of the organization if the your account is the management account of an organization.</p>"
"documentation":"<p>Indicates whether to enroll member accounts of the organization if the account is the management account of an organization.</p>"
}
}
},
@ -1668,7 +1668,7 @@
},
"statistic":{
"shape":"MetricStatistic",
"documentation":"<p>The statistic of the utilization metric.</p> <p>The following statistics are available:</p> <ul> <li> <p> <code>Average</code> - This is the value of Sum / SampleCount during the specified period, or the average value observed during the specified period.</p> </li> <li> <p> <code>Maximum</code> - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.</p> </li> </ul>"
"documentation":"<p>The statistic of the utilization metric.</p> <p>The Compute Optimizer API, AWS Command Line Interface (AWS CLI), and SDKs return utilization metrics using only the <code>Maximum</code> statistic, which is the highest value observed during the specified period.</p> <p>The Compute Optimizer console displays graphs for some utilization metrics using the <code>Average</code> statistic, which is the value of <code>Sum</code> / <code>SampleCount</code> during the specified period. For more information, see <a href=\"https://docs.aws.amazon.com/compute-optimizer/latest/ug/viewing-recommendations.html\">Viewing resource recommendations</a> in the <i>AWS Compute Optimizer User Guide</i>. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html\">Amazon CloudWatch User Guide</a>.</p>"
},
"value":{
"shape":"MetricValue",

100
botocore/data/config/2014-11-12/service-2.json
View file

@ -236,7 +236,7 @@
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deletes the stored query for an AWS account in an AWS Region. </p>"
"documentation":"<p>Deletes the stored query for a single AWS account and a single AWS Region.</p>"
},
"DeliverConfigSnapshot":{
"name":"DeliverConfigSnapshot",
@ -875,7 +875,7 @@
{"shape":"ValidationException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>List the stored queries for an AWS account in an AWS Region. The default is 100. </p>"
"documentation":"<p>Lists the stored queries for a single AWS account and a single AWS Region. The default is 100. </p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
@ -938,7 +938,7 @@
{"shape":"NoAvailableOrganizationException"},
{"shape":"OrganizationAllFeaturesNotEnabledException"}
],
"documentation":"<p>Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.</p> <note> <p>AWS Config should be enabled in source accounts and regions you want to aggregate.</p> <p>If your source type is an organization, you must be signed in to the master account and all features must be enabled in your organization. AWS Config calls <code>EnableAwsServiceAccess</code> API to enable integration between AWS Config and AWS Organizations. </p> </note>"
"documentation":"<p>Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.</p> <p> <code>accountIds</code> that are passed will be replaced with existing accounts. If you want to add additional accounts into the aggregator, call <code>DescribeAggregator</code> to get the previous accounts and then append new ones.</p> <note> <p>AWS Config should be enabled in source accounts and regions you want to aggregate.</p> <p>If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization. If the caller is a management account, AWS Config calls <code>EnableAwsServiceAccess</code> API to enable integration between AWS Config and AWS Organizations. If the caller is a registered delegated administrator, AWS Config calls <code>ListDelegatedAdministrators</code> API to verify whether the caller is a valid delegated administrator.</p> <p>To register a delegated administrator, see <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/set-up-aggregator-cli.html#register-a-delegated-administrator-cli\">Register a Delegated Administrator</a> in the AWS Config developer guide. </p> </note>"
},
"PutConfigurationRecorder":{
"name":"PutConfigurationRecorder",
@ -985,6 +985,7 @@
{"shape":"InvalidDeliveryChannelNameException"},
{"shape":"NoSuchBucketException"},
{"shape":"InvalidS3KeyPrefixException"},
{"shape":"InvalidS3KmsKeyArnException"},
{"shape":"InvalidSNSTopicARNException"},
{"shape":"InsufficientDeliveryPolicyException"}
],
@ -1016,7 +1017,8 @@
"errors":[
{"shape":"NoSuchConfigRuleException"},
{"shape":"InvalidParameterValueException"}
]
],
"documentation":"<p>Add or updates the evaluations for process checks. This API checks if the rule is a process check when the name of the AWS Config rule is provided.</p>"
},
"PutOrganizationConfigRule":{
"name":"PutOrganizationConfigRule",
@ -1084,7 +1086,7 @@
{"shape":"InvalidParameterValueException"},
{"shape":"InsufficientPermissionsException"}
],
"documentation":"<p>A remediation exception is when a specific resource is no longer considered for auto-remediation. This API adds a new exception or updates an exisiting exception for a specific resource with a specific AWS Config rule. </p> <note> <p>AWS Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.</p> </note>"
"documentation":"<p>A remediation exception is when a specific resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specific resource with a specific AWS Config rule. </p> <note> <p>AWS Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.</p> </note>"
},
"PutResourceConfig":{
"name":"PutResourceConfig",
@ -1128,7 +1130,7 @@
{"shape":"TooManyTagsException"},
{"shape":"ResourceConcurrentModificationException"}
],
"documentation":"<p>Saves a new query or updates an existing saved query. The <code>QueryName</code> must be unique for an AWS account in an AWS Region. You can create upto 300 queries in an AWS account in an AWS Region.</p>"
"documentation":"<p>Saves a new query or updates an existing saved query. The <code>QueryName</code> must be unique for a single AWS account and a single AWS Region. You can create upto 300 queries in a single AWS account and a single AWS Region.</p>"
},
"SelectAggregateResourceConfig":{
"name":"SelectAggregateResourceConfig",
@ -2094,7 +2096,7 @@
},
"arn":{
"shape":"ARN",
"documentation":"<p>accoun</p>"
"documentation":"<p>Amazon Resource Name (ARN) associated with the resource.</p>"
},
"resourceType":{
"shape":"ResourceType",
@ -2281,7 +2283,8 @@
"type":"string",
"enum":[
"COMPLIANT",
"NON_COMPLIANT"
"NON_COMPLIANT",
"INSUFFICIENT_DATA"
]
},
"ConformancePackConfigRuleNames":{
@ -2312,11 +2315,11 @@
},
"DeliveryS3Bucket":{
"shape":"DeliveryS3Bucket",
"documentation":"<p>Conformance pack template that is used to create a pack. The delivery bucket name should start with awsconfigconforms. For example: \"Resource\": \"arn:aws:s3:::your_bucket_name/*\".</p>"
"documentation":"<p>Amazon S3 bucket where AWS Config stores conformance pack templates. </p> <note> <p>This field is optional.</p> </note>"
},
"DeliveryS3KeyPrefix":{
"shape":"DeliveryS3KeyPrefix",
"documentation":"<p>The prefix for the Amazon S3 bucket.</p>"
"documentation":"<p>The prefix for the Amazon S3 bucket.</p> <note> <p>This field is optional.</p> </note>"
},
"ConformancePackInputParameters":{
"shape":"ConformancePackInputParameters",
@ -2790,6 +2793,10 @@
"shape":"String",
"documentation":"<p>The prefix for the specified Amazon S3 bucket.</p>"
},
"s3KmsKeyArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) customer managed key (CMK) used to encrypt objects delivered by AWS Config. Must belong to the same Region as the destination S3 bucket.</p>"
},
"snsTopicARN":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes.</p> <p>If you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config. For more information, see <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html\">Permissions for the Amazon SNS Topic</a> in the AWS Config Developer Guide.</p>"
@ -3714,12 +3721,28 @@
"OrderingTimestamp"
],
"members":{
"ComplianceResourceType":{"shape":"StringWithCharLimit256"},
"ComplianceResourceId":{"shape":"BaseResourceId"},
"ComplianceType":{"shape":"ComplianceType"},
"Annotation":{"shape":"StringWithCharLimit256"},
"OrderingTimestamp":{"shape":"OrderingTimestamp"}
}
"ComplianceResourceType":{
"shape":"StringWithCharLimit256",
"documentation":"<p>The evaluated compliance resource type. AWS Config accepts <code>AWS::::Account</code> resource type.</p>"
},
"ComplianceResourceId":{
"shape":"BaseResourceId",
"documentation":"<p>The evaluated compliance resource ID. AWS Config accepts only AWS account ID.</p>"
},
"ComplianceType":{
"shape":"ComplianceType",
"documentation":"<p>The compliance of the AWS resource. The valid values are <code>COMPLIANT, NON_COMPLIANT, </code> and <code>NOT_APPLICABLE</code>.</p>"
},
"Annotation":{
"shape":"StringWithCharLimit256",
"documentation":"<p>Supplementary information about the reason of compliance. For example, this task was completed on a specific date.</p>"
},
"OrderingTimestamp":{
"shape":"OrderingTimestamp",
"documentation":"<p>The time when the compliance was recorded. </p>"
}
},
"documentation":"<p>Identifies an AWS resource and indicates whether it complies with the AWS Config rule that it was evaluated against.</p>"
},
"FailedDeleteRemediationExceptionsBatch":{
"type":"structure",
@ -4430,6 +4453,13 @@
"documentation":"<p>The specified Amazon S3 key prefix is not valid.</p>",
"exception":true
},
"InvalidS3KmsKeyArnException":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified Amazon KMS Key ARN is not valid.</p>",
"exception":true
},
"InvalidSNSTopicARNException":{
"type":"structure",
"members":{
@ -4485,7 +4515,7 @@
},
"Limit":{
"shape":"Limit",
"documentation":"<p>The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.</p>"
"documentation":"<p>The maximum number of resource identifiers returned on each page. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.</p>"
},
"NextToken":{
"shape":"NextToken",
@ -4854,7 +4884,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>For PutConfigAggregator API, no permission to call EnableAWSServiceAccess API.</p> <p>For all OrganizationConfigRule and OrganizationConformancePack APIs, AWS Config throws an exception if APIs are called from member accounts. All APIs must be called from organization master account.</p>",
"documentation":"<p>For <code>PutConfigurationAggregator</code> API, you can see this exception for the following reasons:</p> <ul> <li> <p>No permission to call <code>EnableAWSServiceAccess</code> API</p> </li> <li> <p>The configuration aggregator cannot be updated because your AWS Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current AWS Organization.</p> </li> <li> <p>The configuration aggregator is associated with a previous AWS Organization and AWS Config cannot aggregate data with current AWS Organization. Delete this aggregator and create a new one with the current AWS Organization.</p> </li> <li> <p>You are not a registered delegated administrator for AWS Config with permissions to call <code>ListDelegatedAdministrators</code> API. Ensure that the management account registers delagated administrator for AWS Config service principle name before the delegated administrator creates an aggregator.</p> </li> </ul> <p>For all <code>OrganizationConfigRule</code> and <code>OrganizationConformancePack</code> APIs, AWS Config throws an exception if APIs are called from member accounts. All APIs must be called from organization master account.</p>",
"exception":true
},
"OrganizationAggregationSource":{
@ -5001,11 +5031,11 @@
},
"DeliveryS3Bucket":{
"shape":"DeliveryS3Bucket",
"documentation":"<p>Location of an Amazon S3 bucket where AWS Config can deliver evaluation results and conformance pack template that is used to create a pack. </p>"
"documentation":"<p>Amazon S3 bucket where AWS Config stores conformance pack templates. </p> <note> <p>This field is optional.</p> </note>"
},
"DeliveryS3KeyPrefix":{
"shape":"DeliveryS3KeyPrefix",
"documentation":"<p>Any folder structure you want to add to an Amazon S3 bucket.</p>"
"documentation":"<p>Any folder structure you want to add to an Amazon S3 bucket.</p> <note> <p>This field is optional.</p> </note>"
},
"ConformancePackInputParameters":{
"shape":"ConformancePackInputParameters",
@ -5416,11 +5446,11 @@
},
"DeliveryS3Bucket":{
"shape":"DeliveryS3Bucket",
"documentation":"<p>AWS Config stores intermediate files while processing conformance pack template.</p>"
"documentation":"<p>Amazon S3 bucket where AWS Config stores conformance pack templates.</p> <note> <p>This field is optional.</p> </note>"
},
"DeliveryS3KeyPrefix":{
"shape":"DeliveryS3KeyPrefix",
"documentation":"<p>The prefix for the Amazon S3 bucket. </p>"
"documentation":"<p>The prefix for the Amazon S3 bucket. </p> <note> <p>This field is optional.</p> </note>"
},
"ConformancePackInputParameters":{
"shape":"ConformancePackInputParameters",
@ -5484,8 +5514,14 @@
"ExternalEvaluation"
],
"members":{
"ConfigRuleName":{"shape":"ConfigRuleName"},
"ExternalEvaluation":{"shape":"ExternalEvaluation"}
"ConfigRuleName":{
"shape":"ConfigRuleName",
"documentation":"<p>The name of the AWS Config rule.</p>"
},
"ExternalEvaluation":{
"shape":"ExternalEvaluation",
"documentation":"<p>An <code>ExternalEvaluation</code> object that provides details about compliance.</p>"
}
}
},
"PutExternalEvaluationResponse":{
@ -5542,11 +5578,11 @@
},
"DeliveryS3Bucket":{
"shape":"DeliveryS3Bucket",
"documentation":"<p>Location of an Amazon S3 bucket where AWS Config can deliver evaluation results. AWS Config stores intermediate files while processing conformance pack template. </p> <p>The delivery bucket name should start with awsconfigconforms. For example: \"Resource\": \"arn:aws:s3:::your_bucket_name/*\". For more information, see <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/conformance-pack-organization-apis.html\">Permissions for cross account bucket access</a>.</p>"
"documentation":"<p>Amazon S3 bucket where AWS Config stores conformance pack templates.</p> <note> <p>This field is optional.</p> </note>"
},
"DeliveryS3KeyPrefix":{
"shape":"DeliveryS3KeyPrefix",
"documentation":"<p>The prefix for the Amazon S3 bucket.</p>"
"documentation":"<p>The prefix for the Amazon S3 bucket.</p> <note> <p>This field is optional.</p> </note>"
},
"ConformancePackInputParameters":{
"shape":"ConformancePackInputParameters",
@ -5680,7 +5716,7 @@
"members":{
"StoredQuery":{
"shape":"StoredQuery",
"documentation":"<p>A list of <code>StoredQuery</code> objects. The mandatory fields are <code>QueryName</code> and <code>Expression</code>.</p>"
"documentation":"<p>A list of <code>StoredQuery</code> objects. The mandatory fields are <code>QueryName</code> and <code>Expression</code>.</p> <note> <p>When you are creating a query, you must provide a query name and an expression. When you are updating a query, you must provide a query name but updating the description is optional.</p> </note>"
},
"Tags":{
"shape":"TagsList",
@ -5693,7 +5729,7 @@
"members":{
"QueryArn":{
"shape":"QueryArn",
"documentation":"<p>Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-id.</p>"
"documentation":"<p>Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.</p>"
}
}
},
@ -5763,7 +5799,7 @@
},
"resourceTypes":{
"shape":"ResourceTypeList",
"documentation":"<p>A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, <code>AWS::EC2::Instance</code> or <code>AWS::CloudTrail::Trail</code>).</p> <p>Before you can set this option to <code>true</code>, you must set the <code>allSupported</code> option to <code>false</code>.</p> <p>If you set this option to <code>true</code>, when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.</p> <p>For a list of valid <code>resourceTypes</code> values, see the <b>resourceType Value</b> column in <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources\">Supported AWS Resource Types</a>.</p>"
"documentation":"<p>A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, <code>AWS::EC2::Instance</code> or <code>AWS::CloudTrail::Trail</code>).</p> <p>To record all configuration changes, you must set the <code>allSupported</code> option to <code>false</code>.</p> <p>If you set this option to <code>true</code>, when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.</p> <p>For a list of valid <code>resourceTypes</code> values, see the <b>resourceType Value</b> column in <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources\">Supported AWS Resource Types</a>.</p>"
}
},
"documentation":"<p>Specifies the types of AWS resource for which AWS Config records configuration changes.</p> <p>In the recording group, you specify whether all supported types or specific types of resources are recorded.</p> <p>By default, AWS Config records configuration changes for all supported types of regional resources that AWS Config discovers in the region in which it is running. Regional resources are tied to a region and can be used only in that region. Examples of regional resources are EC2 instances and EBS volumes.</p> <p>You can also have AWS Config record configuration changes for supported types of global resources (for example, IAM resources). Global resources are not tied to an individual region and can be used in all regions.</p> <important> <p>The configuration details for any global resource are the same in all regions. If you customize AWS Config in multiple regions to record global resources, it will create multiple configuration items each time a global resource changes: one configuration item for each region. These configuration items will contain identical data. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources, unless you want the configuration items to be available in multiple regions.</p> </important> <p>If you don't want AWS Config to record all resources, you can specify which types of resources it will record with the <code>resourceTypes</code> parameter.</p> <p>For a list of supported resource types, see <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources\">Supported Resource Types</a>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html\">Selecting Which Resources AWS Config Records</a>.</p>"
@ -6663,7 +6699,7 @@
},
"QueryArn":{
"shape":"QueryArn",
"documentation":"<p>Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-id.</p>",
"documentation":"<p>Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.</p>",
"box":true
},
"QueryName":{
@ -6697,7 +6733,7 @@
},
"QueryArn":{
"shape":"QueryArn",
"documentation":"<p>Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-id.</p>"
"documentation":"<p>Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.</p>"
},
"QueryName":{
"shape":"QueryName",
@ -6864,7 +6900,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>The requested action is not valid.</p>",
"documentation":"<p>The requested action is not valid.</p> <p>For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.</p> <p>For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.</p>",
"exception":true
},
"Value":{"type":"string"},

2
botocore/data/connect/2017-08-08/service-2.json
View file

@ -1969,7 +1969,7 @@
},
"Concurrency":{
"type":"integer",
"max":5,
"max":10,
"min":1
},
"ContactFlow":{

9
botocore/data/cur/2017-01-06/service-2.json
View file

@ -115,6 +115,11 @@
"member":{"shape":"AdditionalArtifact"},
"documentation":"<p>A list of additional artifacts.</p>"
},
"BillingViewArn":{
"type":"string",
"max":128,
"pattern":"(arn:aws(-cn)?:billing::[0-9]{12}:billingview/)?[a-zA-Z0-9_\\+=\\.\\-@].{1,30}"
},
"CompressionFormat":{
"type":"string",
"documentation":"<p>The compression format that AWS uses for the report.</p>",
@ -270,6 +275,10 @@
"ReportVersioning":{
"shape":"ReportVersioning",
"documentation":"<p>Whether you want Amazon Web Services to overwrite the previous version of each report or to deliver the report in addition to the previous versions.</p>"
},
"BillingViewArn":{
"shape":"BillingViewArn",
"documentation":"<p> The Amazon resource name of the billing view. You can get this value by using the billing view service public APIs. </p>"
}
},
"documentation":"<p>The definition of AWS Cost and Usage Report. You can specify the report name, time unit, report format, compression format, S3 bucket, additional artifacts, and schema elements in the definition. </p>"

190
botocore/data/databrew/2017-07-25/service-2.json
View file

@ -25,7 +25,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Deletes one or more versions of a recipe at a time.</p> <p>The entire request will be rejected if:</p> <ul> <li> <p>The recipe does not exist.</p> </li> <li> <p>There is an invalid version identifier in the list of versions.</p> </li> <li> <p>The verision list is empty.</p> </li> <li> <p>The version list size exceeds 50.</p> </li> <li> <p>The verison list contains duplicate entries.</p> </li> </ul> <p>The request will complete successfully, but with partial failures, if:</p> <ul> <li> <p>A version does not exist.</p> </li> <li> <p>A version is being used by a job.</p> </li> <li> <p>You specify <code>LATEST_WORKING</code>, but it's being used by a project.</p> </li> <li> <p>The version fails to be deleted.</p> </li> </ul> <p>The <code>LATEST_WORKING</code> version will only be deleted if the recipe has no other versions. If you try to delete <code>LATEST_WORKING</code> while other versions exist (or if they can't be deleted), then <code>LATEST_WORKING</code> will be listed as partial failure in the response.</p>"
"documentation":"<p>Deletes one or more versions of a recipe at a time.</p> <p>The entire request will be rejected if:</p> <ul> <li> <p>The recipe does not exist.</p> </li> <li> <p>There is an invalid version identifier in the list of versions.</p> </li> <li> <p>The version list is empty.</p> </li> <li> <p>The version list size exceeds 50.</p> </li> <li> <p>The version list contains duplicate entries.</p> </li> </ul> <p>The request will complete successfully, but with partial failures, if:</p> <ul> <li> <p>A version does not exist.</p> </li> <li> <p>A version is being used by a job.</p> </li> <li> <p>You specify <code>LATEST_WORKING</code>, but it's being used by a project.</p> </li> <li> <p>The version fails to be deleted.</p> </li> </ul> <p>The <code>LATEST_WORKING</code> version will only be deleted if the recipe has no other versions. If you try to delete <code>LATEST_WORKING</code> while other versions exist (or if they can't be deleted), then <code>LATEST_WORKING</code> will be listed as partial failure in the response.</p>"
},
"CreateDataset":{
"name":"CreateDataset",
@ -225,6 +225,20 @@
],
"documentation":"<p>Returns the definition of a specific DataBrew job.</p>"
},
"DescribeJobRun":{
"name":"DescribeJobRun",
"http":{
"method":"GET",
"requestUri":"/jobs/{name}/jobRun/{runId}"
},
"input":{"shape":"DescribeJobRunRequest"},
"output":{"shape":"DescribeJobRunResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Represents one run of a DataBrew job.</p>"
},
"DescribeProject":{
"name":"DescribeProject",
"http":{
@ -725,6 +739,10 @@
"shape":"DatasetName",
"documentation":"<p>The name of the dataset to be created. Valid characters are alphanumeric (A-Z, a-z, 0-9), hyphen (-), period (.), and space.</p>"
},
"Format":{
"shape":"InputFormat",
"documentation":"<p>Specifies the file format of a dataset created from an S3 file or folder.</p>"
},
"FormatOptions":{"shape":"FormatOptions"},
"Input":{"shape":"Input"},
"Tags":{
@ -762,7 +780,7 @@
},
"EncryptionMode":{
"shape":"EncryptionMode",
"documentation":"<p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - para&gt;<code>SSE-KMS</code> - server-side encryption with AWS KMS-managed keys.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>"
"documentation":"<p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - <code>SSE-KMS</code> - Server-side encryption with AWS KMS-managed keys.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>"
},
"Name":{
"shape":"JobName",
@ -792,6 +810,10 @@
"Timeout":{
"shape":"Timeout",
"documentation":"<p>The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.</p>"
},
"JobSample":{
"shape":"JobSample",
"documentation":"<p>Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.</p>"
}
}
},
@ -865,7 +887,7 @@
},
"EncryptionMode":{
"shape":"EncryptionMode",
"documentation":"<p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - Server-side encryption with AWS KMS-managed keys.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>"
"documentation":"<p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - Server-side encryption with keys managed by AWS KMS.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>"
},
"Name":{
"shape":"JobName",
@ -998,6 +1020,10 @@
"Delimiter":{
"shape":"Delimiter",
"documentation":"<p>A single character that specifies the delimiter being used in the Csv file.</p>"
},
"HeaderRow":{
"shape":"HeaderRow",
"documentation":"<p>A variable that specifies whether the first row in the file will be parsed as the header. If false, column names will be auto-generated.</p>"
}
},
"documentation":"<p>Options that define how DataBrew will read a Csv file when creating a dataset from that file.</p>"
@ -1010,7 +1036,7 @@
"documentation":"<p>A single character that specifies the delimiter used to create Csv job output.</p>"
}
},
"documentation":"<p>Options that define how DataBrew will write a Csv file a.</p>"
"documentation":"<p>Options that define how DataBrew will write a Csv file.</p>"
},
"DataCatalogInputDefinition":{
"type":"structure",
@ -1066,6 +1092,10 @@
"shape":"DatasetName",
"documentation":"<p>The unique name of the dataset.</p>"
},
"Format":{
"shape":"InputFormat",
"documentation":"<p>Specifies the file format of a dataset created from an S3 file or folder.</p>"
},
"FormatOptions":{
"shape":"FormatOptions",
"documentation":"<p>Options that define how DataBrew interprets the data in the dataset.</p>"
@ -1269,6 +1299,10 @@
"shape":"DatasetName",
"documentation":"<p>The name of the dataset.</p>"
},
"Format":{
"shape":"InputFormat",
"documentation":"<p>Specifies the file format of a dataset created from an S3 file or folder.</p>"
},
"FormatOptions":{"shape":"FormatOptions"},
"Input":{"shape":"Input"},
"LastModifiedDate":{
@ -1327,7 +1361,7 @@
},
"EncryptionMode":{
"shape":"EncryptionMode",
"documentation":"<p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - Server-side encryption with AWS KMS-managed keys.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>"
"documentation":"<p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - Server-side encryption with keys managed by AWS KMS.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>"
},
"Name":{
"shape":"JobName",
@ -1381,6 +1415,94 @@
"Timeout":{
"shape":"Timeout",
"documentation":"<p>The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.</p>"
},
"JobSample":{
"shape":"JobSample",
"documentation":"<p>Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed.</p>"
}
}
},
"DescribeJobRunRequest":{
"type":"structure",
"required":[
"Name",
"RunId"
],
"members":{
"Name":{
"shape":"JobName",
"documentation":"<p>The name of the job being processed during this run.</p>",
"location":"uri",
"locationName":"name"
},
"RunId":{
"shape":"JobRunId",
"documentation":"<p>The unique identifier of the job run.</p>",
"location":"uri",
"locationName":"runId"
}
}
},
"DescribeJobRunResponse":{
"type":"structure",
"required":["JobName"],
"members":{
"Attempt":{
"shape":"Attempt",
"documentation":"<p>The number of times that DataBrew has attempted to run the job.</p>"
},
"CompletedOn":{
"shape":"Date",
"documentation":"<p>The date and time when the job completed processing.</p>"
},
"DatasetName":{
"shape":"DatasetName",
"documentation":"<p>The name of the dataset for the job to process.</p>"
},
"ErrorMessage":{
"shape":"JobRunErrorMessage",
"documentation":"<p>A message indicating an error (if any) that was encountered when the job ran.</p>"
},
"ExecutionTime":{
"shape":"ExecutionTime",
"documentation":"<p>The amount of time, in seconds, during which the job run consumed resources.</p>"
},
"JobName":{
"shape":"JobName",
"documentation":"<p>The name of the job being processed during this run.</p>"
},
"RunId":{
"shape":"JobRunId",
"documentation":"<p>The unique identifier of the job run.</p>"
},
"State":{
"shape":"JobRunState",
"documentation":"<p>The current state of the job run entity itself.</p>"
},
"LogSubscription":{
"shape":"LogSubscription",
"documentation":"<p>The current status of Amazon CloudWatch logging for the job run.</p>"
},
"LogGroupName":{
"shape":"LogGroupName",
"documentation":"<p>The name of an Amazon CloudWatch log group, where the job writes diagnostic messages when it runs.</p>"
},
"Outputs":{
"shape":"OutputList",
"documentation":"<p>One or more output artifacts from a job run.</p>"
},
"RecipeReference":{"shape":"RecipeReference"},
"StartedBy":{
"shape":"StartedBy",
"documentation":"<p>The Amazon Resource Name (ARN) of the user who started the job run.</p>"
},
"StartedOn":{
"shape":"Date",
"documentation":"<p>The date and time when the job run began.</p>"
},
"JobSample":{
"shape":"JobSample",
"documentation":"<p>Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.</p>"
}
}
},
@ -1611,6 +1733,10 @@
"SheetIndexes":{
"shape":"SheetIndexList",
"documentation":"<p>Specifies one or more sheet numbers in the Excel file, which will be included in the dataset.</p>"
},
"HeaderRow":{
"shape":"HeaderRow",
"documentation":"<p>A variable that specifies whether the first row in the file will be parsed as the header. If false, column names will be auto-generated.</p>"
}
},
"documentation":"<p>Options that define how DataBrew will interpret a Microsoft Excel file, when creating a dataset from that file.</p>"
@ -1634,6 +1760,7 @@
},
"documentation":"<p>Options that define the structure of either Csv, Excel, or JSON input.</p>"
},
"HeaderRow":{"type":"boolean"},
"HiddenColumnList":{
"type":"list",
"member":{"shape":"ColumnName"}
@ -1652,6 +1779,15 @@
},
"documentation":"<p>Information on how DataBrew can find data, in either the AWS Glue Data Catalog or Amazon S3.</p>"
},
"InputFormat":{
"type":"string",
"enum":[
"CSV",
"JSON",
"PARQUET",
"EXCEL"
]
},
"InternalServerException":{
"type":"structure",
"members":{
@ -1744,6 +1880,10 @@
"Tags":{
"shape":"TagMap",
"documentation":"<p>Metadata tags that have been applied to the job.</p>"
},
"JobSample":{
"shape":"JobSample",
"documentation":"<p>Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.</p>"
}
},
"documentation":"<p>Represents all of the attributes of a DataBrew job.</p>"
@ -1820,6 +1960,10 @@
"StartedOn":{
"shape":"Date",
"documentation":"<p>The date and time when the job run began. </p>"
},
"JobSample":{
"shape":"JobSample",
"documentation":"<p>Sample configuration for profile jobs only. Determines the number of rows on which the profile job will be executed. If a JobSample value is not provided, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.</p>"
}
},
"documentation":"<p>Represents one run of a DataBrew job.</p>"
@ -1846,6 +1990,21 @@
"TIMEOUT"
]
},
"JobSample":{
"type":"structure",
"members":{
"Mode":{
"shape":"SampleMode",
"documentation":"<p>Determines whether the profile job will be executed on the entire dataset or on a specified number of rows. Must be one of the following:</p> <ul> <li> <p>FULL_DATASET: Profile job will be executed on the entire dataset.</p> </li> <li> <p>CUSTOM_ROWS: Profile job will be executed on the number of rows specified in the Size parameter.</p> </li> </ul>"
},
"Size":{
"shape":"JobSize",
"documentation":"<p>Size parameter is only required when the mode is CUSTOM_ROWS. Profile job will be executed on the the specified number of rows. The maximum value for size is Long.MAX_VALUE.</p> <p>Long.MAX_VALUE = 9223372036854775807</p>"
}
},
"documentation":"<p>Sample configuration for Profile Jobs only. Determines the number of rows on which the Profile job will be executed. If a JobSample value is not provided for profile jobs, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.</p>"
},
"JobSize":{"type":"long"},
"JobType":{
"type":"string",
"enum":[
@ -2253,7 +2412,7 @@
},
"ParameterValue":{
"type":"string",
"max":8192,
"max":12288,
"min":1
},
"Preview":{"type":"boolean"},
@ -2554,6 +2713,13 @@
},
"documentation":"<p>Represents the sample size and sampling type for DataBrew to use for interactive data analysis.</p>"
},
"SampleMode":{
"type":"string",
"enum":[
"FULL_DATASET",
"CUSTOM_ROWS"
]
},
"SampleSize":{
"type":"integer",
"max":5000,
@ -2911,6 +3077,10 @@
"location":"uri",
"locationName":"name"
},
"Format":{
"shape":"InputFormat",
"documentation":"<p>Specifies the file format of a dataset created from an S3 file or folder.</p>"
},
"FormatOptions":{"shape":"FormatOptions"},
"Input":{"shape":"Input"}
}
@ -2939,7 +3109,7 @@
},
"EncryptionMode":{
"shape":"EncryptionMode",
"documentation":"<p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - Server-side encryption with AWS KMS-managed keys.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>"
"documentation":"<p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - Server-side encryption with keys managed by AWS KMS.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>"
},
"Name":{
"shape":"JobName",
@ -2967,6 +3137,10 @@
"Timeout":{
"shape":"Timeout",
"documentation":"<p>The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of <code>TIMEOUT</code>.</p>"
},
"JobSample":{
"shape":"JobSample",
"documentation":"<p>Sample configuration for Profile Jobs only. Determines the number of rows on which the Profile job will be executed. If a JobSample value is not provided for profile jobs, the default value will be used. The default value is CUSTOM_ROWS for the mode parameter and 20000 for the size parameter.</p>"
}
}
},
@ -3028,7 +3202,7 @@
},
"EncryptionMode":{
"shape":"EncryptionMode",
"documentation":"<p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - Server-side encryption with AWS KMS-managed keys.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>"
"documentation":"<p>The encryption mode for the job, which can be one of the following:</p> <ul> <li> <p> <code>SSE-KMS</code> - Server-side encryption with keys managed by AWS KMS.</p> </li> <li> <p> <code>SSE-S3</code> - Server-side encryption with keys managed by Amazon S3.</p> </li> </ul>"
},
"Name":{
"shape":"JobName",

86
botocore/data/dataexchange/2017-07-25/service-2.json
View file

@ -1379,6 +1379,50 @@
"RevisionId"
]
},
"ExportRevisionsToS3RequestDetails": {
"type": "structure",
"members": {
"DataSetId": {
"shape": "Id",
"documentation": "<p>The unique identifier for the data set associated with this export job.</p>"
},
"Encryption": {
"shape": "ExportServerSideEncryption",
"documentation": "<p>Encryption configuration for the export job.</p>"
},
"RevisionDestinations": {
"shape": "ListOfRevisionDestinationEntry",
"documentation": "<p>The destination for the revision.</p>"
}
},
"documentation": "<p>Details of the operation to be performed by the job.</p>",
"required": [
"RevisionDestinations",
"DataSetId"
]
},
"ExportRevisionsToS3ResponseDetails": {
"type": "structure",
"members": {
"DataSetId": {
"shape": "Id",
"documentation": "<p>The unique identifier for the data set associated with this export job.</p>"
},
"Encryption": {
"shape": "ExportServerSideEncryption",
"documentation": "<p>Encryption configuration of the export job.</p>"
},
"RevisionDestinations": {
"shape": "ListOfRevisionDestinationEntry",
"documentation": "<p>The destination in Amazon S3 where the revision is exported.</p>"
}
},
"documentation": "<p>Details about the export revisions to Amazon S3 response.</p>",
"required": [
"RevisionDestinations",
"DataSetId"
]
},
"ExportServerSideEncryption": {
"type": "structure",
"members": {
@ -2034,6 +2078,13 @@
"shape": "AssetSourceEntry"
}
},
"ListOfRevisionDestinationEntry": {
"type": "list",
"documentation": "<p>The destination where the assets in the revision will be exported.</p>",
"member": {
"shape": "RevisionDestinationEntry"
}
},
"ListRevisionAssetsRequest": {
"type": "structure",
"members": {
@ -2147,6 +2198,10 @@
"shape": "ExportAssetsToS3RequestDetails",
"documentation": "<p>Details about the export to Amazon S3 request.</p>"
},
"ExportRevisionsToS3": {
"shape": "ExportRevisionsToS3RequestDetails",
"documentation": "<p>Details about the export to Amazon S3 request.</p>"
},
"ImportAssetFromSignedUrl": {
"shape": "ImportAssetFromSignedUrlRequestDetails",
"documentation": "<p>Details about the import from signed URL request.</p>"
@ -2203,6 +2258,10 @@
"shape": "ExportAssetsToS3ResponseDetails",
"documentation": "<p>Details for the export to Amazon S3 response.</p>"
},
"ExportRevisionsToS3": {
"shape": "ExportRevisionsToS3ResponseDetails",
"documentation": "<p>Details for the export revisions to Amazon S3 response.</p>"
},
"ImportAssetFromSignedUrl": {
"shape": "ImportAssetFromSignedUrlResponseDetails",
"documentation": "<p>Details for the import from signed URL response.</p>"
@ -2214,6 +2273,28 @@
},
"documentation": "<p>Details for the response.</p>"
},
"RevisionDestinationEntry": {
"type": "structure",
"members": {
"Bucket": {
"shape": "__string",
"documentation": "<p>The S3 bucket that is the destination for the assets in the revision.</p>"
},
"KeyPattern": {
"shape": "__string",
"documentation": "<p>A string representing the pattern for generated names of the individual assets in the revision. For more information about key patterns, see <a href=\"https://docs.aws.amazon.com/data-exchange/latest/userguide/jobs.html#revision-export-keypatterns\">Key patterns when exporting revisions</a>.</p>"
},
"RevisionId": {
"shape": "Id",
"documentation": "<p>The unique identifier for the revision.</p>"
}
},
"documentation": "<p>The destination where the assets in the revision will be exported.</p>",
"required": [
"Bucket",
"RevisionId"
]
},
"RevisionEntry": {
"type": "structure",
"members": {
@ -2383,7 +2464,8 @@
"IMPORT_ASSETS_FROM_S3",
"IMPORT_ASSET_FROM_SIGNED_URL",
"EXPORT_ASSETS_TO_S3",
"EXPORT_ASSET_TO_SIGNED_URL"
"EXPORT_ASSET_TO_SIGNED_URL",
"EXPORT_REVISIONS_TO_S3"
]
},
"UntagResourceRequest": {
@ -2704,7 +2786,7 @@
"type": "string",
"min": 24,
"max": 24,
"pattern": "/^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/"
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$"
}
},
"documentation": "<p>AWS Data Exchange is a service that makes it easy for AWS customers to exchange data in the cloud. You can use the AWS Data Exchange APIs to create, update, manage, and access file-based data set in the AWS Cloud.</p><p>As a subscriber, you can view and access the data sets that you have an entitlement to through a subscription. You can use the APIS to download or copy your entitled data sets to Amazon S3 for use across a variety of AWS analytics and machine learning services.</p><p>As a provider, you can create and manage your data sets that you would like to publish to a product. Being able to package and provide your data sets into products requires a few steps to determine eligibility. For more information, visit the AWS Data Exchange User Guide.</p><p>A data set is a collection of data that can be changed or updated over time. Data sets can be updated using revisions, which represent a new version or incremental change to a data set. A revision contains one or more assets. An asset in AWS Data Exchange is a piece of data that can be stored as an Amazon S3 object. The asset can be a structured data file, an image file, or some other data file. Jobs are asynchronous import or export operations used to create or copy assets.</p>"

174
botocore/data/datasync/2018-11-09/service-2.json
View file

@ -68,7 +68,7 @@
{"shape":"InvalidRequestException"},
{"shape":"InternalException"}
],
"documentation":"<p>Creates an endpoint for an Amazon FSx for Windows file system.</p>"
"documentation":"<p>Creates an endpoint for an Amazon FSx for Windows File Server file system.</p>"
},
"CreateLocationNfs":{
"name":"CreateLocationNfs",
@ -138,7 +138,7 @@
{"shape":"InvalidRequestException"},
{"shape":"InternalException"}
],
"documentation":"<p>Creates a task. A task is a set of two locations (source and destination) and a set of Options that you use to control the behavior of a task. If you don't specify Options when you create a task, AWS DataSync populates them with service defaults.</p> <p>When you create a task, it first enters the CREATING state. During CREATING AWS DataSync attempts to mount the on-premises Network File System (NFS) location. The task transitions to the AVAILABLE state without waiting for the AWS location to become mounted. If required, AWS DataSync mounts the AWS location before each task execution.</p> <p>If an agent that is associated with a source (NFS) location goes offline, the task transitions to the UNAVAILABLE status. If the status of the task remains in the CREATING status for more than a few minutes, it means that your agent might be having trouble mounting the source NFS file system. Check the task's ErrorCode and ErrorDetail. Mount issues are often caused by either a misconfigured firewall or a mistyped NFS server hostname.</p>"
"documentation":"<p>Creates a task.</p> <p>A task includes a source location and a destination location, and a configuration that specifies how data is transferred. A task always transfers data from the source location to the destination location. The configuration specifies options such as task scheduling, bandwidth limits, etc. A task is the complete definition of a data transfer.</p> <p>When you create a task that transfers data between AWS services in different AWS Regions, one of the two locations that you specify must reside in the Region where DataSync is being used. The other location must be specified in a different Region.</p> <p>You can transfer data between commercial AWS Regions except for China, or between AWS GovCloud (US-East and US-West) Regions.</p> <important> <p>When you use DataSync to copy files or objects between AWS Regions, you pay for data transfer between Regions. This is billed as data transfer OUT from your source Region to your destination Region. For more information, see <a href=\"http://aws.amazon.com/ec2/pricing/on-demand/#Data_Transfer\">Data Transfer pricing</a>. </p> </important>"
},
"DeleteAgent":{
"name":"DeleteAgent",
@ -222,7 +222,7 @@
{"shape":"InvalidRequestException"},
{"shape":"InternalException"}
],
"documentation":"<p>Returns metadata, such as the path information about an Amazon FSx for Windows location.</p>"
"documentation":"<p>Returns metadata, such as the path information about an Amazon FSx for Windows File Server location.</p>"
},
"DescribeLocationNfs":{
"name":"DescribeLocationNfs",
@ -434,6 +434,48 @@
],
"documentation":"<p>Updates the name of an agent.</p>"
},
"UpdateLocationNfs":{
"name":"UpdateLocationNfs",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateLocationNfsRequest"},
"output":{"shape":"UpdateLocationNfsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalException"}
],
"documentation":"<p>Updates some of the parameters of a previously created location for Network File System (NFS) access. For information about creating an NFS location, see <a>create-nfs-location</a>.</p>"
},
"UpdateLocationObjectStorage":{
"name":"UpdateLocationObjectStorage",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateLocationObjectStorageRequest"},
"output":{"shape":"UpdateLocationObjectStorageResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalException"}
],
"documentation":"<p>Updates some of the parameters of a previously created location for self-managed object storage server access. For information about creating a self-managed object storage location, see <a>create-object-location</a>.</p>"
},
"UpdateLocationSmb":{
"name":"UpdateLocationSmb",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateLocationSmbRequest"},
"output":{"shape":"UpdateLocationSmbResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalException"}
],
"documentation":"<p>Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access. For information about creating an SMB location, see <a>create-smb-location</a>.</p>"
},
"UpdateTask":{
"name":"UpdateTask",
"http":{
@ -460,7 +502,7 @@
{"shape":"InvalidRequestException"},
{"shape":"InternalException"}
],
"documentation":"<p>Updates execution of a task.</p> <p>You can modify bandwidth throttling for a task execution that is running or queued. For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/working-with-task-executions.html#adjust-bandwidth-throttling\">Adjusting Bandwidth Throttling for a Task Execution</a>.</p> <note> <p>The only <code>Option</code> that can be modified by <code>UpdateTaskExecution</code> is <code> <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-BytesPerSecond\">BytesPerSecond</a> </code>.</p> </note>"
"documentation":"<p>Updates execution of a task.</p> <p>You can modify bandwidth throttling for a task execution that is running or queued. For more information, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#adjust-bandwidth-throttling\">Adjusting Bandwidth Throttling for a Task Execution</a>.</p> <note> <p>The only <code>Option</code> that can be modified by <code>UpdateTaskExecution</code> is <code> <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-BytesPerSecond\">BytesPerSecond</a> </code>.</p> </note>"
}
},
"shapes":{
@ -624,15 +666,15 @@
"members":{
"Subdirectory":{
"shape":"FsxWindowsSubdirectory",
"documentation":"<p>A subdirectory in the location’s path. This subdirectory in the Amazon FSx for Windows file system is used to read data from the Amazon FSx for Windows source location or write data to the FSx for Windows destination.</p>"
"documentation":"<p>A subdirectory in the location’s path. This subdirectory in the Amazon FSx for Windows File Server file system is used to read data from the Amazon FSx for Windows File Server source location or write data to the FSx for Windows File Server destination.</p>"
},
"FsxFilesystemArn":{
"shape":"FsxFilesystemArn",
"documentation":"<p>The Amazon Resource Name (ARN) for the FSx for Windows file system.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) for the FSx for Windows File Server file system.</p>"
},
"SecurityGroupArns":{
"shape":"Ec2SecurityGroupArnList",
"documentation":"<p>The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows file system.</p>"
"documentation":"<p>The Amazon Resource Names (ARNs) of the security groups that are to use to configure the FSx for Windows File Server file system.</p>"
},
"Tags":{
"shape":"InputTagList",
@ -640,15 +682,15 @@
},
"User":{
"shape":"SmbUser",
"documentation":"<p>The user who has the permissions to access files and folders in the FSx for Windows file system.</p>"
"documentation":"<p>The user who has the permissions to access files and folders in the FSx for Windows File Server file system.</p>"
},
"Domain":{
"shape":"SmbDomain",
"documentation":"<p>The name of the Windows domain that the FSx for Windows server belongs to.</p>"
"documentation":"<p>The name of the Windows domain that the FSx for Windows File Server belongs to.</p>"
},
"Password":{
"shape":"SmbPassword",
"documentation":"<p>The password of the user who has the permissions to access files and folders in the FSx for Windows file system.</p>"
"documentation":"<p>The password of the user who has the permissions to access files and folders in the FSx for Windows File Server file system.</p>"
}
}
},
@ -657,7 +699,7 @@
"members":{
"LocationArn":{
"shape":"LocationArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the FSx for Windows file system location that is created.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the FSx for Windows File Server file system location that is created.</p>"
}
}
},
@ -1036,7 +1078,7 @@
"members":{
"LocationArn":{
"shape":"LocationArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the FSx for Windows location to describe.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the FSx for Windows File Server location to describe.</p>"
}
}
},
@ -1045,27 +1087,27 @@
"members":{
"LocationArn":{
"shape":"LocationArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the FSx for Windows location that was described.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the FSx for Windows File Server location that was described.</p>"
},
"LocationUri":{
"shape":"LocationUri",
"documentation":"<p>The URL of the FSx for Windows location that was described.</p>"
"documentation":"<p>The URL of the FSx for Windows File Server location that was described.</p>"
},
"SecurityGroupArns":{
"shape":"Ec2SecurityGroupArnList",
"documentation":"<p>The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx for Windows file system.</p>"
"documentation":"<p>The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx for Windows File Server file system.</p>"
},
"CreationTime":{
"shape":"Time",
"documentation":"<p>The time that the FSx for Windows location was created.</p>"
"documentation":"<p>The time that the FSx for Windows File Server location was created.</p>"
},
"User":{
"shape":"SmbUser",
"documentation":"<p>The user who has the permissions to access files and folders in the FSx for Windows file system.</p>"
"documentation":"<p>The user who has the permissions to access files and folders in the FSx for Windows File Server file system.</p>"
},
"Domain":{
"shape":"SmbDomain",
"documentation":"<p>The name of the Windows domain that the FSx for Windows server belongs to.</p>"
"documentation":"<p>The name of the Windows domain that the FSx for Windows File Server belongs to.</p>"
}
}
},
@ -2396,6 +2438,102 @@
"members":{
}
},
"UpdateLocationNfsRequest":{
"type":"structure",
"required":["LocationArn"],
"members":{
"LocationArn":{
"shape":"LocationArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the NFS location to update.</p>"
},
"Subdirectory":{
"shape":"NfsSubdirectory",
"documentation":"<p>The subdirectory in the NFS file system that is used to read data from the NFS source location or write data to the NFS destination. The NFS path should be a path that's exported by the NFS server, or a subdirectory of that path. The path should be such that it can be mounted by other NFS clients in your network.</p> <p>To see all the paths exported by your NFS server, run \"<code>showmount -e nfs-server-name</code>\" from an NFS client that has access to your server. You can specify any directory that appears in the results, and any subdirectory of that directory. Ensure that the NFS export is accessible without Kerberos authentication. </p> <p>To transfer all the data in the folder that you specified, DataSync must have permissions to read all the data. To ensure this, either configure the NFS export with <code>no_root_squash</code>, or ensure that the files you want DataSync to access have permissions that allow read access for all users. Doing either option enables the agent to read the files. For the agent to access directories, you must additionally enable all execute access.</p> <p>If you are copying data to or from your AWS Snowcone device, see <a href=\"https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone\">NFS Server on AWS Snowcone</a> for more information.</p> <p>For information about NFS export configuration, see 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux documentation.</p>"
},
"OnPremConfig":{"shape":"OnPremConfig"},
"MountOptions":{"shape":"NfsMountOptions"}
}
},
"UpdateLocationNfsResponse":{
"type":"structure",
"members":{
}
},
"UpdateLocationObjectStorageRequest":{
"type":"structure",
"required":["LocationArn"],
"members":{
"LocationArn":{
"shape":"LocationArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the self-managed object storage server location to be updated.</p>"
},
"ServerPort":{
"shape":"ObjectStorageServerPort",
"documentation":"<p>The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.</p>"
},
"ServerProtocol":{
"shape":"ObjectStorageServerProtocol",
"documentation":"<p>The protocol that the object storage server uses to communicate. Valid values are <code>HTTP</code> or <code>HTTPS</code>.</p>"
},
"Subdirectory":{
"shape":"S3Subdirectory",
"documentation":"<p>The subdirectory in the self-managed object storage server that is used to read data from.</p>"
},
"AccessKey":{
"shape":"ObjectStorageAccessKey",
"documentation":"<p>Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name and password, respectively.</p>"
},
"SecretKey":{
"shape":"ObjectStorageSecretKey",
"documentation":"<p>Optional. The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use <code>AccessKey</code> and <code>SecretKey</code> to provide the user name and password, respectively.</p>"
},
"AgentArns":{
"shape":"AgentArnList",
"documentation":"<p>The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.</p>"
}
}
},
"UpdateLocationObjectStorageResponse":{
"type":"structure",
"members":{
}
},
"UpdateLocationSmbRequest":{
"type":"structure",
"required":["LocationArn"],
"members":{
"LocationArn":{
"shape":"LocationArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the SMB location to update.</p>"
},
"Subdirectory":{
"shape":"SmbSubdirectory",
"documentation":"<p>The subdirectory in the SMB file system that is used to read data from the SMB source location or write data to the SMB destination. The SMB path should be a path that's exported by the SMB server, or a subdirectory of that path. The path should be such that it can be mounted by other SMB clients in your network.</p> <note> <p> <code>Subdirectory</code> must be specified with forward slashes. For example, <code>/path/to/folder</code>.</p> </note> <p>To transfer all the data in the folder that you specified, DataSync must have permissions to mount the SMB share and to access all the data in that share. To ensure this, do either of the following:</p> <ul> <li> <p>Ensure that the user/password specified belongs to the user who can mount the share and who has the appropriate permissions for all of the files and directories that you want DataSync to access.</p> </li> <li> <p>Use credentials of a member of the Backup Operators group to mount the share. </p> </li> </ul> <p>Doing either of these options enables the agent to access the data. For the agent to access directories, you must also enable all execute access.</p>"
},
"User":{
"shape":"SmbUser",
"documentation":"<p>The user who can mount the share has the permissions to access files and folders in the SMB share.</p>"
},
"Domain":{
"shape":"SmbDomain",
"documentation":"<p>The name of the Windows domain that the SMB server belongs to.</p>"
},
"Password":{
"shape":"SmbPassword",
"documentation":"<p>The password of the user who can mount the share has the permissions to access files and folders in the SMB share.</p>"
},
"AgentArns":{
"shape":"AgentArnList",
"documentation":"<p>The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB) location.</p>"
},
"MountOptions":{"shape":"SmbMountOptions"}
}
},
"UpdateLocationSmbResponse":{
"type":"structure",
"members":{
}
},
"UpdateTaskExecutionRequest":{
"type":"structure",
"required":[

34
botocore/data/detective/2018-10-26/service-2.json
View file

@ -39,7 +39,7 @@
{"shape":"InternalServerException"},
{"shape":"ServiceQuotaExceededException"}
],
"documentation":"<p>Creates a new behavior graph for the calling account, and sets that account as the master account. This operation is called by the account that is enabling Detective.</p> <p>Before you try to enable Detective, make sure that your account has been enrolled in Amazon GuardDuty for at least 48 hours. If you do not meet this requirement, you cannot enable Detective. If you do meet the GuardDuty prerequisite, then when you make the request to enable Detective, it checks whether your data volume is within the Detective quota. If it exceeds the quota, then you cannot enable Detective. </p> <p>The operation also enables Detective for the calling account in the currently selected Region. It returns the ARN of the new behavior graph.</p> <p> <code>CreateGraph</code> triggers a process to create the corresponding data tables for the new behavior graph.</p> <p>An account can only be the master account for one behavior graph within a Region. If the same account calls <code>CreateGraph</code> with the same master account, it always returns the same behavior graph ARN. It does not create a new behavior graph.</p>"
"documentation":"<p>Creates a new behavior graph for the calling account, and sets that account as the administrator account. This operation is called by the account that is enabling Detective.</p> <p>Before you try to enable Detective, make sure that your account has been enrolled in Amazon GuardDuty for at least 48 hours. If you do not meet this requirement, you cannot enable Detective. If you do meet the GuardDuty prerequisite, then when you make the request to enable Detective, it checks whether your data volume is within the Detective quota. If it exceeds the quota, then you cannot enable Detective. </p> <p>The operation also enables Detective for the calling account in the currently selected Region. It returns the ARN of the new behavior graph.</p> <p> <code>CreateGraph</code> triggers a process to create the corresponding data tables for the new behavior graph.</p> <p>An account can only be the administrator account for one behavior graph within a Region. If the same account calls <code>CreateGraph</code> with the same administrator account, it always returns the same behavior graph ARN. It does not create a new behavior graph.</p>"
},
"CreateMembers":{
"name":"CreateMembers",
@ -55,7 +55,7 @@
{"shape":"ValidationException"},
{"shape":"ServiceQuotaExceededException"}
],
"documentation":"<p>Sends a request to invite the specified AWS accounts to be member accounts in the behavior graph. This operation can only be called by the master account for a behavior graph. </p> <p> <code>CreateMembers</code> verifies the accounts and then sends invitations to the verified accounts.</p> <p>The request provides the behavior graph ARN and the list of accounts to invite.</p> <p>The response separates the requested accounts into two lists:</p> <ul> <li> <p>The accounts that <code>CreateMembers</code> was able to start the verification for. This list includes member accounts that are being verified, that have passed verification and are being sent an invitation, and that have failed verification.</p> </li> <li> <p>The accounts that <code>CreateMembers</code> was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph.</p> </li> </ul>"
"documentation":"<p>Sends a request to invite the specified AWS accounts to be member accounts in the behavior graph. This operation can only be called by the administrator account for a behavior graph. </p> <p> <code>CreateMembers</code> verifies the accounts and then invites the verified accounts. The administrator can optionally specify to not send invitation emails to the member accounts. This would be used when the administrator manages their member accounts centrally.</p> <p>The request provides the behavior graph ARN and the list of accounts to invite.</p> <p>The response separates the requested accounts into two lists:</p> <ul> <li> <p>The accounts that <code>CreateMembers</code> was able to start the verification for. This list includes member accounts that are being verified, that have passed verification and are to be invited, and that have failed verification.</p> </li> <li> <p>The accounts that <code>CreateMembers</code> was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph.</p> </li> </ul>"
},
"DeleteGraph":{
"name":"DeleteGraph",
@ -69,7 +69,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Disables the specified behavior graph and queues it to be deleted. This operation removes the graph from each member account's list of behavior graphs.</p> <p> <code>DeleteGraph</code> can only be called by the master account for a behavior graph.</p>"
"documentation":"<p>Disables the specified behavior graph and queues it to be deleted. This operation removes the graph from each member account's list of behavior graphs.</p> <p> <code>DeleteGraph</code> can only be called by the administrator account for a behavior graph.</p>"
},
"DeleteMembers":{
"name":"DeleteMembers",
@ -85,7 +85,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Deletes one or more member accounts from the master account behavior graph. This operation can only be called by a Detective master account. That account cannot use <code>DeleteMembers</code> to delete their own account from the behavior graph. To disable a behavior graph, the master account uses the <code>DeleteGraph</code> API method.</p>"
"documentation":"<p>Deletes one or more member accounts from the administrator account's behavior graph. This operation can only be called by a Detective administrator account. That account cannot use <code>DeleteMembers</code> to delete their own account from the behavior graph. To disable a behavior graph, the administrator account uses the <code>DeleteGraph</code> API method.</p>"
},
"DisassociateMembership":{
"name":"DisassociateMembership",
@ -129,7 +129,7 @@
{"shape":"InternalServerException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Returns the list of behavior graphs that the calling account is a master of. This operation can only be called by a master account.</p> <p>Because an account can currently only be the master of one behavior graph within a Region, the results always contain a single graph.</p>"
"documentation":"<p>Returns the list of behavior graphs that the calling account is an administrator account of. This operation can only be called by an administrator account.</p> <p>Because an account can currently only be the administrator of one behavior graph within a Region, the results always contain a single behavior graph.</p>"
},
"ListInvitations":{
"name":"ListInvitations",
@ -219,7 +219,7 @@
"documentation":"<p>The AWS account root user email address for the AWS account.</p>"
}
},
"documentation":"<p>An AWS account that is the master of or a member of a behavior graph.</p>"
"documentation":"<p>An AWS account that is the administrator account of or a member of a behavior graph.</p>"
},
"AccountId":{
"type":"string",
@ -239,6 +239,7 @@
"max":50,
"min":1
},
"Boolean":{"type":"boolean"},
"ConflictException":{
"type":"structure",
"members":{
@ -272,6 +273,10 @@
"shape":"EmailMessage",
"documentation":"<p>Customized message text to include in the invitation email message to the invited member accounts.</p>"
},
"DisableEmailNotification":{
"shape":"Boolean",
"documentation":"<p>if set to <code>true</code>, then the member accounts do not receive email notifications. By default, this is set to <code>false</code>, and the member accounts receive email notifications.</p>"
},
"Accounts":{
"shape":"AccountList",
"documentation":"<p>The list of AWS accounts to invite to become member accounts in the behavior graph. For each invited account, the account list contains the account identifier and the AWS account root user email address.</p>"
@ -432,7 +437,7 @@
"members":{
"GraphList":{
"shape":"GraphList",
"documentation":"<p>A list of behavior graphs that the account is a master for.</p>"
"documentation":"<p>A list of behavior graphs that the account is an administrator account for.</p>"
},
"NextToken":{
"shape":"PaginationToken",
@ -514,7 +519,13 @@
},
"MasterId":{
"shape":"AccountId",
"documentation":"<p>The AWS account identifier of the master account for the behavior graph.</p>"
"documentation":"<p>Deprecated. Instead of <code>MasterId</code>, use <code>AdministratorId</code>.</p> <p>The AWS account identifier of the administrator account for the behavior graph.</p>",
"deprecated":true,
"deprecatedMessage":"This property is deprecated, use AdministratorId instead."
},
"AdministratorId":{
"shape":"AccountId",
"documentation":"<p>The AWS account identifier of the administrator account for the behavior graph.</p>"
},
"Status":{
"shape":"MemberStatus",
@ -621,7 +632,10 @@
}
}
},
"Timestamp":{"type":"timestamp"},
"Timestamp":{
"type":"timestamp",
"timestampFormat":"iso8601"
},
"UnprocessedAccount":{
"type":"structure",
"members":{
@ -651,5 +665,5 @@
"exception":true
}
},
"documentation":"<p>Detective uses machine learning and purpose-built visualizations to help you analyze and investigate security issues across your Amazon Web Services (AWS) workloads. Detective automatically extracts time-based events such as login attempts, API calls, and network traffic from AWS CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by Amazon GuardDuty.</p> <p>The Detective API primarily supports the creation and management of behavior graphs. A behavior graph contains the extracted data from a set of member accounts, and is created and managed by a master account.</p> <p>Every behavior graph is specific to a Region. You can only use the API to manage graphs that belong to the Region that is associated with the currently selected endpoint.</p> <p>A Detective master account can use the Detective API to do the following:</p> <ul> <li> <p>Enable and disable Detective. Enabling Detective creates a new behavior graph.</p> </li> <li> <p>View the list of member accounts in a behavior graph.</p> </li> <li> <p>Add member accounts to a behavior graph.</p> </li> <li> <p>Remove member accounts from a behavior graph.</p> </li> </ul> <p>A member account can use the Detective API to do the following:</p> <ul> <li> <p>View the list of behavior graphs that they are invited to.</p> </li> <li> <p>Accept an invitation to contribute to a behavior graph.</p> </li> <li> <p>Decline an invitation to contribute to a behavior graph.</p> </li> <li> <p>Remove their account from a behavior graph.</p> </li> </ul> <p>All API actions are logged as CloudTrail events. See <a href=\"https://docs.aws.amazon.com/detective/latest/adminguide/logging-using-cloudtrail.html\">Logging Detective API Calls with CloudTrail</a>.</p>"
"documentation":"<p>Detective uses machine learning and purpose-built visualizations to help you analyze and investigate security issues across your Amazon Web Services (AWS) workloads. Detective automatically extracts time-based events such as login attempts, API calls, and network traffic from AWS CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by Amazon GuardDuty.</p> <p>The Detective API primarily supports the creation and management of behavior graphs. A behavior graph contains the extracted data from a set of member accounts, and is created and managed by an administrator account.</p> <p>Every behavior graph is specific to a Region. You can only use the API to manage graphs that belong to the Region that is associated with the currently selected endpoint.</p> <p>A Detective administrator account can use the Detective API to do the following:</p> <ul> <li> <p>Enable and disable Detective. Enabling Detective creates a new behavior graph.</p> </li> <li> <p>View the list of member accounts in a behavior graph.</p> </li> <li> <p>Add member accounts to a behavior graph.</p> </li> <li> <p>Remove member accounts from a behavior graph.</p> </li> </ul> <p>A member account can use the Detective API to do the following:</p> <ul> <li> <p>View the list of behavior graphs that they are invited to.</p> </li> <li> <p>Accept an invitation to contribute to a behavior graph.</p> </li> <li> <p>Decline an invitation to contribute to a behavior graph.</p> </li> <li> <p>Remove their account from a behavior graph.</p> </li> </ul> <p>All API actions are logged as CloudTrail events. See <a href=\"https://docs.aws.amazon.com/detective/latest/adminguide/logging-using-cloudtrail.html\">Logging Detective API Calls with CloudTrail</a>.</p> <note> <p>We replaced the term \"master account\" with the term \"administrator account.\" An administrator account is used to centrally manage multiple accounts. In the case of Detective, the administrator account manages the accounts in their behavior graph.</p> </note>"
}

33
botocore/data/devops-guru/2020-12-01/service-2.json
View file

@ -84,6 +84,24 @@
],
"documentation":"<p> Returns details about an anomaly that you specify using its ID. </p>"
},
"DescribeFeedback":{
"name":"DescribeFeedback",
"http":{
"method":"POST",
"requestUri":"/feedback",
"responseCode":200
},
"input":{"shape":"DescribeFeedbackRequest"},
"output":{"shape":"DescribeFeedbackResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InternalServerException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"ValidationException"}
],
"documentation":"<p> Returns the most recent feedback submitted in the current AWS account and Region. </p>"
},
"DescribeInsight":{
"name":"DescribeInsight",
"http":{
@ -643,6 +661,21 @@
}
}
},
"DescribeFeedbackRequest":{
"type":"structure",
"members":{
"InsightId":{
"shape":"InsightId",
"documentation":"<p> The ID of the insight for which the feedback was provided. </p>"
}
}
},
"DescribeFeedbackResponse":{
"type":"structure",
"members":{
"InsightFeedback":{"shape":"InsightFeedback"}
}
},
"DescribeInsightRequest":{
"type":"structure",
"required":["Id"],

6
botocore/data/directconnect/2012-10-25/service-2.json
View file

@ -215,7 +215,7 @@
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Creates a BGP peer on the specified virtual interface.</p> <p>You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access AWS resources that also use that address family.</p> <p>If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface.</p> <p>When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.</p> <p>For a public virtual interface, the Autonomous System Number (ASN) must be private or already whitelisted for the virtual interface.</p>"
"documentation":"<p>Creates a BGP peer on the specified virtual interface.</p> <p>You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access AWS resources that also use that address family.</p> <p>If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface.</p> <p>When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.</p> <p>For a public virtual interface, the Autonomous System Number (ASN) must be private or already on the allow list for the virtual interface.</p>"
},
"CreateConnection":{
"name":"CreateConnection",
@ -537,7 +537,7 @@
{"shape":"DirectConnectServerException"},
{"shape":"DirectConnectClientException"}
],
"documentation":"<p>Lists the associations between your Direct Connect gateways and virtual private gateways. You must specify a Direct Connect gateway, a virtual private gateway, or both. If you specify a Direct Connect gateway, the response contains all virtual private gateways associated with the Direct Connect gateway. If you specify a virtual private gateway, the response contains all Direct Connect gateways associated with the virtual private gateway. If you specify both, the response contains the association between the Direct Connect gateway and the virtual private gateway.</p>"
"documentation":"<p>Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways. You must specify one of the following:</p> <ul> <li> <p>A Direct Connect gateway</p> <p>The response contains all virtual private gateways and transit gateways associated with the Direct Connect gateway.</p> </li> <li> <p>A virtual private gateway</p> <p>The response contains the Direct Connect gateway.</p> </li> <li> <p>A transit gateway</p> <p>The response contains the Direct Connect gateway.</p> </li> <li> <p>A Direct Connect gateway and a virtual private gateway</p> <p>The response contains the association between the Direct Connect gateway and virtual private gateway.</p> </li> <li> <p>A Direct Connect gateway and a transit gateway</p> <p>The response contains the association between the Direct Connect gateway and transit gateway.</p> </li> </ul>"
},
"DescribeDirectConnectGatewayAttachments":{
"name":"DescribeDirectConnectGatewayAttachments",
@ -1899,7 +1899,7 @@
},
"virtualGatewayId":{
"shape":"VirtualGatewayId",
"documentation":"<p>The ID of the virtual private gateway.</p>"
"documentation":"<p>The ID of the virtual private gateway or transit gateway.</p>"
}
}
},

45
botocore/data/dlm/2018-01-12/service-2.json
View file

@ -241,6 +241,10 @@
"CreateRule":{
"type":"structure",
"members":{
"Location":{
"shape":"LocationValues",
"documentation":"<p>Specifies the destination for snapshots created by the policy. To create snapshots in the same Region as the source resource, specify <code>CLOUD</code>. To create snapshots on the same Outpost as the source resource, specify <code>OUTPOST_LOCAL</code>. If you omit this parameter, <code>CLOUD</code> is used by default.</p> <p>If the policy targets resources in an AWS Region, then you must create snapshots in the same Region as the source resource. </p> <p>If the policy targets resources on an Outpost, then you can create snapshots on the same Outpost as the source resource, or in the Region of that Outpost.</p>"
},
"Interval":{
"shape":"Interval",
"documentation":"<p>The interval between snapshots. The supported values are 1, 2, 3, 4, 6, 8, 12, and 24.</p>"
@ -307,14 +311,15 @@
},
"CrossRegionCopyRule":{
"type":"structure",
"required":[
"TargetRegion",
"Encrypted"
],
"required":["Encrypted"],
"members":{
"TargetRegion":{
"shape":"TargetRegion",
"documentation":"<p>The target Region.</p>"
"documentation":"<p>The target Region for the snapshot copies.</p> <p>If you specify a target Region, you must omit <b>Target</b>. You cannot specify a target Region and a target Outpost in the same rule.</p>"
},
"Target":{
"shape":"Target",
"documentation":"<p>The Amazon Resource Name (ARN) of the target AWS Outpost for the snapshot copies.</p> <p>If you specify an ARN, you must omit <b>TargetRegion</b>. You cannot specify a target Region and a target Outpost in the same rule.</p>"
},
"Encrypted":{
"shape":"Encrypted",
@ -678,6 +683,13 @@
}
}
},
"LocationValues":{
"type":"string",
"enum":[
"CLOUD",
"OUTPOST_LOCAL"
]
},
"NoReboot":{"type":"boolean"},
"Parameter":{"type":"string"},
"ParameterList":{
@ -721,6 +733,10 @@
"shape":"ResourceTypeValuesList",
"documentation":"<p>The target resource type for snapshot and AMI lifecycle policies. Use <code>VOLUME </code>to create snapshots of individual volumes or use <code>INSTANCE</code> to create multi-volume snapshots from the volumes for an instance.</p> <p>This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.</p>"
},
"ResourceLocations":{
"shape":"ResourceLocationList",
"documentation":"<p>The location of the resources to backup. If the source resources are located in an AWS Region, specify <code>CLOUD</code>. If the source resources are located on an AWS Outpost in your account, specify <code>OUTPOST</code>. </p> <p>If you specify <code>OUTPOST</code>, Amazon Data Lifecycle Manager backs up all resources of the specified type with matching target tags across all of the Outposts in your account.</p>"
},
"TargetTags":{
"shape":"TargetTagList",
"documentation":"<p>The single tag that identifies targeted resources for this policy.</p> <p>This parameter is required for snapshot and AMI policies only. If you are creating an event-based policy, omit this parameter.</p>"
@ -762,6 +778,19 @@
"EVENT_BASED_POLICY"
]
},
"ResourceLocationList":{
"type":"list",
"member":{"shape":"ResourceLocationValues"},
"max":1,
"min":1
},
"ResourceLocationValues":{
"type":"string",
"enum":[
"CLOUD",
"OUTPOST"
]
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
@ -853,7 +882,7 @@
},
"CrossRegionCopyRules":{
"shape":"CrossRegionCopyRules",
"documentation":"<p>The rule for cross-Region snapshot copies.</p>"
"documentation":"<p>The rule for cross-Region snapshot copies.</p> <p>You can only specify cross-Region copy rules for policies that create snapshots in a Region. If the policy creates snapshots on an Outpost, then you cannot copy the snapshots to a Region or to an Outpost. If the policy creates snapshots in a Region, then snapshots can be copied to up to three Regions or Outposts.</p>"
},
"ShareRules":{
"shape":"ShareRules",
@ -1015,9 +1044,9 @@
},
"Target":{
"type":"string",
"max":16,
"max":2048,
"min":0,
"pattern":"^[\\\\w:\\\\-\\\\/\\\\*]+$"
"pattern":"^[\\w:\\-\\/\\*]+$"
},
"TargetRegion":{
"type":"string",

6
botocore/data/ec2/2016-11-15/paginators-1.json
View file

@ -583,6 +583,12 @@
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "TransitGatewayConnects"
},
"DescribeAddressesAttribute": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Addresses"
}
}
}

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

File diff suppressed because one or more lines are too long

170
botocore/data/ecr-public/2020-10-30/service-2.json
View file

@ -78,6 +78,8 @@
"errors":[
{"shape":"ServerException"},
{"shape":"InvalidParameterException"},
{"shape":"InvalidTagParameterException"},
{"shape":"TooManyTagsException"},
{"shape":"RepositoryAlreadyExistsException"},
{"shape":"LimitExceededException"}
],
@ -252,6 +254,21 @@
],
"documentation":"<p>Notifies Amazon ECR that you intend to upload an image layer.</p> <p>When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action.</p> <note> <p>This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the <code>docker</code> CLI to pull, tag, and push images.</p> </note>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"RepositoryNotFoundException"},
{"shape":"ServerException"}
],
"documentation":"<p>List the tags for an Amazon ECR Public resource.</p>"
},
"PutImage":{
"name":"PutImage",
"http":{
@ -320,6 +337,40 @@
],
"documentation":"<p>Applies a repository policy to the specified public repository to control access permissions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/repository-policies.html\">Amazon ECR Repository Policies</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"InvalidTagParameterException"},
{"shape":"TooManyTagsException"},
{"shape":"RepositoryNotFoundException"},
{"shape":"ServerException"}
],
"documentation":"<p>Associates the specified tags to a resource with the specified <code>resourceArn</code>. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"InvalidTagParameterException"},
{"shape":"TooManyTagsException"},
{"shape":"RepositoryNotFoundException"},
{"shape":"ServerException"}
],
"documentation":"<p>Deletes specified tags from a resource.</p>"
},
"UploadLayerPart":{
"name":"UploadLayerPart",
"http":{
@ -512,6 +563,10 @@
"catalogData":{
"shape":"RepositoryCatalogDataInput",
"documentation":"<p>The details about the repository that are publicly visible in the Amazon ECR Public Gallery.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>The metadata that you apply to the repository to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</p>"
}
}
},
@ -1074,6 +1129,14 @@
"documentation":"<p>The specified parameter is invalid. Review the available parameters for the API request.</p>",
"exception":true
},
"InvalidTagParameterException":{
"type":"structure",
"members":{
"message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>An invalid parameter has been specified. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</p>",
"exception":true
},
"Layer":{
"type":"structure",
"members":{
@ -1185,6 +1248,25 @@
"documentation":"<p>The operation did not succeed because it would have exceeded a service limit for your account. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/service-quotas.html\">Amazon ECR Service Quotas</a> in the Amazon Elastic Container Registry User Guide.</p>",
"exception":true
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["resourceArn"],
"members":{
"resourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resource is an Amazon ECR Public repository.</p>"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"tags":{
"shape":"TagList",
"documentation":"<p>The tags for the resource.</p>"
}
}
},
"LogoImageBlob":{
"type":"blob",
"max":512000,
@ -1657,6 +1739,72 @@
}
}
},
"Tag":{
"type":"structure",
"members":{
"Key":{
"shape":"TagKey",
"documentation":"<p>One part of a key-value pair that make up a tag. A <code>key</code> is a general label that acts like a category for more specific tag values.</p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p>The optional part of a key-value pair that make up a tag. A <code>value</code> acts as a descriptor within a tag category (key).</p>"
}
},
"documentation":"<p>The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</p>"
},
"TagKey":{
"type":"string",
"max":128,
"min":1
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":200,
"min":0
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"},
"max":200,
"min":0
},
"TagResourceRequest":{
"type":"structure",
"required":[
"resourceArn",
"tags"
],
"members":{
"resourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resource is an Amazon ECR Public repository.</p>"
},
"tags":{
"shape":"TagList",
"documentation":"<p>The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</p>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256,
"min":0
},
"TooManyTagsException":{
"type":"structure",
"members":{
"message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The list of tags on the repository is over the limit. The maximum number of tags that can be applied to a repository is 50.</p>",
"exception":true
},
"UnsupportedCommandException":{
"type":"structure",
"members":{
@ -1665,6 +1813,28 @@
"documentation":"<p>The action is not supported in this Region.</p>",
"exception":true
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"resourceArn",
"tagKeys"
],
"members":{
"resourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resource is an Amazon ECR Public repository.</p>"
},
"tagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The keys of the tags to be removed.</p>"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"UploadId":{
"type":"string",
"pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"

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

@ -348,6 +348,24 @@
],
"documentation":"<note> <p>This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.</p> </note> <p>Returns an endpoint for the Amazon ECS agent to poll for updates.</p>"
},
"ExecuteCommand":{
"name":"ExecuteCommand",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ExecuteCommandRequest"},
"output":{"shape":"ExecuteCommandResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"InvalidParameterException"},
{"shape":"AccessDeniedException"},
{"shape":"ClusterNotFoundException"},
{"shape":"TargetNotConnectedException"}
],
"documentation":"<p>Runs a command remotely on a container within a task.</p>"
},
"ListAccountSettings":{
"name":"ListAccountSettings",
"http":{
@ -730,6 +748,22 @@
],
"documentation":"<p>Modifies the parameters for a capacity provider.</p>"
},
"UpdateCluster":{
"name":"UpdateCluster",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateClusterRequest"},
"output":{"shape":"UpdateClusterResponse"},
"errors":[
{"shape":"ServerException"},
{"shape":"ClientException"},
{"shape":"ClusterNotFoundException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Updates the cluster.</p>"
},
"UpdateClusterSettings":{
"name":"UpdateClusterSettings",
"http":{
@ -1085,14 +1119,14 @@
},
"weight":{
"shape":"CapacityProviderStrategyItemWeight",
"documentation":"<p>The <i>weight</i> value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.</p> <p>For example, if you have a strategy that contains two capacity providers and both have a weight of <code>1</code>, then when the <code>base</code> is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of <code>1</code> for <i>capacityProviderA</i> and a weight of <code>4</code> for <i>capacityProviderB</i>, then for every one task that is run using <i>capacityProviderA</i>, four tasks would use <i>capacityProviderB</i>.</p>"
"documentation":"<p>The <i>weight</i> value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider. The <code>weight</code> value is taken into consideration after the <code>base</code> value, if defined, is satisfied.</p> <p>If no <code>weight</code> value is specified, the default value of <code>0</code> is used. When multiple capacity providers are specified within a capacity provider strategy, at least one of the capacity providers must have a weight value greater than zero and any capacity providers with a weight of <code>0</code> will not be used to place tasks. If you specify multiple capacity providers in a strategy that all have a weight of <code>0</code>, any <code>RunTask</code> or <code>CreateService</code> actions using the capacity provider strategy will fail.</p> <p>An example scenario for using weights is defining a strategy that contains two capacity providers and both have a weight of <code>1</code>, then when the <code>base</code> is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of <code>1</code> for <i>capacityProviderA</i> and a weight of <code>4</code> for <i>capacityProviderB</i>, then for every one task that is run using <i>capacityProviderA</i>, four tasks would use <i>capacityProviderB</i>.</p>"
},
"base":{
"shape":"CapacityProviderStrategyItemBase",
"documentation":"<p>The <i>base</i> value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a <i>base</i> defined.</p>"
"documentation":"<p>The <i>base</i> value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a <i>base</i> defined. If no value is specified, the default value of <code>0</code> is used.</p>"
}
},
"documentation":"<p>The details of a capacity provider strategy.</p>"
"documentation":"<p>The details of a capacity provider strategy. A capacity provider strategy can be set when using the <a>RunTask</a> or <a>CreateCluster</a> APIs or as the default capacity provider strategy for a cluster with the <a>CreateCluster</a> API.</p> <p>Only capacity providers that are already associated with a cluster and have an <code>ACTIVE</code> or <code>UPDATING</code> status can be used in a capacity provider strategy. The <a>PutClusterCapacityProviders</a> API is used to associate a capacity provider with a cluster.</p> <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New Auto Scaling group capacity providers can be created with the <a>CreateCapacityProvider</a> API operation.</p> <p>To use a AWS Fargate capacity provider, specify either the <code>FARGATE</code> or <code>FARGATE_SPOT</code> capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used in a capacity provider strategy.</p>"
},
"CapacityProviderStrategyItemBase":{
"type":"integer",
@ -1138,6 +1172,10 @@
"shape":"String",
"documentation":"<p>A user-generated string that you use to identify your cluster.</p>"
},
"configuration":{
"shape":"ClusterConfiguration",
"documentation":"<p>The execute command configuration for the cluster.</p>"
},
"status":{
"shape":"String",
"documentation":"<p>The status of the cluster. The following are the possible states that will be returned.</p> <dl> <dt>ACTIVE</dt> <dd> <p>The cluster is ready to accept tasks and if applicable you can register container instances with the cluster.</p> </dd> <dt>PROVISIONING</dt> <dd> <p>The cluster has capacity providers associated with it and the resources needed for the capacity provider are being created.</p> </dd> <dt>DEPROVISIONING</dt> <dd> <p>The cluster has capacity providers associated with it and the resources needed for the capacity provider are being deleted.</p> </dd> <dt>FAILED</dt> <dd> <p>The cluster has capacity providers associated with it and the resources needed for the capacity provider have failed to create.</p> </dd> <dt>INACTIVE</dt> <dd> <p>The cluster has been deleted. Clusters with an <code>INACTIVE</code> status may remain discoverable in your account for a period of time. However, this behavior is subject to change in the future, so you should not rely on <code>INACTIVE</code> clusters persisting.</p> </dd> </dl>"
@ -1189,6 +1227,16 @@
},
"documentation":"<p>A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.</p>"
},
"ClusterConfiguration":{
"type":"structure",
"members":{
"executeCommandConfiguration":{
"shape":"ExecuteCommandConfiguration",
"documentation":"<p>The details of the execute command configuration.</p>"
}
},
"documentation":"<p>The execute command configuration for the cluster.</p>"
},
"ClusterContainsContainerInstancesException":{
"type":"structure",
"members":{
@ -1214,6 +1262,7 @@
"type":"string",
"enum":[
"ATTACHMENTS",
"CONFIGURATIONS",
"SETTINGS",
"STATISTICS",
"TAGS"
@ -1325,6 +1374,10 @@
"shape":"HealthStatus",
"documentation":"<p>The health status of the container. If health checks are not configured for this container in its task definition, then it reports the health status as <code>UNKNOWN</code>.</p>"
},
"managedAgents":{
"shape":"ManagedAgents",
"documentation":"<p>The details of any Amazon ECS managed agents associated with the container.</p>"
},
"cpu":{
"shape":"String",
"documentation":"<p>The number of CPU units set for the container. The value will be <code>0</code> if no value was specified in the container definition when the task definition was registered.</p>"
@ -1454,7 +1507,7 @@
},
"privileged":{
"shape":"BoxedBoolean",
"documentation":"<p>When this parameter is true, the container is given elevated privileges on the host container instance (similar to the <code>root</code> user). This parameter maps to <code>Privileged</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--privileged</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers or tasks using the Fargate launch type.</p> </note>"
"documentation":"<p>When this parameter is true, the container is given elevated privileges on the host container instance (similar to the <code>root</code> user). This parameter maps to <code>Privileged</code> in the <a href=\"https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate\">Create a container</a> section of the <a href=\"https://docs.docker.com/engine/api/v1.35/\">Docker Remote API</a> and the <code>--privileged</code> option to <a href=\"https://docs.docker.com/engine/reference/run/#security-configuration\">docker run</a>.</p> <note> <p>This parameter is not supported for Windows containers or tasks run on AWS Fargate.</p> </note>"
},
"readonlyRootFilesystem":{
"shape":"BoxedBoolean",
@ -1766,13 +1819,17 @@
"shape":"ClusterSettings",
"documentation":"<p>The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the <code>containerInsights</code> value set with <a>PutAccountSetting</a> or <a>PutAccountSettingDefault</a>.</p>"
},
"configuration":{
"shape":"ClusterConfiguration",
"documentation":"<p>The execute command configuration for the cluster.</p>"
},
"capacityProviders":{
"shape":"StringList",
"documentation":"<p>The short name of one or more capacity providers to associate with the cluster.</p> <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New capacity providers can be created with the <a>CreateCapacityProvider</a> API operation.</p> <p>To use a AWS Fargate capacity provider, specify either the <code>FARGATE</code> or <code>FARGATE_SPOT</code> capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.</p> <p>The <a>PutClusterCapacityProviders</a> API operation is used to update the list of available capacity providers for a cluster after the cluster is created.</p>"
"documentation":"<p>The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the <a>CreateService</a> or <a>RunTask</a> actions.</p> <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New Auto Scaling group capacity providers can be created with the <a>CreateCapacityProvider</a> API operation.</p> <p>To use a AWS Fargate capacity provider, specify either the <code>FARGATE</code> or <code>FARGATE_SPOT</code> capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.</p> <p>The <a>PutClusterCapacityProviders</a> API operation is used to update the list of available capacity providers for a cluster after the cluster is created.</p>"
},
"defaultCapacityProviderStrategy":{
"shape":"CapacityProviderStrategy",
"documentation":"<p>The capacity provider strategy to use by default for the cluster.</p> <p>When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.</p> <p>A capacity provider strategy consists of one or more capacity providers along with the <code>base</code> and <code>weight</code> to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The <a>PutClusterCapacityProviders</a> API is used to associate a capacity provider with a cluster. Only capacity providers with an <code>ACTIVE</code> or <code>UPDATING</code> status can be used.</p> <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the <a>CreateCapacityProvider</a> API operation.</p> <p>To use a AWS Fargate capacity provider, specify either the <code>FARGATE</code> or <code>FARGATE_SPOT</code> capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.</p> <p>If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the <a>PutClusterCapacityProviders</a> API operation.</p>"
"documentation":"<p>The capacity provider strategy to set as the default for the cluster. When a default capacity provider strategy is set for a cluster, when calling the <a>RunTask</a> or <a>CreateService</a> APIs wtih no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.</p> <p>If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the <a>PutClusterCapacityProviders</a> API operation.</p>"
}
}
},
@ -1803,11 +1860,11 @@
},
"loadBalancers":{
"shape":"LoadBalancers",
"documentation":"<p>A load balancer object representing the load balancers to use with your service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html\">Service Load Balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If the service is using the rolling update (<code>ECS</code>) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that make use of multiple target groups. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html\">Using Service-Linked Roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If the service is using the <code>CODE_DEPLOY</code> deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a <code>targetGroupPair</code>). During a deployment, AWS CodeDeploy determines which task set in your service has the status <code>PRIMARY</code> and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.</p> <p>After you create a service using the <code>ECS</code> deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the <code>CODE_DEPLOY</code> deployment controller, these values can be changed when updating the service.</p> <p>For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.</p> <p>For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.</p> <p>Services with tasks that use the <code>awsvpc</code> network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose <code>ip</code> as the target type, not <code>instance</code>, because tasks that use the <code>awsvpc</code> network mode are associated with an elastic network interface, not an Amazon EC2 instance.</p>"
"documentation":"<p>A load balancer object representing the load balancers to use with your service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-load-balancing.html\">Service Load Balancing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If the service is using the rolling update (<code>ECS</code>) deployment controller and using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to attach to the service. The service-linked role is required for services that make use of multiple target groups. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html\">Using service-linked roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If the service is using the <code>CODE_DEPLOY</code> deployment controller, the service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment group, you specify two target groups (referred to as a <code>targetGroupPair</code>). During a deployment, AWS CodeDeploy determines which task set in your service has the status <code>PRIMARY</code> and associates one target group with it, and then associates the other target group with the replacement task set. The load balancer can also have up to two listeners: a required listener for production traffic and an optional listener that allows you perform validation tests with Lambda functions before routing production traffic to it.</p> <p>After you create a service using the <code>ECS</code> deployment controller, the load balancer name or target group ARN, container name, and container port specified in the service definition are immutable. If you are using the <code>CODE_DEPLOY</code> deployment controller, these values can be changed when updating the service.</p> <p>For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN, the container name (as it appears in a container definition), and the container port to access from the load balancer. The load balancer name parameter must be omitted. When a task from this service is placed on a container instance, the container instance and port combination is registered as a target in the target group specified here.</p> <p>For Classic Load Balancers, this object must contain the load balancer name, the container name (as it appears in a container definition), and the container port to access from the load balancer. The target group ARN parameter must be omitted. When a task from this service is placed on a container instance, the container instance is registered with the load balancer specified here.</p> <p>Services with tasks that use the <code>awsvpc</code> network mode (for example, those with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are not supported. Also, when you create any target groups for these services, you must choose <code>ip</code> as the target type, not <code>instance</code>, because tasks that use the <code>awsvpc</code> network mode are associated with an elastic network interface, not an Amazon EC2 instance.</p>"
},
"serviceRegistries":{
"shape":"ServiceRegistries",
"documentation":"<p>The details of the service discovery registries to assign to this service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html\">Service Discovery</a>.</p> <note> <p>Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate Platform Versions</a>.</p> </note>"
"documentation":"<p>The details of the service discovery registries to assign to this service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html\">Service discovery</a>.</p> <note> <p>Service discovery is supported for Fargate tasks if you are using platform version v1.1.0 or later. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate platform versions</a>.</p> </note>"
},
"desiredCount":{
"shape":"BoxedInteger",
@ -1819,19 +1876,19 @@
},
"launchType":{
"shape":"LaunchType",
"documentation":"<p>The launch type on which to run your service. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS Launch Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If a <code>launchType</code> is specified, the <code>capacityProviderStrategy</code> parameter must be omitted.</p>"
"documentation":"<p>The launch type on which to run your service. The accepted values are <code>FARGATE</code> and <code>EC2</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS launch types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>When a value of <code>FARGATE</code> is specified, your tasks are launched on AWS Fargate On-Demand infrastructure. To use Fargate Spot, you must use a capacity provider strategy with the <code>FARGATE_SPOT</code> capacity provider.</p> <p>When a value of <code>EC2</code> is specified, your tasks are launched on Amazon EC2 instances registered to your cluster.</p> <p>If a <code>launchType</code> is specified, the <code>capacityProviderStrategy</code> parameter must be omitted.</p>"
},
"capacityProviderStrategy":{
"shape":"CapacityProviderStrategy",
"documentation":"<p>The capacity provider strategy to use for the service.</p> <p>A capacity provider strategy consists of one or more capacity providers along with the <code>base</code> and <code>weight</code> to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The <a>PutClusterCapacityProviders</a> API is used to associate a capacity provider with a cluster. Only capacity providers with an <code>ACTIVE</code> or <code>UPDATING</code> status can be used.</p> <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code> parameter must be omitted. If no <code>capacityProviderStrategy</code> or <code>launchType</code> is specified, the <code>defaultCapacityProviderStrategy</code> for the cluster is used.</p> <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the <a>CreateCapacityProvider</a> API operation.</p> <p>To use a AWS Fargate capacity provider, specify either the <code>FARGATE</code> or <code>FARGATE_SPOT</code> capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.</p> <p>The <a>PutClusterCapacityProviders</a> API operation is used to update the list of available capacity providers for a cluster after the cluster is created.</p>"
"documentation":"<p>The capacity provider strategy to use for the service.</p> <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code> parameter must be omitted. If no <code>capacityProviderStrategy</code> or <code>launchType</code> is specified, the <code>defaultCapacityProviderStrategy</code> for the cluster is used.</p>"
},
"platformVersion":{
"shape":"String",
"documentation":"<p>The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the <code>LATEST</code> platform version is used by default. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate Platform Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
"documentation":"<p>The platform version that your tasks in the service are running on. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the <code>LATEST</code> platform version is used by default. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate platform versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"role":{
"shape":"String",
"documentation":"<p>The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the <code>awsvpc</code> network mode. If you specify the <code>role</code> parameter, you must also specify a load balancer object with the <code>loadBalancers</code> parameter.</p> <important> <p>If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the <code>awsvpc</code> network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you should not specify a role here. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html\">Using Service-Linked Roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </important> <p>If your specified role has a path other than <code>/</code>, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name <code>bar</code> has a path of <code>/foo/</code> then you would specify <code>/foo/bar</code> as the role name. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names\">Friendly Names and Paths</a> in the <i>IAM User Guide</i>.</p>"
"documentation":"<p>The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the <code>awsvpc</code> network mode. If you specify the <code>role</code> parameter, you must also specify a load balancer object with the <code>loadBalancers</code> parameter.</p> <important> <p>If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the <code>awsvpc</code> network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you should not specify a role here. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using-service-linked-roles.html\">Using service-linked roles for Amazon ECS</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> </important> <p>If your specified role has a path other than <code>/</code>, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name <code>bar</code> has a path of <code>/foo/</code> then you would specify <code>/foo/bar</code> as the role name. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-friendly-names\">Friendly names and paths</a> in the <i>IAM User Guide</i>.</p>"
},
"deploymentConfiguration":{
"shape":"DeploymentConfiguration",
@ -1847,7 +1904,7 @@
},
"networkConfiguration":{
"shape":"NetworkConfiguration",
"documentation":"<p>The network configuration for the service. This parameter is required for task definitions that use the <code>awsvpc</code> network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task Networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
"documentation":"<p>The network configuration for the service. This parameter is required for task definitions that use the <code>awsvpc</code> network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-networking.html\">Task networking</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"healthCheckGracePeriodSeconds":{
"shape":"BoxedInteger",
@ -1872,6 +1929,10 @@
"propagateTags":{
"shape":"PropagateTags",
"documentation":"<p>Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks within the service during service creation. To add tags to a task after service creation, use the <a>TagResource</a> API action.</p>"
},
"enableExecuteCommand":{
"shape":"Boolean",
"documentation":"<p>Whether or not the execute command functionality is enabled for the service. If <code>true</code>, this enables execute command functionality on all containers in the service tasks.</p>"
}
}
},
@ -2659,7 +2720,7 @@
"documentation":"<p>The file type to use. The only supported value is <code>s3</code>.</p>"
}
},
"documentation":"<p>A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a <code>.env</code> file extension. Each line in an environment file should contain an environment variable in <code>VARIABLE=VALUE</code> format. Lines beginning with <code>#</code> are treated as comments and are ignored. For more information on the environment variable file syntax, see <a href=\"https://docs.docker.com/compose/env-file/\">Declare default environment variables in file</a>.</p> <p>If there are environment variables specified using the <code>environment</code> parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html\">Specifying Environment Variables</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>This field is not valid for containers in tasks using the Fargate launch type.</p>"
"documentation":"<p>A list of files containing the environment variables to pass to a container. You can specify up to ten environment files. The file must have a <code>.env</code> file extension. Each line in an environment file should contain an environment variable in <code>VARIABLE=VALUE</code> format. Lines beginning with <code>#</code> are treated as comments and are ignored. For more information on the environment variable file syntax, see <a href=\"https://docs.docker.com/compose/env-file/\">Declare default environment variables in file</a>.</p> <p>If there are environment variables specified using the <code>environment</code> parameter in a container definition, they take precedence over the variables contained within an environment file. If multiple environment files are specified that contain the same variable, they are processed from the top down. It is recommended to use unique variable names. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html\">Specifying environment variables</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>This field is only valid for containers in Fargate tasks that use platform version <code>1.4.0</code> or later.</p>"
},
"EnvironmentFileType":{
"type":"string",
@ -2673,6 +2734,117 @@
"type":"list",
"member":{"shape":"KeyValuePair"}
},
"ExecuteCommandConfiguration":{
"type":"structure",
"members":{
"kmsKeyId":{
"shape":"String",
"documentation":"<p>Specify an AWS Key Management Service key ID to encrypt the data between the local client and the container.</p>"
},
"logging":{
"shape":"ExecuteCommandLogging",
"documentation":"<p>The log setting to use for redirecting logs for your execute command results. The following log settings are available.</p> <ul> <li> <p> <code>NONE</code>: The execute command session is not logged.</p> </li> <li> <p> <code>DEFAULT</code>: The <code>awslogs</code> configuration in the task definition is used. If no logging parameter is specified, it defaults to this value. If no <code>awslogs</code> log driver is configured in the task definition, the output won't be logged.</p> </li> <li> <p> <code>OVERRIDE</code>: Specify the logging details as a part of <code>logConfiguration</code>. If the <code>OVERRIDE</code> logging option is specified, the <code>logConfiguration</code> is required.</p> </li> </ul>"
},
"logConfiguration":{
"shape":"ExecuteCommandLogConfiguration",
"documentation":"<p>The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket. When <code>logging=OVERRIDE</code> is specified, a <code>logConfiguration</code> must be provided.</p>"
}
},
"documentation":"<p>The details of the execute command configuration.</p>"
},
"ExecuteCommandLogConfiguration":{
"type":"structure",
"members":{
"cloudWatchLogGroupName":{
"shape":"String",
"documentation":"<p>The name of the CloudWatch log group to send logs to.</p> <note> <p>The CloudWatch log group must already be created.</p> </note>"
},
"cloudWatchEncryptionEnabled":{
"shape":"Boolean",
"documentation":"<p>Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.</p>"
},
"s3BucketName":{
"shape":"String",
"documentation":"<p>The name of the S3 bucket to send logs to.</p> <note> <p>The S3 bucket must already be created.</p> </note>"
},
"s3EncryptionEnabled":{
"shape":"Boolean",
"documentation":"<p>Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.</p>"
},
"s3KeyPrefix":{
"shape":"String",
"documentation":"<p>An optional folder in the S3 bucket to place logs in.</p>"
}
},
"documentation":"<p>The log configuration for the results of the execute command actions. The logs can be sent to CloudWatch Logs or an Amazon S3 bucket.</p>"
},
"ExecuteCommandLogging":{
"type":"string",
"enum":[
"NONE",
"DEFAULT",
"OVERRIDE"
]
},
"ExecuteCommandRequest":{
"type":"structure",
"required":[
"command",
"interactive",
"task"
],
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) or short name of the cluster the task is running in. If you do not specify a cluster, the default cluster is assumed.</p>"
},
"container":{
"shape":"String",
"documentation":"<p>The name of the container to execute the command on. A container name only needs to be specified for tasks containing multiple containers.</p>"
},
"command":{
"shape":"String",
"documentation":"<p>The command to run on the container.</p>"
},
"interactive":{
"shape":"Boolean",
"documentation":"<p>Use this flag to run your command in interactive mode.</p>"
},
"task":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) or ID of the task the container is part of.</p>"
}
}
},
"ExecuteCommandResponse":{
"type":"structure",
"members":{
"clusterArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the cluster.</p>"
},
"containerArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the container.</p>"
},
"containerName":{
"shape":"String",
"documentation":"<p>The name of the container.</p>"
},
"interactive":{
"shape":"Boolean",
"documentation":"<p>Whether or not the execute command session is running in interactive mode.</p>"
},
"session":{
"shape":"Session",
"documentation":"<p>The details of the SSM session that was created for this instance of execute-command.</p>"
},
"taskArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the task.</p>"
}
}
},
"FSxWindowsFileServerAuthorizationConfig":{
"type":"structure",
"required":[
@ -2746,7 +2918,7 @@
},
"options":{
"shape":"FirelensConfigurationOptionsMap",
"documentation":"<p>The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is <code>\"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef\">Creating a Task Definition that Uses a FireLens Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
"documentation":"<p>The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is <code>\"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html#firelens-taskdef\">Creating a Task Definition that Uses a FireLens Configuration</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>Tasks hosted on AWS Fargate only support the <code>file</code> configuration file type.</p> </note>"
}
},
"documentation":"<p>The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html\">Custom Log Routing</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
@ -3362,6 +3534,67 @@
]
},
"Long":{"type":"long"},
"ManagedAgent":{
"type":"structure",
"members":{
"lastStartedAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix timestamp for when the managed agent was last started.</p>"
},
"name":{
"shape":"ManagedAgentName",
"documentation":"<p>The name of the managed agent. When the execute command feature is enabled, the managed agent name is <code>ExecuteCommandAgent</code>.</p>"
},
"reason":{
"shape":"String",
"documentation":"<p>The reason for why the managed agent is in the state it is in.</p>"
},
"lastStatus":{
"shape":"String",
"documentation":"<p>The last known status of the managed agent.</p>"
}
},
"documentation":"<p>Details about the managed agent status for the container.</p>"
},
"ManagedAgentName":{
"type":"string",
"enum":["ExecuteCommandAgent"]
},
"ManagedAgentStateChange":{
"type":"structure",
"required":[
"containerName",
"managedAgentName",
"status"
],
"members":{
"containerName":{
"shape":"String",
"documentation":"<p>The name of the container associated with the managed agent.</p>"
},
"managedAgentName":{
"shape":"ManagedAgentName",
"documentation":"<p>The name of the managed agent.</p>"
},
"status":{
"shape":"String",
"documentation":"<p>The status of the managed agent.</p>"
},
"reason":{
"shape":"String",
"documentation":"<p>The reason for the status of the managed agent.</p>"
}
},
"documentation":"<p>An object representing a change in state for a managed agent.</p>"
},
"ManagedAgentStateChanges":{
"type":"list",
"member":{"shape":"ManagedAgentStateChange"}
},
"ManagedAgents":{
"type":"list",
"member":{"shape":"ManagedAgent"}
},
"ManagedScaling":{
"type":"structure",
"members":{
@ -3865,7 +4098,7 @@
},
"requiresCompatibilities":{
"shape":"CompatibilityList",
"documentation":"<p>The task launch type that Amazon ECS should validate the task definition against. This ensures that the task definition parameters are compatible with the specified launch type. If no value is specified, it defaults to <code>EC2</code>.</p>"
"documentation":"<p>The task launch type that Amazon ECS should validate the task definition against. A client exception is returned if the task definition doesn't validate against the compatibilities specified. If no value is specified, the parameter is omitted from the response.</p>"
},
"cpu":{
"shape":"String",
@ -3881,11 +4114,11 @@
},
"pidMode":{
"shape":"PidMode",
"documentation":"<p>The process namespace to use for the containers in the task. The valid values are <code>host</code> or <code>task</code>. If <code>host</code> is specified, then all containers within the tasks that specified the <code>host</code> PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If <code>task</code> is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#pid-settings---pid\">PID settings</a> in the <i>Docker run reference</i>.</p> <p>If the <code>host</code> PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see <a href=\"https://docs.docker.com/engine/security/security/\">Docker security</a>.</p> <note> <p>This parameter is not supported for Windows containers or tasks using the Fargate launch type.</p> </note>"
"documentation":"<p>The process namespace to use for the containers in the task. The valid values are <code>host</code> or <code>task</code>. If <code>host</code> is specified, then all containers within the tasks that specified the <code>host</code> PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If <code>task</code> is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#pid-settings---pid\">PID settings</a> in the <i>Docker run reference</i>.</p> <p>If the <code>host</code> PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see <a href=\"https://docs.docker.com/engine/security/security/\">Docker security</a>.</p> <note> <p>This parameter is not supported for Windows containers or tasks run on AWS Fargate.</p> </note>"
},
"ipcMode":{
"shape":"IpcMode",
"documentation":"<p>The IPC resource namespace to use for the containers in the task. The valid values are <code>host</code>, <code>task</code>, or <code>none</code>. If <code>host</code> is specified, then all containers within the tasks that specified the <code>host</code> IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If <code>task</code> is specified, all containers within the specified task share the same IPC resources. If <code>none</code> is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#ipc-settings---ipc\">IPC settings</a> in the <i>Docker run reference</i>.</p> <p>If the <code>host</code> IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see <a href=\"https://docs.docker.com/engine/security/security/\">Docker security</a>.</p> <p>If you are setting namespaced kernel parameters using <code>systemControls</code> for the containers in the task, the following will apply to your IPC resource namespace. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html\">System Controls</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <ul> <li> <p>For tasks that use the <code>host</code> IPC mode, IPC namespace related <code>systemControls</code> are not supported.</p> </li> <li> <p>For tasks that use the <code>task</code> IPC mode, IPC namespace related <code>systemControls</code> will apply to all containers within a task.</p> </li> </ul> <note> <p>This parameter is not supported for Windows containers or tasks using the Fargate launch type.</p> </note>"
"documentation":"<p>The IPC resource namespace to use for the containers in the task. The valid values are <code>host</code>, <code>task</code>, or <code>none</code>. If <code>host</code> is specified, then all containers within the tasks that specified the <code>host</code> IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If <code>task</code> is specified, all containers within the specified task share the same IPC resources. If <code>none</code> is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#ipc-settings---ipc\">IPC settings</a> in the <i>Docker run reference</i>.</p> <p>If the <code>host</code> IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see <a href=\"https://docs.docker.com/engine/security/security/\">Docker security</a>.</p> <p>If you are setting namespaced kernel parameters using <code>systemControls</code> for the containers in the task, the following will apply to your IPC resource namespace. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html\">System Controls</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <ul> <li> <p>For tasks that use the <code>host</code> IPC mode, IPC namespace related <code>systemControls</code> are not supported.</p> </li> <li> <p>For tasks that use the <code>task</code> IPC mode, IPC namespace related <code>systemControls</code> will apply to all containers within a task.</p> </li> </ul> <note> <p>This parameter is not supported for Windows containers or tasks run on AWS Fargate.</p> </note>"
},
"proxyConfiguration":{"shape":"ProxyConfiguration"},
"inferenceAccelerators":{
@ -4005,7 +4238,7 @@
"members":{
"capacityProviderStrategy":{
"shape":"CapacityProviderStrategy",
"documentation":"<p>The capacity provider strategy to use for the task.</p> <p>A capacity provider strategy consists of one or more capacity providers along with the <code>base</code> and <code>weight</code> to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The <a>PutClusterCapacityProviders</a> API is used to associate a capacity provider with a cluster. Only capacity providers with an <code>ACTIVE</code> or <code>UPDATING</code> status can be used.</p> <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code> parameter must be omitted. If no <code>capacityProviderStrategy</code> or <code>launchType</code> is specified, the <code>defaultCapacityProviderStrategy</code> for the cluster is used.</p> <p>If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the <a>CreateCapacityProvider</a> API operation.</p> <p>To use a AWS Fargate capacity provider, specify either the <code>FARGATE</code> or <code>FARGATE_SPOT</code> capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.</p> <p>The <a>PutClusterCapacityProviders</a> API operation is used to update the list of available capacity providers for a cluster after the cluster is created.</p>"
"documentation":"<p>The capacity provider strategy to use for the task.</p> <p>If a <code>capacityProviderStrategy</code> is specified, the <code>launchType</code> parameter must be omitted. If no <code>capacityProviderStrategy</code> or <code>launchType</code> is specified, the <code>defaultCapacityProviderStrategy</code> for the cluster is used.</p>"
},
"cluster":{
"shape":"String",
@ -4019,13 +4252,17 @@
"shape":"Boolean",
"documentation":"<p>Specifies whether to enable Amazon ECS managed tags for the task. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html\">Tagging Your Amazon ECS Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"enableExecuteCommand":{
"shape":"Boolean",
"documentation":"<p>Whether or not to enable the execute command functionality for the containers in this task. If <code>true</code>, this enables execute command functionality on all containers in the task.</p>"
},
"group":{
"shape":"String",
"documentation":"<p>The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).</p>"
},
"launchType":{
"shape":"LaunchType",
"documentation":"<p>The launch type on which to run your task. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS Launch Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>If a <code>launchType</code> is specified, the <code>capacityProviderStrategy</code> parameter must be omitted.</p>"
"documentation":"<p>The launch type on which to run your task. The accepted values are <code>FARGATE</code> and <code>EC2</code>. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS Launch Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>When a value of <code>FARGATE</code> is specified, your tasks are launched on AWS Fargate On-Demand infrastructure. To use Fargate Spot, you must use a capacity provider strategy with the <code>FARGATE_SPOT</code> capacity provider.</p> <p>When a value of <code>EC2</code> is specified, your tasks are launched on Amazon EC2 instances registered to your cluster.</p> <p>If a <code>launchType</code> is specified, the <code>capacityProviderStrategy</code> parameter must be omitted.</p>"
},
"networkConfiguration":{
"shape":"NetworkConfiguration",
@ -4136,6 +4373,10 @@
"type":"list",
"member":{"shape":"Secret"}
},
"SensitiveString":{
"type":"string",
"sensitive":true
},
"ServerException":{
"type":"structure",
"members":{
@ -4263,6 +4504,10 @@
"propagateTags":{
"shape":"PropagateTags",
"documentation":"<p>Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.</p>"
},
"enableExecuteCommand":{
"shape":"Boolean",
"documentation":"<p>Whether or not the execute command functionality is enabled for the service. If <code>true</code>, the execute command functionality is enabled for all containers in tasks as part of the service.</p>"
}
},
"documentation":"<p>Details on a service within a cluster</p>"
@ -4341,6 +4586,24 @@
"type":"list",
"member":{"shape":"Service"}
},
"Session":{
"type":"structure",
"members":{
"sessionId":{
"shape":"String",
"documentation":"<p>The ID of the execute command session.</p>"
},
"streamUrl":{
"shape":"String",
"documentation":"<p>A URL back to managed agent on the container that the SSM Session Manager client uses to send commands and receive output from the container.</p>"
},
"tokenValue":{
"shape":"SensitiveString",
"documentation":"<p>An encrypted token value containing session and caller information. Used to authenticate the connection to the container.</p>"
}
},
"documentation":"<p>The details of the execute command session.</p>"
},
"Setting":{
"type":"structure",
"members":{
@ -4406,6 +4669,10 @@
"shape":"Boolean",
"documentation":"<p>Specifies whether to enable Amazon ECS managed tags for the task. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html\">Tagging Your Amazon ECS Resources</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"enableExecuteCommand":{
"shape":"Boolean",
"documentation":"<p>Whether or not the execute command functionality is enabled for the task. If <code>true</code>, this enables execute command functionality on all containers in the task.</p>"
},
"group":{
"shape":"String",
"documentation":"<p>The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).</p>"
@ -4590,6 +4857,10 @@
"shape":"AttachmentStateChanges",
"documentation":"<p>Any attachments associated with the state change request.</p>"
},
"managedAgents":{
"shape":"ManagedAgentStateChanges",
"documentation":"<p>The details for the managed agent associated with the task.</p>"
},
"pullStartedAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix timestamp for when the container image pull began.</p>"
@ -4689,6 +4960,13 @@
"max":50,
"min":0
},
"TargetNotConnectedException":{
"type":"structure",
"members":{
},
"documentation":"<p>The target container is not properly configured with the execute command agent or the container is no longer active or running.</p>",
"exception":true
},
"TargetNotFoundException":{
"type":"structure",
"members":{
@ -4751,6 +5029,10 @@
"shape":"String",
"documentation":"<p>The desired status of the task. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-lifecycle.html\">Task Lifecycle</a>.</p>"
},
"enableExecuteCommand":{
"shape":"Boolean",
"documentation":"<p>Whether or not execute command functionality is enabled for this task. If <code>true</code>, this enables execute command functionality on all containers in the task.</p>"
},
"executionStoppedAt":{
"shape":"Timestamp",
"documentation":"<p>The Unix timestamp for when the task execution stopped.</p>"
@ -4855,7 +5137,7 @@
},
"taskRoleArn":{
"shape":"String",
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html\">Amazon ECS Task Role</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>IAM roles for tasks on Windows require that the <code>-EnableTaskIAMRole</code> option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html\">Windows IAM Roles for Tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
"documentation":"<p>The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants containers in the task permission to call AWS APIs on your behalf. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html\">Amazon ECS Task Role</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <p>IAM roles for tasks on Windows require that the <code>-EnableTaskIAMRole</code> option is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some configuration code in order to take advantage of the feature. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/windows_task_IAM_roles.html\">Windows IAM roles for tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"executionRoleArn":{
"shape":"String",
@ -4871,7 +5153,7 @@
},
"volumes":{
"shape":"VolumeList",
"documentation":"<p>The list of volume definitions for the task.</p> <p>If your tasks are using the Fargate launch type, the <code>host</code> and <code>sourcePath</code> parameters are not supported.</p> <p>For more information about volume definition parameters and defaults, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definitions.html\">Amazon ECS Task Definitions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
"documentation":"<p>The list of data volume definitions for the task. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html\">Using data volumes in tasks</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>The <code>host</code> and <code>sourcePath</code> parameters are not supported for tasks run on AWS Fargate.</p> </note>"
},
"status":{
"shape":"TaskDefinitionStatus",
@ -4879,19 +5161,19 @@
},
"requiresAttributes":{
"shape":"RequiresAttributes",
"documentation":"<p>The container instance attributes required by your task. This field is not valid if you are using the Fargate launch type for your task.</p>"
"documentation":"<p>The container instance attributes required by your task. When an Amazon EC2 instance is registered to your cluster, the Amazon ECS container agent assigns some standard attributes to the instance. You can apply custom attributes, specified as key-value pairs using the Amazon ECS console or the <a>PutAttributes</a> API. These attributes are used when considering task placement for tasks hosted on Amazon EC2 instances. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html#attributes\">Attributes</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>This parameter is not supported for tasks run on AWS Fargate.</p> </note>"
},
"placementConstraints":{
"shape":"TaskDefinitionPlacementConstraints",
"documentation":"<p>An array of placement constraint objects to use for tasks. This field is not valid if you are using the Fargate launch type for your task.</p>"
"documentation":"<p>An array of placement constraint objects to use for tasks.</p> <note> <p>This parameter is not supported for tasks run on AWS Fargate.</p> </note>"
},
"compatibilities":{
"shape":"CompatibilityList",
"documentation":"<p>The launch type to use with your task. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS Launch Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
"documentation":"<p>The task launch types the task definition validated against during task definition registration. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS launch types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"requiresCompatibilities":{
"shape":"CompatibilityList",
"documentation":"<p>The launch type the task requires. If no value is specified, it will default to <code>EC2</code>. Valid values include <code>EC2</code> and <code>FARGATE</code>.</p>"
"documentation":"<p>The task launch types the task definition was validated against. To determine which task launch types the task definition is validated for, see the <a>TaskDefinition$compatibilities</a> parameter.</p>"
},
"cpu":{
"shape":"String",
@ -4899,7 +5181,7 @@
},
"memory":{
"shape":"String",
"documentation":"<p>The amount (in MiB) of memory used by the task.</p> <p>If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified then the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html\">ContainerDefinition</a>.</p> <p>If using the Fargate launch type, this field is required and you must use one of the following values, which determines your range of valid values for the <code>cpu</code> parameter:</p> <ul> <li> <p>512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available <code>cpu</code> values: 256 (.25 vCPU)</p> </li> <li> <p>1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available <code>cpu</code> values: 512 (.5 vCPU)</p> </li> <li> <p>2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available <code>cpu</code> values: 1024 (1 vCPU)</p> </li> <li> <p>Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 2048 (2 vCPU)</p> </li> <li> <p>Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 4096 (4 vCPU)</p> </li> </ul>"
"documentation":"<p>The amount (in MiB) of memory used by the task.</p> <p>If your tasks will be run on Amazon EC2 instances, you must specify either a task-level memory value or a container-level memory value. This field is optional and any value can be used. If a task-level memory value is specified then the container-level memory value is optional. For more information regarding container-level memory and memory reservation, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html\">ContainerDefinition</a>.</p> <p>If your tasks will be run on AWS Fargate, this field is required and you must use one of the following values, which determines your range of valid values for the <code>cpu</code> parameter:</p> <ul> <li> <p>512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available <code>cpu</code> values: 256 (.25 vCPU)</p> </li> <li> <p>1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available <code>cpu</code> values: 512 (.5 vCPU)</p> </li> <li> <p>2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available <code>cpu</code> values: 1024 (1 vCPU)</p> </li> <li> <p>Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 2048 (2 vCPU)</p> </li> <li> <p>Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available <code>cpu</code> values: 4096 (4 vCPU)</p> </li> </ul>"
},
"inferenceAccelerators":{
"shape":"InferenceAccelerators",
@ -4907,11 +5189,11 @@
},
"pidMode":{
"shape":"PidMode",
"documentation":"<p>The process namespace to use for the containers in the task. The valid values are <code>host</code> or <code>task</code>. If <code>host</code> is specified, then all containers within the tasks that specified the <code>host</code> PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If <code>task</code> is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#pid-settings---pid\">PID settings</a> in the <i>Docker run reference</i>.</p> <p>If the <code>host</code> PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see <a href=\"https://docs.docker.com/engine/security/security/\">Docker security</a>.</p> <note> <p>This parameter is not supported for Windows containers or tasks using the Fargate launch type.</p> </note>"
"documentation":"<p>The process namespace to use for the containers in the task. The valid values are <code>host</code> or <code>task</code>. If <code>host</code> is specified, then all containers within the tasks that specified the <code>host</code> PID mode on the same container instance share the same process namespace with the host Amazon EC2 instance. If <code>task</code> is specified, all containers within the specified task share the same process namespace. If no value is specified, the default is a private namespace. For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#pid-settings---pid\">PID settings</a> in the <i>Docker run reference</i>.</p> <p>If the <code>host</code> PID mode is used, be aware that there is a heightened risk of undesired process namespace expose. For more information, see <a href=\"https://docs.docker.com/engine/security/security/\">Docker security</a>.</p> <note> <p>This parameter is not supported for Windows containers or tasks run on AWS Fargate.</p> </note>"
},
"ipcMode":{
"shape":"IpcMode",
"documentation":"<p>The IPC resource namespace to use for the containers in the task. The valid values are <code>host</code>, <code>task</code>, or <code>none</code>. If <code>host</code> is specified, then all containers within the tasks that specified the <code>host</code> IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If <code>task</code> is specified, all containers within the specified task share the same IPC resources. If <code>none</code> is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#ipc-settings---ipc\">IPC settings</a> in the <i>Docker run reference</i>.</p> <p>If the <code>host</code> IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see <a href=\"https://docs.docker.com/engine/security/security/\">Docker security</a>.</p> <p>If you are setting namespaced kernel parameters using <code>systemControls</code> for the containers in the task, the following will apply to your IPC resource namespace. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html\">System Controls</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <ul> <li> <p>For tasks that use the <code>host</code> IPC mode, IPC namespace related <code>systemControls</code> are not supported.</p> </li> <li> <p>For tasks that use the <code>task</code> IPC mode, IPC namespace related <code>systemControls</code> will apply to all containers within a task.</p> </li> </ul> <note> <p>This parameter is not supported for Windows containers or tasks using the Fargate launch type.</p> </note>"
"documentation":"<p>The IPC resource namespace to use for the containers in the task. The valid values are <code>host</code>, <code>task</code>, or <code>none</code>. If <code>host</code> is specified, then all containers within the tasks that specified the <code>host</code> IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance. If <code>task</code> is specified, all containers within the specified task share the same IPC resources. If <code>none</code> is specified, then IPC resources within the containers of a task are private and not shared with other containers in a task or on the container instance. If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see <a href=\"https://docs.docker.com/engine/reference/run/#ipc-settings---ipc\">IPC settings</a> in the <i>Docker run reference</i>.</p> <p>If the <code>host</code> IPC mode is used, be aware that there is a heightened risk of undesired IPC namespace expose. For more information, see <a href=\"https://docs.docker.com/engine/security/security/\">Docker security</a>.</p> <p>If you are setting namespaced kernel parameters using <code>systemControls</code> for the containers in the task, the following will apply to your IPC resource namespace. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html\">System Controls</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <ul> <li> <p>For tasks that use the <code>host</code> IPC mode, IPC namespace related <code>systemControls</code> are not supported.</p> </li> <li> <p>For tasks that use the <code>task</code> IPC mode, IPC namespace related <code>systemControls</code> will apply to all containers within a task.</p> </li> </ul> <note> <p>This parameter is not supported for Windows containers or tasks run on AWS Fargate.</p> </note>"
},
"proxyConfiguration":{
"shape":"ProxyConfiguration",
@ -4957,10 +5239,10 @@
},
"expression":{
"shape":"String",
"documentation":"<p>A cluster query language expression to apply to the constraint. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html\">Cluster Query Language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
"documentation":"<p>A cluster query language expression to apply to the constraint. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html\">Cluster query language</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
}
},
"documentation":"<p>An object representing a constraint on task placement in the task definition. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html\">Task Placement Constraints</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>If you are using the Fargate launch type, task placement constraints are not supported.</p> </note>"
"documentation":"<p>An object representing a constraint on task placement in the task definition. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html\">Task placement constraints</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p> <note> <p>Task placement constraints are not supported for tasks run on AWS Fargate.</p> </note>"
},
"TaskDefinitionPlacementConstraintType":{
"type":"string",
@ -5072,7 +5354,7 @@
},
"launchType":{
"shape":"LaunchType",
"documentation":"<p>The launch type the tasks in the task set are using. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS Launch Types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
"documentation":"<p>The launch type the tasks in the task set are using. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS launch types</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"capacityProviderStrategy":{
"shape":"CapacityProviderStrategy",
@ -5080,7 +5362,7 @@
},
"platformVersion":{
"shape":"String",
"documentation":"<p>The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the <code>LATEST</code> platform version is used by default. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate Platform Versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
"documentation":"<p>The AWS Fargate platform version on which the tasks in the task set are running. A platform version is only specified for tasks run on AWS Fargate. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html\">AWS Fargate platform versions</a> in the <i>Amazon Elastic Container Service Developer Guide</i>.</p>"
},
"networkConfiguration":{
"shape":"NetworkConfiguration",
@ -5092,7 +5374,7 @@
},
"serviceRegistries":{
"shape":"ServiceRegistries",
"documentation":"<p>The details of the service discovery registries to assign to this task set. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html\">Service Discovery</a>.</p>"
"documentation":"<p>The details of the service discovery registries to assign to this task set. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html\">Service discovery</a>.</p>"
},
"scale":{
"shape":"Scale",
@ -5277,6 +5559,30 @@
"capacityProvider":{"shape":"CapacityProvider"}
}
},
"UpdateClusterRequest":{
"type":"structure",
"required":["cluster"],
"members":{
"cluster":{
"shape":"String",
"documentation":"<p>The name of the cluster to modify the settings for.</p>"
},
"settings":{
"shape":"ClusterSettings",
"documentation":"<p>The cluster settings for your cluster.</p>"
},
"configuration":{
"shape":"ClusterConfiguration",
"documentation":"<p>The execute command configuration for the cluster.</p>"
}
}
},
"UpdateClusterResponse":{
"type":"structure",
"members":{
"cluster":{"shape":"Cluster"}
}
},
"UpdateClusterSettingsRequest":{
"type":"structure",
"required":[
@ -5440,6 +5746,10 @@
"healthCheckGracePeriodSeconds":{
"shape":"BoxedInteger",
"documentation":"<p>The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.</p>"
},
"enableExecuteCommand":{
"shape":"BoxedBoolean",
"documentation":"<p>If <code>true</code>, this enables execute command functionality on all task containers.</p> <p>If you do not want to override the value that was set when the service was created, you can set this to <code>null</code> when performing this action.</p>"
}
}
},
@ -5513,7 +5823,7 @@
},
"dockerVolumeConfiguration":{
"shape":"DockerVolumeConfiguration",
"documentation":"<p>This parameter is specified when you are using Docker volumes. Docker volumes are only supported when you are using the EC2 launch type. Windows containers only support the use of the <code>local</code> driver. To use bind mounts, specify the <code>host</code> parameter instead.</p>"
"documentation":"<p>This parameter is specified when you are using Docker volumes.</p> <p>Windows containers only support the use of the <code>local</code> driver. To use bind mounts, specify the <code>host</code> parameter instead.</p> <note> <p>Docker volumes are not supported by tasks run on AWS Fargate.</p> </note>"
},
"efsVolumeConfiguration":{
"shape":"EFSVolumeConfiguration",
@ -5549,5 +5859,5 @@
"member":{"shape":"Volume"}
}
},
"documentation":"<fullname>Amazon Elastic Container Service</fullname> <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks using the Fargate launch type. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2 launch type. For more information about launch types, see <a href=\"https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html\">Amazon ECS Launch Types</a>.</p> <p>Amazon ECS lets you launch and stop container-based applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.</p> <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.</p>"
"documentation":"<fullname>Amazon Elastic Container Service</fullname> <p>Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes it easy to run, stop, and manage Docker containers on a cluster. You can host your cluster on a serverless infrastructure that is managed by Amazon ECS by launching your services or tasks on AWS Fargate. For more control, you can host your tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage.</p> <p>Amazon ECS makes it easy to launch and stop container-based applications with simple API calls, allows you to get the state of your cluster from a centralized service, and gives you access to many familiar Amazon EC2 features.</p> <p>You can use Amazon ECS to schedule the placement of containers across your cluster based on your resource needs, isolation policies, and availability requirements. Amazon ECS eliminates the need for you to operate your own cluster management and configuration management systems or worry about scaling your management infrastructure.</p>"
}

135
botocore/data/efs/2015-02-01/service-2.json
View file

File diff suppressed because one or more lines are too long

6
botocore/data/eks/2017-11-01/paginators-1.json
View file

@ -35,6 +35,12 @@
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "addons"
},
"ListIdentityProviderConfigs": {
"input_token": "nextToken",
"limit_key": "maxResults",
"output_token": "nextToken",
"result_key": "identityProviderConfigs"
}
}
}

468
botocore/data/eks/2017-11-01/service-2.json
View file

@ -13,6 +13,42 @@
"uid":"eks-2017-11-01"
},
"operations":{
"AssociateEncryptionConfig":{
"name":"AssociateEncryptionConfig",
"http":{
"method":"POST",
"requestUri":"/clusters/{name}/encryption-config/associate"
},
"input":{"shape":"AssociateEncryptionConfigRequest"},
"output":{"shape":"AssociateEncryptionConfigResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServerException"},
{"shape":"ResourceInUseException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Associate encryption configuration to an existing cluster.</p> <p>You can use this API to enable encryption on existing clusters which do not have encryption already enabled. This allows you to implement a defense-in-depth security strategy without migrating applications to new EKS clusters.</p>"
},
"AssociateIdentityProviderConfig":{
"name":"AssociateIdentityProviderConfig",
"http":{
"method":"POST",
"requestUri":"/clusters/{name}/identity-provider-configs/associate"
},
"input":{"shape":"AssociateIdentityProviderConfigRequest"},
"output":{"shape":"AssociateIdentityProviderConfigResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServerException"},
{"shape":"ResourceInUseException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Associate an identity provider configuration to a cluster.</p> <p>If you want to authenticate identities using an identity provider, you can create an identity provider configuration and associate it to your cluster. After configuring authentication to your cluster you can create Kubernetes <code>roles</code> and <code>clusterroles</code> to assign permissions to the roles, and then bind the roles to the identities using Kubernetes <code>rolebindings</code> and <code>clusterrolebindings</code>. For more information see <a href=\"https://kubernetes.io/docs/reference/access-authn-authz/rbac/\">Using RBAC Authorization</a> in the Kubernetes documentation.</p>"
},
"CreateAddon":{
"name":"CreateAddon",
"http":{
@ -48,7 +84,7 @@
{"shape":"ServiceUnavailableException"},
{"shape":"UnsupportedAvailabilityZoneException"}
],
"documentation":"<p>Creates an Amazon EKS control plane. </p> <p>The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as <code>etcd</code> and the API server. The control plane runs in an account managed by AWS, and the Kubernetes API is exposed via the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single-tenant and unique and runs on its own set of Amazon EC2 instances.</p> <p>The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the worker nodes (for example, to support <code>kubectl exec</code>, <code>logs</code>, and <code>proxy</code> data flows).</p> <p>Amazon EKS worker nodes run in your AWS account and connect to your cluster's control plane via the Kubernetes API server endpoint and a certificate file that is created for your cluster.</p> <p>You can use the <code>endpointPublicAccess</code> and <code>endpointPrivateAccess</code> parameters to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html\">Amazon EKS Cluster Endpoint Access Control</a> in the <i> <i>Amazon EKS User Guide</i> </i>. </p> <p>You can use the <code>logging</code> parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html\">Amazon EKS Cluster Control Plane Logs</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p> <note> <p>CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see <a href=\"http://aws.amazon.com/cloudwatch/pricing/\">Amazon CloudWatch Pricing</a>.</p> </note> <p>Cluster creation typically takes between 10 and 15 minutes. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch worker nodes into your cluster. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/managing-auth.html\">Managing Cluster Authentication</a> and <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html\">Launching Amazon EKS Worker Nodes</a> in the <i>Amazon EKS User Guide</i>.</p>"
"documentation":"<p>Creates an Amazon EKS control plane. </p> <p>The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as <code>etcd</code> and the API server. The control plane runs in an account managed by AWS, and the Kubernetes API is exposed via the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single-tenant and unique and runs on its own set of Amazon EC2 instances.</p> <p>The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the nodes (for example, to support <code>kubectl exec</code>, <code>logs</code>, and <code>proxy</code> data flows).</p> <p>Amazon EKS nodes run in your AWS account and connect to your cluster's control plane via the Kubernetes API server endpoint and a certificate file that is created for your cluster.</p> <p>Cluster creation typically takes several minutes. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/managing-auth.html\">Managing Cluster Authentication</a> and <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/launch-workers.html\">Launching Amazon EKS nodes</a> in the <i>Amazon EKS User Guide</i>.</p>"
},
"CreateFargateProfile":{
"name":"CreateFargateProfile",
@ -85,7 +121,7 @@
{"shape":"ServerException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Creates a managed worker node group for an Amazon EKS cluster. You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template. For more information about using launch templates, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html\">Launch template support</a>.</p> <p>An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by AWS for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS optimized Amazon Linux 2 AMI. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html\">Managed Node Groups</a> in the <i>Amazon EKS User Guide</i>. </p>"
"documentation":"<p>Creates a managed node group for an Amazon EKS cluster. You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template. For more information about using launch templates, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html\">Launch template support</a>.</p> <p>An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by AWS for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS optimized Amazon Linux 2 AMI. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html\">Managed Node Groups</a> in the <i>Amazon EKS User Guide</i>. </p>"
},
"DeleteAddon":{
"name":"DeleteAddon",
@ -219,6 +255,23 @@
],
"documentation":"<p>Returns descriptive information about an AWS Fargate profile.</p>"
},
"DescribeIdentityProviderConfig":{
"name":"DescribeIdentityProviderConfig",
"http":{
"method":"POST",
"requestUri":"/clusters/{name}/identity-provider-configs/describe"
},
"input":{"shape":"DescribeIdentityProviderConfigRequest"},
"output":{"shape":"DescribeIdentityProviderConfigResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ClientException"},
{"shape":"ServerException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Returns descriptive information about an identity provider configuration.</p>"
},
"DescribeNodegroup":{
"name":"DescribeNodegroup",
"http":{
@ -252,6 +305,24 @@
],
"documentation":"<p>Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group.</p> <p>When the status of the update is <code>Succeeded</code>, the update is complete. If an update fails, the status is <code>Failed</code>, and an error detail explains the reason for the failure.</p>"
},
"DisassociateIdentityProviderConfig":{
"name":"DisassociateIdentityProviderConfig",
"http":{
"method":"POST",
"requestUri":"/clusters/{name}/identity-provider-configs/disassociate"
},
"input":{"shape":"DisassociateIdentityProviderConfigRequest"},
"output":{"shape":"DisassociateIdentityProviderConfigResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServerException"},
{"shape":"ResourceInUseException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Disassociates an identity provider configuration from a cluster. If you disassociate an identity provider from your cluster, users included in the provider can no longer access the cluster. However, you can still access the cluster with AWS IAM users.</p>"
},
"ListAddons":{
"name":"ListAddons",
"http":{
@ -301,6 +372,23 @@
],
"documentation":"<p>Lists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified Region.</p>"
},
"ListIdentityProviderConfigs":{
"name":"ListIdentityProviderConfigs",
"http":{
"method":"GET",
"requestUri":"/clusters/{name}/identity-provider-configs"
},
"input":{"shape":"ListIdentityProviderConfigsRequest"},
"output":{"shape":"ListIdentityProviderConfigsResponse"},
"errors":[
{"shape":"InvalidParameterException"},
{"shape":"ClientException"},
{"shape":"ServerException"},
{"shape":"ServiceUnavailableException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>A list of identity provider configurations.</p>"
},
"ListNodegroups":{
"name":"ListNodegroups",
"http":{
@ -360,7 +448,7 @@
{"shape":"BadRequestException"},
{"shape":"NotFoundException"}
],
"documentation":"<p>Associates the specified tags to a resource with the specified <code>resourceArn</code>. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. Tags that you create for Amazon EKS resources do not propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag does not automatically propagate to the subnets and worker nodes associated with the cluster.</p>"
"documentation":"<p>Associates the specified tags to a resource with the specified <code>resourceArn</code>. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well. Tags that you create for Amazon EKS resources do not propagate to any other resources associated with the cluster. For example, if you tag a cluster with this operation, that tag does not automatically propagate to the subnets and nodes associated with the cluster.</p>"
},
"UntagResource":{
"name":"UntagResource",
@ -575,7 +663,8 @@
"InternalFailure",
"ClusterUnreachable",
"InsufficientNumberOfReplicas",
"ConfigurationConflict"
"ConfigurationConflict",
"AdmissionRequestDenied"
]
},
"AddonIssueList":{
@ -620,6 +709,74 @@
"type":"list",
"member":{"shape":"AddonInfo"}
},
"AssociateEncryptionConfigRequest":{
"type":"structure",
"required":[
"clusterName",
"encryptionConfig"
],
"members":{
"clusterName":{
"shape":"String",
"documentation":"<p>The name of the cluster that you are associating with encryption configuration.</p>",
"location":"uri",
"locationName":"name"
},
"encryptionConfig":{
"shape":"EncryptionConfigList",
"documentation":"<p>The configuration you are using for encryption.</p>"
},
"clientRequestToken":{
"shape":"String",
"documentation":"<p>The client request token you are using with the encryption configuration.</p>",
"idempotencyToken":true
}
}
},
"AssociateEncryptionConfigResponse":{
"type":"structure",
"members":{
"update":{"shape":"Update"}
}
},
"AssociateIdentityProviderConfigRequest":{
"type":"structure",
"required":[
"clusterName",
"oidc"
],
"members":{
"clusterName":{
"shape":"String",
"documentation":"<p>The name of the cluster to associate the configuration to.</p>",
"location":"uri",
"locationName":"name"
},
"oidc":{
"shape":"OidcIdentityProviderConfigRequest",
"documentation":"<p>An object that represents an OpenID Connect (OIDC) identity provider configuration.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The metadata to apply to the configuration to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define.</p>"
},
"clientRequestToken":{
"shape":"String",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"idempotencyToken":true
}
}
},
"AssociateIdentityProviderConfigResponse":{
"type":"structure",
"members":{
"update":{"shape":"Update"},
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags for the resource.</p>"
}
}
},
"AutoScalingGroup":{
"type":"structure",
"members":{
@ -985,7 +1142,7 @@
},
"instanceTypes":{
"shape":"StringList",
"documentation":"<p>Specify the instance types for a node group. If you specify a GPU instance type, be sure to specify <code>AL2_x86_64_GPU</code> with the <code>amiType</code> parameter. If you specify <code>launchTemplate</code>, then you can specify zero or one instance type in your launch template <i>or</i> you can specify 0-20 instance types for <code>instanceTypes</code>. If however, you specify an instance type in your launch template <i>and</i> specify any <code>instanceTypes</code>, the node group deployment will fail. If you don't specify an instance type in a launch template or for <code>instanceTypes</code>, then <code>t3.medium</code> is used, by default. If you specify <code>Spot</code> for <code>capacityType</code>, then we recommend specifying multiple values for <code>instanceTypes</code>. For more information, see <a href=\"https://docs.aws.amazon.com/managed-node-groups.html#managed-node-group-capacity-types\">Managed node group capacity types</a> and <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html\">Launch template support</a> in the <i>Amazon EKS User Guide</i>.</p>"
"documentation":"<p>Specify the instance types for a node group. If you specify a GPU instance type, be sure to specify <code>AL2_x86_64_GPU</code> with the <code>amiType</code> parameter. If you specify <code>launchTemplate</code>, then you can specify zero or one instance type in your launch template <i>or</i> you can specify 0-20 instance types for <code>instanceTypes</code>. If however, you specify an instance type in your launch template <i>and</i> specify any <code>instanceTypes</code>, the node group deployment will fail. If you don't specify an instance type in a launch template or for <code>instanceTypes</code>, then <code>t3.medium</code> is used, by default. If you specify <code>Spot</code> for <code>capacityType</code>, then we recommend specifying multiple values for <code>instanceTypes</code>. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html#managed-node-group-capacity-types\">Managed node group capacity types</a> and <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html\">Launch template support</a> in the <i>Amazon EKS User Guide</i>.</p>"
},
"amiType":{
"shape":"AMITypes",
@ -997,7 +1154,7 @@
},
"nodeRole":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node <code>kubelet</code> daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/worker_node_IAM_role.html\">Amazon EKS Worker Node IAM Role</a> in the <i> <i>Amazon EKS User Guide</i> </i>. If you specify <code>launchTemplate</code>, then don't specify <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html\"> <code>IamInstanceProfile</code> </a> in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html\">Launch template support</a> in the Amazon EKS User Guide.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node <code>kubelet</code> daemon makes calls to AWS APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch nodes and register them into a cluster, you must create an IAM role for those nodes to use when they are launched. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/worker_node_IAM_role.html\">Amazon EKS node IAM role</a> in the <i> <i>Amazon EKS User Guide</i> </i>. If you specify <code>launchTemplate</code>, then don't specify <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_IamInstanceProfile.html\"> <code>IamInstanceProfile</code> </a> in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html\">Launch template support</a> in the Amazon EKS User Guide.</p>"
},
"labels":{
"shape":"labelsMap",
@ -1273,6 +1430,34 @@
}
}
},
"DescribeIdentityProviderConfigRequest":{
"type":"structure",
"required":[
"clusterName",
"identityProviderConfig"
],
"members":{
"clusterName":{
"shape":"String",
"documentation":"<p>The cluster name that the identity provider configuration is associated to.</p>",
"location":"uri",
"locationName":"name"
},
"identityProviderConfig":{
"shape":"IdentityProviderConfig",
"documentation":"<p>An object that represents an identity provider configuration.</p>"
}
}
},
"DescribeIdentityProviderConfigResponse":{
"type":"structure",
"members":{
"identityProviderConfig":{
"shape":"IdentityProviderConfigResponse",
"documentation":"<p>The object that represents an OpenID Connect (OIDC) identity provider configuration.</p>"
}
}
},
"DescribeNodegroupRequest":{
"type":"structure",
"required":[
@ -1345,6 +1530,36 @@
}
}
},
"DisassociateIdentityProviderConfigRequest":{
"type":"structure",
"required":[
"clusterName",
"identityProviderConfig"
],
"members":{
"clusterName":{
"shape":"String",
"documentation":"<p>The name of the cluster to disassociate an identity provider from.</p>",
"location":"uri",
"locationName":"name"
},
"identityProviderConfig":{
"shape":"IdentityProviderConfig",
"documentation":"<p>An object that represents an identity provider configuration.</p>"
},
"clientRequestToken":{
"shape":"String",
"documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"idempotencyToken":true
}
}
},
"DisassociateIdentityProviderConfigResponse":{
"type":"structure",
"members":{
"update":{"shape":"Update"}
}
},
"EncryptionConfig":{
"type":"structure",
"members":{
@ -1380,7 +1595,8 @@
"InsufficientFreeAddresses",
"ClusterUnreachable",
"InsufficientNumberOfReplicas",
"ConfigurationConflict"
"ConfigurationConflict",
"AdmissionRequestDenied"
]
},
"ErrorDetail":{
@ -1491,10 +1707,42 @@
"members":{
"oidc":{
"shape":"OIDC",
"documentation":"<p>The <a href=\"https://openid.net/connect/\">OpenID Connect</a> identity provider information for the cluster.</p>"
"documentation":"<p>An object representing the <a href=\"https://openid.net/connect/\">OpenID Connect</a> identity provider information.</p>"
}
},
"documentation":"<p>An object representing an identity provider for authentication credentials.</p>"
"documentation":"<p>An object representing an identity provider.</p>"
},
"IdentityProviderConfig":{
"type":"structure",
"required":[
"type",
"name"
],
"members":{
"type":{
"shape":"String",
"documentation":"<p>The type of the identity provider configuration.</p>"
},
"name":{
"shape":"String",
"documentation":"<p>The name of the identity provider configuration.</p>"
}
},
"documentation":"<p>An object representing an identity provider configuration.</p>"
},
"IdentityProviderConfigResponse":{
"type":"structure",
"members":{
"oidc":{
"shape":"OidcIdentityProviderConfig",
"documentation":"<p>An object that represents an OpenID Connect (OIDC) identity provider configuration.</p>"
}
},
"documentation":"<p>An object that represents an identity configuration.</p>"
},
"IdentityProviderConfigs":{
"type":"list",
"member":{"shape":"IdentityProviderConfig"}
},
"InvalidParameterException":{
"type":"structure",
@ -1541,7 +1789,7 @@
"members":{
"code":{
"shape":"NodegroupIssueCode",
"documentation":"<p>A brief description of the error.</p> <ul> <li> <p> <b>AccessDenied</b>: Amazon EKS or one or more of your managed nodes is failing to authenticate or authorize with your Kubernetes cluster API server.</p> </li> <li> <p> <b>AsgInstanceLaunchFailures</b>: Your Auto Scaling group is experiencing failures while attempting to launch instances.</p> </li> <li> <p> <b>AutoScalingGroupNotFound</b>: We couldn't find the Auto Scaling group associated with the managed node group. You may be able to recreate an Auto Scaling group with the same settings to recover.</p> </li> <li> <p> <b>ClusterUnreachable</b>: Amazon EKS or one or more of your managed nodes is unable to to communicate with your Kubernetes cluster API server. This can happen if there are network disruptions or if API servers are timing out processing requests. </p> </li> <li> <p> <b>Ec2LaunchTemplateNotFound</b>: We couldn't find the Amazon EC2 launch template for your managed node group. You may be able to recreate a launch template with the same settings to recover.</p> </li> <li> <p> <b>Ec2LaunchTemplateVersionMismatch</b>: The Amazon EC2 launch template version for your managed node group does not match the version that Amazon EKS created. You may be able to revert to the version that Amazon EKS created to recover.</p> </li> <li> <p> <b>Ec2SecurityGroupDeletionFailure</b>: We could not delete the remote access security group for your managed node group. Remove any dependencies from the security group.</p> </li> <li> <p> <b>Ec2SecurityGroupNotFound</b>: We couldn't find the cluster security group for the cluster. You must recreate your cluster.</p> </li> <li> <p> <b>Ec2SubnetInvalidConfiguration</b>: One or more Amazon EC2 subnets specified for a node group do not automatically assign public IP addresses to instances launched into it. If you want your instances to be assigned a public IP address, then you need to enable the <code>auto-assign public IP address</code> setting for the subnet. See <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/vpc-ip-addressing.html#subnet-public-ip\">Modifying the public IPv4 addressing attribute for your subnet</a> in the Amazon VPC User Guide.</p> </li> <li> <p> <b>IamInstanceProfileNotFound</b>: We couldn't find the IAM instance profile for your managed node group. You may be able to recreate an instance profile with the same settings to recover.</p> </li> <li> <p> <b>IamNodeRoleNotFound</b>: We couldn't find the IAM role for your managed node group. You may be able to recreate an IAM role with the same settings to recover.</p> </li> <li> <p> <b>InstanceLimitExceeded</b>: Your AWS account is unable to launch any more instances of the specified instance type. You may be able to request an Amazon EC2 instance limit increase to recover.</p> </li> <li> <p> <b>InsufficientFreeAddresses</b>: One or more of the subnets associated with your managed node group does not have enough available IP addresses for new nodes.</p> </li> <li> <p> <b>InternalFailure</b>: These errors are usually caused by an Amazon EKS server-side issue.</p> </li> <li> <p> <b>NodeCreationFailure</b>: Your launched instances are unable to register with your Amazon EKS cluster. Common causes of this failure are insufficient <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/worker_node_IAM_role.html\">worker node IAM role</a> permissions or lack of outbound internet access for the nodes. </p> </li> </ul>"
"documentation":"<p>A brief description of the error.</p> <ul> <li> <p> <b>AccessDenied</b>: Amazon EKS or one or more of your managed nodes is failing to authenticate or authorize with your Kubernetes cluster API server.</p> </li> <li> <p> <b>AsgInstanceLaunchFailures</b>: Your Auto Scaling group is experiencing failures while attempting to launch instances.</p> </li> <li> <p> <b>AutoScalingGroupNotFound</b>: We couldn't find the Auto Scaling group associated with the managed node group. You may be able to recreate an Auto Scaling group with the same settings to recover.</p> </li> <li> <p> <b>ClusterUnreachable</b>: Amazon EKS or one or more of your managed nodes is unable to to communicate with your Kubernetes cluster API server. This can happen if there are network disruptions or if API servers are timing out processing requests. </p> </li> <li> <p> <b>Ec2LaunchTemplateNotFound</b>: We couldn't find the Amazon EC2 launch template for your managed node group. You may be able to recreate a launch template with the same settings to recover.</p> </li> <li> <p> <b>Ec2LaunchTemplateVersionMismatch</b>: The Amazon EC2 launch template version for your managed node group does not match the version that Amazon EKS created. You may be able to revert to the version that Amazon EKS created to recover.</p> </li> <li> <p> <b>Ec2SecurityGroupDeletionFailure</b>: We could not delete the remote access security group for your managed node group. Remove any dependencies from the security group.</p> </li> <li> <p> <b>Ec2SecurityGroupNotFound</b>: We couldn't find the cluster security group for the cluster. You must recreate your cluster.</p> </li> <li> <p> <b>Ec2SubnetInvalidConfiguration</b>: One or more Amazon EC2 subnets specified for a node group do not automatically assign public IP addresses to instances launched into it. If you want your instances to be assigned a public IP address, then you need to enable the <code>auto-assign public IP address</code> setting for the subnet. See <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/vpc-ip-addressing.html#subnet-public-ip\">Modifying the public IPv4 addressing attribute for your subnet</a> in the Amazon VPC User Guide.</p> </li> <li> <p> <b>IamInstanceProfileNotFound</b>: We couldn't find the IAM instance profile for your managed node group. You may be able to recreate an instance profile with the same settings to recover.</p> </li> <li> <p> <b>IamNodeRoleNotFound</b>: We couldn't find the IAM role for your managed node group. You may be able to recreate an IAM role with the same settings to recover.</p> </li> <li> <p> <b>InstanceLimitExceeded</b>: Your AWS account is unable to launch any more instances of the specified instance type. You may be able to request an Amazon EC2 instance limit increase to recover.</p> </li> <li> <p> <b>InsufficientFreeAddresses</b>: One or more of the subnets associated with your managed node group does not have enough available IP addresses for new nodes.</p> </li> <li> <p> <b>InternalFailure</b>: These errors are usually caused by an Amazon EKS server-side issue.</p> </li> <li> <p> <b>NodeCreationFailure</b>: Your launched instances are unable to register with your Amazon EKS cluster. Common causes of this failure are insufficient <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/worker_node_IAM_role.html\">node IAM role</a> permissions or lack of outbound internet access for the nodes. </p> </li> </ul>"
},
"message":{
"shape":"String",
@ -1712,6 +1960,49 @@
}
}
},
"ListIdentityProviderConfigsRequest":{
"type":"structure",
"required":["clusterName"],
"members":{
"clusterName":{
"shape":"String",
"documentation":"<p>The cluster name that you want to list identity provider configurations for.</p>",
"location":"uri",
"locationName":"name"
},
"maxResults":{
"shape":"ListIdentityProviderConfigsRequestMaxResults",
"documentation":"<p>The maximum number of identity provider configurations returned by <code>ListIdentityProviderConfigs</code> in paginated output. When you use this parameter, <code>ListIdentityProviderConfigs</code> returns only <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. You can see the remaining results of the initial request by sending another <code>ListIdentityProviderConfigs</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If you don't use this parameter, <code>ListIdentityProviderConfigs</code> returns up to 100 results and a <code>nextToken</code> value, if applicable.</p>",
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>IdentityProviderConfigsRequest</code> where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListIdentityProviderConfigsRequestMaxResults":{
"type":"integer",
"box":true,
"max":100,
"min":1
},
"ListIdentityProviderConfigsResponse":{
"type":"structure",
"members":{
"identityProviderConfigs":{
"shape":"IdentityProviderConfigs",
"documentation":"<p>The identity provider configurations for the cluster.</p>"
},
"nextToken":{
"shape":"String",
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>ListIdentityProviderConfigsResponse</code> where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value.</p>"
}
}
},
"ListNodegroupsRequest":{
"type":"structure",
"required":["clusterName"],
@ -1934,7 +2225,7 @@
},
"nodeRole":{
"shape":"String",
"documentation":"<p>The IAM role associated with your node group. The Amazon EKS worker node <code>kubelet</code> daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies.</p>"
"documentation":"<p>The IAM role associated with your node group. The Amazon EKS node <code>kubelet</code> daemon makes calls to AWS APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies.</p>"
},
"labels":{
"shape":"labelsMap",
@ -2005,7 +2296,7 @@
},
"remoteAccessSecurityGroup":{
"shape":"String",
"documentation":"<p>The remote access security group associated with the node group. This security group controls SSH access to the worker nodes.</p>"
"documentation":"<p>The remote access security group associated with the node group. This security group controls SSH access to the nodes.</p>"
}
},
"documentation":"<p>An object representing the resources associated with the node group, such as Auto Scaling groups and security groups for remote access.</p>"
@ -2015,15 +2306,15 @@
"members":{
"minSize":{
"shape":"Capacity",
"documentation":"<p>The minimum number of worker nodes that the managed node group can scale in to. This number must be greater than zero.</p>"
"documentation":"<p>The minimum number of nodes that the managed node group can scale in to. This number must be greater than zero.</p>"
},
"maxSize":{
"shape":"Capacity",
"documentation":"<p>The maximum number of worker nodes that the managed node group can scale out to. Managed node groups can support up to 100 nodes by default.</p>"
"documentation":"<p>The maximum number of nodes that the managed node group can scale out to. For information about the maximum number that you can specify, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html\">Amazon EKS service quotas</a> in the <i>Amazon EKS User Guide</i>.</p>"
},
"desiredSize":{
"shape":"Capacity",
"documentation":"<p>The current number of worker nodes that the managed node group should maintain.</p>"
"documentation":"<p>The current number of nodes that the managed node group should maintain.</p>"
}
},
"documentation":"<p>An object representing the scaling configuration details for the Auto Scaling group that is associated with your node group. If you specify a value for any property, then you must specify values for all of the properties.</p>"
@ -2054,10 +2345,107 @@
"members":{
"issuer":{
"shape":"String",
"documentation":"<p>The issuer URL for the OpenID Connect identity provider.</p>"
"documentation":"<p>The issuer URL for the OIDC identity provider.</p>"
}
},
"documentation":"<p>An object representing the <a href=\"https://openid.net/connect/\">OpenID Connect</a> identity provider information for the cluster.</p>"
"documentation":"<p>An object representing the <a href=\"https://openid.net/connect/\">OpenID Connect</a> (OIDC) identity provider information for the cluster.</p>"
},
"OidcIdentityProviderConfig":{
"type":"structure",
"members":{
"identityProviderConfigName":{
"shape":"String",
"documentation":"<p>The name of the configuration.</p>"
},
"identityProviderConfigArn":{
"shape":"String",
"documentation":"<p>The ARN of the configuration.</p>"
},
"clusterName":{
"shape":"String",
"documentation":"<p>The cluster that the configuration is associated to.</p>"
},
"issuerUrl":{
"shape":"String",
"documentation":"<p>The URL of the OIDC identity provider that allows the API server to discover public signing keys for verifying tokens.</p>"
},
"clientId":{
"shape":"String",
"documentation":"<p>This is also known as <i>audience</i>. The ID of the client application that makes authentication requests to the OIDC identity provider.</p>"
},
"usernameClaim":{
"shape":"String",
"documentation":"<p>The JSON Web token (JWT) claim that is used as the username.</p>"
},
"usernamePrefix":{
"shape":"String",
"documentation":"<p>The prefix that is prepended to username claims to prevent clashes with existing names. The prefix can't contain <code>system:</code> </p>"
},
"groupsClaim":{
"shape":"String",
"documentation":"<p>The JSON web token (JWT) claim that the provider uses to return your groups.</p>"
},
"groupsPrefix":{
"shape":"String",
"documentation":"<p>The prefix that is prepended to group claims to prevent clashes with existing names (such as <code>system:</code> groups). For example, the value<code> oidc:</code> creates group names like <code>oidc:engineering</code> and <code>oidc:infra</code>. The prefix can't contain <code>system:</code> </p>"
},
"requiredClaims":{
"shape":"requiredClaimsMap",
"documentation":"<p>The key-value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The metadata to apply to the provider configuration to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you defined.</p>"
},
"status":{
"shape":"configStatus",
"documentation":"<p>The status of the OIDC identity provider.</p>"
}
},
"documentation":"<p>An object that represents the configuration for an OpenID Connect (OIDC) identity provider. </p>"
},
"OidcIdentityProviderConfigRequest":{
"type":"structure",
"required":[
"identityProviderConfigName",
"issuerUrl",
"clientId"
],
"members":{
"identityProviderConfigName":{
"shape":"String",
"documentation":"<p>The name of the OIDC provider configuration.</p>"
},
"issuerUrl":{
"shape":"String",
"documentation":"<p>The URL of the OpenID identity provider that allows the API server to discover public signing keys for verifying tokens. The URL must begin with <code>https://</code> and should correspond to the <code>iss</code> claim in the provider's OIDC ID tokens. Per the OIDC standard, path components are allowed but query parameters are not. Typically the URL consists of only a hostname, like <code>https://server.example.org</code> or <code>https://example.com</code>. This URL should point to the level below <code>.well-known/openid-configuration</code> and must be publicly accessible over the internet.</p>"
},
"clientId":{
"shape":"String",
"documentation":"<p>This is also known as <i>audience</i>. The ID for the client application that makes authentication requests to the OpenID identity provider.</p>"
},
"usernameClaim":{
"shape":"String",
"documentation":"<p>The JSON Web Token (JWT) claim to use as the username. The default is <code>sub</code>, which is expected to be a unique identifier of the end user. You can choose other claims, such as <code>email</code> or <code>name</code>, depending on the OpenID identity provider. Claims other than <code>email</code> are prefixed with the issuer URL to prevent naming clashes with other plug-ins.</p>"
},
"usernamePrefix":{
"shape":"String",
"documentation":"<p>The prefix that is prepended to username claims to prevent clashes with existing names. If you do not provide this field, and <code>username</code> is a value other than <code>email</code>, the prefix defaults to <code>issuerurl#</code>. You can use the value <code>-</code> to disable all prefixing.</p>"
},
"groupsClaim":{
"shape":"String",
"documentation":"<p>The JWT claim that the provider uses to return your groups.</p>"
},
"groupsPrefix":{
"shape":"String",
"documentation":"<p>The prefix that is prepended to group claims to prevent clashes with existing names (such as <code>system:</code> groups). For example, the value<code> oidc:</code> will create group names like <code>oidc:engineering</code> and <code>oidc:infra</code>.</p>"
},
"requiredClaims":{
"shape":"requiredClaimsMap",
"documentation":"<p>The key value pairs that describe required claims in the identity token. If set, each claim is verified to be present in the token with a matching value. For the maximum number of claims that you can require, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/service-quotas.html\">Amazon EKS service quotas</a> in the <i>Amazon EKS User Guide</i>.</p>"
}
},
"documentation":"<p>An object representing an OpenID Connect (OIDC) configuration. Before associating an OIDC identity provider to your cluster, review the considerations in <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/authenticate-oidc-identity-provider.html\">Authenticating users for your cluster from an OpenID Connect identity provider</a> in the <i>Amazon EKS User Guide</i>.</p>"
},
"Provider":{
"type":"structure",
@ -2074,11 +2462,11 @@
"members":{
"ec2SshKey":{
"shape":"String",
"documentation":"<p>The Amazon EC2 SSH key that provides access for SSH communication with the worker nodes in the managed node group. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Amazon EC2 Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide for Linux Instances</i>.</p>"
"documentation":"<p>The Amazon EC2 SSH key that provides access for SSH communication with the nodes in the managed node group. For more information, see <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html\">Amazon EC2 Key Pairs</a> in the <i>Amazon Elastic Compute Cloud User Guide for Linux Instances</i>.</p>"
},
"sourceSecurityGroups":{
"shape":"StringList",
"documentation":"<p>The security groups that are allowed SSH access (port 22) to the worker nodes. If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the worker nodes is opened to the internet (0.0.0.0/0). For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html\">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>"
"documentation":"<p>The security groups that are allowed SSH access (port 22) to the nodes. If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the nodes is opened to the internet (0.0.0.0/0). For more information, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/VPC_SecurityGroups.html\">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.</p>"
}
},
"documentation":"<p>An object representing the remote access configuration for the managed node group.</p>"
@ -2546,6 +2934,8 @@
"MinSize",
"ReleaseVersion",
"PublicAccessCidrs",
"IdentityProviderConfig",
"EncryptionConfig",
"AddonVersion",
"ServiceAccountRoleArn",
"ResolveConflicts"
@ -2571,6 +2961,9 @@
"EndpointAccessUpdate",
"LoggingUpdate",
"ConfigUpdate",
"AssociateIdentityProviderConfig",
"DisassociateIdentityProviderConfig",
"AssociateEncryptionConfig",
"AddonUpdate"
]
},
@ -2579,11 +2972,11 @@
"members":{
"subnetIds":{
"shape":"StringList",
"documentation":"<p>Specify subnets for your Amazon EKS worker nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your worker nodes and the Kubernetes control plane.</p>"
"documentation":"<p>Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.</p>"
},
"securityGroupIds":{
"shape":"StringList",
"documentation":"<p>Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your worker nodes and the Kubernetes control plane. If you don't specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes:</p> <ul> <li> <p>1.14 Amazon EKS platform version <code>eks.2</code> and earlier</p> </li> <li> <p>1.14 Amazon EKS platform version <code>eks.3</code> and later </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html\">Amazon EKS security group considerations</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
"documentation":"<p>Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your nodes and the Kubernetes control plane. If you don't specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes:</p> <ul> <li> <p>1.14 Amazon EKS platform version <code>eks.2</code> and earlier</p> </li> <li> <p>1.14 Amazon EKS platform version <code>eks.3</code> and later </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html\">Amazon EKS security group considerations</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
},
"endpointPublicAccess":{
"shape":"BoxedBoolean",
@ -2591,11 +2984,11 @@
},
"endpointPrivateAccess":{
"shape":"BoxedBoolean",
"documentation":"<p>Set this value to <code>true</code> to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is <code>false</code>, which disables private access for your Kubernetes API server. If you disable private access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that <code>publicAccessCidrs</code> includes the necessary CIDR blocks for communication with the worker nodes or Fargate pods. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html\">Amazon EKS Cluster Endpoint Access Control</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
"documentation":"<p>Set this value to <code>true</code> to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is <code>false</code>, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that <code>publicAccessCidrs</code> includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html\">Amazon EKS Cluster Endpoint Access Control</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
},
"publicAccessCidrs":{
"shape":"StringList",
"documentation":"<p>The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is <code>0.0.0.0/0</code>. If you've disabled private endpoint access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html\">Amazon EKS Cluster Endpoint Access Control</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
"documentation":"<p>The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is <code>0.0.0.0/0</code>. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html\">Amazon EKS Cluster Endpoint Access Control</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
}
},
"documentation":"<p>An object representing the VPC configuration to use for an Amazon EKS cluster.</p>"
@ -2609,7 +3002,7 @@
},
"securityGroupIds":{
"shape":"StringList",
"documentation":"<p>The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your worker nodes and the Kubernetes control plane.</p>"
"documentation":"<p>The security groups associated with the cross-account elastic network interfaces that are used to allow communication between your nodes and the Kubernetes control plane.</p>"
},
"clusterSecurityGroupId":{
"shape":"String",
@ -2625,15 +3018,23 @@
},
"endpointPrivateAccess":{
"shape":"Boolean",
"documentation":"<p>This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have worker nodes or AWS Fargate pods in the cluster, then ensure that <code>publicAccessCidrs</code> includes the necessary CIDR blocks for communication with the worker nodes or Fargate pods. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html\">Amazon EKS Cluster Endpoint Access Control</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
"documentation":"<p>This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate from within your cluster's VPC use the private VPC endpoint instead of traversing the internet. If this value is disabled and you have nodes or AWS Fargate pods in the cluster, then ensure that <code>publicAccessCidrs</code> includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html\">Amazon EKS Cluster Endpoint Access Control</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
},
"publicAccessCidrs":{
"shape":"StringList",
"documentation":"<p>The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks is denied. The default value is <code>0.0.0.0/0</code>. If you've disabled private endpoint access and you have worker nodes or AWS Fargate pods in the cluster, then ensure that the necessary CIDR blocks are listed. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html\">Amazon EKS Cluster Endpoint Access Control</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
"documentation":"<p>The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks is denied. The default value is <code>0.0.0.0/0</code>. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that the necessary CIDR blocks are listed. For more information, see <a href=\"https://docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html\">Amazon EKS Cluster Endpoint Access Control</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"
}
},
"documentation":"<p>An object representing an Amazon EKS cluster VPC configuration response.</p>"
},
"configStatus":{
"type":"string",
"enum":[
"CREATING",
"DELETING",
"ACTIVE"
]
},
"labelKey":{
"type":"string",
"max":63,
@ -2652,6 +3053,21 @@
"type":"map",
"key":{"shape":"labelKey"},
"value":{"shape":"labelValue"}
},
"requiredClaimsKey":{
"type":"string",
"max":63,
"min":1
},
"requiredClaimsMap":{
"type":"map",
"key":{"shape":"requiredClaimsKey"},
"value":{"shape":"requiredClaimsValue"}
},
"requiredClaimsValue":{
"type":"string",
"max":253,
"min":1
}
},
"documentation":"<p>Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on AWS without needing to stand up or maintain your own Kubernetes control plane. Kubernetes is an open-source system for automating the deployment, scaling, and management of containerized applications. </p> <p>Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use all the existing plugins and tooling from the Kubernetes community. Applications running on Amazon EKS are fully compatible with applications running on any standard Kubernetes environment, whether running in on-premises data centers or public clouds. This means that you can easily migrate any standard Kubernetes application to Amazon EKS without any code modification required.</p>"

8
botocore/data/elasticache/2015-02-02/service-2.json
View file

@ -439,7 +439,7 @@
{"shape":"CacheSubnetGroupInUse"},
{"shape":"CacheSubnetGroupNotFoundFault"}
],
"documentation":"<p>Deletes a cache subnet group.</p> <note> <p>You cannot delete a cache subnet group if it is associated with any clusters.</p> </note>"
"documentation":"<p>Deletes a cache subnet group.</p> <note> <p>You cannot delete a default cache subnet group or one that is associated with any clusters.</p> </note>"
},
"DeleteGlobalReplicationGroup":{
"name":"DeleteGlobalReplicationGroup",
@ -1090,7 +1090,7 @@
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidParameterCombinationException"}
],
"documentation":"<p>Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among exisiting shards.</p>"
"documentation":"<p>Modifies a replication group's shards (node groups) by allowing you to add shards, remove shards, or rebalance the keyspaces among existing shards.</p>"
},
"ModifyUser":{
"name":"ModifyUser",
@ -2412,7 +2412,7 @@
},
"PreferredMaintenanceWindow":{
"shape":"String",
"documentation":"<p>Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for <code>ddd</code> are:</p> <p>Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period.</p> <p>Valid values for <code>ddd</code> are:</p> <ul> <li> <p> <code>sun</code> </p> </li> <li> <p> <code>mon</code> </p> </li> <li> <p> <code>tue</code> </p> </li> <li> <p> <code>wed</code> </p> </li> <li> <p> <code>thu</code> </p> </li> <li> <p> <code>fri</code> </p> </li> <li> <p> <code>sat</code> </p> </li> </ul> <p>Example: <code>sun:23:00-mon:01:30</code> </p>"
"documentation":"<p>Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for <code>ddd</code> are:</p>"
},
"Port":{
"shape":"IntegerOptional",
@ -2625,7 +2625,7 @@
},
"Engine":{
"shape":"String",
"documentation":"<p>The name of the cache engine to be used for the clusters in this replication group.</p>"
"documentation":"<p>The name of the cache engine to be used for the clusters in this replication group. Must be Redis.</p>"
},
"EngineVersion":{
"shape":"String",

8
botocore/data/elbv2/2015-12-01/service-2.json
View file

@ -80,7 +80,7 @@
{"shape":"ALPNPolicyNotSupportedException"},
{"shape":"TooManyTagsException"}
],
"documentation":"<p>Creates a listener for the specified Application Load Balancer, Network Load Balancer. or Gateway Load Balancer.</p> <p>For more information, see the following:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html\">Listeners for your Application Load Balancers</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-listeners.html\">Listeners for your Network Load Balancers</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/gateway-listeners.html\">Listeners for your Gateway Load Balancers</a> </p> </li> </ul> <p>This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds.</p>"
"documentation":"<p>Creates a listener for the specified Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.</p> <p>For more information, see the following:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-listeners.html\">Listeners for your Application Load Balancers</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/network/load-balancer-listeners.html\">Listeners for your Network Load Balancers</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/gateway-listeners.html\">Listeners for your Gateway Load Balancers</a> </p> </li> </ul> <p>This operation is idempotent, which means that it completes at most one time. If you attempt to create multiple listeners with the same settings, each call succeeds.</p>"
},
"CreateLoadBalancer":{
"name":"CreateLoadBalancer",
@ -1231,7 +1231,7 @@
},
"HealthCheckIntervalSeconds":{
"shape":"HealthCheckIntervalSeconds",
"documentation":"<p>The approximate amount of time, in seconds, between health checks of an individual target. For TCP health checks, the supported values are 10 and 30 seconds. If the target type is <code>instance</code> or <code>ip</code>, the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds. If the target type is <code>lambda</code>, the default is 35 seconds.</p>"
"documentation":"<p>The approximate amount of time, in seconds, between health checks of an individual target. If the target group protocol is TCP, TLS, UDP, or TCP_UDP, the supported values are 10 and 30 seconds. If the target group protocol is HTTP or HTTPS, the default is 30 seconds. If the target group protocol is GENEVE, the default is 10 seconds. If the target type is <code>lambda</code>, the default is 35 seconds.</p>"
},
"HealthCheckTimeoutSeconds":{
"shape":"HealthCheckTimeoutSeconds",
@ -2147,7 +2147,7 @@
"members":{
"Code":{
"shape":"LoadBalancerStateEnum",
"documentation":"<p>The state code. The initial state of the load balancer is <code>provisioning</code>. After the load balancer is fully set up and ready to route traffic, its state is <code>active</code>. If the load balancer could not be set up, its state is <code>failed</code>.</p>"
"documentation":"<p>The state code. The initial state of the load balancer is <code>provisioning</code>. After the load balancer is fully set up and ready to route traffic, its state is <code>active</code>. If load balancer is routing traffic but does not have the resources it needs to scale, its state is<code>active_impaired</code>. If the load balancer could not be set up, its state is <code>failed</code>.</p>"
},
"Reason":{
"shape":"StateReason",
@ -3100,7 +3100,7 @@
"members":{
"Key":{
"shape":"TargetGroupAttributeKey",
"documentation":"<p>The name of the attribute.</p> <p>The following attribute is supported by all load balancers:</p> <ul> <li> <p> <code>deregistration_delay.timeout_seconds</code> - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from <code>draining</code> to <code>unused</code>. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported.</p> </li> </ul> <p>The following attributes are supported by both Application Load Balancers and Network Load Balancers:</p> <ul> <li> <p> <code>stickiness.enabled</code> - Indicates whether sticky sessions are enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> <li> <p> <code>stickiness.type</code> - The type of sticky sessions. The possible values are <code>lb_cookie</code> for Application Load Balancers or <code>source_ip</code> for Network Load Balancers.</p> </li> </ul> <p>The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address:</p> <ul> <li> <p> <code>load_balancing.algorithm.type</code> - The load balancing algorithm determines how the load balancer selects targets when routing requests. The value is <code>round_robin</code> or <code>least_outstanding_requests</code>. The default is <code>round_robin</code>.</p> </li> <li> <p> <code>slow_start.duration_seconds</code> - The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled).</p> </li> <li> <p> <code>stickiness.lb_cookie.duration_seconds</code> - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).</p> </li> </ul> <p>The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function:</p> <ul> <li> <p> <code>lambda.multi_value_headers.enabled</code> - Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>. If the value is <code>false</code> and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client.</p> </li> </ul> <p>The following attributes are supported only by Network Load Balancers:</p> <ul> <li> <p> <code>deregistration_delay.connection_termination.enabled</code> - Indicates whether the load balancer terminates connections at the end of the deregistration timeout. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> <li> <p> <code>proxy_protocol_v2.enabled</code> - Indicates whether Proxy Protocol version 2 is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> </ul>"
"documentation":"<p>The name of the attribute.</p> <p>The following attribute is supported by all load balancers:</p> <ul> <li> <p> <code>deregistration_delay.timeout_seconds</code> - The amount of time, in seconds, for Elastic Load Balancing to wait before changing the state of a deregistering target from <code>draining</code> to <code>unused</code>. The range is 0-3600 seconds. The default value is 300 seconds. If the target is a Lambda function, this attribute is not supported.</p> </li> </ul> <p>The following attributes are supported by both Application Load Balancers and Network Load Balancers:</p> <ul> <li> <p> <code>stickiness.enabled</code> - Indicates whether sticky sessions are enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> <li> <p> <code>stickiness.type</code> - The type of sticky sessions. The possible values are <code>lb_cookie</code> and <code>app_cookie</code> for Application Load Balancers or <code>source_ip</code> for Network Load Balancers.</p> </li> </ul> <p>The following attributes are supported only if the load balancer is an Application Load Balancer and the target is an instance or an IP address:</p> <ul> <li> <p> <code>load_balancing.algorithm.type</code> - The load balancing algorithm determines how the load balancer selects targets when routing requests. The value is <code>round_robin</code> or <code>least_outstanding_requests</code>. The default is <code>round_robin</code>.</p> </li> <li> <p> <code>slow_start.duration_seconds</code> - The time period, in seconds, during which a newly registered target receives an increasing share of the traffic to the target group. After this time period ends, the target receives its full share of traffic. The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled).</p> </li> <li> <p> <code>stickiness.app_cookie.cookie_name</code> - Indicates the name of the application-based cookie. Names that start with the following names are not allowed: <code>AWSALB</code>, <code>AWSALBAPP</code>, and <code>AWSALBTG</code>. They're reserved for use by the load balancer.</p> </li> <li> <p> <code>stickiness.app_cookie.duration_seconds</code> - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the application-based cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).</p> </li> <li> <p> <code>stickiness.lb_cookie.duration_seconds</code> - The time period, in seconds, during which requests from a client should be routed to the same target. After this time period expires, the load balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The default value is 1 day (86400 seconds).</p> </li> </ul> <p>The following attribute is supported only if the load balancer is an Application Load Balancer and the target is a Lambda function:</p> <ul> <li> <p> <code>lambda.multi_value_headers.enabled</code> - Indicates whether the request and response headers that are exchanged between the load balancer and the Lambda function include arrays of values or strings. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>. If the value is <code>false</code> and the request contains a duplicate header field name or query parameter key, the load balancer uses the last value sent by the client.</p> </li> </ul> <p>The following attributes are supported only by Network Load Balancers:</p> <ul> <li> <p> <code>deregistration_delay.connection_termination.enabled</code> - Indicates whether the load balancer terminates connections at the end of the deregistration timeout. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> <li> <p> <code>preserve_client_ip.enabled</code> - Indicates whether client IP preservation is enabled. The value is <code>true</code> or <code>false</code>. The default is disabled if the target group type is IP address and the target group protocol is TCP or TLS. Otherwise, the default is enabled. Client IP preservation cannot be disabled for UDP and TCP_UDP target groups.</p> </li> <li> <p> <code>proxy_protocol_v2.enabled</code> - Indicates whether Proxy Protocol version 2 is enabled. The value is <code>true</code> or <code>false</code>. The default is <code>false</code>.</p> </li> </ul>"
},
"Value":{
"shape":"TargetGroupAttributeValue",

5
botocore/data/emr-containers/2020-10-01/service-2.json
View file

@ -487,7 +487,10 @@
}
}
},
"Date":{"type":"timestamp"},
"Date":{
"type":"timestamp",
"timestampFormat":"iso8601"
},
"DeleteManagedEndpointRequest":{
"type":"structure",
"required":[

175
botocore/data/emr/2009-03-31/service-2.json
View file

@ -107,7 +107,7 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<note> <p>The Amazon EMR Studio APIs are in preview release for Amazon EMR and are subject to change.</p> </note> <p>Creates a new Amazon EMR Studio.</p>"
"documentation":"<p>Creates a new Amazon EMR Studio.</p>"
},
"CreateStudioSessionMapping":{
"name":"CreateStudioSessionMapping",
@ -120,7 +120,7 @@
{"shape":"InternalServerError"},
{"shape":"InvalidRequestException"}
],
"documentation":"<note> <p>The Amazon EMR Studio APIs are in preview release for Amazon EMR and are subject to change.</p> </note> <p>Maps a user or group to the Amazon EMR Studio specified by <code>StudioId</code>, and applies a session policy to refine Studio permissions for that user or group.</p>"
"documentation":"<p>Maps a user or group to the Amazon EMR Studio specified by <code>StudioId</code>, and applies a session policy to refine Studio permissions for that user or group.</p>"
},
"DeleteSecurityConfiguration":{
"name":"DeleteSecurityConfiguration",
@ -147,7 +147,7 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<note> <p>The Amazon EMR Studio APIs are in preview release for Amazon EMR and are subject to change.</p> </note> <p>Removes an Amazon EMR Studio from the Studio metadata store.</p>"
"documentation":"<p>Removes an Amazon EMR Studio from the Studio metadata store.</p>"
},
"DeleteStudioSessionMapping":{
"name":"DeleteStudioSessionMapping",
@ -160,7 +160,7 @@
{"shape":"InternalServerError"},
{"shape":"InvalidRequestException"}
],
"documentation":"<note> <p>The Amazon EMR Studio APIs are in preview release for Amazon EMR and are subject to change.</p> </note> <p>Removes a user or group from an Amazon EMR Studio.</p>"
"documentation":"<p>Removes a user or group from an Amazon EMR Studio.</p>"
},
"DescribeCluster":{
"name":"DescribeCluster",
@ -244,7 +244,7 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<note> <p>The Amazon EMR Studio APIs are in preview release for Amazon EMR and are subject to change.</p> </note> <p>Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on.</p>"
"documentation":"<p>Returns details for the specified Amazon EMR Studio including ID, Name, VPC, Studio access URL, and so on.</p>"
},
"GetBlockPublicAccessConfiguration":{
"name":"GetBlockPublicAccessConfiguration",
@ -282,7 +282,7 @@
{"shape":"InternalServerError"},
{"shape":"InvalidRequestException"}
],
"documentation":"<note> <p>The Amazon EMR Studio APIs are in preview release for Amazon EMR and are subject to change.</p> </note> <p>Fetches mapping details for the specified Amazon EMR Studio and identity (user or group).</p>"
"documentation":"<p>Fetches mapping details for the specified Amazon EMR Studio and identity (user or group).</p>"
},
"ListBootstrapActions":{
"name":"ListBootstrapActions",
@ -394,7 +394,7 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Provides a list of steps for the cluster in reverse order unless you specify <code>stepIds</code> with the request of filter by <code>StepStates</code>. You can specify a maximum of ten <code>stepIDs</code>.</p>"
"documentation":"<p>Provides a list of steps for the cluster in reverse order unless you specify <code>stepIds</code> with the request of filter by <code>StepStates</code>. You can specify a maximum of 10 <code>stepIDs</code>.</p>"
},
"ListStudioSessionMappings":{
"name":"ListStudioSessionMappings",
@ -408,7 +408,7 @@
{"shape":"InternalServerError"},
{"shape":"InvalidRequestException"}
],
"documentation":"<note> <p>The Amazon EMR Studio APIs are in preview release for Amazon EMR and are subject to change.</p> </note> <p>Returns a list of all user or group session mappings for the EMR Studio specified by <code>StudioId</code>.</p>"
"documentation":"<p>Returns a list of all user or group session mappings for the Amazon EMR Studio specified by <code>StudioId</code>.</p>"
},
"ListStudios":{
"name":"ListStudios",
@ -422,7 +422,7 @@
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<note> <p>The Amazon EMR Studio APIs are in preview release for Amazon EMR and are subject to change.</p> </note> <p>Returns a list of all Amazon EMR Studios associated with the AWS account. The list includes details such as ID, Studio Access URL, and creation time for each Studio.</p>"
"documentation":"<p>Returns a list of all Amazon EMR Studios associated with the AWS account. The list includes details such as ID, Studio Access URL, and creation time for each Studio.</p>"
},
"ModifyCluster":{
"name":"ModifyCluster",
@ -607,6 +607,19 @@
],
"documentation":"<p>TerminateJobFlows shuts a list of clusters (job flows) down. When a job flow is shut down, any step not yet completed is canceled and the EC2 instances on which the cluster is running are stopped. Any log files not already saved are uploaded to Amazon S3 if a LogUri was specified when the cluster was created.</p> <p>The maximum number of clusters allowed is 10. The call to <code>TerminateJobFlows</code> is asynchronous. Depending on the configuration of the cluster, it may take up to 1-5 minutes for the cluster to completely terminate and release allocated resources, such as Amazon EC2 instances.</p>"
},
"UpdateStudio":{
"name":"UpdateStudio",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UpdateStudioInput"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Updates an Amazon EMR Studio configuration, including attributes such as name, description, and subnets.</p>"
},
"UpdateStudioSessionMapping":{
"name":"UpdateStudioSessionMapping",
"http":{
@ -618,7 +631,7 @@
{"shape":"InternalServerError"},
{"shape":"InvalidRequestException"}
],
"documentation":"<note> <p>The Amazon EMR Studio APIs are in preview release for Amazon EMR and are subject to change.</p> </note> <p>Updates the session policy attached to the user or group for the specified Amazon EMR Studio.</p>"
"documentation":"<p>Updates the session policy attached to the user or group for the specified Amazon EMR Studio.</p>"
}
},
"shapes":{
@ -1438,7 +1451,8 @@
"ServiceRole",
"UserRole",
"WorkspaceSecurityGroupId",
"EngineSecurityGroupId"
"EngineSecurityGroupId",
"DefaultS3Location"
],
"members":{
"Name":{
@ -1447,7 +1461,7 @@
},
"Description":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>A detailed description of the Studio.</p>"
"documentation":"<p>A detailed description of the Amazon EMR Studio.</p>"
},
"AuthMode":{
"shape":"AuthMode",
@ -1459,7 +1473,7 @@
},
"SubnetIds":{
"shape":"SubnetIdList",
"documentation":"<p>A list of subnet IDs to associate with the Studio. The subnets must belong to the VPC specified by <code>VpcId</code>. Studio users can create a Workspace in any of the specified subnets.</p>"
"documentation":"<p>A list of subnet IDs to associate with the Amazon EMR Studio. A Studio can have a maximum of 5 subnets. The subnets must belong to the VPC specified by <code>VpcId</code>. Studio users can create a Workspace in any of the specified subnets.</p>"
},
"ServiceRole":{
"shape":"XmlString",
@ -1467,7 +1481,7 @@
},
"UserRole":{
"shape":"XmlString",
"documentation":"<p>The IAM user role that will be assumed by users and groups logged in to a Studio. The permissions attached to this IAM role can be scoped down for each user or group using session policies.</p>"
"documentation":"<p>The IAM user role that will be assumed by users and groups logged in to an Amazon EMR Studio. The permissions attached to this IAM role can be scoped down for each user or group using session policies.</p>"
},
"WorkspaceSecurityGroupId":{
"shape":"XmlStringMaxLen256",
@ -1479,11 +1493,11 @@
},
"DefaultS3Location":{
"shape":"XmlString",
"documentation":"<p>The default Amazon S3 location to back up EMR Studio Workspaces and notebook files. A Studio user can select an alternative Amazon S3 location when creating a Workspace.</p>"
"documentation":"<p>The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>A list of tags to associate with the Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.</p>"
"documentation":"<p>A list of tags to associate with the Amazon EMR Studio. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters, and an optional value string with a maximum of 256 characters.</p>"
}
}
},
@ -1518,11 +1532,11 @@
},
"IdentityName":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>The name of the user or group. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId\">UserName</a> and <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName\">DisplayName</a> in the <i>AWS SSO Identity Store API Reference</i>. Either <code>IdentityName</code> or <code>IdentityId</code> must be specified.</p>"
"documentation":"<p>The name of the user or group. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName\">UserName</a> and <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName\">DisplayName</a> in the <i>AWS SSO Identity Store API Reference</i>. Either <code>IdentityName</code> or <code>IdentityId</code> must be specified.</p>"
},
"IdentityType":{
"shape":"IdentityType",
"documentation":"<p>Specifies whether the identity to map to the Studio is a user or a group.</p>"
"documentation":"<p>Specifies whether the identity to map to the Amazon EMR Studio is a user or a group.</p>"
},
"SessionPolicyArn":{
"shape":"XmlStringMaxLen256",
@ -1573,11 +1587,11 @@
},
"IdentityName":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>The name of the user name or group to remove from the Studio. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId\">UserName</a> and <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName\">DisplayName</a> in the <i>AWS SSO Identity Store API Reference</i>. Either <code>IdentityName</code> or <code>IdentityId</code> must be specified.</p>"
"documentation":"<p>The name of the user name or group to remove from the Amazon EMR Studio. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName\">UserName</a> and <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName\">DisplayName</a> in the <i>AWS SSO Identity Store API Reference</i>. Either <code>IdentityName</code> or <code>IdentityId</code> must be specified.</p>"
},
"IdentityType":{
"shape":"IdentityType",
"documentation":"<p>Specifies whether the identity to delete from the Studio is a user or a group.</p>"
"documentation":"<p>Specifies whether the identity to delete from the Amazon EMR Studio is a user or a group.</p>"
}
}
},
@ -1959,7 +1973,7 @@
},
"IdentityName":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>The name of the user or group to fetch. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId\">UserName</a> and <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName\">DisplayName</a> in the <i>AWS SSO Identity Store API Reference</i>. Either <code>IdentityName</code> or <code>IdentityId</code> must be specified.</p>"
"documentation":"<p>The name of the user or group to fetch. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName\">UserName</a> and <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName\">DisplayName</a> in the <i>AWS SSO Identity Store API Reference</i>. Either <code>IdentityName</code> or <code>IdentityId</code> must be specified.</p>"
},
"IdentityType":{
"shape":"IdentityType",
@ -1982,7 +1996,7 @@
"members":{
"Properties":{
"shape":"KeyValueList",
"documentation":"<p>A list of Java properties that are set when the step runs. You can use these properties to pass key value pairs to your main function.</p>"
"documentation":"<p>A list of Java properties that are set when the step runs. You can use these properties to pass key-value pairs to your main function.</p>"
},
"Jar":{
"shape":"XmlString",
@ -2114,7 +2128,7 @@
},
"TargetSpotCapacity":{
"shape":"WholeNumber",
"documentation":"<p>The target capacity of Spot units for the instance fleet, which determines how many Spot instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot instances as specified by <a>InstanceTypeConfig</a>. Each instance configuration has a specified <code>WeightedCapacity</code>. When a Spot instance is provisioned, the <code>WeightedCapacity</code> units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a <code>WeightedCapacity</code> of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use <a>InstanceFleet$ProvisionedSpotCapacity</a> to determine the Spot capacity units that have been provisioned for the instance fleet.</p> <note> <p>If not specified or set to 0, only On-Demand instances are provisioned for the instance fleet. At least one of <code>TargetSpotCapacity</code> and <code>TargetOnDemandCapacity</code> should be greater than 0. For a master instance fleet, only one of <code>TargetSpotCapacity</code> and <code>TargetOnDemandCapacity</code> can be specified, and its value must be 1.</p> </note>"
"documentation":"<p>The target capacity of Spot units for the instance fleet, which determines how many Spot Instances to provision. When the instance fleet launches, Amazon EMR tries to provision Spot Instances as specified by <a>InstanceTypeConfig</a>. Each instance configuration has a specified <code>WeightedCapacity</code>. When a Spot instance is provisioned, the <code>WeightedCapacity</code> units count toward the target capacity. Amazon EMR provisions instances until the target capacity is totally fulfilled, even if this results in an overage. For example, if there are 2 units remaining to fulfill capacity, and Amazon EMR can only provision an instance with a <code>WeightedCapacity</code> of 5 units, the instance is provisioned, and the target capacity is exceeded by 3 units. You can use <a>InstanceFleet$ProvisionedSpotCapacity</a> to determine the Spot capacity units that have been provisioned for the instance fleet.</p> <note> <p>If not specified or set to 0, only On-Demand Instances are provisioned for the instance fleet. At least one of <code>TargetSpotCapacity</code> and <code>TargetOnDemandCapacity</code> should be greater than 0. For a master instance fleet, only one of <code>TargetSpotCapacity</code> and <code>TargetOnDemandCapacity</code> can be specified, and its value must be 1.</p> </note>"
},
"ProvisionedOnDemandCapacity":{
"shape":"WholeNumber",
@ -2145,7 +2159,7 @@
},
"InstanceFleetType":{
"shape":"InstanceFleetType",
"documentation":"<p>The node type that the instance fleet hosts. Valid values are MASTER,CORE,and TASK.</p>"
"documentation":"<p>The node type that the instance fleet hosts. Valid values are MASTER, CORE, and TASK.</p>"
},
"TargetOnDemandCapacity":{
"shape":"WholeNumber",
@ -2308,7 +2322,7 @@
},
"BidPrice":{
"shape":"String",
"documentation":"<p>The bid price for each EC2 Spot Instance type as defined by <code>InstanceType</code>. Expressed in USD. If neither <code>BidPrice</code> nor <code>BidPriceAsPercentageOfOnDemandPrice</code> is provided, <code>BidPriceAsPercentageOfOnDemandPrice</code> defaults to 100%.</p>"
"documentation":"<p>If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify <code>OnDemandPrice</code> to set the amount equal to the On-Demand price, or specify an amount in USD.</p>"
},
"InstanceType":{
"shape":"InstanceType",
@ -2383,7 +2397,7 @@
},
"BidPrice":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>The bid price for each EC2 Spot Instance type as defined by <code>InstanceType</code>. Expressed in USD. If neither <code>BidPrice</code> nor <code>BidPriceAsPercentageOfOnDemandPrice</code> is provided, <code>BidPriceAsPercentageOfOnDemandPrice</code> defaults to 100%.</p>"
"documentation":"<p>If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify <code>OnDemandPrice</code> to set the amount equal to the On-Demand price, or specify an amount in USD.</p>"
},
"InstanceType":{
"shape":"InstanceType",
@ -2442,7 +2456,7 @@
},
"BidPrice":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>The bid price for each EC2 Spot Instance type as defined by <code>InstanceType</code>. Expressed in USD. If neither <code>BidPrice</code> nor <code>BidPriceAsPercentageOfOnDemandPrice</code> is provided, <code>BidPriceAsPercentageOfOnDemandPrice</code> defaults to 100%.</p>"
"documentation":"<p>If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify <code>OnDemandPrice</code> to set the amount equal to the On-Demand price, or specify an amount in USD.</p>"
},
"InstanceType":{
"shape":"InstanceType",
@ -2814,7 +2828,7 @@
"documentation":"<p>The message associated with the exception.</p>"
}
},
"documentation":"<p>This exception occurs when there is an internal failure in the EMR service.</p>",
"documentation":"<p>This exception occurs when there is an internal failure in the Amazon EMR service.</p>",
"exception":true,
"fault":true
},
@ -3435,7 +3449,7 @@
"members":{
"SessionMappings":{
"shape":"SessionMappingSummaryList",
"documentation":"<p>A list of session mapping summary objects. Each object includes session mapping details such as creation time, identity type (user or group), and Studio ID.</p>"
"documentation":"<p>A list of session mapping summary objects. Each object includes session mapping details such as creation time, identity type (user or group), and Amazon EMR Studio ID.</p>"
},
"Marker":{
"shape":"Marker",
@ -3512,7 +3526,7 @@
},
"StepConcurrencyLevel":{
"shape":"Integer",
"documentation":"<p>The number of steps that can be executed concurrently. You can specify a maximum of 256 steps. </p>"
"documentation":"<p>The number of steps that can be executed concurrently. You can specify a minimum of 1 step and a maximum of 256 steps. </p>"
}
}
},
@ -3671,6 +3685,35 @@
"type":"list",
"member":{"shape":"NotebookExecutionSummary"}
},
"OnDemandCapacityReservationOptions":{
"type":"structure",
"members":{
"UsageStrategy":{
"shape":"OnDemandCapacityReservationUsageStrategy",
"documentation":"<p>Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.</p> <p>If you specify <code>use-capacity-reservations-first</code>, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (<code>lowest-price</code>) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (<code>lowest-price</code>).</p> <p>If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.</p>"
},
"CapacityReservationPreference":{
"shape":"OnDemandCapacityReservationPreference",
"documentation":"<p>Indicates the instance's Capacity Reservation preferences. Possible preferences include:</p> <ul> <li> <p> <code>open</code> - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).</p> </li> <li> <p> <code>none</code> - The instance avoids running in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.</p> </li> </ul>"
},
"CapacityReservationResourceGroupArn":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>The ARN of the Capacity Reservation resource group in which to run the instance.</p>"
}
},
"documentation":"<p>Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.</p>"
},
"OnDemandCapacityReservationPreference":{
"type":"string",
"enum":[
"open",
"none"
]
},
"OnDemandCapacityReservationUsageStrategy":{
"type":"string",
"enum":["use-capacity-reservations-first"]
},
"OnDemandProvisioningAllocationStrategy":{
"type":"string",
"enum":["lowest-price"]
@ -3681,7 +3724,11 @@
"members":{
"AllocationStrategy":{
"shape":"OnDemandProvisioningAllocationStrategy",
"documentation":"<p> Specifies the strategy to use in launching On-Demand Instance fleets. Currently, the only option is lowest-price (the default), which launches the lowest price first. </p>"
"documentation":"<p>Specifies the strategy to use in launching On-Demand instance fleets. Currently, the only option is <code>lowest-price</code> (the default), which launches the lowest price first.</p>"
},
"CapacityReservationOptions":{
"shape":"OnDemandCapacityReservationOptions",
"documentation":"<p>The launch specification for On-Demand instances in the instance fleet, which determines the allocation strategy.</p>"
}
},
"documentation":"<p> The launch specification for On-Demand Instances in the instance fleet, which determines the allocation strategy. </p> <note> <p>The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. On-Demand Instances allocation strategy is available in Amazon EMR version 5.12.1 and later.</p> </note>"
@ -3796,7 +3843,7 @@
},
"ClusterArn":{
"shape":"ArnType",
"documentation":"<p>The Amazon Resource Name of the cluster.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the cluster.</p>"
}
}
},
@ -3955,7 +4002,7 @@
},
"NewSupportedProducts":{
"shape":"NewSupportedProductsList",
"documentation":"<note> <p>For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.</p> </note> <p>A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see \"Launch a Job Flow on the MapR Distribution for Hadoop\" in the <a href=\"https://docs.aws.amazon.com/emr/latest/DeveloperGuide/emr-dg.pdf\">Amazon EMR Developer Guide</a>. Supported values are:</p> <ul> <li> <p>\"mapr-m3\" - launch the cluster using MapR M3 Edition.</p> </li> <li> <p>\"mapr-m5\" - launch the cluster using MapR M5 Edition.</p> </li> <li> <p>\"mapr\" with the user arguments specifying \"--edition,m3\" or \"--edition,m5\" - launch the job flow using MapR M3 or M5 Edition respectively.</p> </li> <li> <p>\"mapr-m7\" - launch the cluster using MapR M7 Edition.</p> </li> <li> <p>\"hunk\" - launch the cluster with the Hunk Big Data Analtics Platform.</p> </li> <li> <p>\"hue\"- launch the cluster with Hue installed.</p> </li> <li> <p>\"spark\" - launch the cluster with Apache Spark installed.</p> </li> <li> <p>\"ganglia\" - launch the cluster with the Ganglia Monitoring System installed.</p> </li> </ul>"
"documentation":"<note> <p>For Amazon EMR releases 3.x and 2.x. For Amazon EMR releases 4.x and later, use Applications.</p> </note> <p>A list of strings that indicates third-party software to use with the job flow that accepts a user argument list. EMR accepts and forwards the argument list to the corresponding installation script as bootstrap action arguments. For more information, see \"Launch a Job Flow on the MapR Distribution for Hadoop\" in the <a href=\"https://docs.aws.amazon.com/emr/latest/DeveloperGuide/emr-dg.pdf\">Amazon EMR Developer Guide</a>. Supported values are:</p> <ul> <li> <p>\"mapr-m3\" - launch the cluster using MapR M3 Edition.</p> </li> <li> <p>\"mapr-m5\" - launch the cluster using MapR M5 Edition.</p> </li> <li> <p>\"mapr\" with the user arguments specifying \"--edition,m3\" or \"--edition,m5\" - launch the job flow using MapR M3 or M5 Edition respectively.</p> </li> <li> <p>\"mapr-m7\" - launch the cluster using MapR M7 Edition.</p> </li> <li> <p>\"hunk\" - launch the cluster with the Hunk Big Data Analytics Platform.</p> </li> <li> <p>\"hue\"- launch the cluster with Hue installed.</p> </li> <li> <p>\"spark\" - launch the cluster with Apache Spark installed.</p> </li> <li> <p>\"ganglia\" - launch the cluster with the Ganglia Monitoring System installed.</p> </li> </ul>"
},
"Applications":{
"shape":"ApplicationList",
@ -4029,11 +4076,11 @@
"members":{
"JobFlowId":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>An unique identifier for the job flow.</p>"
"documentation":"<p>A unique identifier for the job flow.</p>"
},
"ClusterArn":{
"shape":"ArnType",
"documentation":"<p>The Amazon Resource Name of the cluster.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the cluster.</p>"
}
},
"documentation":"<p> The result of the <a>RunJobFlow</a> operation. </p>"
@ -4170,11 +4217,11 @@
},
"IdentityName":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>The name of the user or group. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId\">UserName</a> and <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName\">DisplayName</a> in the <i>AWS SSO Identity Store API Reference</i>.</p>"
"documentation":"<p>The name of the user or group. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName\">UserName</a> and <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName\">DisplayName</a> in the <i>AWS SSO Identity Store API Reference</i>.</p>"
},
"IdentityType":{
"shape":"IdentityType",
"documentation":"<p>Specifies whether the identity mapped to the Studio is a user or a group.</p>"
"documentation":"<p>Specifies whether the identity mapped to the Amazon EMR Studio is a user or a group.</p>"
},
"SessionPolicyArn":{
"shape":"XmlStringMaxLen256",
@ -4204,11 +4251,11 @@
},
"IdentityName":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>The name of the user or group. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId\">UserName</a> and <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName\">DisplayName</a> in the <i>AWS SSO Identity Store API Reference</i>.</p>"
"documentation":"<p>The name of the user or group. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName\">UserName</a> and <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName\">DisplayName</a> in the <i>AWS SSO Identity Store API Reference</i>.</p>"
},
"IdentityType":{
"shape":"IdentityType",
"documentation":"<p>Specifies whether the identity mapped to the Studio is a user or a group.</p>"
"documentation":"<p>Specifies whether the identity mapped to the Amazon EMR Studio is a user or a group.</p>"
},
"SessionPolicyArn":{
"shape":"XmlStringMaxLen256",
@ -4315,7 +4362,7 @@
},
"BlockDurationMinutes":{
"shape":"WholeNumber",
"documentation":"<p>The defined duration for Spot Instances (also known as Spot blocks) in minutes. When specified, the Spot Instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot Instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates. </p>"
"documentation":"<p>The defined duration for Spot Instances (also known as Spot blocks) in minutes. When specified, the Spot Instance does not terminate before the defined duration expires, and defined duration pricing for Spot Instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot Instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates. </p>"
},
"AllocationStrategy":{
"shape":"SpotProvisioningAllocationStrategy",
@ -4650,27 +4697,27 @@
"members":{
"StudioId":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>The ID of the EMR Studio.</p>"
"documentation":"<p>The ID of the Amazon EMR Studio.</p>"
},
"StudioArn":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>The Amazon Resource Name (ARN) of the EMR Studio.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon EMR Studio.</p>"
},
"Name":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>The name of the EMR Studio.</p>"
"documentation":"<p>The name of the Amazon EMR Studio.</p>"
},
"Description":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>The detailed description of the EMR Studio.</p>"
"documentation":"<p>The detailed description of the Amazon EMR Studio.</p>"
},
"AuthMode":{
"shape":"AuthMode",
"documentation":"<p>Specifies whether the Studio authenticates users using single sign-on (SSO) or IAM.</p>"
"documentation":"<p>Specifies whether the Amazon EMR Studio authenticates users using single sign-on (SSO) or IAM.</p>"
},
"VpcId":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>The ID of the VPC associated with the EMR Studio.</p>"
"documentation":"<p>The ID of the VPC associated with the Amazon EMR Studio.</p>"
},
"SubnetIds":{
"shape":"SubnetIdList",
@ -4702,7 +4749,7 @@
},
"DefaultS3Location":{
"shape":"XmlString",
"documentation":"<p>The default Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.</p>"
"documentation":"<p>The Amazon S3 location to back up Amazon EMR Studio Workspaces and notebook files.</p>"
},
"Tags":{
"shape":"TagList",
@ -4728,7 +4775,7 @@
},
"Description":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>The detailed description of the EMR Studio.</p>"
"documentation":"<p>The detailed description of the Amazon EMR Studio.</p>"
},
"Url":{
"shape":"XmlStringMaxLen256",
@ -4761,7 +4808,7 @@
"documentation":"<p>The list of user-supplied arguments.</p>"
}
},
"documentation":"<p>The list of supported product configurations which allow user-supplied arguments. EMR accepts these arguments and forwards them to the corresponding installation script as bootstrap action arguments.</p>"
"documentation":"<p>The list of supported product configurations that allow user-supplied arguments. EMR accepts these arguments and forwards them to the corresponding installation script as bootstrap action arguments.</p>"
},
"SupportedProductsList":{
"type":"list",
@ -4828,6 +4875,32 @@
"COUNT_PER_SECOND"
]
},
"UpdateStudioInput":{
"type":"structure",
"required":["StudioId"],
"members":{
"StudioId":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>The ID of the Amazon EMR Studio to update.</p>"
},
"Name":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>A descriptive name for the Amazon EMR Studio.</p>"
},
"Description":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>A detailed description to assign to the Amazon EMR Studio.</p>"
},
"SubnetIds":{
"shape":"SubnetIdList",
"documentation":"<p>A list of subnet IDs to associate with the Amazon EMR Studio. The list can include new subnet IDs, but must also include all of the subnet IDs previously associated with the Studio. The list order does not matter. A Studio can have a maximum of 5 subnets. The subnets must belong to the same VPC as the Studio. </p>"
},
"DefaultS3Location":{
"shape":"XmlString",
"documentation":"<p>The Amazon S3 location to back up Workspaces and notebook files for the Amazon EMR Studio.</p>"
}
}
},
"UpdateStudioSessionMappingInput":{
"type":"structure",
"required":[
@ -4838,7 +4911,7 @@
"members":{
"StudioId":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>The ID of the EMR Studio.</p>"
"documentation":"<p>The ID of the Amazon EMR Studio.</p>"
},
"IdentityId":{
"shape":"XmlStringMaxLen256",
@ -4846,7 +4919,7 @@
},
"IdentityName":{
"shape":"XmlStringMaxLen256",
"documentation":"<p>The name of the user or group to update. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserId\">UserName</a> and <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName\">DisplayName</a> in the <i>AWS SSO Identity Store API Reference</i>. Either <code>IdentityName</code> or <code>IdentityId</code> must be specified.</p>"
"documentation":"<p>The name of the user or group to update. For more information, see <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_User.html#singlesignon-Type-User-UserName\">UserName</a> and <a href=\"https://docs.aws.amazon.com/singlesignon/latest/IdentityStoreAPIReference/API_Group.html#singlesignon-Type-Group-DisplayName\">DisplayName</a> in the <i>AWS SSO Identity Store API Reference</i>. Either <code>IdentityName</code> or <code>IdentityId</code> must be specified.</p>"
},
"IdentityType":{
"shape":"IdentityType",

226
botocore/data/endpoints.json
View file

@ -22,6 +22,9 @@
"ap-northeast-2" : {
"description" : "Asia Pacific (Seoul)"
},
"ap-northeast-3" : {
"description" : "Asia Pacific (Osaka)"
},
"ap-south-1" : {
"description" : "Asia Pacific (Mumbai)"
},
@ -83,6 +86,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -137,6 +141,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -255,6 +260,22 @@
"us-west-2" : { }
}
},
"amplifybackend" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-2" : { }
}
},
"api.detective" : {
"defaults" : {
"protocols" : [ "https" ]
@ -332,6 +353,12 @@
},
"hostname" : "api.ecr.ap-northeast-2.amazonaws.com"
},
"ap-northeast-3" : {
"credentialScope" : {
"region" : "ap-northeast-3"
},
"hostname" : "api.ecr.ap-northeast-3.amazonaws.com"
},
"ap-south-1" : {
"credentialScope" : {
"region" : "ap-south-1"
@ -581,6 +608,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -638,6 +666,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -785,6 +814,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -856,9 +886,11 @@
},
"batch" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -983,6 +1015,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -1240,6 +1273,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -1448,6 +1482,12 @@
},
"hostname" : "cognito-idp-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "cognito-idp-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
@ -1548,6 +1588,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -1603,7 +1644,10 @@
},
"contact-lens" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-southeast-2" : { },
"eu-central-1" : { },
"eu-west-2" : { },
"us-east-1" : { },
"us-west-2" : { }
}
@ -1760,6 +1804,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -1819,6 +1864,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -1994,6 +2040,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -2055,6 +2102,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -2112,6 +2160,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -2166,6 +2215,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -2217,6 +2267,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -2265,6 +2316,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -2295,6 +2347,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -2343,6 +2396,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -2377,6 +2431,12 @@
},
"hostname" : "elasticfilesystem-fips.ap-northeast-2.amazonaws.com"
},
"fips-ap-northeast-3" : {
"credentialScope" : {
"region" : "ap-northeast-3"
},
"hostname" : "elasticfilesystem-fips.ap-northeast-3.amazonaws.com"
},
"fips-ap-south-1" : {
"credentialScope" : {
"region" : "ap-south-1"
@ -2490,6 +2550,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -2542,6 +2603,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -2618,8 +2680,18 @@
},
"emr-containers" : {
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
"eu-central-1" : { },
"eu-west-1" : { },
"eu-west-2" : { },
"us-east-1" : { },
"us-east-2" : { },
"us-west-1" : { },
"us-west-2" : { }
}
},
@ -2639,6 +2711,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -2669,6 +2742,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -2717,6 +2791,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -3009,6 +3084,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -3063,6 +3139,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -3509,6 +3586,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -3599,6 +3677,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -3656,6 +3735,7 @@
},
"hostname" : "lakeformation-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -3669,6 +3749,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -3782,6 +3863,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -4070,6 +4152,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -4142,6 +4225,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -4735,6 +4819,36 @@
"eu-west-1" : { },
"eu-west-2" : { },
"eu-west-3" : { },
"fips-ca-central-1" : {
"credentialScope" : {
"region" : "ca-central-1"
},
"hostname" : "ram-fips.ca-central-1.amazonaws.com"
},
"fips-us-east-1" : {
"credentialScope" : {
"region" : "us-east-1"
},
"hostname" : "ram-fips.us-east-1.amazonaws.com"
},
"fips-us-east-2" : {
"credentialScope" : {
"region" : "us-east-2"
},
"hostname" : "ram-fips.us-east-2.amazonaws.com"
},
"fips-us-west-1" : {
"credentialScope" : {
"region" : "us-west-1"
},
"hostname" : "ram-fips.us-west-1.amazonaws.com"
},
"fips-us-west-2" : {
"credentialScope" : {
"region" : "us-west-2"
},
"hostname" : "ram-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
@ -4749,6 +4863,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -4805,6 +4920,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -4906,6 +5022,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -5099,6 +5216,7 @@
"signatureVersions" : [ "s3", "s3v4" ]
},
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : {
"hostname" : "s3.ap-southeast-1.amazonaws.com",
@ -5174,6 +5292,13 @@
"hostname" : "s3-control.ap-northeast-2.amazonaws.com",
"signatureVersions" : [ "s3v4" ]
},
"ap-northeast-3" : {
"credentialScope" : {
"region" : "ap-northeast-3"
},
"hostname" : "s3-control.ap-northeast-3.amazonaws.com",
"signatureVersions" : [ "s3v4" ]
},
"ap-south-1" : {
"credentialScope" : {
"region" : "ap-south-1"
@ -5366,6 +5491,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -5604,6 +5730,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -5711,6 +5838,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -5833,6 +5961,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -5885,6 +6014,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -5935,6 +6065,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -5989,6 +6120,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -6131,6 +6263,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -6197,6 +6330,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -6245,6 +6379,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -6328,6 +6463,8 @@
},
"transfer" : {
"endpoints" : {
"af-south-1" : { },
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
@ -6369,6 +6506,7 @@
},
"hostname" : "transfer-fips.us-west-2.amazonaws.com"
},
"me-south-1" : { },
"sa-east-1" : { },
"us-east-1" : { },
"us-east-2" : { },
@ -6715,6 +6853,7 @@
"endpoints" : {
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
"ca-central-1" : { },
@ -6744,6 +6883,7 @@
"ap-east-1" : { },
"ap-northeast-1" : { },
"ap-northeast-2" : { },
"ap-northeast-3" : { },
"ap-south-1" : { },
"ap-southeast-1" : { },
"ap-southeast-2" : { },
@ -7165,6 +7305,16 @@
},
"isRegionalized" : true
},
"guardduty" : {
"defaults" : {
"protocols" : [ "https" ]
},
"endpoints" : {
"cn-north-1" : { },
"cn-northwest-1" : { }
},
"isRegionalized" : true
},
"health" : {
"endpoints" : {
"cn-north-1" : { },
@ -7958,6 +8108,11 @@
"us-gov-west-1" : { }
}
},
"connect" : {
"endpoints" : {
"us-gov-west-1" : { }
}
},
"data.iot" : {
"defaults" : {
"credentialScope" : {
@ -8566,6 +8721,22 @@
"us-gov-west-1" : { }
}
},
"models.lex" : {
"defaults" : {
"credentialScope" : {
"service" : "lex"
}
},
"endpoints" : {
"us-gov-west-1" : { },
"us-gov-west-1-fips" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "models-fips.lex.us-gov-west-1.amazonaws.com"
}
}
},
"monitoring" : {
"endpoints" : {
"fips-us-gov-east-1" : {
@ -8668,8 +8839,18 @@
},
"ram" : {
"endpoints" : {
"us-gov-east-1" : { },
"us-gov-west-1" : { }
"us-gov-east-1" : {
"credentialScope" : {
"region" : "us-gov-east-1"
},
"hostname" : "ram.us-gov-east-1.amazonaws.com"
},
"us-gov-west-1" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "ram.us-gov-west-1.amazonaws.com"
}
}
},
"rds" : {
@ -8759,9 +8940,31 @@
"us-gov-west-1" : { }
}
},
"runtime.lex" : {
"defaults" : {
"credentialScope" : {
"service" : "lex"
}
},
"endpoints" : {
"us-gov-west-1" : { },
"us-gov-west-1-fips" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "runtime-fips.lex.us-gov-west-1.amazonaws.com"
}
}
},
"runtime.sagemaker" : {
"endpoints" : {
"us-gov-west-1" : { }
"us-gov-west-1" : { },
"us-gov-west-1-fips" : {
"credentialScope" : {
"region" : "us-gov-west-1"
},
"hostname" : "runtime.sagemaker.us-gov-west-1.amazonaws.com"
}
}
},
"s3" : {
@ -9422,6 +9625,11 @@
"us-iso-east-1" : { }
}
},
"outposts" : {
"endpoints" : {
"us-iso-east-1" : { }
}
},
"rds" : {
"endpoints" : {
"us-iso-east-1" : { }
@ -9749,6 +9957,18 @@
"us-isob-east-1" : { }
}
},
"route53" : {
"endpoints" : {
"aws-iso-b-global" : {
"credentialScope" : {
"region" : "us-isob-east-1"
},
"hostname" : "route53.sc2s.sgov.gov"
}
},
"isRegionalized" : false,
"partitionEndpoint" : "aws-iso-b-global"
},
"s3" : {
"defaults" : {
"protocols" : [ "http", "https" ],

323
botocore/data/es/2015-01-01/service-2.json
View file

@ -203,6 +203,22 @@
],
"documentation":"<p>Delete the package.</p>"
},
"DescribeDomainAutoTunes":{
"name":"DescribeDomainAutoTunes",
"http":{
"method":"GET",
"requestUri":"/2015-01-01/es/domain/{DomainName}/autoTunes"
},
"input":{"shape":"DescribeDomainAutoTunesRequest"},
"output":{"shape":"DescribeDomainAutoTunesResponse"},
"errors":[
{"shape":"BaseException"},
{"shape":"InternalException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ValidationException"}
],
"documentation":"<p>Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.</p>"
},
"DescribeElasticsearchDomain":{
"name":"DescribeElasticsearchDomain",
"http":{
@ -847,6 +863,181 @@
},
"documentation":"<p> Container for response returned by <code> <a>AssociatePackage</a> </code> operation. </p>"
},
"AutoTune":{
"type":"structure",
"members":{
"AutoTuneType":{
"shape":"AutoTuneType",
"documentation":"<p>Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION. </p>"
},
"AutoTuneDetails":{
"shape":"AutoTuneDetails",
"documentation":"<p>Specifies details of the Auto-Tune action. See the <a href=\"https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\">Developer Guide</a> for more information. </p>"
}
},
"documentation":"<p>Specifies Auto-Tune type and Auto-Tune action details. </p>"
},
"AutoTuneDate":{
"type":"timestamp",
"documentation":"<p>Specifies timestamp for the Auto-Tune action scheduled for the domain. </p>"
},
"AutoTuneDesiredState":{
"type":"string",
"documentation":"<p>Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.</p>",
"enum":[
"ENABLED",
"DISABLED"
]
},
"AutoTuneDetails":{
"type":"structure",
"members":{
"ScheduledAutoTuneDetails":{"shape":"ScheduledAutoTuneDetails"}
},
"documentation":"<p>Specifies details of the Auto-Tune action. See the <a href=\"https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\">Developer Guide</a> for more information. </p>"
},
"AutoTuneList":{
"type":"list",
"member":{"shape":"AutoTune"}
},
"AutoTuneMaintenanceSchedule":{
"type":"structure",
"members":{
"StartAt":{
"shape":"StartAt",
"documentation":"<p>Specifies timestamp at which Auto-Tune maintenance schedule start. </p>"
},
"Duration":{
"shape":"Duration",
"documentation":"<p>Specifies maintenance schedule duration: duration value and duration unit. See the <a href=\"https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\">Developer Guide</a> for more information.</p>"
},
"CronExpressionForRecurrence":{
"shape":"String",
"documentation":"<p>Specifies cron expression for a recurring maintenance schedule. See the <a href=\"https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\">Developer Guide</a> for more information.</p>"
}
},
"documentation":"<p>Specifies Auto-Tune maitenance schedule. See the <a href=\"https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\">Developer Guide</a> for more information.</p>"
},
"AutoTuneMaintenanceScheduleList":{
"type":"list",
"member":{"shape":"AutoTuneMaintenanceSchedule"},
"max":100
},
"AutoTuneOptions":{
"type":"structure",
"members":{
"DesiredState":{
"shape":"AutoTuneDesiredState",
"documentation":"<p>Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED. </p>"
},
"RollbackOnDisable":{
"shape":"RollbackOnDisable",
"documentation":"<p>Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK. </p>"
},
"MaintenanceSchedules":{
"shape":"AutoTuneMaintenanceScheduleList",
"documentation":"<p>Specifies list of maitenance schedules. See the <a href=\"https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\">Developer Guide</a> for more information.</p>"
}
},
"documentation":"<p>Specifies the Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.</p>"
},
"AutoTuneOptionsInput":{
"type":"structure",
"members":{
"DesiredState":{
"shape":"AutoTuneDesiredState",
"documentation":"<p>Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED. </p>"
},
"MaintenanceSchedules":{
"shape":"AutoTuneMaintenanceScheduleList",
"documentation":"<p>Specifies list of maitenance schedules. See the <a href=\"https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\">Developer Guide</a> for more information.</p>"
}
},
"documentation":"<p>Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.</p>"
},
"AutoTuneOptionsOutput":{
"type":"structure",
"members":{
"State":{
"shape":"AutoTuneState",
"documentation":"<p>Specifies the <code>AutoTuneState</code> for the Elasticsearch domain.</p>"
},
"ErrorMessage":{
"shape":"String",
"documentation":"<p>Specifies the error message while enabling or disabling the Auto-Tune.</p>"
}
},
"documentation":"<p>Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.</p>"
},
"AutoTuneOptionsStatus":{
"type":"structure",
"members":{
"Options":{
"shape":"AutoTuneOptions",
"documentation":"<p> Specifies Auto-Tune options for the specified Elasticsearch domain.</p>"
},
"Status":{
"shape":"AutoTuneStatus",
"documentation":"<p> Specifies Status of the Auto-Tune options for the specified Elasticsearch domain.</p>"
}
},
"documentation":"<p> Specifies the status of Auto-Tune options for the specified Elasticsearch domain.</p>"
},
"AutoTuneState":{
"type":"string",
"documentation":"<p>Specifies the Auto-Tune state for the Elasticsearch domain. For valid states see the <a href=\"https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\">Developer Guide</a>.</p>",
"enum":[
"ENABLED",
"DISABLED",
"ENABLE_IN_PROGRESS",
"DISABLE_IN_PROGRESS",
"DISABLED_AND_ROLLBACK_SCHEDULED",
"DISABLED_AND_ROLLBACK_IN_PROGRESS",
"DISABLED_AND_ROLLBACK_COMPLETE",
"DISABLED_AND_ROLLBACK_ERROR",
"ERROR"
]
},
"AutoTuneStatus":{
"type":"structure",
"required":[
"CreationDate",
"UpdateDate",
"State"
],
"members":{
"CreationDate":{
"shape":"UpdateTimestamp",
"documentation":"<p>Timestamp which tells Auto-Tune options creation date .</p>"
},
"UpdateDate":{
"shape":"UpdateTimestamp",
"documentation":"<p>Timestamp which tells Auto-Tune options last updated time.</p>"
},
"UpdateVersion":{
"shape":"UIntValue",
"documentation":"<p>Specifies the Auto-Tune options latest version.</p>"
},
"State":{
"shape":"AutoTuneState",
"documentation":"<p>Specifies the <code>AutoTuneState</code> for the Elasticsearch domain.</p>"
},
"ErrorMessage":{
"shape":"String",
"documentation":"<p>Specifies the error message while enabling or disabling the Auto-Tune options.</p>"
},
"PendingDeletion":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the Elasticsearch domain is being deleted.</p>"
}
},
"documentation":"<p>Provides the current status of the Auto-Tune options. </p>"
},
"AutoTuneType":{
"type":"string",
"documentation":"<p>Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION. </p>",
"enum":["SCHEDULED_ACTION"]
},
"BackendRole":{
"type":"string",
"max":256,
@ -1019,6 +1210,14 @@
"AdvancedSecurityOptions":{
"shape":"AdvancedSecurityOptionsInput",
"documentation":"<p>Specifies advanced security options.</p>"
},
"AutoTuneOptions":{
"shape":"AutoTuneOptionsInput",
"documentation":"<p>Specifies Auto-Tune options.</p>"
},
"TagList":{
"shape":"TagList",
"documentation":"<p>A list of <code>Tag</code> added during domain creation.</p>"
}
}
},
@ -1224,6 +1423,41 @@
"ELIGIBLE"
]
},
"DescribeDomainAutoTunesRequest":{
"type":"structure",
"required":["DomainName"],
"members":{
"DomainName":{
"shape":"DomainName",
"documentation":"<p>Specifies the domain name for which you want Auto-Tune action details.</p>",
"location":"uri",
"locationName":"DomainName"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>Set this value to limit the number of results returned. If not specified, defaults to 100.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.</p>"
}
},
"documentation":"<p>Container for the parameters to the <code>DescribeDomainAutoTunes</code> operation.</p>"
},
"DescribeDomainAutoTunesResponse":{
"type":"structure",
"members":{
"AutoTunes":{
"shape":"AutoTuneList",
"documentation":"<p>Specifies the list of setting adjustments that Auto-Tune has made to the domain. See the <a href=\"https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\">Developer Guide</a> for more information.</p>"
},
"NextToken":{
"shape":"NextToken",
"documentation":"<p>Specifies an identifier to allow retrieval of paginated results.</p>"
}
},
"documentation":"<p>The result of <code>DescribeDomainAutoTunes</code> request. See the <a href=\"https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\">Developer Guide</a> for more information. </p>"
},
"DescribeElasticsearchDomainConfigRequest":{
"type":"structure",
"required":["DomainName"],
@ -1718,6 +1952,26 @@
]
},
"Double":{"type":"double"},
"Duration":{
"type":"structure",
"members":{
"Value":{
"shape":"DurationValue",
"documentation":"<p> Integer to specify the value of a maintenance schedule duration. See the <a href=\"https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\">Developer Guide</a> for more information.</p>"
},
"Unit":{
"shape":"TimeUnit",
"documentation":"<p>Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the <a href=\"https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\">Developer Guide</a> for more information.</p>"
}
},
"documentation":"<p>Specifies maintenance schedule duration: duration value and duration unit. See the <a href=\"https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\">Developer Guide</a> for more information.</p>"
},
"DurationValue":{
"type":"long",
"documentation":"<p> Integer to specify the value of a maintenance schedule duration. See the <a href=\"https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\">Developer Guide</a> for more information.</p>",
"max":24,
"min":1
},
"EBSOptions":{
"type":"structure",
"members":{
@ -1946,6 +2200,10 @@
"AdvancedSecurityOptions":{
"shape":"AdvancedSecurityOptionsStatus",
"documentation":"<p>Specifies <code>AdvancedSecurityOptions</code> for the domain. </p>"
},
"AutoTuneOptions":{
"shape":"AutoTuneOptionsStatus",
"documentation":"<p>Specifies <code>AutoTuneOptions</code> for the domain. </p>"
}
},
"documentation":"<p>The configuration of an Elasticsearch domain.</p>"
@ -2047,6 +2305,10 @@
"AdvancedSecurityOptions":{
"shape":"AdvancedSecurityOptions",
"documentation":"<p>The current status of the Elasticsearch domain's advanced security options.</p>"
},
"AutoTuneOptions":{
"shape":"AutoTuneOptionsOutput",
"documentation":"<p>The current status of the Elasticsearch domain's Auto-Tune options.</p>"
}
},
"documentation":"<p>The current status of an Elasticsearch domain.</p>"
@ -3163,6 +3425,14 @@
"max":2048,
"min":20
},
"RollbackOnDisable":{
"type":"string",
"documentation":"<p>Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.</p>",
"enum":[
"NO_ROLLBACK",
"DEFAULT_ROLLBACK"
]
},
"S3BucketName":{
"type":"string",
"max":63,
@ -3257,6 +3527,49 @@
},
"documentation":"<p>Describes the SAML application configured for the domain.</p>"
},
"ScheduledAutoTuneActionType":{
"type":"string",
"documentation":"<p>Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING. </p>",
"enum":[
"JVM_HEAP_SIZE_TUNING",
"JVM_YOUNG_GEN_TUNING"
]
},
"ScheduledAutoTuneDescription":{
"type":"string",
"documentation":"<p>Specifies Auto-Tune action description. </p>"
},
"ScheduledAutoTuneDetails":{
"type":"structure",
"members":{
"Date":{
"shape":"AutoTuneDate",
"documentation":"<p>Specifies timestamp for the Auto-Tune action scheduled for the domain. </p>"
},
"ActionType":{
"shape":"ScheduledAutoTuneActionType",
"documentation":"<p>Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING. </p>"
},
"Action":{
"shape":"ScheduledAutoTuneDescription",
"documentation":"<p>Specifies Auto-Tune action description. </p>"
},
"Severity":{
"shape":"ScheduledAutoTuneSeverityType",
"documentation":"<p>Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH. </p>"
}
},
"documentation":"<p>Specifies details of the scheduled Auto-Tune action. See the <a href=\"https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\">Developer Guide</a> for more information. </p>"
},
"ScheduledAutoTuneSeverityType":{
"type":"string",
"documentation":"<p>Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH. </p>",
"enum":[
"LOW",
"MEDIUM",
"HIGH"
]
},
"ServiceSoftwareOptions":{
"type":"structure",
"members":{
@ -3327,6 +3640,7 @@
},
"documentation":"<p>Status of a daily automated snapshot.</p>"
},
"StartAt":{"type":"timestamp"},
"StartElasticsearchServiceSoftwareUpdateRequest":{
"type":"structure",
"required":["DomainName"],
@ -3438,6 +3752,11 @@
"max":256,
"min":0
},
"TimeUnit":{
"type":"string",
"documentation":"<p>Specifies the unit of a maintenance schedule duration. Valid value is HOUR. See the <a href=\"https://docs.aws.amazon.com/elasticsearch-service/latest/developerguide/auto-tune.html\" target=\"_blank\">Developer Guide</a> for more information.</p>",
"enum":["HOURS"]
},
"UIntValue":{
"type":"integer",
"min":0
@ -3499,6 +3818,10 @@
"EncryptionAtRestOptions":{
"shape":"EncryptionAtRestOptions",
"documentation":"<p>Specifies the Encryption At Rest Options.</p>"
},
"AutoTuneOptions":{
"shape":"AutoTuneOptions",
"documentation":"<p>Specifies Auto-Tune options.</p>"
}
},
"documentation":"<p>Container for the parameters to the <code><a>UpdateElasticsearchDomain</a></code> operation. Specifies the type and number of instances in the domain cluster.</p>"

1212
botocore/data/events/2015-10-07/service-2.json
View file

File diff suppressed because one or more lines are too long

3
botocore/data/fis/2020-12-01/paginators-1.json Normal file
View file

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

1610
botocore/data/fis/2020-12-01/service-2.json Normal file
View file

@ -0,0 +1,1610 @@
{
"version":"2.0",
"metadata":{
"apiVersion":"2020-12-01",
"endpointPrefix":"fis",
"jsonVersion":"1.1",
"protocol":"rest-json",
"serviceAbbreviation":"FIS",
"serviceFullName":"AWS Fault Injection Simulator",
"serviceId":"fis",
"signatureVersion":"v4",
"signingName":"fis",
"uid":"fis-2020-12-01"
},
"operations":{
"CreateExperimentTemplate":{
"name":"CreateExperimentTemplate",
"http":{
"method":"POST",
"requestUri":"/experimentTemplates",
"responseCode":200
},
"input":{"shape":"CreateExperimentTemplateRequest"},
"output":{"shape":"CreateExperimentTemplateResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ServiceQuotaExceededException"}
],
"documentation":"<p>Creates an experiment template. </p> <p>To create a template, specify the following information: </p> <ul> <li> <p> <b>Targets</b>: A target can be a specific resource in your AWS environment, or one or more resources that match criteria that you specify, for example, resources that have specific tags.</p> </li> <li> <p> <b>Actions</b>: The actions to carry out on the target. You can specify multiple actions, the duration of each action, and when to start each action during an experiment.</p> </li> <li> <p> <b>Stop conditions</b>: If a stop condition is triggered while an experiment is running, the experiment is automatically stopped. You can define a stop condition as a CloudWatch alarm.</p> </li> </ul> <p>For more information, see the <a href=\"https://docs.aws.amazon.com/fis/latest/userguide/\">AWS Fault Injection Simulator User Guide</a>.</p>"
},
"DeleteExperimentTemplate":{
"name":"DeleteExperimentTemplate",
"http":{
"method":"DELETE",
"requestUri":"/experimentTemplates/{id}",
"responseCode":200
},
"input":{"shape":"DeleteExperimentTemplateRequest"},
"output":{"shape":"DeleteExperimentTemplateResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Deletes the specified experiment template.</p>"
},
"GetAction":{
"name":"GetAction",
"http":{
"method":"GET",
"requestUri":"/actions/{id}",
"responseCode":200
},
"input":{"shape":"GetActionRequest"},
"output":{"shape":"GetActionResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Gets information about the specified AWS FIS action.</p>"
},
"GetExperiment":{
"name":"GetExperiment",
"http":{
"method":"GET",
"requestUri":"/experiments/{id}",
"responseCode":200
},
"input":{"shape":"GetExperimentRequest"},
"output":{"shape":"GetExperimentResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Gets information about the specified experiment.</p>"
},
"GetExperimentTemplate":{
"name":"GetExperimentTemplate",
"http":{
"method":"GET",
"requestUri":"/experimentTemplates/{id}",
"responseCode":200
},
"input":{"shape":"GetExperimentTemplateRequest"},
"output":{"shape":"GetExperimentTemplateResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Gets information about the specified experiment template.</p>"
},
"ListActions":{
"name":"ListActions",
"http":{
"method":"GET",
"requestUri":"/actions",
"responseCode":200
},
"input":{"shape":"ListActionsRequest"},
"output":{"shape":"ListActionsResponse"},
"errors":[
{"shape":"ValidationException"}
],
"documentation":"<p>Lists the available AWS FIS actions.</p>"
},
"ListExperimentTemplates":{
"name":"ListExperimentTemplates",
"http":{
"method":"GET",
"requestUri":"/experimentTemplates",
"responseCode":200
},
"input":{"shape":"ListExperimentTemplatesRequest"},
"output":{"shape":"ListExperimentTemplatesResponse"},
"errors":[
{"shape":"ValidationException"}
],
"documentation":"<p>Lists your experiment templates.</p>"
},
"ListExperiments":{
"name":"ListExperiments",
"http":{
"method":"GET",
"requestUri":"/experiments",
"responseCode":200
},
"input":{"shape":"ListExperimentsRequest"},
"output":{"shape":"ListExperimentsResponse"},
"errors":[
{"shape":"ValidationException"}
],
"documentation":"<p>Lists your experiments.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"GET",
"requestUri":"/tags/{resourceArn}",
"responseCode":200
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"documentation":"<p>Lists the tags for the specified resource.</p>"
},
"StartExperiment":{
"name":"StartExperiment",
"http":{
"method":"POST",
"requestUri":"/experiments",
"responseCode":200
},
"input":{"shape":"StartExperimentRequest"},
"output":{"shape":"StartExperimentResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ServiceQuotaExceededException"}
],
"documentation":"<p>Starts running an experiment from the specified experiment template.</p>"
},
"StopExperiment":{
"name":"StopExperiment",
"http":{
"method":"DELETE",
"requestUri":"/experiments/{id}",
"responseCode":200
},
"input":{"shape":"StopExperimentRequest"},
"output":{"shape":"StopExperimentResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Stops the specified experiment.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/tags/{resourceArn}",
"responseCode":200
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"documentation":"<p>Applies the specified tags to the specified resource.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"DELETE",
"requestUri":"/tags/{resourceArn}",
"responseCode":200
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"documentation":"<p>Removes the specified tags from the specified resource.</p>"
},
"UpdateExperimentTemplate":{
"name":"UpdateExperimentTemplate",
"http":{
"method":"PATCH",
"requestUri":"/experimentTemplates/{id}",
"responseCode":200
},
"input":{"shape":"UpdateExperimentTemplateRequest"},
"output":{"shape":"UpdateExperimentTemplateResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ServiceQuotaExceededException"}
],
"documentation":"<p>Updates the specified experiment template.</p>"
}
},
"shapes":{
"Action":{
"type":"structure",
"members":{
"id":{
"shape":"ActionId",
"documentation":"<p>The ID of the action.</p>"
},
"description":{
"shape":"ActionDescription",
"documentation":"<p>The description for the action.</p>"
},
"parameters":{
"shape":"ActionParameterMap",
"documentation":"<p>The action parameters, if applicable.</p>"
},
"targets":{
"shape":"ActionTargetMap",
"documentation":"<p>The supported targets for the action.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags for the action.</p>"
}
},
"documentation":"<p>Describes an action. For more information, see <a href=\"https://docs.aws.amazon.com/fis/latest/userguide/fis-actions-reference.html\">AWS FIS actions</a> in the <i>AWS Fault Injection Simulator User Guide</i>.</p>"
},
"ActionDescription":{
"type":"string",
"max":512,
"pattern":"[\\s\\S]+"
},
"ActionId":{
"type":"string",
"max":128,
"pattern":"[\\S]+"
},
"ActionParameter":{
"type":"structure",
"members":{
"description":{
"shape":"ActionParameterDescription",
"documentation":"<p>The parameter description.</p>"
},
"required":{
"shape":"ActionParameterRequired",
"documentation":"<p>Indicates whether the parameter is required.</p>",
"box":true
}
},
"documentation":"<p>Describes a parameter for an action.</p>"
},
"ActionParameterDescription":{
"type":"string",
"max":512,
"pattern":"[\\s\\S]+"
},
"ActionParameterMap":{
"type":"map",
"key":{"shape":"ActionParameterName"},
"value":{"shape":"ActionParameter"}
},
"ActionParameterName":{
"type":"string",
"max":64,
"pattern":"[\\S]+"
},
"ActionParameterRequired":{"type":"boolean"},
"ActionSummary":{
"type":"structure",
"members":{
"id":{
"shape":"ActionId",
"documentation":"<p>The ID of the action.</p>"
},
"description":{
"shape":"ActionDescription",
"documentation":"<p>The description for the action.</p>"
},
"targets":{
"shape":"ActionTargetMap",
"documentation":"<p>The targets for the action.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags for the action.</p>"
}
},
"documentation":"<p>Provides a summary of an action.</p>"
},
"ActionSummaryList":{
"type":"list",
"member":{"shape":"ActionSummary"}
},
"ActionTarget":{
"type":"structure",
"members":{
"resourceType":{
"shape":"TargetResourceType",
"documentation":"<p>The resource type of the target.</p>"
}
},
"documentation":"<p>Describes a target for an action.</p>"
},
"ActionTargetMap":{
"type":"map",
"key":{"shape":"ActionTargetName"},
"value":{"shape":"ActionTarget"}
},
"ActionTargetName":{
"type":"string",
"max":64,
"pattern":"[\\S]+"
},
"ClientToken":{
"type":"string",
"max":1024,
"min":1,
"pattern":"[\\S]+"
},
"ConflictException":{
"type":"structure",
"members":{
"message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The request could not be processed because of a conflict.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"CreateExperimentTemplateActionInput":{
"type":"structure",
"required":["actionId"],
"members":{
"actionId":{
"shape":"ActionId",
"documentation":"<p>The ID of the action.</p>"
},
"description":{
"shape":"ExperimentTemplateActionDescription",
"documentation":"<p>A description for the action.</p>"
},
"parameters":{
"shape":"ExperimentTemplateActionParameterMap",
"documentation":"<p>The parameters for the action, if applicable.</p>"
},
"targets":{
"shape":"ExperimentTemplateActionTargetMap",
"documentation":"<p>The targets for the action.</p>"
},
"startAfter":{
"shape":"ExperimentTemplateActionStartAfterList",
"documentation":"<p>The name of the action that must be completed before the current action starts. Omit this parameter to run the action at the start of the experiment.</p>"
}
},
"documentation":"<p>Specifies an action for an experiment template.</p>"
},
"CreateExperimentTemplateActionInputMap":{
"type":"map",
"key":{"shape":"ExperimentTemplateActionName"},
"value":{"shape":"CreateExperimentTemplateActionInput"}
},
"CreateExperimentTemplateRequest":{
"type":"structure",
"required":[
"clientToken",
"description",
"stopConditions",
"actions",
"roleArn"
],
"members":{
"clientToken":{
"shape":"ClientToken",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"idempotencyToken":true
},
"description":{
"shape":"ExperimentTemplateDescription",
"documentation":"<p>A description for the experiment template. Can contain up to 64 letters (A-Z and a-z).</p>"
},
"stopConditions":{
"shape":"CreateExperimentTemplateStopConditionInputList",
"documentation":"<p>The stop conditions.</p>"
},
"targets":{
"shape":"CreateExperimentTemplateTargetInputMap",
"documentation":"<p>The targets for the experiment.</p>"
},
"actions":{
"shape":"CreateExperimentTemplateActionInputMap",
"documentation":"<p>The actions for the experiment.</p>"
},
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags to apply to the experiment template.</p>"
}
}
},
"CreateExperimentTemplateResponse":{
"type":"structure",
"members":{
"experimentTemplate":{
"shape":"ExperimentTemplate",
"documentation":"<p>Information about the experiment template.</p>"
}
}
},
"CreateExperimentTemplateStopConditionInput":{
"type":"structure",
"required":["source"],
"members":{
"source":{
"shape":"StopConditionSource",
"documentation":"<p>The source for the stop condition. Specify <code>aws:cloudwatch:alarm</code> if the stop condition is defined by a CloudWatch alarm. Specify <code>none</code> if there is no stop condition.</p>"
},
"value":{
"shape":"StopConditionValue",
"documentation":"<p>The Amazon Resource Name (ARN) of the CloudWatch alarm. This is required if the source is a CloudWatch alarm.</p>"
}
},
"documentation":"<p>Specifies a stop condition for an experiment template.</p>"
},
"CreateExperimentTemplateStopConditionInputList":{
"type":"list",
"member":{"shape":"CreateExperimentTemplateStopConditionInput"}
},
"CreateExperimentTemplateTargetInput":{
"type":"structure",
"required":[
"resourceType",
"selectionMode"
],
"members":{
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The AWS resource type. The resource type must be supported for the specified action.</p>"
},
"resourceArns":{
"shape":"ResourceArnList",
"documentation":"<p>The Amazon Resource Names (ARNs) of the resources.</p>"
},
"resourceTags":{
"shape":"TagMap",
"documentation":"<p>The tags for the target resources.</p>"
},
"filters":{
"shape":"ExperimentTemplateTargetFilterInputList",
"documentation":"<p>The filters to apply to identify target resources using specific attributes.</p>"
},
"selectionMode":{
"shape":"ExperimentTemplateTargetSelectionMode",
"documentation":"<p>Scopes the identified resources to a specific count of the resources at random, or a percentage of the resources. All identified resources are included in the target.</p> <ul> <li> <p>ALL - Run the action on all identified targets. This is the default.</p> </li> <li> <p>COUNT(n) - Run the action on the specified number of targets, chosen from the identified targets at random. For example, COUNT(1) selects one of the targets.</p> </li> <li> <p>PERCENT(n) - Run the action on the specified percentage of targets, chosen from the identified targets at random. For example, PERCENT(25) selects 25% of the targets.</p> </li> </ul>"
}
},
"documentation":"<p>Specifies a target for an experiment. You must specify at least one Amazon Resource Name (ARN) or at least one resource tag. You cannot specify both ARNs and tags.</p>"
},
"CreateExperimentTemplateTargetInputMap":{
"type":"map",
"key":{"shape":"ExperimentTemplateTargetName"},
"value":{"shape":"CreateExperimentTemplateTargetInput"}
},
"CreationTime":{"type":"timestamp"},
"DeleteExperimentTemplateRequest":{
"type":"structure",
"required":["id"],
"members":{
"id":{
"shape":"ExperimentTemplateId",
"documentation":"<p>The ID of the experiment template.</p>",
"location":"uri",
"locationName":"id"
}
}
},
"DeleteExperimentTemplateResponse":{
"type":"structure",
"members":{
"experimentTemplate":{
"shape":"ExperimentTemplate",
"documentation":"<p>Information about the experiment template.</p>"
}
}
},
"ExceptionMessage":{
"type":"string",
"max":1024,
"pattern":"[\\s\\S]+"
},
"Experiment":{
"type":"structure",
"members":{
"id":{
"shape":"ExperimentId",
"documentation":"<p>The ID of the experiment.</p>"
},
"experimentTemplateId":{
"shape":"ExperimentTemplateId",
"documentation":"<p>The ID of the experiment template.</p>"
},
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.</p>"
},
"state":{
"shape":"ExperimentState",
"documentation":"<p>The state of the experiment.</p>"
},
"targets":{
"shape":"ExperimentTargetMap",
"documentation":"<p>The targets for the experiment.</p>"
},
"actions":{
"shape":"ExperimentActionMap",
"documentation":"<p>The actions for the experiment.</p>"
},
"stopConditions":{
"shape":"ExperimentStopConditionList",
"documentation":"<p>The stop conditions for the experiment.</p>"
},
"creationTime":{
"shape":"CreationTime",
"documentation":"<p>The time the experiment was created.</p>"
},
"startTime":{
"shape":"ExperimentStartTime",
"documentation":"<p>The time that the experiment was started.</p>"
},
"endTime":{
"shape":"ExperimentEndTime",
"documentation":"<p>The time that the experiment ended.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags for the experiment.</p>"
}
},
"documentation":"<p>Describes an experiment.</p>"
},
"ExperimentAction":{
"type":"structure",
"members":{
"actionId":{
"shape":"ActionId",
"documentation":"<p>The ID of the action.</p>"
},
"description":{
"shape":"ExperimentActionDescription",
"documentation":"<p>The description for the action.</p>"
},
"parameters":{
"shape":"ExperimentActionParameterMap",
"documentation":"<p>The parameters for the action.</p>"
},
"targets":{
"shape":"ExperimentActionTargetMap",
"documentation":"<p>The targets for the action.</p>"
},
"startAfter":{
"shape":"ExperimentActionStartAfterList",
"documentation":"<p>The name of the action that must be completed before this action starts.</p>"
},
"state":{
"shape":"ExperimentActionState",
"documentation":"<p>The state of the action.</p>"
}
},
"documentation":"<p>Describes the action for an experiment.</p>"
},
"ExperimentActionDescription":{
"type":"string",
"max":512,
"pattern":"[\\s\\S]+"
},
"ExperimentActionMap":{
"type":"map",
"key":{"shape":"ExperimentActionName"},
"value":{"shape":"ExperimentAction"}
},
"ExperimentActionName":{
"type":"string",
"max":64,
"pattern":"[\\S]+"
},
"ExperimentActionParameter":{
"type":"string",
"max":1024,
"pattern":"[\\S]+"
},
"ExperimentActionParameterMap":{
"type":"map",
"key":{"shape":"ExperimentActionParameterName"},
"value":{"shape":"ExperimentActionParameter"}
},
"ExperimentActionParameterName":{
"type":"string",
"max":64,
"pattern":"[\\S]+"
},
"ExperimentActionStartAfter":{
"type":"string",
"max":64,
"pattern":"[\\S]+"
},
"ExperimentActionStartAfterList":{
"type":"list",
"member":{"shape":"ExperimentActionStartAfter"}
},
"ExperimentActionState":{
"type":"structure",
"members":{
"status":{
"shape":"ExperimentActionStatus",
"documentation":"<p>The state of the action.</p>"
},
"reason":{
"shape":"ExperimentActionStatusReason",
"documentation":"<p>The reason for the state.</p>"
}
},
"documentation":"<p>Describes the state of an action.</p>"
},
"ExperimentActionStatus":{
"type":"string",
"enum":[
"pending",
"initiating",
"running",
"completed",
"cancelled",
"stopping",
"stopped",
"failed"
]
},
"ExperimentActionStatusReason":{
"type":"string",
"max":512,
"pattern":"[\\s\\S]+"
},
"ExperimentActionTargetMap":{
"type":"map",
"key":{"shape":"ExperimentActionTargetName"},
"value":{"shape":"ExperimentTargetName"}
},
"ExperimentActionTargetName":{
"type":"string",
"max":64,
"pattern":"[\\S]+"
},
"ExperimentEndTime":{"type":"timestamp"},
"ExperimentId":{
"type":"string",
"max":64,
"pattern":"[\\S]+"
},
"ExperimentStartTime":{"type":"timestamp"},
"ExperimentState":{
"type":"structure",
"members":{
"status":{
"shape":"ExperimentStatus",
"documentation":"<p>The state of the experiment.</p>"
},
"reason":{
"shape":"ExperimentStatusReason",
"documentation":"<p>The reason for the state.</p>"
}
},
"documentation":"<p>Describes the state of an experiment.</p>"
},
"ExperimentStatus":{
"type":"string",
"enum":[
"pending",
"initiating",
"running",
"completed",
"stopping",
"stopped",
"failed"
]
},
"ExperimentStatusReason":{
"type":"string",
"max":512,
"pattern":"[\\s\\S]+"
},
"ExperimentStopCondition":{
"type":"structure",
"members":{
"source":{
"shape":"StopConditionSource",
"documentation":"<p>The source for the stop condition.</p>"
},
"value":{
"shape":"StopConditionValue",
"documentation":"<p>The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.</p>"
}
},
"documentation":"<p>Describes the stop condition for an experiment.</p>"
},
"ExperimentStopConditionList":{
"type":"list",
"member":{"shape":"ExperimentStopCondition"}
},
"ExperimentSummary":{
"type":"structure",
"members":{
"id":{
"shape":"ExperimentId",
"documentation":"<p>The ID of the experiment.</p>"
},
"experimentTemplateId":{
"shape":"ExperimentTemplateId",
"documentation":"<p>The ID of the experiment template.</p>"
},
"state":{
"shape":"ExperimentState",
"documentation":"<p>The state of the experiment.</p>"
},
"creationTime":{
"shape":"CreationTime",
"documentation":"<p>The time that the experiment was created.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags for the experiment.</p>"
}
},
"documentation":"<p>Provides a summary of an experiment.</p>"
},
"ExperimentSummaryList":{
"type":"list",
"member":{"shape":"ExperimentSummary"}
},
"ExperimentTarget":{
"type":"structure",
"members":{
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The resource type.</p>"
},
"resourceArns":{
"shape":"ResourceArnList",
"documentation":"<p>The Amazon Resource Names (ARNs) of the resources.</p>"
},
"resourceTags":{
"shape":"TagMap",
"documentation":"<p>The tags for the target resources.</p>"
},
"filters":{
"shape":"ExperimentTargetFilterList",
"documentation":"<p>The filters to apply to identify target resources using specific attributes.</p>"
},
"selectionMode":{
"shape":"ExperimentTargetSelectionMode",
"documentation":"<p>Scopes the identified resources to a specific count or percentage.</p>"
}
},
"documentation":"<p>Describes a target for an experiment.</p>"
},
"ExperimentTargetFilter":{
"type":"structure",
"members":{
"path":{
"shape":"ExperimentTargetFilterPath",
"documentation":"<p>The attribute path for the filter.</p>"
},
"values":{
"shape":"ExperimentTargetFilterValues",
"documentation":"<p>The attribute values for the filter.</p>"
}
},
"documentation":"<p>Describes a filter used for the target resources in an experiment.</p>"
},
"ExperimentTargetFilterList":{
"type":"list",
"member":{"shape":"ExperimentTargetFilter"}
},
"ExperimentTargetFilterPath":{
"type":"string",
"max":256,
"pattern":"[\\S]+"
},
"ExperimentTargetFilterValue":{
"type":"string",
"max":128,
"pattern":"[\\S]+"
},
"ExperimentTargetFilterValues":{
"type":"list",
"member":{"shape":"ExperimentTargetFilterValue"}
},
"ExperimentTargetMap":{
"type":"map",
"key":{"shape":"ExperimentTargetName"},
"value":{"shape":"ExperimentTarget"}
},
"ExperimentTargetName":{
"type":"string",
"max":64,
"pattern":"[\\S]+"
},
"ExperimentTargetSelectionMode":{
"type":"string",
"max":64,
"pattern":"[\\S]+"
},
"ExperimentTemplate":{
"type":"structure",
"members":{
"id":{
"shape":"ExperimentTemplateId",
"documentation":"<p>The ID of the experiment template.</p>"
},
"description":{
"shape":"ExperimentTemplateDescription",
"documentation":"<p>The description for the experiment template.</p>"
},
"targets":{
"shape":"ExperimentTemplateTargetMap",
"documentation":"<p>The targets for the experiment.</p>"
},
"actions":{
"shape":"ExperimentTemplateActionMap",
"documentation":"<p>The actions for the experiment.</p>"
},
"stopConditions":{
"shape":"ExperimentTemplateStopConditionList",
"documentation":"<p>The stop conditions for the experiment.</p>"
},
"creationTime":{
"shape":"CreationTime",
"documentation":"<p>The time the experiment template was created.</p>"
},
"lastUpdateTime":{
"shape":"LastUpdateTime",
"documentation":"<p>The time the experiment template was last updated.</p>"
},
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of an IAM role.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags for the experiment template.</p>"
}
},
"documentation":"<p>Describes an experiment template.</p>"
},
"ExperimentTemplateAction":{
"type":"structure",
"members":{
"actionId":{
"shape":"ActionId",
"documentation":"<p>The ID of the action.</p>"
},
"description":{
"shape":"ExperimentTemplateActionDescription",
"documentation":"<p>A description for the action.</p>"
},
"parameters":{
"shape":"ExperimentTemplateActionParameterMap",
"documentation":"<p>The parameters for the action.</p>"
},
"targets":{
"shape":"ExperimentTemplateActionTargetMap",
"documentation":"<p>The targets for the action.</p>"
},
"startAfter":{
"shape":"ExperimentTemplateActionStartAfterList",
"documentation":"<p>The name of the action that must be completed before the current action starts.</p>"
}
},
"documentation":"<p>Describes an action for an experiment template.</p>"
},
"ExperimentTemplateActionDescription":{
"type":"string",
"max":512,
"pattern":"[\\s\\S]+"
},
"ExperimentTemplateActionMap":{
"type":"map",
"key":{"shape":"ExperimentTemplateActionName"},
"value":{"shape":"ExperimentTemplateAction"}
},
"ExperimentTemplateActionName":{
"type":"string",
"max":64,
"pattern":"[\\S]+"
},
"ExperimentTemplateActionParameter":{
"type":"string",
"max":1024,
"pattern":"[\\S]+"
},
"ExperimentTemplateActionParameterMap":{
"type":"map",
"key":{"shape":"ExperimentTemplateActionParameterName"},
"value":{"shape":"ExperimentTemplateActionParameter"}
},
"ExperimentTemplateActionParameterName":{
"type":"string",
"max":64,
"pattern":"[\\S]+"
},
"ExperimentTemplateActionStartAfter":{
"type":"string",
"max":64,
"pattern":"[\\S]+"
},
"ExperimentTemplateActionStartAfterList":{
"type":"list",
"member":{"shape":"ExperimentTemplateActionStartAfter"}
},
"ExperimentTemplateActionTargetMap":{
"type":"map",
"key":{"shape":"ExperimentTemplateActionTargetName"},
"value":{"shape":"ExperimentTemplateTargetName"}
},
"ExperimentTemplateActionTargetName":{
"type":"string",
"max":64,
"pattern":"[\\S]+"
},
"ExperimentTemplateDescription":{
"type":"string",
"max":512,
"pattern":"[\\s\\S]+"
},
"ExperimentTemplateId":{
"type":"string",
"max":64,
"pattern":"[\\S]+"
},
"ExperimentTemplateStopCondition":{
"type":"structure",
"members":{
"source":{
"shape":"StopConditionSource",
"documentation":"<p>The source for the stop condition.</p>"
},
"value":{
"shape":"StopConditionValue",
"documentation":"<p>The Amazon Resource Name (ARN) of the CloudWatch alarm, if applicable.</p>"
}
},
"documentation":"<p>Describes a stop condition for an experiment template.</p>"
},
"ExperimentTemplateStopConditionList":{
"type":"list",
"member":{"shape":"ExperimentTemplateStopCondition"}
},
"ExperimentTemplateSummary":{
"type":"structure",
"members":{
"id":{
"shape":"ExperimentTemplateId",
"documentation":"<p>The ID of the experiment template.</p>"
},
"description":{
"shape":"ExperimentTemplateDescription",
"documentation":"<p>The description of the experiment template.</p>"
},
"creationTime":{
"shape":"CreationTime",
"documentation":"<p>The time that the experiment template was created.</p>"
},
"lastUpdateTime":{
"shape":"LastUpdateTime",
"documentation":"<p>The time that the experiment template was last updated.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags for the experiment template.</p>"
}
},
"documentation":"<p>Provides a summary of an experiment template.</p>"
},
"ExperimentTemplateSummaryList":{
"type":"list",
"member":{"shape":"ExperimentTemplateSummary"}
},
"ExperimentTemplateTarget":{
"type":"structure",
"members":{
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The resource type.</p>"
},
"resourceArns":{
"shape":"ResourceArnList",
"documentation":"<p>The Amazon Resource Names (ARNs) of the targets.</p>"
},
"resourceTags":{
"shape":"TagMap",
"documentation":"<p>The tags for the target resources.</p>"
},
"filters":{
"shape":"ExperimentTemplateTargetFilterList",
"documentation":"<p>The filters to apply to identify target resources using specific attributes.</p>"
},
"selectionMode":{
"shape":"ExperimentTemplateTargetSelectionMode",
"documentation":"<p>Scopes the identified resources to a specific count or percentage.</p>"
}
},
"documentation":"<p>Describes a target for an experiment template.</p>"
},
"ExperimentTemplateTargetFilter":{
"type":"structure",
"members":{
"path":{
"shape":"ExperimentTemplateTargetFilterPath",
"documentation":"<p>The attribute path for the filter.</p>"
},
"values":{
"shape":"ExperimentTemplateTargetFilterValues",
"documentation":"<p>The attribute values for the filter.</p>"
}
},
"documentation":"<p>Describes a filter used for the target resources in an experiment template.</p>"
},
"ExperimentTemplateTargetFilterInputList":{
"type":"list",
"member":{"shape":"ExperimentTemplateTargetInputFilter"}
},
"ExperimentTemplateTargetFilterList":{
"type":"list",
"member":{"shape":"ExperimentTemplateTargetFilter"}
},
"ExperimentTemplateTargetFilterPath":{
"type":"string",
"max":256,
"pattern":"[\\S]+"
},
"ExperimentTemplateTargetFilterValue":{
"type":"string",
"max":128,
"pattern":"[\\S]+"
},
"ExperimentTemplateTargetFilterValues":{
"type":"list",
"member":{"shape":"ExperimentTemplateTargetFilterValue"}
},
"ExperimentTemplateTargetInputFilter":{
"type":"structure",
"required":[
"path",
"values"
],
"members":{
"path":{
"shape":"ExperimentTemplateTargetFilterPath",
"documentation":"<p>The attribute path for the filter.</p>"
},
"values":{
"shape":"ExperimentTemplateTargetFilterValues",
"documentation":"<p>The attribute values for the filter.</p>"
}
},
"documentation":"<p>Describes a filter used for the target resource input in an experiment template.</p>"
},
"ExperimentTemplateTargetMap":{
"type":"map",
"key":{"shape":"ExperimentTemplateTargetName"},
"value":{"shape":"ExperimentTemplateTarget"}
},
"ExperimentTemplateTargetName":{
"type":"string",
"max":64,
"pattern":"[\\S]+"
},
"ExperimentTemplateTargetSelectionMode":{
"type":"string",
"max":64,
"pattern":"[\\S]+"
},
"GetActionRequest":{
"type":"structure",
"required":["id"],
"members":{
"id":{
"shape":"ActionId",
"documentation":"<p>The ID of the action.</p>",
"location":"uri",
"locationName":"id"
}
}
},
"GetActionResponse":{
"type":"structure",
"members":{
"action":{
"shape":"Action",
"documentation":"<p>Information about the action.</p>"
}
}
},
"GetExperimentRequest":{
"type":"structure",
"required":["id"],
"members":{
"id":{
"shape":"ExperimentId",
"documentation":"<p>The ID of the experiment.</p>",
"location":"uri",
"locationName":"id"
}
}
},
"GetExperimentResponse":{
"type":"structure",
"members":{
"experiment":{
"shape":"Experiment",
"documentation":"<p>Information about the experiment.</p>"
}
}
},
"GetExperimentTemplateRequest":{
"type":"structure",
"required":["id"],
"members":{
"id":{
"shape":"ExperimentTemplateId",
"documentation":"<p>The ID of the experiment template.</p>",
"location":"uri",
"locationName":"id"
}
}
},
"GetExperimentTemplateResponse":{
"type":"structure",
"members":{
"experimentTemplate":{
"shape":"ExperimentTemplate",
"documentation":"<p>Information about the experiment template.</p>"
}
}
},
"LastUpdateTime":{"type":"timestamp"},
"ListActionsMaxResults":{
"type":"integer",
"max":100,
"min":1
},
"ListActionsRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"ListActionsMaxResults",
"documentation":"<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListActionsResponse":{
"type":"structure",
"members":{
"actions":{
"shape":"ActionSummaryList",
"documentation":"<p>The actions.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"ListExperimentTemplatesMaxResults":{
"type":"integer",
"max":100,
"min":1
},
"ListExperimentTemplatesRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"ListExperimentTemplatesMaxResults",
"documentation":"<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListExperimentTemplatesResponse":{
"type":"structure",
"members":{
"experimentTemplates":{
"shape":"ExperimentTemplateSummaryList",
"documentation":"<p>The experiment templates.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"ListExperimentsMaxResults":{
"type":"integer",
"max":100,
"min":1
},
"ListExperimentsRequest":{
"type":"structure",
"members":{
"maxResults":{
"shape":"ListExperimentsMaxResults",
"documentation":"<p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next page of results.</p>",
"location":"querystring",
"locationName":"nextToken"
}
}
},
"ListExperimentsResponse":{
"type":"structure",
"members":{
"experiments":{
"shape":"ExperimentSummaryList",
"documentation":"<p>The experiments.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token to use to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.</p>"
}
}
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["resourceArn"],
"members":{
"resourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>",
"location":"uri",
"locationName":"resourceArn"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags for the resource.</p>"
}
}
},
"NextToken":{
"type":"string",
"max":1024,
"min":1,
"pattern":"[\\S]+"
},
"ResourceArn":{
"type":"string",
"max":2048,
"min":20,
"pattern":"[\\S]+"
},
"ResourceArnList":{
"type":"list",
"member":{"shape":"ResourceArn"},
"max":5
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The specified resource cannot be found.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"ResourceType":{
"type":"string",
"max":64,
"pattern":"[\\S]+"
},
"RoleArn":{
"type":"string",
"max":2048,
"min":20,
"pattern":"[\\S]+"
},
"ServiceQuotaExceededException":{
"type":"structure",
"members":{
"message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>You have exceeded your service quota.</p>",
"error":{"httpStatusCode":402},
"exception":true
},
"StartExperimentRequest":{
"type":"structure",
"required":[
"clientToken",
"experimentTemplateId"
],
"members":{
"clientToken":{
"shape":"ClientToken",
"documentation":"<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"idempotencyToken":true
},
"experimentTemplateId":{
"shape":"ExperimentTemplateId",
"documentation":"<p>The ID of the experiment template.</p>"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags to apply to the experiment.</p>"
}
}
},
"StartExperimentResponse":{
"type":"structure",
"members":{
"experiment":{
"shape":"Experiment",
"documentation":"<p>Information about the experiment.</p>"
}
}
},
"StopConditionSource":{
"type":"string",
"max":64,
"pattern":"[\\S]+"
},
"StopConditionValue":{
"type":"string",
"max":2048,
"min":20,
"pattern":"[\\s\\S]+"
},
"StopExperimentRequest":{
"type":"structure",
"required":["id"],
"members":{
"id":{
"shape":"ExperimentId",
"documentation":"<p>The ID of the experiment.</p>",
"location":"uri",
"locationName":"id"
}
}
},
"StopExperimentResponse":{
"type":"structure",
"members":{
"experiment":{
"shape":"Experiment",
"documentation":"<p>Information about the experiment.</p>"
}
}
},
"TagKey":{
"type":"string",
"max":128,
"pattern":"[\\s\\S]+"
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"}
},
"TagMap":{
"type":"map",
"key":{"shape":"TagKey"},
"value":{"shape":"TagValue"},
"max":50
},
"TagResourceRequest":{
"type":"structure",
"required":[
"resourceArn",
"tags"
],
"members":{
"resourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags for the resource.</p>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256,
"pattern":"[\\s\\S]*"
},
"TargetResourceType":{
"type":"string",
"max":128,
"pattern":"[\\S]+"
},
"UntagResourceRequest":{
"type":"structure",
"required":["resourceArn"],
"members":{
"resourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>",
"location":"uri",
"locationName":"resourceArn"
},
"tagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The tag keys to remove.</p>",
"location":"querystring",
"locationName":"tagKeys"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"UpdateExperimentTemplateActionInputItem":{
"type":"structure",
"members":{
"actionId":{
"shape":"ActionId",
"documentation":"<p>The ID of the action.</p>"
},
"description":{
"shape":"ExperimentTemplateActionDescription",
"documentation":"<p>A description for the action.</p>"
},
"parameters":{
"shape":"ExperimentTemplateActionParameterMap",
"documentation":"<p>The parameters for the action, if applicable.</p>"
},
"targets":{
"shape":"ExperimentTemplateActionTargetMap",
"documentation":"<p>The targets for the action.</p>"
},
"startAfter":{
"shape":"ExperimentTemplateActionStartAfterList",
"documentation":"<p>The name of the action that must be completed before the current action starts. Omit this parameter to run the action at the start of the experiment.</p>"
}
},
"documentation":"<p>Specifies an action for an experiment template.</p>"
},
"UpdateExperimentTemplateActionInputMap":{
"type":"map",
"key":{"shape":"ExperimentTemplateActionName"},
"value":{"shape":"UpdateExperimentTemplateActionInputItem"}
},
"UpdateExperimentTemplateRequest":{
"type":"structure",
"required":["id"],
"members":{
"id":{
"shape":"ExperimentTemplateId",
"documentation":"<p>The ID of the experiment template.</p>",
"location":"uri",
"locationName":"id"
},
"description":{
"shape":"ExperimentTemplateDescription",
"documentation":"<p>A description for the template.</p>"
},
"stopConditions":{
"shape":"UpdateExperimentTemplateStopConditionInputList",
"documentation":"<p>The stop conditions for the experiment.</p>"
},
"targets":{
"shape":"UpdateExperimentTemplateTargetInputMap",
"documentation":"<p>The targets for the experiment.</p>"
},
"actions":{
"shape":"UpdateExperimentTemplateActionInputMap",
"documentation":"<p>The actions for the experiment.</p>"
},
"roleArn":{
"shape":"RoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) of an IAM role that grants the AWS FIS service permission to perform service actions on your behalf.</p>"
}
}
},
"UpdateExperimentTemplateResponse":{
"type":"structure",
"members":{
"experimentTemplate":{
"shape":"ExperimentTemplate",
"documentation":"<p>Information about the experiment template.</p>"
}
}
},
"UpdateExperimentTemplateStopConditionInput":{
"type":"structure",
"required":["source"],
"members":{
"source":{
"shape":"StopConditionSource",
"documentation":"<p>The source for the stop condition. Specify <code>aws:cloudwatch:alarm</code> if the stop condition is defined by a CloudWatch alarm. Specify <code>none</code> if there is no stop condition.</p>"
},
"value":{
"shape":"StopConditionValue",
"documentation":"<p>The Amazon Resource Name (ARN) of the CloudWatch alarm.</p>"
}
},
"documentation":"<p>Specifies a stop condition for an experiment. You can define a stop condition as a CloudWatch alarm.</p>"
},
"UpdateExperimentTemplateStopConditionInputList":{
"type":"list",
"member":{"shape":"UpdateExperimentTemplateStopConditionInput"}
},
"UpdateExperimentTemplateTargetInput":{
"type":"structure",
"required":[
"resourceType",
"selectionMode"
],
"members":{
"resourceType":{
"shape":"ResourceType",
"documentation":"<p>The AWS resource type. The resource type must be supported for the specified action.</p>"
},
"resourceArns":{
"shape":"ResourceArnList",
"documentation":"<p>The Amazon Resource Names (ARNs) of the targets.</p>"
},
"resourceTags":{
"shape":"TagMap",
"documentation":"<p>The tags for the target resources.</p>"
},
"filters":{
"shape":"ExperimentTemplateTargetFilterInputList",
"documentation":"<p>The filters to apply to identify target resources using specific attributes.</p>"
},
"selectionMode":{
"shape":"ExperimentTemplateTargetSelectionMode",
"documentation":"<p>Scopes the identified resources to a specific count or percentage.</p>"
}
},
"documentation":"<p>Specifies a target for an experiment. You must specify at least one Amazon Resource Name (ARN) or at least one resource tag. You cannot specify both.</p>"
},
"UpdateExperimentTemplateTargetInputMap":{
"type":"map",
"key":{"shape":"ExperimentTemplateTargetName"},
"value":{"shape":"UpdateExperimentTemplateTargetInput"}
},
"ValidationException":{
"type":"structure",
"members":{
"message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The specified input is not valid, or fails to satisfy the constraints for the request.</p>",
"error":{"httpStatusCode":400},
"exception":true
}
},
"documentation":"<p>AWS Fault Injection Simulator is a managed service that enables you to perform fault injection experiments on your AWS workloads. For more information, see the <a href=\"https://docs.aws.amazon.com/fis/latest/userguide/\">AWS Fault Injection Simulator User Guide</a>.</p>"
}

67
botocore/data/forecast/2018-06-26/service-2.json
View file

@ -473,6 +473,21 @@
],
"documentation":"<p>Lists the tags for an Amazon Forecast resource.</p>"
},
"StopResource":{
"name":"StopResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopResourceRequest"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Stops a resource.</p> <p>The resource undergoes the following states: <code>CREATE_STOPPING</code> and <code>CREATE_STOPPED</code>. You cannot resume a resource once it has been stopped.</p> <p>This operation can be applied to the following resources (and their corresponding child resources):</p> <ul> <li> <p>Dataset Import Job</p> </li> <li> <p>Predictor Job</p> </li> <li> <p>Forecast Job</p> </li> <li> <p>Forecast Export Job</p> </li> <li> <p>Predictor Backtest Export Job</p> </li> </ul>",
"idempotent":true
},
"TagResource":{
"name":"TagResource",
"http":{
@ -968,7 +983,7 @@
},
"Status":{
"shape":"Status",
"documentation":"<p>The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the import job status is <code>CREATE_IN_PROGRESS</code>, the status of the dataset is <code>UPDATE_IN_PROGRESS</code>. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul>"
"documentation":"<p>The status of the dataset import job. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> <li> <p> <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </p> </li> </ul>"
},
"Message":{
"shape":"ErrorMessage",
@ -980,7 +995,7 @@
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>The last time that the dataset was modified. The time depends on the status of the job, as follows:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - The same time as <code>CreationTime</code>.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p> </li> </ul>"
"documentation":"<p>The last time the resource was modified. The timestamp depends on the status of the job:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPING</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPED</code> - When the job stopped.</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p> </li> </ul>"
}
},
"documentation":"<p>Provides a summary of the dataset import job properties used in the <a>ListDatasetImportJobs</a> operation. To get the complete set of properties, call the <a>DescribeDatasetImportJob</a> operation, and provide the <code>DatasetImportJobArn</code>.</p>"
@ -1199,7 +1214,7 @@
},
"Status":{
"shape":"Status",
"documentation":"<p>The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the import job status is <code>CREATE_IN_PROGRESS</code>, the status of the dataset is <code>UPDATE_IN_PROGRESS</code>. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul>"
"documentation":"<p>The status of the dataset import job. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> <li> <p> <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </p> </li> </ul>"
},
"Message":{
"shape":"Message",
@ -1211,7 +1226,7 @@
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>The last time that the dataset was modified. The time depends on the status of the job, as follows:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - The same time as <code>CreationTime</code>.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p> </li> </ul>"
"documentation":"<p>The last time the resource was modified. The timestamp depends on the status of the job:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPING</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPED</code> - When the job stopped.</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p> </li> </ul>"
}
}
},
@ -1305,7 +1320,7 @@
},
"Status":{
"shape":"Status",
"documentation":"<p>The status of the forecast export job. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the forecast export job must be <code>ACTIVE</code> before you can access the forecast in your S3 bucket.</p> </note>"
"documentation":"<p>The status of the forecast export job. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the forecast export job must be <code>ACTIVE</code> before you can access the forecast in your S3 bucket.</p> </note>"
},
"CreationTime":{
"shape":"Timestamp",
@ -1313,7 +1328,7 @@
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>When the last successful export job finished.</p>"
"documentation":"<p>The last time the resource was modified. The timestamp depends on the status of the job:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPING</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPED</code> - When the job stopped.</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p> </li> </ul>"
}
}
},
@ -1352,7 +1367,7 @@
},
"Status":{
"shape":"String",
"documentation":"<p>The status of the forecast. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the forecast must be <code>ACTIVE</code> before you can query or export the forecast.</p> </note>"
"documentation":"<p>The status of the forecast. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the forecast must be <code>ACTIVE</code> before you can query or export the forecast.</p> </note>"
},
"Message":{
"shape":"ErrorMessage",
@ -1364,7 +1379,7 @@
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>Initially, the same as <code>CreationTime</code> (status is <code>CREATE_PENDING</code>). Updated when inference (creating the forecast) starts (status changed to <code>CREATE_IN_PROGRESS</code>), and when inference is complete (status changed to <code>ACTIVE</code>) or fails (status changed to <code>CREATE_FAILED</code>).</p>"
"documentation":"<p>The last time the resource was modified. The timestamp depends on the status of the job:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPING</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPED</code> - When the job stopped.</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p> </li> </ul>"
}
}
},
@ -1400,7 +1415,7 @@
},
"Status":{
"shape":"Status",
"documentation":"<p>The status of the predictor backtest export job. States include: </p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code> </p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> </p> </li> <li> <p> <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code> </p> </li> <li> <p> <code>DELETE_IN_PROGRESS</code> </p> </li> <li> <p> <code>DELETE_FAILED</code> </p> </li> </ul>"
"documentation":"<p>The status of the predictor backtest export job. States include: </p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul>"
},
"CreationTime":{
"shape":"Timestamp",
@ -1408,7 +1423,7 @@
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>When the last successful export job finished.</p>"
"documentation":"<p>The last time the resource was modified. The timestamp depends on the status of the job:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPING</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPED</code> - When the job stopped.</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p> </li> </ul>"
}
}
},
@ -1491,7 +1506,7 @@
},
"Status":{
"shape":"Status",
"documentation":"<p>The status of the predictor. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> <li> <p> <code>UPDATE_PENDING</code>, <code>UPDATE_IN_PROGRESS</code>, <code>UPDATE_FAILED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the predictor must be <code>ACTIVE</code> before you can use the predictor to create a forecast.</p> </note>"
"documentation":"<p>The status of the predictor. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> <li> <p> <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the predictor must be <code>ACTIVE</code> before you can use the predictor to create a forecast.</p> </note>"
},
"Message":{
"shape":"Message",
@ -1503,7 +1518,7 @@
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>Initially, the same as <code>CreationTime</code> (when the status is <code>CREATE_PENDING</code>). This value is updated when training starts (when the status changes to <code>CREATE_IN_PROGRESS</code>), and when training has completed (when the status changes to <code>ACTIVE</code>) or fails (when the status changes to <code>CREATE_FAILED</code>).</p>"
"documentation":"<p>The last time the resource was modified. The timestamp depends on the status of the job:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPING</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPED</code> - When the job stopped.</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p> </li> </ul>"
}
}
},
@ -1730,7 +1745,7 @@
},
"Status":{
"shape":"Status",
"documentation":"<p>The status of the forecast export job. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the forecast export job must be <code>ACTIVE</code> before you can access the forecast in your S3 bucket.</p> </note>"
"documentation":"<p>The status of the forecast export job. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the forecast export job must be <code>ACTIVE</code> before you can access the forecast in your S3 bucket.</p> </note>"
},
"Message":{
"shape":"ErrorMessage",
@ -1742,7 +1757,7 @@
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>When the last successful export job finished.</p>"
"documentation":"<p>The last time the resource was modified. The timestamp depends on the status of the job:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPING</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPED</code> - When the job stopped.</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p> </li> </ul>"
}
},
"documentation":"<p>Provides a summary of the forecast export job properties used in the <a>ListForecastExportJobs</a> operation. To get the complete set of properties, call the <a>DescribeForecastExportJob</a> operation, and provide the listed <code>ForecastExportJobArn</code>.</p>"
@ -1772,7 +1787,7 @@
},
"Status":{
"shape":"Status",
"documentation":"<p>The status of the forecast. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the forecast must be <code>ACTIVE</code> before you can query or export the forecast.</p> </note>"
"documentation":"<p>The status of the forecast. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the forecast must be <code>ACTIVE</code> before you can query or export the forecast.</p> </note>"
},
"Message":{
"shape":"ErrorMessage",
@ -1784,7 +1799,7 @@
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>Initially, the same as <code>CreationTime</code> (status is <code>CREATE_PENDING</code>). Updated when inference (creating the forecast) starts (status changed to <code>CREATE_IN_PROGRESS</code>), and when inference is complete (status changed to <code>ACTIVE</code>) or fails (status changed to <code>CREATE_FAILED</code>).</p>"
"documentation":"<p>The last time the resource was modified. The timestamp depends on the status of the job:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPING</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPED</code> - When the job stopped.</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p> </li> </ul>"
}
},
"documentation":"<p>Provides a summary of the forecast properties used in the <a>ListForecasts</a> operation. To get the complete set of properties, call the <a>DescribeForecast</a> operation, and provide the <code>ForecastArn</code> that is listed in the summary.</p>"
@ -2074,7 +2089,7 @@
},
"Filters":{
"shape":"Filters",
"documentation":"<p>An array of filters. For each filter, provide a condition and a match statement. The condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude the predictor backtest export jobs that match the statement from the list. The match statement consists of a key and a value.</p> <p> <b>Filter properties</b> </p> <ul> <li> <p> <code>Condition</code> - The condition to apply. Valid values are <code>IS</code> and <code>IS_NOT</code>. To include the predictor backtest export jobs that match the statement, specify <code>IS</code>. To exclude matching predictor backtest export jobs, specify <code>IS_NOT</code>.</p> </li> <li> <p> <code>Key</code> - The name of the parameter to filter on. Valid values are <code>PredictorBacktestExportJobArn</code> and <code>Status</code>.</p> </li> <li> <p> <code>Value</code> - The value to match.</p> </li> </ul>"
"documentation":"<p>An array of filters. For each filter, provide a condition and a match statement. The condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude the predictor backtest export jobs that match the statement from the list. The match statement consists of a key and a value.</p> <p> <b>Filter properties</b> </p> <ul> <li> <p> <code>Condition</code> - The condition to apply. Valid values are <code>IS</code> and <code>IS_NOT</code>. To include the predictor backtest export jobs that match the statement, specify <code>IS</code>. To exclude matching predictor backtest export jobs, specify <code>IS_NOT</code>.</p> </li> <li> <p> <code>Key</code> - The name of the parameter to filter on. Valid values are <code>PredictorArn</code> and <code>Status</code>.</p> </li> <li> <p> <code>Value</code> - The value to match.</p> </li> </ul>"
}
}
},
@ -2219,7 +2234,7 @@
"Destination":{"shape":"DataDestination"},
"Status":{
"shape":"Status",
"documentation":"<p>The status of the predictor backtest export job. States include: </p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code> </p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> </p> </li> <li> <p> <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code> </p> </li> <li> <p> <code>DELETE_IN_PROGRESS</code> </p> </li> <li> <p> <code>DELETE_FAILED</code> </p> </li> </ul>"
"documentation":"<p>The status of the predictor backtest export job. States include: </p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> </ul>"
},
"Message":{
"shape":"ErrorMessage",
@ -2231,7 +2246,7 @@
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>When the last successful export job finished.</p>"
"documentation":"<p>The last time the resource was modified. The timestamp depends on the status of the job:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPING</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPED</code> - When the job stopped.</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p> </li> </ul>"
}
},
"documentation":"<p>Provides a summary of the predictor backtest export job properties used in the <a>ListPredictorBacktestExportJobs</a> operation. To get a complete set of properties, call the <a>DescribePredictorBacktestExportJob</a> operation, and provide the listed <code>PredictorBacktestExportJobArn</code>.</p>"
@ -2291,7 +2306,7 @@
},
"Status":{
"shape":"Status",
"documentation":"<p>The status of the predictor. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> <li> <p> <code>UPDATE_PENDING</code>, <code>UPDATE_IN_PROGRESS</code>, <code>UPDATE_FAILED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the predictor must be <code>ACTIVE</code> before you can use the predictor to create a forecast.</p> </note>"
"documentation":"<p>The status of the predictor. States include:</p> <ul> <li> <p> <code>ACTIVE</code> </p> </li> <li> <p> <code>CREATE_PENDING</code>, <code>CREATE_IN_PROGRESS</code>, <code>CREATE_FAILED</code> </p> </li> <li> <p> <code>DELETE_PENDING</code>, <code>DELETE_IN_PROGRESS</code>, <code>DELETE_FAILED</code> </p> </li> <li> <p> <code>CREATE_STOPPING</code>, <code>CREATE_STOPPED</code> </p> </li> </ul> <note> <p>The <code>Status</code> of the predictor must be <code>ACTIVE</code> before you can use the predictor to create a forecast.</p> </note>"
},
"Message":{
"shape":"ErrorMessage",
@ -2303,7 +2318,7 @@
},
"LastModificationTime":{
"shape":"Timestamp",
"documentation":"<p>Initially, the same as <code>CreationTime</code> (status is <code>CREATE_PENDING</code>). Updated when training starts (status changed to <code>CREATE_IN_PROGRESS</code>), and when training is complete (status changed to <code>ACTIVE</code>) or fails (status changed to <code>CREATE_FAILED</code>).</p>"
"documentation":"<p>The last time the resource was modified. The timestamp depends on the status of the job:</p> <ul> <li> <p> <code>CREATE_PENDING</code> - The <code>CreationTime</code>.</p> </li> <li> <p> <code>CREATE_IN_PROGRESS</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPING</code> - The current timestamp.</p> </li> <li> <p> <code>CREATE_STOPPED</code> - When the job stopped.</p> </li> <li> <p> <code>ACTIVE</code> or <code>CREATE_FAILED</code> - When the job finished or failed.</p> </li> </ul>"
}
},
"documentation":"<p>Provides a summary of the predictor properties that are used in the <a>ListPredictors</a> operation. To get the complete set of properties, call the <a>DescribePredictor</a> operation, and provide the listed <code>PredictorArn</code>.</p>"
@ -2443,6 +2458,16 @@
"type":"string",
"max":256
},
"StopResourceRequest":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs are <code>DatasetImportJobArn</code>, <code>PredictorArn</code>, <code>PredictorBacktestExportJobArn</code>, <code>ForecastArn</code>, and <code>ForecastExportJobArn</code>. </p>"
}
}
},
"String":{
"type":"string",
"max":256,

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

File diff suppressed because one or more lines are too long

8
botocore/data/globalaccelerator/2018-08-08/service-2.json
View file

@ -91,7 +91,7 @@
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"}
],
"documentation":"<p>Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.</p> <p>Be aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/api/API_AllowCustomRoutingTraffic.html\"> AllowCustomRoutingTraffic</a> operation.</p>"
"documentation":"<p>Create a custom routing accelerator. A custom routing accelerator directs traffic to one of possibly thousands of Amazon EC2 instance destinations running in a single or multiple virtual private clouds (VPC) subnet endpoints.</p> <p>Be aware that, by default, all destination EC2 instances in a VPC subnet endpoint cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/api/API_AllowCustomRoutingTraffic.html\"> AllowCustomRoutingTraffic</a> operation.</p> <important> <p>Global Accelerator is a global service that supports endpoints in multiple AWS Regions but you must specify the US West (Oregon) Region to create or update accelerators.</p> </important>"
},
"CreateCustomRoutingEndpointGroup":{
"name":"CreateCustomRoutingEndpointGroup",
@ -1063,7 +1063,7 @@
},
"IpAddresses":{
"shape":"IpAddresses",
"documentation":"<p>Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator. You can specify one or two addresses, separated by a comma. Do not include the /32 suffix.</p> <p>Only one IP address from each of your IP address ranges can be used for each accelerator. If you specify only one IP address from your IP address range, Global Accelerator assigns a second static IP address for the accelerator from the AWS IP address pool.</p> <p> Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html\">Bring Your Own IP Addresses (BYOIP)</a> in the <i>AWS Global Accelerator Developer Guide</i>.</p>"
"documentation":"<p>Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator. You can specify one or two addresses, separated by a space. Do not include the /32 suffix.</p> <p>Only one IP address from each of your IP address ranges can be used for each accelerator. If you specify only one IP address from your IP address range, Global Accelerator assigns a second static IP address for the accelerator from the AWS IP address pool.</p> <p>Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html\">Bring Your Own IP Addresses (BYOIP)</a> in the <i>AWS Global Accelerator Developer Guide</i>.</p>"
},
"Enabled":{
"shape":"GenericBoolean",
@ -1104,6 +1104,10 @@
"shape":"IpAddressType",
"documentation":"<p>The value for the address type must be IPv4.</p>"
},
"IpAddresses":{
"shape":"IpAddresses",
"documentation":"<p>Optionally, if you've added your own IP address pool to Global Accelerator (BYOIP), you can choose IP addresses from your own pool to use for the accelerator's static IP addresses when you create an accelerator. You can specify one or two addresses, separated by a space. Do not include the /32 suffix.</p> <p>Only one IP address from each of your IP address ranges can be used for each accelerator. If you specify only one IP address from your IP address range, Global Accelerator assigns a second static IP address for the accelerator from the AWS IP address pool.</p> <p>Note that you can't update IP addresses for an existing accelerator. To change them, you must create a new accelerator with the new addresses.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/global-accelerator/latest/dg/using-byoip.html\">Bring your own IP addresses (BYOIP)</a> in the <i>AWS Global Accelerator Developer Guide</i>.</p>"
},
"Enabled":{
"shape":"GenericBoolean",
"documentation":"<p>Indicates whether an accelerator is enabled. The value is true or false. The default value is true. </p> <p>If the value is set to true, an accelerator cannot be deleted. If set to false, the accelerator can be deleted.</p>"

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

@ -3288,6 +3288,12 @@
},
"documentation":"<p>Specifies a table definition in the AWS Glue Data Catalog.</p>"
},
"CatalogGetterPageSize":{
"type":"integer",
"box":true,
"max":100,
"min":1
},
"CatalogIdString":{
"type":"string",
"max":255,
@ -6774,7 +6780,7 @@
"documentation":"<p>A continuation token, if this is a continuation call.</p>"
},
"MaxResults":{
"shape":"PageSize",
"shape":"CatalogGetterPageSize",
"documentation":"<p>The maximum number of databases to return in one response.</p>"
},
"ResourceShareType":{
@ -7355,7 +7361,8 @@
"MaxResults":{
"shape":"PageSize",
"documentation":"<p>The maximum number of partitions to return in a single response.</p>"
}
},
"ExcludeColumnSchema":{"shape":"BooleanNullable"}
}
},
"GetPartitionsResponse":{
@ -7848,7 +7855,7 @@
"documentation":"<p>A continuation token, if this is not the first call.</p>"
},
"MaxResults":{
"shape":"PageSize",
"shape":"CatalogGetterPageSize",
"documentation":"<p>The maximum number of table versions to return in one response.</p>"
}
}
@ -7887,7 +7894,7 @@
"documentation":"<p>A continuation token, included if this is a continuation call.</p>"
},
"MaxResults":{
"shape":"PageSize",
"shape":"CatalogGetterPageSize",
"documentation":"<p>The maximum number of tables to return in a single response.</p>"
}
}
@ -8024,7 +8031,7 @@
"documentation":"<p>A continuation token, if this is a continuation call.</p>"
},
"MaxResults":{
"shape":"PageSize",
"shape":"CatalogGetterPageSize",
"documentation":"<p>The maximum number of functions to return in one response.</p>"
}
}

22
botocore/data/health/2016-08-04/service-2.json
View file

@ -24,7 +24,7 @@
"errors":[
{"shape":"InvalidPaginationToken"}
],
"documentation":"<p>Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event. For more information about the different types of AWS Health events, see <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html\">Event</a>. </p> <p>Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html\">EnableHealthServiceAccessForOrganization</a> operation from your organization's master account.</p> <note> <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p> </note>",
"documentation":"<p>Returns a list of accounts in the organization from AWS Organizations that are affected by the provided event. For more information about the different types of AWS Health events, see <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html\">Event</a>. </p> <p>Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html\">EnableHealthServiceAccessForOrganization</a> operation from your organization's management account.</p> <note> <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p> </note>",
"idempotent":true
},
"DescribeAffectedEntities":{
@ -39,7 +39,7 @@
{"shape":"InvalidPaginationToken"},
{"shape":"UnsupportedLocale"}
],
"documentation":"<p>Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.</p> <p>At least one event ARN is required. Results are sorted by the <code>lastUpdatedTime</code> of the entity, starting with the most recent.</p> <note> <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p> </note>",
"documentation":"<p>Returns a list of entities that have been affected by the specified events, based on the specified filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service. Events that have impact beyond that of the affected entities, or where the extent of impact is unknown, include at least one entity indicating this.</p> <p>At least one event ARN is required. Results are sorted by the <code>lastUpdatedTime</code> of the entity, starting with the most recent.</p> <note> <ul> <li> <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p> </li> <li> <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific AWS Health events. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions\">Resource- and action-based conditions</a> in the <i>AWS Health User Guide</i>.</p> </li> </ul> </note>",
"idempotent":true
},
"DescribeAffectedEntitiesForOrganization":{
@ -54,7 +54,7 @@
{"shape":"InvalidPaginationToken"},
{"shape":"UnsupportedLocale"}
],
"documentation":"<p>Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service.</p> <p>At least one event Amazon Resource Name (ARN) and account ID are required. Results are sorted by the <code>lastUpdatedTime</code> of the entity, starting with the most recent.</p> <p>Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html\">EnableHealthServiceAccessForOrganization</a> operation from your organization's master account. </p> <note> <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p> </note>",
"documentation":"<p>Returns a list of entities that have been affected by one or more events for one or more accounts in your organization in AWS Organizations, based on the filter criteria. Entities can refer to individual customer resources, groups of customer resources, or any other construct, depending on the AWS service.</p> <p>At least one event Amazon Resource Name (ARN) and account ID are required. Results are sorted by the <code>lastUpdatedTime</code> of the entity, starting with the most recent.</p> <p>Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html\">EnableHealthServiceAccessForOrganization</a> operation from your organization's management account.</p> <note> <ul> <li> <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p> </li> <li> <p>This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific AWS Health events. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions\">Resource- and action-based conditions</a> in the <i>AWS Health User Guide</i>.</p> </li> </ul> </note>",
"idempotent":true
},
"DescribeEntityAggregates":{
@ -93,7 +93,7 @@
"errors":[
{"shape":"UnsupportedLocale"}
],
"documentation":"<p>Returns detailed information about one or more specified events. Information includes standard event data (Region, service, and so on, as returned by <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html\">DescribeEvents</a>), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve those, use the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html\">DescribeAffectedEntities</a> operation.</p> <p>If a specified event cannot be retrieved, an error message is returned for that event.</p>",
"documentation":"<p>Returns detailed information about one or more specified events. Information includes standard event data (AWS Region, service, and so on, as returned by <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEvents.html\">DescribeEvents</a>), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included. To retrieve those, use the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntities.html\">DescribeAffectedEntities</a> operation.</p> <p>If a specified event cannot be retrieved, an error message is returned for that event.</p> <note> <p>This operation supports resource-level permissions. You can use this operation to allow or deny access to specific AWS Health events. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions\">Resource- and action-based conditions</a> in the <i>AWS Health User Guide</i>.</p> </note>",
"idempotent":true
},
"DescribeEventDetailsForOrganization":{
@ -107,7 +107,7 @@
"errors":[
{"shape":"UnsupportedLocale"}
],
"documentation":"<p>Returns detailed information about one or more specified events for one or more accounts in your organization. Information includes standard event data (Region, service, and so on, as returned by <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html\">DescribeEventsForOrganization</a>), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html\">DescribeAffectedEntitiesForOrganization</a> operation.</p> <p>Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html\">EnableHealthServiceAccessForOrganization</a> operation from your organization's master account.</p> <p>When you call the <code>DescribeEventDetailsForOrganization</code> operation, you specify the <code>organizationEventDetailFilters</code> object in the request. Depending on the AWS Health event type, note the following differences:</p> <ul> <li> <p>If the event is public, the <code>awsAccountId</code> parameter must be empty. If you specify an account ID for a public event, then an error message is returned. That's because the event might apply to all AWS accounts and isn't specific to an account in your organization.</p> </li> <li> <p>If the event is specific to an account, then you must specify the <code>awsAccountId</code> parameter in the request. If you don't specify an account ID, an error message returns because the event is specific to an AWS account in your organization. </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html\">Event</a>.</p>",
"documentation":"<p>Returns detailed information about one or more specified events for one or more accounts in your organization. Information includes standard event data (AWS Region, service, and so on, as returned by <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventsForOrganization.html\">DescribeEventsForOrganization</a>), a detailed event description, and possible additional metadata that depends upon the nature of the event. Affected entities are not included; to retrieve those, use the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html\">DescribeAffectedEntitiesForOrganization</a> operation.</p> <p>Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html\">EnableHealthServiceAccessForOrganization</a> operation from your organization's management account.</p> <p>When you call the <code>DescribeEventDetailsForOrganization</code> operation, you specify the <code>organizationEventDetailFilters</code> object in the request. Depending on the AWS Health event type, note the following differences:</p> <ul> <li> <p>If the event is public, the <code>awsAccountId</code> parameter must be empty. If you specify an account ID for a public event, then an error message is returned. That's because the event might apply to all AWS accounts and isn't specific to an account in your organization.</p> </li> <li> <p>If the event is specific to an account, then you must specify the <code>awsAccountId</code> parameter in the request. If you don't specify an account ID, an error message returns because the event is specific to an AWS account in your organization. </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html\">Event</a>.</p> <note> <p>This operation doesn't support resource-level permissions. You can't use this operation to allow or deny access to specific AWS Health events. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html#resource-action-based-conditions\">Resource- and action-based conditions</a> in the <i>AWS Health User Guide</i>.</p> </note>",
"idempotent":true
},
"DescribeEventTypes":{
@ -122,7 +122,7 @@
{"shape":"InvalidPaginationToken"},
{"shape":"UnsupportedLocale"}
],
"documentation":"<p>Returns the event types that meet the specified filter criteria. If no filter criteria are specified, all event types are returned, in no particular order.</p> <note> <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p> </note>",
"documentation":"<p>Returns the event types that meet the specified filter criteria. You can use this API operation to find information about the AWS Health event, such as the category, AWS service, and event code. The metadata for each event appears in the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_EventType.html\">EventType</a> object. </p> <p>If you don't specify a filter criteria, the API operation returns all event types, in no particular order. </p> <note> <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p> </note>",
"idempotent":true
},
"DescribeEvents":{
@ -152,7 +152,7 @@
{"shape":"InvalidPaginationToken"},
{"shape":"UnsupportedLocale"}
],
"documentation":"<p>Returns information about events across your organization in AWS Organizations. You can use the<code>filters</code> parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedAccountsForOrganization.html\">DescribeAffectedAccountsForOrganization</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html\">DescribeEventDetailsForOrganization</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html\">DescribeAffectedEntitiesForOrganization</a> </p> </li> </ul> <p>If you don't specify a <code>filter</code>, the <code>DescribeEventsForOrganizations</code> returns all events across your organization. Results are sorted by <code>lastModifiedTime</code>, starting with the most recent event. </p> <p>For more information about the different types of AWS Health events, see <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html\">Event</a>.</p> <p>Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html\">EnableHealthServiceAccessForOrganization</a> operation from your organization's master AWS account.</p> <note> <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p> </note>",
"documentation":"<p>Returns information about events across your organization in AWS Organizations. You can use the<code>filters</code> parameter to specify the events that you want to return. Events are returned in a summary form and don't include the affected accounts, detailed description, any additional metadata that depends on the event type, or any affected resources. To retrieve that information, use the following operations:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedAccountsForOrganization.html\">DescribeAffectedAccountsForOrganization</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventDetailsForOrganization.html\">DescribeEventDetailsForOrganization</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeAffectedEntitiesForOrganization.html\">DescribeAffectedEntitiesForOrganization</a> </p> </li> </ul> <p>If you don't specify a <code>filter</code>, the <code>DescribeEventsForOrganizations</code> returns all events across your organization. Results are sorted by <code>lastModifiedTime</code>, starting with the most recent event. </p> <p>For more information about the different types of AWS Health events, see <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_Event.html\">Event</a>.</p> <p>Before you can call this operation, you must first enable AWS Health to work with AWS Organizations. To do this, call the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_EnableHealthServiceAccessForOrganization.html\">EnableHealthServiceAccessForOrganization</a> operation from your organization's management account.</p> <note> <p>This API operation uses pagination. Specify the <code>nextToken</code> parameter in the next request to return more results.</p> </note>",
"idempotent":true
},
"DescribeHealthServiceStatusForOrganization":{
@ -162,7 +162,7 @@
"requestUri":"/"
},
"output":{"shape":"DescribeHealthServiceStatusForOrganizationResponse"},
"documentation":"<p>This operation provides status information on enabling or disabling AWS Health to work with your organization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account.</p>",
"documentation":"<p>This operation provides status information on enabling or disabling AWS Health to work with your organization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's management account.</p>",
"idempotent":true
},
"DisableHealthServiceAccessForOrganization":{
@ -174,7 +174,7 @@
"errors":[
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Disables AWS Health from working with AWS Organizations. To call this operation, you must sign in as an AWS Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master AWS account. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html\">Aggregating AWS Health events</a> in the <i>AWS Health User Guide</i>.</p> <p>This operation doesn't remove the service-linked role (SLR) from the AWS master account in your organization. You must use the IAM console, API, or AWS Command Line Interface (AWS CLI) to remove the SLR. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#delete-service-linked-role\">Deleting a Service-Linked Role</a> in the <i>IAM User Guide</i>.</p> <note> <p>You can also disable the organizational feature by using the Organizations <a href=\"https://docs.aws.amazon.com/organizations/latest/APIReference/API_DisableAWSServiceAccess.html\">DisableAWSServiceAccess</a> API operation. After you call this operation, AWS Health stops aggregating events for all other AWS accounts in your organization. If you call the AWS Health API operations for organizational view, AWS Health returns an error. AWS Health continues to aggregate health events for your AWS account.</p> </note>",
"documentation":"<p>Disables AWS Health from working with AWS Organizations. To call this operation, you must sign in as an AWS Identity and Access Management (IAM) user, assume an IAM role, or sign in as the root user (not recommended) in the organization's management account. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html\">Aggregating AWS Health events</a> in the <i>AWS Health User Guide</i>.</p> <p>This operation doesn't remove the service-linked role from the management account in your organization. You must use the IAM console, API, or AWS Command Line Interface (AWS CLI) to remove the service-linked role. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html#delete-service-linked-role\">Deleting a Service-Linked Role</a> in the <i>IAM User Guide</i>.</p> <note> <p>You can also disable the organizational feature by using the Organizations <a href=\"https://docs.aws.amazon.com/organizations/latest/APIReference/API_DisableAWSServiceAccess.html\">DisableAWSServiceAccess</a> API operation. After you call this operation, AWS Health stops aggregating events for all other AWS accounts in your organization. If you call the AWS Health API operations for organizational view, AWS Health returns an error. AWS Health continues to aggregate health events for your AWS account.</p> </note>",
"idempotent":true
},
"EnableHealthServiceAccessForOrganization":{
@ -186,7 +186,7 @@
"errors":[
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Calling this operation enables AWS Health to work with AWS Organizations. This applies a service-linked role (SLR) to the master account in the organization. To call this operation, you must sign in as an IAM user, assume an IAM role, or sign in as the root user (not recommended) in the organization's master account.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html\">Aggregating AWS Health events</a> in the <i>AWS Health User Guide</i>.</p>",
"documentation":"<p>Enables AWS Health to work with AWS Organizations. You can use the organizational view feature to aggregate events from all AWS accounts in your organization in a centralized location. </p> <p>This operation also creates a service-linked role for the management account in the organization. </p> <note> <p>To call this operation, you must meet the following requirements:</p> <ul> <li> <p>You must have a Business or Enterprise support plan from <a href=\"http://aws.amazon.com/premiumsupport/\">AWS Support</a> to use the AWS Health API. If you call the AWS Health API from an AWS account that doesn't have a Business or Enterprise support plan, you receive a <code>SubscriptionRequiredException</code> error.</p> </li> <li> <p>You must have permission to call this operation from the organization's management account. For example IAM policies, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/security_iam_id-based-policy-examples.html\">AWS Health identity-based policy examples</a>.</p> </li> </ul> </note> <p>If you don't have the required support plan, you can instead use the AWS Health console to enable the organizational view feature. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/aggregate-events.html\">Aggregating AWS Health events</a> in the <i>AWS Health User Guide</i>.</p>",
"idempotent":true
}
},
@ -864,7 +864,7 @@
"documentation":"<p>A list of event type category codes (<code>issue</code>, <code>scheduledChange</code>, or <code>accountNotification</code>).</p>"
}
},
"documentation":"<p>Metadata about a type of event that is reported by AWS Health. Data consists of the category (for example, <code>issue</code>), the service (for example, <code>EC2</code>), and the event type code (for example, <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code>).</p>"
"documentation":"<p>Contains the metadata about a type of event that is reported by AWS Health. The <code>EventType</code> shows the category, service, and the event type code of the event. For example, an <code>issue</code> might be the category, <code>EC2</code> the service, and <code>AWS_EC2_SYSTEM_MAINTENANCE_EVENT</code> the event type code.</p> <p>You can use the <a href=\"https://docs.aws.amazon.com/health/latest/APIReference/API_DescribeEventTypes.html\">DescribeEventTypes</a> API operation to return this information about an event.</p> <p>You can also use the Amazon CloudWatch Events console to create a rule so that you can get notified or take action when AWS Health delivers a specific event to your AWS account. For more information, see <a href=\"https://docs.aws.amazon.com/health/latest/ug/cloudwatch-events-health.html\">Monitor for AWS Health events with Amazon CloudWatch Events</a> in the <i>AWS Health User Guide</i>.</p>"
},
"EventTypeCategoryList":{
"type":"list",

1247
botocore/data/iam/2010-05-08/service-2.json
View file

File diff suppressed because one or more lines are too long

101
botocore/data/imagebuilder/2019-12-02/service-2.json
View file

@ -638,6 +638,26 @@
],
"documentation":"<p> Returns a list of image build versions. </p>"
},
"ListImagePackages":{
"name":"ListImagePackages",
"http":{
"method":"POST",
"requestUri":"/ListImagePackages"
},
"input":{"shape":"ListImagePackagesRequest"},
"output":{"shape":"ListImagePackagesResponse"},
"errors":[
{"shape":"ServiceException"},
{"shape":"ClientException"},
{"shape":"ServiceUnavailableException"},
{"shape":"InvalidRequestException"},
{"shape":"InvalidPaginationTokenException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ForbiddenException"},
{"shape":"CallRateLimitExceededException"}
],
"documentation":"<p>List the Packages that are associated with an Image Build Version, as determined by AWS Systems Manager Inventory at build time.</p>"
},
"ListImagePipelineImages":{
"name":"ListImagePipelineImages",
"http":{
@ -2279,6 +2299,7 @@
"io1",
"io2",
"gp2",
"gp3",
"sc1",
"st1"
]
@ -2704,6 +2725,24 @@
"type":"string",
"pattern":"^arn:aws[^:]*:imagebuilder:[^:]+:(?:\\d{12}|aws):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline)/[a-z0-9-_]+(?:/(?:(?:x|\\d+)\\.(?:x|\\d+)\\.(?:x|\\d+))(?:/\\d+)?)?$"
},
"ImagePackage":{
"type":"structure",
"members":{
"packageName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the package as reported to the operating system package manager.</p>"
},
"packageVersion":{
"shape":"NonEmptyString",
"documentation":"<p>The version of the package as reported to the operating system package manager.</p>"
}
},
"documentation":"<p>Represents a package installed on an Image Builder image.</p>"
},
"ImagePackageList":{
"type":"list",
"member":{"shape":"ImagePackage"}
},
"ImagePipeline":{
"type":"structure",
"members":{
@ -3145,7 +3184,7 @@
"documentation":"<p>The instance types of the infrastructure configuration.</p>"
},
"instanceProfileName":{
"shape":"NonEmptyString",
"shape":"InstanceProfileNameType",
"documentation":"<p>The instance profile of the infrastructure configuration.</p>"
},
"securityGroupIds":{
@ -3225,6 +3264,14 @@
"tags":{
"shape":"TagMap",
"documentation":"<p>The tags of the infrastructure configuration.</p>"
},
"instanceTypes":{
"shape":"InstanceTypeList",
"documentation":"<p>The instance types of the infrastructure configuration.</p>"
},
"instanceProfileName":{
"shape":"InstanceProfileNameType",
"documentation":"<p>The instance profile of the infrastructure configuration.</p>"
}
},
"documentation":"<p>The infrastructure used when building EC2 AMIs.</p>"
@ -3271,6 +3318,12 @@
"type":"list",
"member":{"shape":"InstanceBlockDeviceMapping"}
},
"InstanceProfileNameType":{
"type":"string",
"max":256,
"min":1,
"pattern":"^[\\w+=,.@-]+$"
},
"InstanceType":{"type":"string"},
"InstanceTypeList":{
"type":"list",
@ -3547,6 +3600,42 @@
}
}
},
"ListImagePackagesRequest":{
"type":"structure",
"required":["imageBuildVersionArn"],
"members":{
"imageBuildVersionArn":{
"shape":"ImageBuildVersionArn",
"documentation":"<p>Filter results for the ListImagePackages request by the Image Build Version ARN</p>"
},
"maxResults":{
"shape":"RestrictedInteger",
"documentation":"<p>The maxiumum number of results to return from the ListImagePackages request.</p>",
"box":true
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>A token to specify where to start paginating. This is the NextToken from a previously truncated response.</p>"
}
}
},
"ListImagePackagesResponse":{
"type":"structure",
"members":{
"requestId":{
"shape":"NonEmptyString",
"documentation":"<p>The request ID that uniquely identifies this request.</p>"
},
"imagePackageList":{
"shape":"ImagePackageList",
"documentation":"<p>The list of Image Packages returned in the response.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>A token to specify where to start paginating. This is the NextToken from a previously truncated response.</p>"
}
}
},
"ListImagePipelineImagesRequest":{
"type":"structure",
"required":["imagePipelineArn"],
@ -4040,6 +4129,10 @@
"shape":"NonEmptyString",
"documentation":"<p>The cron expression determines how often EC2 Image Builder evaluates your <code>pipelineExecutionStartCondition</code>.</p> <p>For information on how to format a cron expression in Image Builder, see <a href=\"https://docs.aws.amazon.com/imagebuilder/latest/userguide/image-builder-cron.html\">Use cron expressions in EC2 Image Builder</a>.</p>"
},
"timezone":{
"shape":"Timezone",
"documentation":"<p>The timezone that applies to the scheduling expression. For example, \"Etc/UTC\", \"America/Los_Angeles\" in the <a href=\"https://www.joda.org/joda-time/timezones.html\">IANA timezone format</a>. If not specified this defaults to UTC.</p>"
},
"pipelineExecutionStartCondition":{
"shape":"PipelineExecutionStartCondition",
"documentation":"<p>The condition configures when the pipeline should trigger a new image build. When the <code>pipelineExecutionStartCondition</code> is set to <code>EXPRESSION_MATCH_AND_DEPENDENCY_UPDATES_AVAILABLE</code>, and you use semantic version filters on the source image or components in your image recipe, EC2 Image Builder will build a new image only when there are new versions of the image or components in your recipe that match the semantic version filter. When it is set to <code>EXPRESSION_MATCH_ONLY</code>, it will build a new image every time the CRON expression matches the current time. For semantic version syntax, see <a href=\"https://docs.aws.amazon.com/imagebuilder/latest/APIReference/API_CreateComponent.html\">CreateComponent</a> in the <i> EC2 Image Builder API Reference</i>.</p>"
@ -4186,6 +4279,12 @@
},
"documentation":"<p>The container repository where the output container image is stored.</p>"
},
"Timezone":{
"type":"string",
"max":100,
"min":3,
"pattern":"[a-zA-Z0-9]{2,}(?:\\/[a-zA-z0-9-_+]+)*"
},
"UntagResourceRequest":{
"type":"structure",
"required":[

254
botocore/data/iotevents/2018-07-27/service-2.json
View file

@ -102,6 +102,23 @@
],
"documentation":"<p>Describes a detector model. If the <code>version</code> parameter is not specified, information about the latest version is returned.</p>"
},
"DescribeDetectorModelAnalysis":{
"name":"DescribeDetectorModelAnalysis",
"http":{
"method":"GET",
"requestUri":"/analysis/detector-models/{analysisId}"
},
"input":{"shape":"DescribeDetectorModelAnalysisRequest"},
"output":{"shape":"DescribeDetectorModelAnalysisResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Retrieves execution information about a detector model analysis</p>"
},
"DescribeInput":{
"name":"DescribeInput",
"http":{
@ -137,6 +154,23 @@
],
"documentation":"<p>Retrieves the current settings of the AWS IoT Events logging options.</p>"
},
"GetDetectorModelAnalysisResults":{
"name":"GetDetectorModelAnalysisResults",
"http":{
"method":"GET",
"requestUri":"/analysis/detector-models/{analysisId}/results"
},
"input":{"shape":"GetDetectorModelAnalysisResultsRequest"},
"output":{"shape":"GetDetectorModelAnalysisResultsResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Retrieves one or more analysis results of the detector model.</p>"
},
"ListDetectorModelVersions":{
"name":"ListDetectorModelVersions",
"http":{
@ -220,6 +254,23 @@
],
"documentation":"<p>Sets or updates the AWS IoT Events logging options.</p> <p>If you update the value of any <code>loggingOptions</code> field, it takes up to one minute for the change to take effect. If you change the policy attached to the role you specified in the <code>roleArn</code> field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.</p>"
},
"StartDetectorModelAnalysis":{
"name":"StartDetectorModelAnalysis",
"http":{
"method":"POST",
"requestUri":"/analysis/detector-models/"
},
"input":{"shape":"StartDetectorModelAnalysisRequest"},
"output":{"shape":"StartDetectorModelAnalysisResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"LimitExceededException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"},
{"shape":"ServiceUnavailableException"}
],
"documentation":"<p>Performs an analysis of your detector model. For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html\">Running detector model analyses</a> in the <i>AWS IoT Events Developer Guide</i>.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
@ -338,11 +389,11 @@
},
"dynamoDB":{
"shape":"DynamoDBAction",
"documentation":"<p>Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html\">payload</a>. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html\">Actions</a> in <i>AWS IoT Events Developer Guide</i>.</p>"
"documentation":"<p>Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html\">payload</a>. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify. For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html\">Actions</a> in <i>AWS IoT Events Developer Guide</i>.</p>"
},
"dynamoDBv2":{
"shape":"DynamoDBv2Action",
"documentation":"<p>Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html\">payload</a>. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html\">Actions</a> in <i>AWS IoT Events Developer Guide</i>.</p>"
"documentation":"<p>Writes to the DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can customize the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html\">payload</a>. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify. For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-event-actions.html\">Actions</a> in <i>AWS IoT Events Developer Guide</i>.</p>"
},
"iotSiteWise":{
"shape":"IotSiteWiseAction",
@ -360,6 +411,66 @@
"max":2048,
"min":1
},
"AnalysisId":{"type":"string"},
"AnalysisMessage":{"type":"string"},
"AnalysisResult":{
"type":"structure",
"members":{
"type":{
"shape":"AnalysisType",
"documentation":"<p>The type of the analysis result. Analyses fall into the following types based on the validators used to generate the analysis result:</p> <ul> <li> <p> <code>supported-actions</code> - You must specify AWS IoT Events supported actions that work with other AWS services in a supported AWS Region.</p> </li> <li> <p> <code>service-limits</code> - Resources or operations can't exceed service limits. Update your detector model or request a limit adjust.</p> </li> <li> <p> <code>structure</code> - The detector model must follow a structure that AWS IoT Events supports. </p> </li> <li> <p> <code>expression-syntax</code> - Your expression must follow the required syntax.</p> </li> <li> <p> <code>data-type</code> - Data types referenced in the detector model must be compatible.</p> </li> <li> <p> <code>referenced-data</code> - You must define the data referenced in your detector model before you can use the data.</p> </li> <li> <p> <code>referenced-resource</code> - Resources that the detector model uses must be available.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html\">Running detector model analyses</a> in the <i>AWS IoT Events Developer Guide</i>.</p>"
},
"level":{
"shape":"AnalysisResultLevel",
"documentation":"<p>The severity level of the analysis result. Analysis results fall into three general categories based on the severity level:</p> <ul> <li> <p> <code>INFO</code> - An information result informs you about a significant field in your detector model. This type of result usually doesn't require immediate action.</p> </li> <li> <p> <code>WARNING</code> - A warning result draws special attention to fields that are potentially damaging to your detector model. We recommend that you review warnings and take necessary actions before you use your detetor model in production environments. Otherwise, the detector model may not fully function as expected.</p> </li> <li> <p> <code>ERROR</code> - An error result notifies you about a problem found in your detector model. You must fix all errors before you can publish your detector model.</p> </li> </ul>"
},
"message":{
"shape":"AnalysisMessage",
"documentation":"<p>Contains additional information about the analysis result.</p>"
},
"locations":{
"shape":"AnalysisResultLocations",
"documentation":"<p>Contains one or more locations that you can use to locate the fields in your detector model that the analysis result references.</p>"
}
},
"documentation":"<p>Contains the result of the analysis.</p>"
},
"AnalysisResultLevel":{
"type":"string",
"enum":[
"INFO",
"WARNING",
"ERROR"
]
},
"AnalysisResultLocation":{
"type":"structure",
"members":{
"path":{
"shape":"AnalysisResultLocationPath",
"documentation":"<p>A <a href=\"https://github.com/json-path/JsonPath\">JsonPath</a> expression that identifies the error field in your detector model.</p>"
}
},
"documentation":"<p>Contains information that you can use to locate the field in your detector model that the analysis result references.</p>"
},
"AnalysisResultLocationPath":{"type":"string"},
"AnalysisResultLocations":{
"type":"list",
"member":{"shape":"AnalysisResultLocation"}
},
"AnalysisResults":{
"type":"list",
"member":{"shape":"AnalysisResult"}
},
"AnalysisStatus":{
"type":"string",
"enum":[
"RUNNING",
"COMPLETE",
"FAILED"
]
},
"AnalysisType":{"type":"string"},
"AssetId":{"type":"string"},
"AssetPropertyAlias":{"type":"string"},
"AssetPropertyBooleanValue":{"type":"string"},
@ -377,14 +488,14 @@
"members":{
"timeInSeconds":{
"shape":"AssetPropertyTimeInSeconds",
"documentation":"<p>The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199. You can also specify an expression.</p>"
"documentation":"<p>The timestamp, in seconds, in the Unix epoch format. The valid range is between 1-31556889864403199.</p>"
},
"offsetInNanos":{
"shape":"AssetPropertyOffsetInNanos",
"documentation":"<p>The nanosecond offset converted from <code>timeInSeconds</code>. The valid range is between 0-999999999. You can also specify an expression.</p>"
"documentation":"<p>The nanosecond offset converted from <code>timeInSeconds</code>. The valid range is between 0-999999999.</p>"
}
},
"documentation":"<p>A structure that contains timestamp information. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html\">TimeInNanos</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <p>For parameters that are string data type, you can specify the following options:</p> <ul> <li> <p>Use a string. For example, the <code>timeInSeconds</code> value can be <code>'1586400675'</code>.</p> </li> <li> <p>Use an expression. For example, the <code>timeInSeconds</code> value can be <code>'${$input.TemperatureInput.sensorData.timestamp/1000}'</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> </li> </ul>"
"documentation":"<p>A structure that contains timestamp information. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_TimeInNanos.html\">TimeInNanos</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <p>You must use expressions for all parameters in <code>AssetPropertyTimestamp</code>. The expressions accept literals, operators, functions, references, and substitution templates.</p> <p class=\"title\"> <b>Examples</b> </p> <ul> <li> <p>For literal values, the expressions must contain single quotes. For example, the value for the <code>timeInSeconds</code> parameter can be <code>'1586400675'</code>.</p> </li> <li> <p>For references, you must specify either variables or input values. For example, the value for the <code>offsetInNanos</code> parameter can be <code>$variable.time</code>.</p> </li> <li> <p>For a substitution template, you must use <code>${}</code>, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.</p> <p>In the following example, the value for the <code>timeInSeconds</code> parameter uses a substitution template.</p> <p> <code>'${$input.TemperatureInput.sensorData.timestamp / 1000}'</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p>"
},
"AssetPropertyValue":{
"type":"structure",
@ -400,32 +511,32 @@
},
"quality":{
"shape":"AssetPropertyQuality",
"documentation":"<p>The quality of the asset property value. The value must be <code>GOOD</code>, <code>BAD</code>, or <code>UNCERTAIN</code>. You can also specify an expression.</p>"
"documentation":"<p>The quality of the asset property value. The value must be <code>'GOOD'</code>, <code>'BAD'</code>, or <code>'UNCERTAIN'</code>.</p>"
}
},
"documentation":"<p>A structure that contains value information. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html\">AssetPropertyValue</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <p>For parameters that are string data type, you can specify the following options: </p> <ul> <li> <p>Use a string. For example, the <code>quality</code> value can be <code>'GOOD'</code>.</p> </li> <li> <p>Use an expression. For example, the <code>quality</code> value can be <code>$input.TemperatureInput.sensorData.quality</code> .</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> </li> </ul>"
"documentation":"<p>A structure that contains value information. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetPropertyValue.html\">AssetPropertyValue</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <p>You must use expressions for all parameters in <code>AssetPropertyValue</code>. The expressions accept literals, operators, functions, references, and substitution templates.</p> <p class=\"title\"> <b>Examples</b> </p> <ul> <li> <p>For literal values, the expressions must contain single quotes. For example, the value for the <code>quality</code> parameter can be <code>'GOOD'</code>.</p> </li> <li> <p>For references, you must specify either variables or input values. For example, the value for the <code>quality</code> parameter can be <code>$input.TemperatureInput.sensorData.quality</code>.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p>"
},
"AssetPropertyVariant":{
"type":"structure",
"members":{
"stringValue":{
"shape":"AssetPropertyStringValue",
"documentation":"<p>The asset property value is a string. You can also specify an expression. If you use an expression, the evaluated result should be a string.</p>"
"documentation":"<p>The asset property value is a string. You must use an expression, and the evaluated result should be a string.</p>"
},
"integerValue":{
"shape":"AssetPropertyIntegerValue",
"documentation":"<p>The asset property value is an integer. You can also specify an expression. If you use an expression, the evaluated result should be an integer.</p>"
"documentation":"<p>The asset property value is an integer. You must use an expression, and the evaluated result should be an integer.</p>"
},
"doubleValue":{
"shape":"AssetPropertyDoubleValue",
"documentation":"<p>The asset property value is a double. You can also specify an expression. If you use an expression, the evaluated result should be a double.</p>"
"documentation":"<p>The asset property value is a double. You must use an expression, and the evaluated result should be a double.</p>"
},
"booleanValue":{
"shape":"AssetPropertyBooleanValue",
"documentation":"<p>The asset property value is a Boolean value that must be <code>TRUE</code> or <code>FALSE</code>. You can also specify an expression. If you use an expression, the evaluated result should be a Boolean value.</p>"
"documentation":"<p>The asset property value is a Boolean value that must be <code>'TRUE'</code> or <code>'FALSE'</code>. You must use an expression, and the evaluated result should be a Boolean value.</p>"
}
},
"documentation":"<p>A structure that contains an asset property value. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html\">Variant</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <important> <p>You must specify one of the following value types, depending on the <code>dataType</code> of the specified asset property. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html\">AssetProperty</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> </important> <p>For parameters that are string data type, you can specify the following options:</p> <ul> <li> <p>Use a string. For example, the <code>doubleValue</code> value can be <code>'47.9'</code>.</p> </li> <li> <p>Use an expression. For example, the <code>doubleValue</code> value can be <code>$input.TemperatureInput.sensorData.temperature</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> </li> </ul>"
"documentation":"<p>A structure that contains an asset property value. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_Variant.html\">Variant</a> in the <i>AWS IoT SiteWise API Reference</i>.</p> <p>You must use expressions for all parameters in <code>AssetPropertyVariant</code>. The expressions accept literals, operators, functions, references, and substitution templates.</p> <p class=\"title\"> <b>Examples</b> </p> <ul> <li> <p>For literal values, the expressions must contain single quotes. For example, the value for the <code>integerValue</code> parameter can be <code>'100'</code>.</p> </li> <li> <p>For references, you must specify either variables or parameters. For example, the value for the <code>booleanValue</code> parameter can be <code>$variable.offline</code>.</p> </li> <li> <p>For a substitution template, you must use <code>${}</code>, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates. </p> <p>In the following example, the value for the <code>doubleValue</code> parameter uses a substitution template. </p> <p> <code>'${$input.TemperatureInput.sensorData.temperature * 6 / 5 + 32}'</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> <p>You must specify one of the following value types, depending on the <code>dataType</code> of the specified asset property. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_AssetProperty.html\">AssetProperty</a> in the <i>AWS IoT SiteWise API Reference</i>.</p>"
},
"Attribute":{
"type":"structure",
@ -585,6 +696,27 @@
}
},
"DeliveryStreamName":{"type":"string"},
"DescribeDetectorModelAnalysisRequest":{
"type":"structure",
"required":["analysisId"],
"members":{
"analysisId":{
"shape":"AnalysisId",
"documentation":"<p>The ID of the analysis result that you want to retrieve.</p>",
"location":"uri",
"locationName":"analysisId"
}
}
},
"DescribeDetectorModelAnalysisResponse":{
"type":"structure",
"members":{
"status":{
"shape":"AnalysisStatus",
"documentation":"<p>The status of the analysis activity. The status can be one of the following values:</p> <ul> <li> <p> <code>RUNNING</code> - AWS IoT Events is analyzing your detector model. This process can take several minutes to complete.</p> </li> <li> <p> <code>COMPLETE</code> - AWS IoT Events finished analyzing your detector model .</p> </li> <li> <p> <code>FAILED</code> - AWS IoT Events couldn't analyze your detector model. Try again later.</p> </li> </ul>"
}
}
},
"DescribeDetectorModelRequest":{
"type":"structure",
"required":["detectorModelName"],
@ -847,11 +979,11 @@
"members":{
"hashKeyType":{
"shape":"DynamoKeyType",
"documentation":"<p>The data type for the hash key (also called the partition key). You can specify the following values:</p> <ul> <li> <p> <code>STRING</code> - The hash key is a string.</p> </li> <li> <p> <code>NUMBER</code> - The hash key is a number.</p> </li> </ul> <p>If you don't specify <code>hashKeyType</code>, the default value is <code>STRING</code>.</p>"
"documentation":"<p>The data type for the hash key (also called the partition key). You can specify the following values:</p> <ul> <li> <p> <code>'STRING'</code> - The hash key is a string.</p> </li> <li> <p> <code>'NUMBER'</code> - The hash key is a number.</p> </li> </ul> <p>If you don't specify <code>hashKeyType</code>, the default value is <code>'STRING'</code>.</p>"
},
"hashKeyField":{
"shape":"DynamoKeyField",
"documentation":"<p>The name of the hash key (also called the partition key).</p>"
"documentation":"<p>The name of the hash key (also called the partition key). The <code>hashKeyField</code> value must match the partition key of the target DynamoDB table.</p>"
},
"hashKeyValue":{
"shape":"DynamoKeyValue",
@ -859,11 +991,11 @@
},
"rangeKeyType":{
"shape":"DynamoKeyType",
"documentation":"<p>The data type for the range key (also called the sort key), You can specify the following values:</p> <ul> <li> <p> <code>STRING</code> - The range key is a string.</p> </li> <li> <p> <code>NUMBER</code> - The range key is number.</p> </li> </ul> <p>If you don't specify <code>rangeKeyField</code>, the default value is <code>STRING</code>.</p>"
"documentation":"<p>The data type for the range key (also called the sort key), You can specify the following values:</p> <ul> <li> <p> <code>'STRING'</code> - The range key is a string.</p> </li> <li> <p> <code>'NUMBER'</code> - The range key is number.</p> </li> </ul> <p>If you don't specify <code>rangeKeyField</code>, the default value is <code>'STRING'</code>.</p>"
},
"rangeKeyField":{
"shape":"DynamoKeyField",
"documentation":"<p>The name of the range key (also called the sort key).</p>"
"documentation":"<p>The name of the range key (also called the sort key). The <code>rangeKeyField</code> value must match the sort key of the target DynamoDB table. </p>"
},
"rangeKeyValue":{
"shape":"DynamoKeyValue",
@ -871,7 +1003,7 @@
},
"operation":{
"shape":"DynamoOperation",
"documentation":"<p>The type of operation to perform. You can specify the following values: </p> <ul> <li> <p> <code>INSERT</code> - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.</p> </li> <li> <p> <code>UPDATE</code> - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.</p> </li> <li> <p> <code>DELETE</code> - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.</p> </li> </ul> <p>If you don't specify this parameter, AWS IoT Events triggers the <code>INSERT</code> operation.</p>"
"documentation":"<p>The type of operation to perform. You can specify the following values: </p> <ul> <li> <p> <code>'INSERT'</code> - Insert data as a new item into the DynamoDB table. This item uses the specified hash key as a partition key. If you specified a range key, the item uses the range key as a sort key.</p> </li> <li> <p> <code>'UPDATE'</code> - Update an existing item of the DynamoDB table with new data. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.</p> </li> <li> <p> <code>'DELETE'</code> - Delete an existing item of the DynamoDB table. This item's partition key must match the specified hash key. If you specified a range key, the range key must match the item's sort key.</p> </li> </ul> <p>If you don't specify this parameter, AWS IoT Events triggers the <code>'INSERT'</code> operation.</p>"
},
"payloadField":{
"shape":"DynamoKeyField",
@ -879,11 +1011,11 @@
},
"tableName":{
"shape":"DynamoTableName",
"documentation":"<p>The name of the DynamoDB table.</p>"
"documentation":"<p>The name of the DynamoDB table. The <code>tableName</code> value must match the table name of the target DynamoDB table. </p>"
},
"payload":{"shape":"Payload"}
},
"documentation":"<p>Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html\">payload</a>. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.</p> <p>The <code>tableName</code> and <code>hashKeyField</code> values must match the table name and the partition key of the DynamoDB table. </p> <note> <p>If the DynamoDB table also has a sort key, you must specify <code>rangeKeyField</code>. The <code>rangeKeyField</code> value must match the sort key.</p> </note> <p/> <p>The <code>hashKeyValue</code> and <code>rangeKeyValue</code> use substitution templates. These templates provide data at runtime. The syntax is <code>${sql-expression}</code>.</p> <p>You can use expressions for parameters that are string data type. For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> <note> <p>If the defined payload type is a string, <code>DynamoDBAction</code> writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The <code>payloadField</code> is <code>&lt;payload-field&gt;_raw</code>.</p> </note>"
"documentation":"<p>Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html\">payload</a>. One column of the DynamoDB table receives all attribute-value pairs in the payload that you specify.</p> <p>You must use expressions for all parameters in <code>DynamoDBAction</code>. The expressions accept literals, operators, functions, references, and substitution templates.</p> <p class=\"title\"> <b>Examples</b> </p> <ul> <li> <p>For literal values, the expressions must contain single quotes. For example, the value for the <code>hashKeyType</code> parameter can be <code>'STRING'</code>.</p> </li> <li> <p>For references, you must specify either variables or input values. For example, the value for the <code>hashKeyField</code> parameter can be <code>$input.GreenhouseInput.name</code>.</p> </li> <li> <p>For a substitution template, you must use <code>${}</code>, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.</p> <p>In the following example, the value for the <code>hashKeyValue</code> parameter uses a substitution template. </p> <p> <code>'${$input.GreenhouseInput.temperature * 6 / 5 + 32} in Fahrenheit'</code> </p> </li> <li> <p>For a string concatenation, you must use <code>+</code>. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.</p> <p>In the following example, the value for the <code>tableName</code> parameter uses a string concatenation. </p> <p> <code>'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> <p>If the defined payload type is a string, <code>DynamoDBAction</code> writes non-JSON data to the DynamoDB table as binary data. The DynamoDB console displays the data as Base64-encoded text. The value for the <code>payloadField</code> parameter is <code>&lt;payload-field&gt;_raw</code>.</p>"
},
"DynamoDBv2Action":{
"type":"structure",
@ -895,7 +1027,7 @@
},
"payload":{"shape":"Payload"}
},
"documentation":"<p>Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all attribute-value pairs that have the information about the detector model instance and the event that triggered the action. You can also customize the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html\">payload</a>. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.</p> <important> <p>The <code>type</code> value for <code>Payload</code> must be <code>JSON</code>.</p> </important> <p>You can use expressions for parameters that are strings. For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p>"
"documentation":"<p>Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model instance and the event that triggered the action. You can customize the <a href=\"https://docs.aws.amazon.com/iotevents/latest/apireference/API_Payload.html\">payload</a>. A separate column of the DynamoDB table receives one attribute-value pair in the payload that you specify.</p> <p>You must use expressions for all parameters in <code>DynamoDBv2Action</code>. The expressions accept literals, operators, functions, references, and substitution templates.</p> <p class=\"title\"> <b>Examples</b> </p> <ul> <li> <p>For literal values, the expressions must contain single quotes. For example, the value for the <code>tableName</code> parameter can be <code>'GreenhouseTemperatureTable'</code>.</p> </li> <li> <p>For references, you must specify either variables or input values. For example, the value for the <code>tableName</code> parameter can be <code>$variable.ddbtableName</code>.</p> </li> <li> <p>For a substitution template, you must use <code>${}</code>, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.</p> <p>In the following example, the value for the <code>contentExpression</code> parameter in <code>Payload</code> uses a substitution template. </p> <p> <code>'{\\\"sensorID\\\": \\\"${$input.GreenhouseInput.sensor_id}\\\", \\\"temperature\\\": \\\"${$input.GreenhouseInput.temperature * 9 / 5 + 32}\\\"}'</code> </p> </li> <li> <p>For a string concatenation, you must use <code>+</code>. A string concatenation can also contain a combination of literals, operators, functions, references, and substitution templates.</p> <p>In the following example, the value for the <code>tableName</code> parameter uses a string concatenation. </p> <p> <code>'GreenhouseTemperatureTable ' + $input.GreenhouseInput.date</code> </p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> <p>The value for the <code>type</code> parameter in <code>Payload</code> must be <code>JSON</code>.</p>"
},
"DynamoKeyField":{"type":"string"},
"DynamoKeyType":{"type":"string"},
@ -959,6 +1091,43 @@
"type":"string",
"pattern":"([\\n\\t])|(\\r\\n)|(,)"
},
"GetDetectorModelAnalysisResultsRequest":{
"type":"structure",
"required":["analysisId"],
"members":{
"analysisId":{
"shape":"AnalysisId",
"documentation":"<p>The ID of the analysis result that you want to retrieve.</p>",
"location":"uri",
"locationName":"analysisId"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token that you can use to return the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxAnalysisResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"GetDetectorModelAnalysisResultsResponse":{
"type":"structure",
"members":{
"analysisResults":{
"shape":"AnalysisResults",
"documentation":"<p>Contains information about one or more analysis results.</p>"
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token that you can use to return the next set of results, or <code>null</code> if there are no more results.</p>"
}
}
},
"Input":{
"type":"structure",
"members":{
@ -1121,26 +1290,26 @@
"members":{
"entryId":{
"shape":"AssetPropertyEntryId",
"documentation":"<p>A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier. You can also specify an expression.</p>"
"documentation":"<p>A unique identifier for this entry. You can use the entry ID to track which data entry causes an error in case of failure. The default is a new unique identifier.</p>"
},
"assetId":{
"shape":"AssetId",
"documentation":"<p>The ID of the asset that has the specified property. You can specify an expression.</p>"
"documentation":"<p>The ID of the asset that has the specified property.</p>"
},
"propertyId":{
"shape":"AssetPropertyId",
"documentation":"<p>The ID of the asset property. You can specify an expression.</p>"
"documentation":"<p>The ID of the asset property.</p>"
},
"propertyAlias":{
"shape":"AssetPropertyAlias",
"documentation":"<p>The alias of the asset property. You can also specify an expression.</p>"
"documentation":"<p>The alias of the asset property.</p>"
},
"propertyValue":{
"shape":"AssetPropertyValue",
"documentation":"<p>The value to send to the asset property. This value contains timestamp, quality, and value (TQV) information. </p>"
}
},
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.</p> <important> <p>You must specify either <code>propertyAlias</code> or both <code>assetId</code> and <code>propertyId</code> to identify the target asset property in AWS IoT SiteWise.</p> </important> <p>For parameters that are string data type, you can specify the following options: </p> <ul> <li> <p>Use a string. For example, the <code>propertyAlias</code> value can be <code>'/company/windfarm/3/turbine/7/temperature'</code>.</p> </li> <li> <p>Use an expression. For example, the <code>propertyAlias</code> value can be <code>'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/${$input.TemperatureInput.sensorData.turbineID}/temperature'</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p> </li> </ul>"
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise.</p> <p>You must use expressions for all parameters in <code>IotSiteWiseAction</code>. The expressions accept literals, operators, functions, references, and substitutions templates.</p> <p class=\"title\"> <b>Examples</b> </p> <ul> <li> <p>For literal values, the expressions must contain single quotes. For example, the value for the <code>propertyAlias</code> parameter can be <code>'/company/windfarm/3/turbine/7/temperature'</code>.</p> </li> <li> <p>For references, you must specify either variables or input values. For example, the value for the <code>assetId</code> parameter can be <code>$input.TurbineInput.assetId1</code>.</p> </li> <li> <p>For a substitution template, you must use <code>${}</code>, and the template must be in single quotes. A substitution template can also contain a combination of literals, operators, functions, references, and substitution templates.</p> <p>In the following example, the value for the <code>propertyAlias</code> parameter uses a substitution template. </p> <p> <code>'company/windfarm/${$input.TemperatureInput.sensorData.windfarmID}/turbine/ ${$input.TemperatureInput.sensorData.turbineID}/temperature'</code> </p> </li> </ul> <p>You must specify either <code>propertyAlias</code> or both <code>assetId</code> and <code>propertyId</code> to identify the target asset property in AWS IoT SiteWise.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-expressions.html\">Expressions</a> in the <i>AWS IoT Events Developer Guide</i>.</p>"
},
"IotTopicPublishAction":{
"type":"structure",
@ -1202,13 +1371,13 @@
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results.</p>",
"documentation":"<p>The token that you can use to return the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return at one time.</p>",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"location":"querystring",
"locationName":"maxResults"
}
@ -1223,7 +1392,7 @@
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>"
"documentation":"<p>The token that you can use to return the next set of results, or <code>null</code> if there are no more results.</p>"
}
}
},
@ -1232,13 +1401,13 @@
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results.</p>",
"documentation":"<p>The token that you can use to return the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return at one time.</p>",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"location":"querystring",
"locationName":"maxResults"
}
@ -1253,7 +1422,7 @@
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>"
"documentation":"<p>The token that you can use to return the next set of results, or <code>null</code> if there are no more results.</p>"
}
}
},
@ -1262,13 +1431,13 @@
"members":{
"nextToken":{
"shape":"NextToken",
"documentation":"<p>The token for the next set of results.</p>",
"documentation":"<p>The token that you can use to return the next set of results.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return at one time.</p>",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"location":"querystring",
"locationName":"maxResults"
}
@ -1283,7 +1452,7 @@
},
"nextToken":{
"shape":"NextToken",
"documentation":"<p>A token to retrieve the next set of results, or <code>null</code> if there are no additional results.</p>"
"documentation":"<p>The token that you can use to return the next set of results, or <code>null</code> if there are no more results.</p>"
}
}
},
@ -1349,6 +1518,7 @@
"max":128,
"min":1
},
"MaxAnalysisResults":{"type":"integer"},
"MaxResults":{
"type":"integer",
"max":250,
@ -1571,6 +1741,22 @@
},
"documentation":"<p>Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.</p>"
},
"StartDetectorModelAnalysisRequest":{
"type":"structure",
"required":["detectorModelDefinition"],
"members":{
"detectorModelDefinition":{"shape":"DetectorModelDefinition"}
}
},
"StartDetectorModelAnalysisResponse":{
"type":"structure",
"members":{
"analysisId":{
"shape":"AnalysisId",
"documentation":"<p>The ID that you can use to retrieve the analysis result.</p>"
}
}
},
"State":{
"type":"structure",
"required":["stateName"],

17
botocore/data/iotsitewise/2019-12-02/service-2.json
View file

@ -3610,6 +3610,17 @@
},
"documentation":"<p>Contains information for a group identity in an access policy.</p>"
},
"IAMRoleIdentity":{
"type":"structure",
"required":["arn"],
"members":{
"arn":{
"shape":"ARN",
"documentation":"<p>The ARN of the IAM role. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.htmll#identifiers-arns\">IAM ARNs</a> in the <i>IAM User Guide</i>.</p>"
}
},
"documentation":"<p>Contains information about an AWS Identity and Access Management (IAM) role. For more information, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html\">IAM roles</a> in the <i>IAM User Guide</i>.</p>"
},
"IAMUserIdentity":{
"type":"structure",
"required":["arn"],
@ -3647,6 +3658,10 @@
"iamUser":{
"shape":"IAMUserIdentity",
"documentation":"<p>An IAM user identity.</p>"
},
"iamRole":{
"shape":"IAMRoleIdentity",
"documentation":"<p>An IAM role identity.</p>"
}
},
"documentation":"<p>Contains an identity that can access an AWS IoT SiteWise Monitor resource.</p> <note> <p>Currently, you can't use AWS APIs to retrieve AWS SSO identity IDs. You can find the AWS SSO identity IDs in the URL of user and group pages in the <a href=\"https://console.aws.amazon.com/singlesignon\">AWS SSO console</a>.</p> </note>"
@ -4232,7 +4247,7 @@
"type":"structure",
"members":{
},
"documentation":"<p>Contains an asset measurement property. This structure is empty. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#measurements\">Measurements</a> in the <i>AWS IoT SiteWise User Guide</i>.</p>"
"documentation":"<p>Contains an asset measurement property. For more information, see <a href=\"https://docs.aws.amazon.com/iot-sitewise/latest/userguide/asset-properties.html#measurements\">Measurements</a> in the <i>AWS IoT SiteWise User Guide</i>.</p>"
},
"Metric":{
"type":"structure",

33
botocore/data/iotwireless/2020-11-22/service-2.json
View file

@ -990,6 +990,10 @@
"shape":"ClientRequestToken",
"documentation":"<p>Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. </p>",
"idempotencyToken":true
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags attached to the specified resource. Tags are metadata that can be used to manage a resource</p>"
}
}
},
@ -999,6 +1003,10 @@
"Sidewalk":{
"shape":"SidewalkAccountInfo",
"documentation":"<p>The Sidewalk account credentials.</p>"
},
"Arn":{
"shape":"PartnerAccountArn",
"documentation":"<p>The Amazon Resource Name of the resource.</p>"
}
}
},
@ -1351,6 +1359,10 @@
"shape":"ClientRequestToken",
"documentation":"<p>Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. </p>",
"idempotencyToken":true
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags attached to the specified resource. Tags are metadata that can be used to manage a resource</p>"
}
}
},
@ -1360,6 +1372,10 @@
"Id":{
"shape":"WirelessGatewayTaskDefinitionId",
"documentation":"<p>The ID of the new wireless gateway task definition.</p>"
},
"Arn":{
"shape":"WirelessGatewayTaskDefinitionArn",
"documentation":"<p>The Amazon Resource Name of the resource.</p>"
}
}
},
@ -2027,7 +2043,7 @@
},
"LoRaWANNetworkServerCertificateId":{
"shape":"IotCertificateId",
"documentation":"<p>The ID of the certificate associated with the wireless gateway and used for LoRaWANNetworkServer endpoint.</p>"
"documentation":"<p>The ID of the certificate that is associated with the wireless gateway and used for the LoRaWANNetworkServer endpoint.</p>"
}
}
},
@ -2157,6 +2173,10 @@
"Update":{
"shape":"UpdateWirelessGatewayTaskCreate",
"documentation":"<p>Information about the gateways to update.</p>"
},
"Arn":{
"shape":"WirelessGatewayTaskDefinitionArn",
"documentation":"<p>The Amazon Resource Name of the resource.</p>"
}
}
},
@ -2946,6 +2966,7 @@
"max":32,
"min":1
},
"PartnerAccountArn":{"type":"string"},
"PartnerAccountId":{
"type":"string",
"max":256
@ -3076,6 +3097,7 @@
},
"Seq":{
"type":"integer",
"max":16383,
"min":0
},
"ServiceProfile":{
@ -3169,6 +3191,10 @@
"Fingerprint":{
"shape":"Fingerprint",
"documentation":"<p>The fingerprint of the Sidewalk application server private key.</p>"
},
"Arn":{
"shape":"PartnerAccountArn",
"documentation":"<p>The Amazon Resource Name of the resource.</p>"
}
},
"documentation":"<p>Information about a Sidewalk account.</p>"
@ -3532,6 +3558,10 @@
"LoRaWAN":{
"shape":"LoRaWANUpdateGatewayTaskEntry",
"documentation":"<p>The properties that relate to the LoRaWAN wireless gateway.</p>"
},
"Arn":{
"shape":"WirelessGatewayTaskDefinitionArn",
"documentation":"<p>The Amazon Resource Name of the resource.</p>"
}
},
"documentation":"<p>UpdateWirelessGatewayTaskEntry object.</p>"
@ -3669,6 +3699,7 @@
"type":"list",
"member":{"shape":"WirelessGatewayStatistics"}
},
"WirelessGatewayTaskDefinitionArn":{"type":"string"},
"WirelessGatewayTaskDefinitionId":{
"type":"string",
"max":36,

14
botocore/data/ivs/2020-07-14/service-2.json
View file

@ -69,7 +69,8 @@
"name":"DeleteChannel",
"http":{
"method":"POST",
"requestUri":"/DeleteChannel"
"requestUri":"/DeleteChannel",
"responseCode":204
},
"input":{"shape":"DeleteChannelRequest"},
"errors":[
@ -101,7 +102,8 @@
"name":"DeleteStreamKey",
"http":{
"method":"POST",
"requestUri":"/DeleteStreamKey"
"requestUri":"/DeleteStreamKey",
"responseCode":204
},
"input":{"shape":"DeleteStreamKeyRequest"},
"errors":[
@ -200,7 +202,8 @@
"output":{"shape":"ListChannelsResponse"},
"errors":[
{"shape":"ValidationException"},
{"shape":"AccessDeniedException"}
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"}
],
"documentation":"<p>Gets summary information about all channels in your account, in the AWS region where the API request is processed. This list can be filtered to match a specified string.</p>"
},
@ -1143,7 +1146,10 @@
"member":{"shape":"StreamSummary"}
},
"StreamMetadata":{"type":"string"},
"StreamStartTime":{"type":"timestamp"},
"StreamStartTime":{
"type":"timestamp",
"timestampFormat":"iso8601"
},
"StreamState":{
"type":"string",
"enum":[

82
botocore/data/kinesis-video-archived-media/2017-09-30/service-2.json
View file

File diff suppressed because one or more lines are too long

23
botocore/data/lambda/2015-03-31/service-2.json
View file

@ -646,7 +646,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"InvalidParameterValueException"}
],
"documentation":"<p>Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.</p> <p>Set <code>FunctionVersion</code> to <code>ALL</code> to include all published versions of each function in addition to the unpublished version. To get more information about a function or version, use <a>GetFunction</a>.</p>"
"documentation":"<p>Returns a list of Lambda functions, with the version-specific configuration of each. Lambda returns up to 50 functions per call.</p> <p>Set <code>FunctionVersion</code> to <code>ALL</code> to include all published versions of each function in addition to the unpublished version. </p> <note> <p>The <code>ListFunctions</code> action returns a subset of the <a>FunctionConfiguration</a> fields. To get the additional fields (State, StateReasonCode, StateReason, LastUpdateStatus, LastUpdateStatusReason, LastUpdateStatusReasonCode) for a function or version, use <a>GetFunction</a>.</p> </note>"
},
"ListFunctionsByCodeSigningConfig":{
"name":"ListFunctionsByCodeSigningConfig",
@ -1525,7 +1525,7 @@
},
"TumblingWindowInSeconds":{
"shape":"TumblingWindowInSeconds",
"documentation":"<p>(Streams) The duration of a processing window in seconds. The range is between 1 second up to 15 minutes.</p>"
"documentation":"<p>(Streams) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.</p>"
},
"Topics":{
"shape":"Topics",
@ -1631,7 +1631,7 @@
},
"ImageConfig":{
"shape":"ImageConfig",
"documentation":"<p>Configuration values that override the container image Dockerfile.</p>"
"documentation":"<p> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/images-parms.html\">Container image configuration values</a> that override the values in the container image Dockerfile.</p>"
},
"CodeSigningConfigArn":{
"shape":"CodeSigningConfigArn",
@ -2070,7 +2070,7 @@
},
"TumblingWindowInSeconds":{
"shape":"TumblingWindowInSeconds",
"documentation":"<p>(Streams) The duration of a processing window in seconds. The range is between 1 second up to 15 minutes.</p>"
"documentation":"<p>(Streams) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.</p>"
},
"FunctionResponseTypes":{
"shape":"FunctionResponseTypeList",
@ -2358,7 +2358,7 @@
"type":"list",
"member":{"shape":"FunctionResponseType"},
"max":1,
"min":1
"min":0
},
"FunctionVersion":{
"type":"string",
@ -2769,7 +2769,7 @@
"documentation":"<p>Specifies the working directory.</p>"
}
},
"documentation":"<p>Configuration values that override the container image Dockerfile settings. See <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/images-parms.html\">Container settings</a>. </p>"
"documentation":"<p>Configuration values that override the container image Dockerfile settings. See <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/images-create.html#images-parms\">Container settings</a>. </p>"
},
"ImageConfigError":{
"type":"structure",
@ -3442,7 +3442,7 @@
},
"MaxItems":{
"shape":"MaxListItems",
"documentation":"<p>The maximum number of functions to return.</p>",
"documentation":"<p>The maximum number of functions to return in the response. Note that <code>ListFunctions</code> returns a maximum of 50 items in each response, even if you set the number higher.</p>",
"location":"querystring",
"locationName":"MaxItems"
}
@ -4249,6 +4249,7 @@
"nodejs8.10",
"nodejs10.x",
"nodejs12.x",
"nodejs14.x",
"java8",
"java8.al2",
"java11",
@ -4325,7 +4326,7 @@
"members":{
"Type":{
"shape":"SourceAccessType",
"documentation":"<p>The type of authentication protocol or the VPC components for your event source. For example: <code>\"Type\":\"SASL_SCRAM_512_AUTH\"</code>.</p> <ul> <li> <p> <code>BASIC_AUTH</code> - (MQ) The Secrets Manager secret that stores your broker credentials.</p> </li> <li> <p> <code>VPC_SUBNET</code> - The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your Kafka cluster.</p> </li> <li> <p> <code>VPC_SECURITY_GROUP</code> - The VPC security group used to manage access to your Kafka brokers.</p> </li> <li> <p> <code>SASL_SCRAM_256_AUTH</code> - The ARN of your secret key used for SASL SCRAM-256 authentication of your Kafka brokers.</p> </li> <li> <p> <code>SASL_SCRAM_512_AUTH</code> - The ARN of your secret key used for SASL SCRAM-512 authentication of your Kafka brokers.</p> </li> </ul>"
"documentation":"<p>The type of authentication protocol or the VPC components for your event source. For example: <code>\"Type\":\"SASL_SCRAM_512_AUTH\"</code>.</p> <ul> <li> <p> <code>BASIC_AUTH</code> - (MQ) The Secrets Manager secret that stores your broker credentials.</p> </li> <li> <p> <code>VPC_SUBNET</code> - The subnets associated with your VPC. Lambda connects to these subnets to fetch data from your Self-Managed Apache Kafka cluster.</p> </li> <li> <p> <code>VPC_SECURITY_GROUP</code> - The VPC security group used to manage access to your Self-Managed Apache Kafka brokers.</p> </li> <li> <p> <code>SASL_SCRAM_256_AUTH</code> - The Secrets Manager ARN of your secret key used for SASL SCRAM-256 authentication of your Self-Managed Apache Kafka brokers.</p> </li> <li> <p> <code>SASL_SCRAM_512_AUTH</code> - The Secrets Manager ARN of your secret key used for SASL SCRAM-512 authentication of your Self-Managed Apache Kafka brokers.</p> </li> </ul>"
},
"URI":{
"shape":"URI",
@ -4338,7 +4339,7 @@
"type":"list",
"member":{"shape":"SourceAccessConfiguration"},
"max":22,
"min":1
"min":0
},
"SourceAccessType":{
"type":"string",
@ -4680,7 +4681,7 @@
},
"TumblingWindowInSeconds":{
"shape":"TumblingWindowInSeconds",
"documentation":"<p>(Streams) The duration of a processing window in seconds. The range is between 1 second up to 15 minutes.</p>"
"documentation":"<p>(Streams) The duration in seconds of a processing window. The range is between 1 second up to 900 seconds.</p>"
},
"FunctionResponseTypes":{
"shape":"FunctionResponseTypeList",
@ -4800,7 +4801,7 @@
},
"ImageConfig":{
"shape":"ImageConfig",
"documentation":"<p>Configuration values that override the container image Dockerfile.</p>"
"documentation":"<p> <a href=\"https://docs.aws.amazon.com/lambda/latest/dg/images-parms.html\">Container image configuration values</a> that override the values in the container image Dockerfile.</p>"
}
}
},

1
botocore/data/license-manager/2018-08-01/service-2.json
View file

@ -3052,7 +3052,6 @@
"type":"structure",
"required":[
"ProductInformationFilterName",
"ProductInformationFilterValue",
"ProductInformationFilterComparator"
],
"members":{

26
botocore/data/lightsail/2016-11-28/service-2.json
View file

@ -178,7 +178,7 @@
{"shape":"AccessDeniedException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Creates an SSL/TLS certificate for a Amazon Lightsail content delivery network (CDN) distribution.</p> <p>After the certificate is created, use the <code>AttachCertificateToDistribution</code> action to attach the certificate to your distribution.</p> <important> <p>Only certificates created in the <code>us-east-1</code> AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the <code>us-east-1</code> Region.</p> </important>"
"documentation":"<p>Creates an SSL/TLS certificate for an Amazon Lightsail content delivery network (CDN) distribution and a container service.</p> <p>After the certificate is valid, use the <code>AttachCertificateToDistribution</code> action to use the certificate and its domains with your distribution. Or use the <code>UpdateContainerService</code> action to use the certificate and its domains with your container service.</p> <important> <p>Only certificates created in the <code>us-east-1</code> AWS Region can be attached to Lightsail distributions. Lightsail distributions are global resources that can reference an origin in any AWS Region, and distribute its content globally. However, all distributions are located in the <code>us-east-1</code> Region.</p> </important>"
},
"CreateCloudFormationStack":{
"name":"CreateCloudFormationStack",
@ -493,7 +493,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Creates a Lightsail load balancer TLS certificate.</p> <p>TLS is just an updated, more secure version of Secure Socket Layer (SSL).</p> <p>The <code>CreateLoadBalancerTlsCertificate</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
"documentation":"<p>Creates an SSL/TLS certificate for an Amazon Lightsail load balancer.</p> <p>TLS is just an updated, more secure version of Secure Socket Layer (SSL).</p> <p>The <code>CreateLoadBalancerTlsCertificate</code> operation supports tag-based access control via resource tags applied to the resource identified by <code>load balancer name</code>. For more information, see the <a href=\"https://lightsail.aws.amazon.com/ls/docs/en/articles/amazon-lightsail-controlling-access-using-tags\">Lightsail Dev Guide</a>.</p>"
},
"CreateRelationalDatabase":{
"name":"CreateRelationalDatabase",
@ -2295,7 +2295,7 @@
{"shape":"AccessDeniedException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Registers a container image to your Amazon Lightsail container service.</p> <note> <p>This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see <a href=\"amazon-lightsail-pushing-container-images\">Pushing and managing container images on your Amazon Lightsail container services</a> in the <i>Lightsail Dev Guide</i>.</p> </note>"
"documentation":"<p>Registers a container image to your Amazon Lightsail container service.</p> <note> <p>This action is not required if you install and use the Lightsail Control (lightsailctl) plugin to push container images to your Lightsail container service. For more information, see <a href=\"https://lightsail.aws.amazon.com/ls/docs/en_us/articles/amazon-lightsail-pushing-container-images\">Pushing and managing container images on your Amazon Lightsail container services</a> in the <i>Lightsail Dev Guide</i>.</p> </note>"
},
"ReleaseStaticIp":{
"name":"ReleaseStaticIp",
@ -2369,7 +2369,7 @@
{"shape":"AccountSetupInProgressException"},
{"shape":"UnauthenticatedException"}
],
"documentation":"<p>Sets the IP address type for a Amazon Lightsail resource.</p> <p>Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.</p>"
"documentation":"<p>Sets the IP address type for an Amazon Lightsail resource.</p> <p>Use this action to enable dual-stack for a resource, which enables IPv4 and IPv6 for the specified resource. Alternately, you can use this action to disable dual-stack, and enable IPv4 only.</p>"
},
"StartInstance":{
"name":"StartInstance",
@ -3783,23 +3783,23 @@
"members":{
"healthyThreshold":{
"shape":"integer",
"documentation":"<p>The number of consecutive health checks successes required before moving the container to the <code>Healthy</code> state.</p>"
"documentation":"<p>The number of consecutive health checks successes required before moving the container to the <code>Healthy</code> state. The default value is <code>2</code>.</p>"
},
"unhealthyThreshold":{
"shape":"integer",
"documentation":"<p>The number of consecutive health check failures required before moving the container to the <code>Unhealthy</code> state.</p>"
"documentation":"<p>The number of consecutive health check failures required before moving the container to the <code>Unhealthy</code> state. The default value is <code>2</code>.</p>"
},
"timeoutSeconds":{
"shape":"integer",
"documentation":"<p>The amount of time, in seconds, during which no response means a failed health check. You may specify between 2 and 60 seconds.</p>"
"documentation":"<p>The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is <code>2</code>.</p>"
},
"intervalSeconds":{
"shape":"integer",
"documentation":"<p>The approximate interval, in seconds, between health checks of an individual container. You may specify between 5 and 300 seconds.</p>"
"documentation":"<p>The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is <code>5</code>.</p>"
},
"path":{
"shape":"string",
"documentation":"<p>The path on the container on which to perform the health check.</p>"
"documentation":"<p>The path on the container on which to perform the health check. The default value is <code>/</code>.</p>"
},
"successCodes":{
"shape":"string",
@ -4764,7 +4764,7 @@
"members":{
"relationalDatabaseName":{
"shape":"ResourceName",
"documentation":"<p>The name to use for your new database.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 2 to 255 alphanumeric characters, or hyphens.</p> </li> <li> <p>The first and last character must be a letter or number.</p> </li> </ul>"
"documentation":"<p>The name to use for your new Lightsail database resource.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 2 to 255 alphanumeric characters, or hyphens.</p> </li> <li> <p>The first and last character must be a letter or number.</p> </li> </ul>"
},
"availabilityZone":{
"shape":"string",
@ -5535,7 +5535,7 @@
},
"progress":{
"shape":"string",
"documentation":"<p>The progress of the disk snapshot operation.</p>"
"documentation":"<p>The progress of the snapshot.</p>"
},
"fromDiskName":{
"shape":"ResourceName",
@ -7921,7 +7921,7 @@
},
"progress":{
"shape":"string",
"documentation":"<p>The progress of the snapshot.</p>"
"documentation":"<p>The progress of the snapshot.</p> <note> <p>This is populated only for disk snapshots, and is <code>null</code> for instance snapshots.</p> </note>"
},
"fromAttachedDisks":{
"shape":"DiskList",
@ -8351,7 +8351,7 @@
},
"failureReason":{
"shape":"LoadBalancerTlsCertificateFailureReason",
"documentation":"<p>The validation failure reason, if any, of the certificate.</p> <p>The following failure reasons are possible:</p> <ul> <li> <p> <b> <code>NO_AVAILABLE_CONTACTS</code> </b> - This failure applies to email validation, which is not available for Lightsail certificates.</p> </li> <li> <p> <b> <code>ADDITIONAL_VERIFICATION_REQUIRED</code> </b> - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the <a href=\"https://console.aws.amazon.com/support/home\">AWS Support Center</a> to contact AWS Support.</p> <note> <p>You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.</p> </note> </li> <li> <p> <b> <code>DOMAIN_NOT_ALLOWED</code> </b> - One or more of the domain names in the certificate request was reported as an unsafe domain by <a href=\"https://www.virustotal.com/gui/home/url\">VirusTotal</a>. To correct the problem, search for your domain name on the <a href=\"https://www.virustotal.com/gui/home/url\">VirusTotal</a> website. If your domain is reported as suspicious, see <a href=\"https://www.google.com/webmasters/hacked/?hl=en\">Google Help for Hacked Websites</a> to learn what you can do.</p> <p>If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.</p> <p>If you see this error and your domain is not included in the VirusTotal list, visit the <a href=\"https://console.aws.amazon.com/support/home\">AWS Support Center</a> and create a case.</p> </li> <li> <p> <b> <code>INVALID_PUBLIC_DOMAIN</code> </b> - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for <code>example.invalidpublicdomain</code> because <code>invalidpublicdomain</code> is not a valid top-level domain.</p> </li> <li> <p> <b> <code>OTHER</code> </b> - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request. </p> </li> </ul>"
"documentation":"<p>The validation failure reason, if any, of the certificate.</p> <p>The following failure reasons are possible:</p> <ul> <li> <p> <b> <code>NO_AVAILABLE_CONTACTS</code> </b> - This failure applies to email validation, which is not available for Lightsail certificates.</p> </li> <li> <p> <b> <code>ADDITIONAL_VERIFICATION_REQUIRED</code> </b> - Lightsail requires additional information to process this certificate request. This can happen as a fraud-protection measure, such as when the domain ranks within the Alexa top 1000 websites. To provide the required information, use the <a href=\"https://console.aws.amazon.com/support/home\">AWS Support Center</a> to contact AWS Support.</p> <note> <p>You cannot request a certificate for Amazon-owned domain names such as those ending in amazonaws.com, cloudfront.net, or elasticbeanstalk.com.</p> </note> </li> <li> <p> <b> <code>DOMAIN_NOT_ALLOWED</code> </b> - One or more of the domain names in the certificate request was reported as an unsafe domain by <a href=\"https://www.virustotal.com/gui/home/url\">VirusTotal</a>. To correct the problem, search for your domain name on the <a href=\"https://www.virustotal.com/gui/home/url\">VirusTotal</a> website. If your domain is reported as suspicious, see <a href=\"https://developers.google.com/web/fundamentals/security/hacked\">Google Help for Hacked Websites</a> to learn what you can do.</p> <p>If you believe that the result is a false positive, notify the organization that is reporting the domain. VirusTotal is an aggregate of several antivirus and URL scanners and cannot remove your domain from a block list itself. After you correct the problem and the VirusTotal registry has been updated, request a new certificate.</p> <p>If you see this error and your domain is not included in the VirusTotal list, visit the <a href=\"https://console.aws.amazon.com/support/home\">AWS Support Center</a> and create a case.</p> </li> <li> <p> <b> <code>INVALID_PUBLIC_DOMAIN</code> </b> - One or more of the domain names in the certificate request is not valid. Typically, this is because a domain name in the request is not a valid top-level domain. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request, and ensure that all domain names in the request are for valid top-level domains. For example, you cannot request a certificate for <code>example.invalidpublicdomain</code> because <code>invalidpublicdomain</code> is not a valid top-level domain.</p> </li> <li> <p> <b> <code>OTHER</code> </b> - Typically, this failure occurs when there is a typographical error in one or more of the domain names in the certificate request. Try to request a certificate again, correcting any spelling errors or typos that were in the failed request. </p> </li> </ul>"
},
"issuedAt":{
"shape":"IsoDate",

27
botocore/data/lookoutvision/2020-11-20/service-2.json
View file

@ -88,7 +88,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Deletes an existing Amazon Lookout for Vision <code>dataset</code>. </p> <p>If your the project has a single dataset, you must create a new dataset before you can create a model.</p> <p>If you project has a training dataset and a test dataset consider the following. </p> <ul> <li> <p>If you delete the test dataset, your project reverts to a single dataset project. If you then train the model, Amazon Lookout for Vision internally splits the remaining dataset into a training and test dataset.</p> </li> <li> <p>If you delete the training dataset, you must create a training dataset before you can create a model.</p> </li> </ul> <p>It might take a while to delete the dataset. To check the current status, check the <code>Status</code> field in the response from a call to <a>DescribeDataset</a>. </p> <p>This operation requires permissions to perform the <code>lookoutvision:DeleteDataset</code> operation.</p>"
"documentation":"<p>Deletes an existing Amazon Lookout for Vision <code>dataset</code>. </p> <p>If your the project has a single dataset, you must create a new dataset before you can create a model.</p> <p>If you project has a training dataset and a test dataset consider the following. </p> <ul> <li> <p>If you delete the test dataset, your project reverts to a single dataset project. If you then train the model, Amazon Lookout for Vision internally splits the remaining dataset into a training and test dataset.</p> </li> <li> <p>If you delete the training dataset, you must create a training dataset before you can create a model.</p> </li> </ul> <p>This operation requires permissions to perform the <code>lookoutvision:DeleteDataset</code> operation.</p>"
},
"DeleteModel":{
"name":"DeleteModel",
@ -107,7 +107,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model, use the <a>StopModel</a> operation.</p> <p>This operation requires permissions to perform the <code>lookoutvision:DeleteModel</code> operation.</p>"
"documentation":"<p>Deletes an Amazon Lookout for Vision model. You can't delete a running model. To stop a running model, use the <a>StopModel</a> operation.</p> <p>It might take a few seconds to delete a model. To determine if a model has been deleted, call <a>ListProjects</a> and check if the version of the model (<code>ModelVersion</code>) is in the <code>Models</code> array. </p> <p>This operation requires permissions to perform the <code>lookoutvision:DeleteModel</code> operation.</p>"
},
"DeleteProject":{
"name":"DeleteProject",
@ -289,7 +289,7 @@
{"shape":"ThrottlingException"},
{"shape":"ServiceQuotaExceededException"}
],
"documentation":"<p>Starts the running of the version of an Amazon Lookout for Vision model. Starting a model takes a while to complete. To check the current state of the model, use <a>DescribeModel</a>.</p> <p>Once the model is running, you can detect custom labels in new images by calling <a>DetectAnomalies</a>.</p> <note> <p>You are charged for the amount of time that the model is running. To stop a running model, call <a>StopModel</a>.</p> </note> <p>This operation requires permissions to perform the <code>lookoutvision:StartModel</code> operation.</p>"
"documentation":"<p>Starts the running of the version of an Amazon Lookout for Vision model. Starting a model takes a while to complete. To check the current state of the model, use <a>DescribeModel</a>.</p> <p>A model is ready to use when its status is <code>HOSTED</code>.</p> <p>Once the model is running, you can detect custom labels in new images by calling <a>DetectAnomalies</a>.</p> <note> <p>You are charged for the amount of time that the model is running. To stop a running model, call <a>StopModel</a>.</p> </note> <p>This operation requires permissions to perform the <code>lookoutvision:StartModel</code> operation.</p>"
},
"StopModel":{
"name":"StopModel",
@ -308,7 +308,7 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"}
],
"documentation":"<p>Stops a running model. The operation might take a while to complete. To check the current status, call <a>DescribeModel</a>. </p> <p>This operation requires permissions to perform the <code>lookoutvision:StopModel</code> operation.</p>"
"documentation":"<p>Stops the hosting of a running model. The operation might take a while to complete. To check the current status, call <a>DescribeModel</a>. </p> <p>After the model hosting stops, the <code>Status</code> of the model is <code>TRAINED</code>.</p> <p>This operation requires permissions to perform the <code>lookoutvision:StopModel</code> operation.</p>"
},
"TagResource":{
"name":"TagResource",
@ -488,7 +488,7 @@
},
"KmsKeyId":{
"shape":"KmsKeyId",
"documentation":"<p>The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for encypting the model. If this parameter is not specified, the model is encrypted by a key that AWS owns and manages.</p>"
"documentation":"<p>The identifier for your AWS Key Management Service (AWS KMS) customer master key (CMK). The key is used to encrypt training and test images copied into the service for model training. Your source images are unaffected. If this parameter is not specified, the copied images are encrypted by a key that AWS owns and manages.</p>"
},
"Tags":{
"shape":"TagList",
@ -879,7 +879,7 @@
"shape":"ContentType",
"documentation":"<p>The type of the image passed in <code>Body</code>. Valid values are <code>image/png</code> (PNG format images) and <code>image/jpeg</code> (JPG format images). </p>",
"location":"header",
"locationName":"content-type"
"locationName":"Content-Type"
}
},
"payload":"Body"
@ -1206,10 +1206,11 @@
"ModelHostingStatus":{
"type":"string",
"enum":[
"RUNNING",
"STARTING",
"STOPPED",
"FAILED"
"STARTING_HOSTING",
"HOSTED",
"HOSTING_FAILED",
"STOPPING_HOSTING",
"SYSTEM_UPDATING"
]
},
"ModelMetadata":{
@ -1434,14 +1435,14 @@
"members":{
"Bucket":{
"shape":"S3BucketName",
"documentation":"<p>The S3 bucket that contain the manifest file.</p>"
"documentation":"<p>The S3 bucket that contains the training output.</p>"
},
"Prefix":{
"shape":"S3KeyPrefix",
"documentation":"<p>The path and name of the manifest file with the S3 bucket.</p>"
"documentation":"<p>The path of the folder, within the S3 bucket, that contains the training output.</p>"
}
},
"documentation":"<p>Information about the location of a manifest file.</p>"
"documentation":"<p>Information about the location training output.</p>"
},
"S3ObjectKey":{
"type":"string",

20
botocore/data/macie/2017-12-19/service-2.json
View file

@ -40,7 +40,7 @@
{"shape":"LimitExceededException"},
{"shape":"InternalException"}
],
"documentation":"<p>Associates specified S3 resources with Amazon Macie Classic for monitoring and data classification. If memberAccountId isn't specified, the action associates specified S3 resources with Macie Classic for the current master account. If memberAccountId is specified, the action associates specified S3 resources with Macie Classic for the specified member account. </p>"
"documentation":"<p>Associates specified S3 resources with Amazon Macie Classic for monitoring and data classification. If memberAccountId isn't specified, the action associates specified S3 resources with Macie Classic for the current Macie Classic administrator account. If memberAccountId is specified, the action associates specified S3 resources with Macie Classic for the specified member account. </p>"
},
"DisassociateMemberAccount":{
"name":"DisassociateMemberAccount",
@ -68,7 +68,7 @@
{"shape":"AccessDeniedException"},
{"shape":"InternalException"}
],
"documentation":"<p>Removes specified S3 resources from being monitored by Amazon Macie Classic. If memberAccountId isn't specified, the action removes specified S3 resources from Macie Classic for the current master account. If memberAccountId is specified, the action removes specified S3 resources from Macie Classic for the specified member account.</p>"
"documentation":"<p>Removes specified S3 resources from being monitored by Amazon Macie Classic. If memberAccountId isn't specified, the action removes specified S3 resources from Macie Classic for the current Macie Classic administrator account. If memberAccountId is specified, the action removes specified S3 resources from Macie Classic for the specified member account.</p>"
},
"ListMemberAccounts":{
"name":"ListMemberAccounts",
@ -82,7 +82,7 @@
{"shape":"InternalException"},
{"shape":"InvalidInputException"}
],
"documentation":"<p>Lists all Amazon Macie Classic member accounts for the current Amazon Macie Classic master account.</p>"
"documentation":"<p>Lists all Amazon Macie Classic member accounts for the current Macie Classic administrator account.</p>"
},
"ListS3Resources":{
"name":"ListS3Resources",
@ -97,7 +97,7 @@
{"shape":"AccessDeniedException"},
{"shape":"InternalException"}
],
"documentation":"<p>Lists all the S3 resources associated with Amazon Macie Classic. If memberAccountId isn't specified, the action lists the S3 resources associated with Amazon Macie Classic for the current master account. If memberAccountId is specified, the action lists the S3 resources associated with Amazon Macie Classic for the specified member account. </p>"
"documentation":"<p>Lists all the S3 resources associated with Amazon Macie Classic. If memberAccountId isn't specified, the action lists the S3 resources associated with Macie Classic for the current Macie Classic administrator account. If memberAccountId is specified, the action lists the S3 resources associated with Macie Classic for the specified member account. </p>"
},
"UpdateS3Resources":{
"name":"UpdateS3Resources",
@ -112,7 +112,7 @@
{"shape":"AccessDeniedException"},
{"shape":"InternalException"}
],
"documentation":"<p>Updates the classification types for the specified S3 resources. If memberAccountId isn't specified, the action updates the classification types of the S3 resources associated with Amazon Macie Classic for the current master account. If memberAccountId is specified, the action updates the classification types of the S3 resources associated with Amazon Macie Classic for the specified member account. </p>"
"documentation":"<p>Updates the classification types for the specified S3 resources. If memberAccountId isn't specified, the action updates the classification types of the S3 resources associated with Amazon Macie Classic for the current Macie Classic administrator account. If memberAccountId is specified, the action updates the classification types of the S3 resources associated with Macie Classic for the specified member account. </p>"
}
},
"shapes":{
@ -179,7 +179,7 @@
},
"continuous":{
"shape":"S3ContinuousClassificationType",
"documentation":"<p>A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie Classic begins performing continuous classification after a bucket is successfully associated with Amazon Macie Classic. </p>"
"documentation":"<p>A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie Classic begins performing continuous classification after a bucket is successfully associated with Macie Classic. </p>"
}
},
"documentation":"<p>The classification type that Amazon Macie Classic applies to the associated S3 resources. </p>"
@ -193,7 +193,7 @@
},
"continuous":{
"shape":"S3ContinuousClassificationType",
"documentation":"<p>A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie Classic begins performing continuous classification after a bucket is successfully associated with Amazon Macie Classic. </p>"
"documentation":"<p>A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie Classic begins performing continuous classification after a bucket is successfully associated with Macie Classic. </p>"
}
},
"documentation":"<p>The classification type that Amazon Macie Classic applies to the associated S3 resources. At least one of the classification types (oneTime or continuous) must be specified. </p>"
@ -214,7 +214,7 @@
"members":{
"memberAccountId":{
"shape":"AWSAccountId",
"documentation":"<p>The ID of the Amazon Macie Classic member account whose resources you want to remove from being monitored by Amazon Macie Classic. </p>"
"documentation":"<p>The ID of the Amazon Macie Classic member account whose resources you want to remove from being monitored by Macie Classic. </p>"
},
"associatedS3Resources":{
"shape":"S3Resources",
@ -315,7 +315,7 @@
"members":{
"memberAccounts":{
"shape":"MemberAccounts",
"documentation":"<p>A list of the Amazon Macie Classic member accounts returned by the action. The current master account is also included in this list. </p>"
"documentation":"<p>A list of the Amazon Macie Classic member accounts returned by the action. The current Macie Classic administrator account is also included in this list. </p>"
},
"nextToken":{
"shape":"NextToken",
@ -491,5 +491,5 @@
}
}
},
"documentation":"<fullname>Amazon Macie Classic</fullname> <p>Amazon Macie Classic is a security service that uses machine learning to automatically discover, classify, and protect sensitive data in AWS. Macie Classic recognizes sensitive data such as personally identifiable information (PII) or intellectual property, and provides you with dashboards and alerts that give visibility into how this data is being accessed or moved. For more information, see the <a href=\"https://docs.aws.amazon.com/macie/latest/userguide/what-is-macie.html\">Amazon Macie Classic User Guide</a>. </p> <p>A new Amazon Macie is now available with significant design improvements and additional features, at a lower price and in most AWS Regions. We encourage you to explore and use the new and improved features, and benefit from the reduced cost. To learn about features and pricing for the new Amazon Macie, see <a href=\"https://aws.amazon.com/macie/\">Amazon Macie</a>.</p>"
"documentation":"<fullname>Amazon Macie Classic</fullname> <p>Amazon Macie Classic is a security service that uses machine learning to automatically discover, classify, and protect sensitive data in AWS. Macie Classic recognizes sensitive data such as personally identifiable information (PII) or intellectual property, and provides you with dashboards and alerts that give visibility into how this data is being accessed or moved. For more information, see the <a href=\"https://docs.aws.amazon.com/macie/latest/userguide/what-is-macie.html\">Amazon Macie Classic User Guide</a>. </p>"
}

5
botocore/data/macie2/2020-01-01/paginators-1.json
View file

@ -10,7 +10,10 @@
"input_token": "nextToken",
"output_token": "nextToken",
"limit_key": "maxResults",
"result_key": "records"
"result_key": "records",
"non_aggregate_keys": [
"timeRange"
]
},
"ListClassificationJobs": {
"input_token": "nextToken",

499
botocore/data/macie2/2020-01-01/service-2.json
View file

@ -284,7 +284,7 @@
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
}
],
"documentation": " <p>Sends an Amazon Macie membership invitation to one or more accounts.</p>"
"documentation": "<p>Sends an Amazon Macie membership invitation to one or more accounts.</p>"
},
"CreateMember": {
"name": "CreateMember",
@ -330,7 +330,7 @@
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
}
],
"documentation": " <p>Associates an account with an Amazon Macie master account.</p>"
"documentation": "<p>Associates an account with an Amazon Macie administrator account.</p>"
},
"CreateSampleFindings": {
"name": "CreateSampleFindings",
@ -606,7 +606,7 @@
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
}
],
"documentation": "<p>Deletes the association between an Amazon Macie master account and an account.</p>"
"documentation": "<p>Deletes the association between an Amazon Macie administrator account and an account.</p>"
},
"DescribeBuckets": {
"name": "DescribeBuckets",
@ -838,6 +838,51 @@
],
"documentation": "<p>Disables an account as the delegated Amazon Macie administrator account for an AWS organization.</p>"
},
"DisassociateFromAdministratorAccount": {
"name": "DisassociateFromAdministratorAccount",
"http": {
"method": "POST",
"requestUri": "/administrator/disassociate",
"responseCode": 200
},
"input": {
"shape": "DisassociateFromAdministratorAccountRequest"
},
"output": {
"shape": "DisassociateFromAdministratorAccountResponse"
},
"errors": [
{
"shape": "ValidationException",
"documentation": "<p>The request failed because it contains a syntax error.</p>"
},
{
"shape": "InternalServerException",
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
},
{
"shape": "ServiceQuotaExceededException",
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
},
{
"shape": "AccessDeniedException",
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
},
{
"shape": "ResourceNotFoundException",
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
},
{
"shape": "ThrottlingException",
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
},
{
"shape": "ConflictException",
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
}
],
"documentation": "<p>Disassociates a member account from its Amazon Macie administrator account.</p>"
},
"DisassociateFromMasterAccount": {
"name": "DisassociateFromMasterAccount",
"http": {
@ -882,7 +927,7 @@
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
}
],
"documentation": "<p>Disassociates a member account from its Amazon Macie master account.</p>"
"documentation": "<p>(Deprecated) Disassociates a member account from its Amazon Macie administrator account. This operation has been replaced by the <link linkend=\"DisassociateFromAdministratorAccount\">DisassociateFromAdministratorAccount</link> operation.</p>"
},
"DisassociateMember": {
"name": "DisassociateMember",
@ -928,7 +973,7 @@
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
}
],
"documentation": "<p>Disassociates an Amazon Macie master account from a member account.</p>"
"documentation": "<p>Disassociates an Amazon Macie administrator account from a member account.</p>"
},
"EnableMacie": {
"name": "EnableMacie",
@ -1022,6 +1067,51 @@
],
"documentation": "<p>Designates an account as the delegated Amazon Macie administrator account for an AWS organization.</p>"
},
"GetAdministratorAccount": {
"name": "GetAdministratorAccount",
"http": {
"method": "GET",
"requestUri": "/administrator",
"responseCode": 200
},
"input": {
"shape": "GetAdministratorAccountRequest"
},
"output": {
"shape": "GetAdministratorAccountResponse"
},
"errors": [
{
"shape": "ValidationException",
"documentation": "<p>The request failed because it contains a syntax error.</p>"
},
{
"shape": "InternalServerException",
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
},
{
"shape": "ServiceQuotaExceededException",
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
},
{
"shape": "AccessDeniedException",
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
},
{
"shape": "ResourceNotFoundException",
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
},
{
"shape": "ThrottlingException",
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
},
{
"shape": "ConflictException",
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
}
],
"documentation": "<p>Retrieves information about the Amazon Macie administrator account for an account.</p>"
},
"GetBucketStatistics": {
"name": "GetBucketStatistics",
"http": {
@ -1298,6 +1388,52 @@
],
"documentation": "<p>Retrieves the criteria and other settings for a findings filter.</p>"
},
"GetFindingsPublicationConfiguration": {
"name": "GetFindingsPublicationConfiguration",
"http": {
"method": "GET",
"requestUri": "/findings-publication-configuration",
"responseCode": 200
},
"input": {
"shape": "GetFindingsPublicationConfigurationRequest"
},
"output": {
"shape": "GetFindingsPublicationConfigurationResponse",
"documentation": "<p>The request succeeded.</p>"
},
"errors": [
{
"shape": "ValidationException",
"documentation": "<p>The request failed because it contains a syntax error.</p>"
},
{
"shape": "InternalServerException",
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
},
{
"shape": "ServiceQuotaExceededException",
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
},
{
"shape": "AccessDeniedException",
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
},
{
"shape": "ResourceNotFoundException",
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
},
{
"shape": "ThrottlingException",
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
},
{
"shape": "ConflictException",
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
}
],
"documentation": "<p>Retrieves the configuration settings for publishing findings to AWS Security Hub.</p>"
},
"GetInvitationsCount": {
"name": "GetInvitationsCount",
"http": {
@ -1434,7 +1570,7 @@
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
}
],
"documentation": "<p>Retrieves information about the Amazon Macie master account for an account.</p>"
"documentation": "<p>(Deprecated) Retrieves information about the Amazon Macie administrator account for an account. This operation has been replaced by the <link linkend=\"GetAdministratorAccount\">GetAdministratorAccount</link> operation.</p>"
},
"GetMember": {
"name": "GetMember",
@ -1480,7 +1616,7 @@
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
}
],
"documentation": "<p>Retrieves information about a member account that's associated with an Amazon Macie master account.</p>"
"documentation": "<p>Retrieves information about an account that's associated with an Amazon Macie administrator account.</p>"
},
"GetUsageStatistics": {
"name": "GetUsageStatistics",
@ -1848,7 +1984,7 @@
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
}
],
"documentation": "<p>Retrieves information about the accounts that are associated with an Amazon Macie master account.</p>"
"documentation": "<p>Retrieves information about the accounts that are associated with an Amazon Macie administrator account.</p>"
},
"ListOrganizationAdminAccounts": {
"name": "ListOrganizationAdminAccounts",
@ -1959,6 +2095,52 @@
],
"documentation": "<p>Creates or updates the configuration settings for storing data classification results.</p>"
},
"PutFindingsPublicationConfiguration": {
"name": "PutFindingsPublicationConfiguration",
"http": {
"method": "PUT",
"requestUri": "/findings-publication-configuration",
"responseCode": 200
},
"input": {
"shape": "PutFindingsPublicationConfigurationRequest"
},
"output": {
"shape": "PutFindingsPublicationConfigurationResponse",
"documentation": "<p>The request succeeded and there isn't any content to include in the body of the response (No Content).</p>"
},
"errors": [
{
"shape": "ValidationException",
"documentation": "<p>The request failed because it contains a syntax error.</p>"
},
{
"shape": "InternalServerException",
"documentation": "<p>The request failed due to an unknown internal server error, exception, or failure.</p>"
},
{
"shape": "ServiceQuotaExceededException",
"documentation": "<p>The request failed because fulfilling the request would exceed one or more service quotas for your account.</p>"
},
{
"shape": "AccessDeniedException",
"documentation": "<p>The request was denied because you don't have sufficient access to the specified resource.</p>"
},
{
"shape": "ResourceNotFoundException",
"documentation": "<p>The request failed because the specified resource wasn't found.</p>"
},
{
"shape": "ThrottlingException",
"documentation": "<p>The request failed because you sent too many requests during a certain amount of time.</p>"
},
{
"shape": "ConflictException",
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
}
],
"documentation": "<p>Updates the configuration settings for publishing findings to AWS Security Hub.</p>"
},
"TagResource": {
"name": "TagResource",
"http": {
@ -2221,7 +2403,7 @@
"documentation": "<p>The request failed because it conflicts with the current state of the specified resource.</p>"
}
],
"documentation": " <p>Enables an Amazon Macie master account to suspend or re-enable a member account.</p>"
"documentation": "<p>Enables an Amazon Macie administrator to suspend or re-enable a member account.</p>"
},
"UpdateOrganizationConfiguration": {
"name": "UpdateOrganizationConfiguration",
@ -2274,6 +2456,11 @@
"AcceptInvitationRequest": {
"type": "structure",
"members": {
"administratorAccountId": {
"shape": "__string",
"locationName": "administratorAccountId",
"documentation": "<p>The AWS account ID for the account that sent the invitation.</p>"
},
"invitationId": {
"shape": "__string",
"locationName": "invitationId",
@ -2282,11 +2469,10 @@
"masterAccount": {
"shape": "__string",
"locationName": "masterAccount",
"documentation": "<p>The AWS account ID for the account that sent the invitation.</p>"
"documentation": "<p>(Deprecated) The AWS account ID for the account that sent the invitation. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.</p>"
}
},
"required": [
"masterAccount",
"invitationId"
]
},
@ -2339,7 +2525,7 @@
"documentation": "<p>The email address for the account.</p>"
}
},
"documentation": "<p>Specifies details for an account to associate with an Amazon Macie master account.</p>",
"documentation": "<p>Specifies details for an account to associate with an Amazon Macie administrator account.</p>",
"required": [
"email",
"accountId"
@ -2351,10 +2537,10 @@
"blockPublicAccess": {
"shape": "BlockPublicAccess",
"locationName": "blockPublicAccess",
"documentation": "<p>The block public access settings for the bucket.</p>"
"documentation": "<p>The block public access settings for the AWS account that owns the bucket.</p>"
}
},
"documentation": "<p>Provides information about account-level permissions settings that apply to an S3 bucket.</p>"
"documentation": "<p>Provides information about the account-level permissions settings that apply to an S3 bucket.</p>"
},
"AdminAccount": {
"type": "structure",
@ -2367,14 +2553,14 @@
"status": {
"shape": "AdminStatus",
"locationName": "status",
"documentation": "<p>The current status of the account as a delegated administrator of Amazon Macie for the organization.</p>"
"documentation": "<p>The current status of the account as the delegated administrator of Amazon Macie for the organization.</p>"
}
},
"documentation": "<p>Provides information about the delegated Amazon Macie administrator account for an AWS organization.</p>"
},
"AdminStatus": {
"type": "string",
"documentation": "<p>The current status of an account as the delegated Amazon Macie administrator account for an AWS organization.</p>",
"documentation": "<p>The current status of an account as the delegated Amazon Macie administrator account for an AWS organization. Possible values are:</p>",
"enum": [
"ENABLED",
"DISABLING_IN_PROGRESS"
@ -2583,20 +2769,20 @@
"kmsManaged": {
"shape": "__long",
"locationName": "kmsManaged",
"documentation": " <p>The total number of buckets that use an AWS Key Management Service (AWS KMS) customer master key (CMK) by default to encrypt objects. These buckets use AWS managed AWS KMS (AWS-KMS) encryption or customer managed AWS KMS (SSE-KMS) encryption.</p>"
"documentation": " <p>The total number of buckets that use an AWS Key Management Service (AWS KMS) customer master key (CMK) to encrypt new objects by default. These buckets use AWS managed AWS KMS encryption (AWS-KMS) or customer managed AWS KMS encryption (SSE-KMS).</p>"
},
"s3Managed": {
"shape": "__long",
"locationName": "s3Managed",
"documentation": "<p>The total number of buckets that use an Amazon S3 managed key by default to encrypt objects. These buckets use Amazon S3 managed (SSE-S3) encryption.</p>"
"documentation": "<p>The total number of buckets that use an Amazon S3 managed key to encrypt new objects by default. These buckets use Amazon S3 managed encryption (SSE-S3).</p>"
},
"unencrypted": {
"shape": "__long",
"locationName": "unencrypted",
"documentation": "<p>The total number of buckets that don't encrypt objects by default. Default encryption is disabled for these buckets.</p>"
"documentation": "<p>The total number of buckets that don't encrypt new objects by default. Default encryption is disabled for these buckets.</p>"
}
},
"documentation": "<p>Provides information about the number of S3 buckets that use certain types of server-side encryption or don't encrypt objects by default.</p>"
"documentation": "<p>Provides information about the number of S3 buckets that use certain types of server-side encryption by default or don't encrypt new objects by default.</p>"
},
"BucketCountBySharedAccessType": {
"type": "structure",
@ -2727,7 +2913,7 @@
"classifiableSizeInBytes": {
"shape": "__long",
"locationName": "classifiableSizeInBytes",
"documentation": "<p>The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.</p>"
"documentation": "<p>The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.</p> <p>If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.</p>"
},
"jobDetails": {
"shape": "JobDetails",
@ -2737,7 +2923,7 @@
"lastUpdated": {
"shape": "__timestampIso8601",
"locationName": "lastUpdated",
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved data about the bucket from Amazon S3.</p>"
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved both bucket and object metadata from Amazon S3 for the bucket.</p>"
},
"objectCount": {
"shape": "__long",
@ -2752,7 +2938,7 @@
"publicAccess": {
"shape": "BucketPublicAccess",
"locationName": "publicAccess",
"documentation": "<p>Specifies whether the bucket is publicly accessible. If this value is true, an access control list (ACL), bucket policy, or block public access settings allow the bucket to be accessed by the general public.</p>"
"documentation": "<p>Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket, and provides information about those settings.</p>"
},
"region": {
"shape": "__string",
@ -2764,6 +2950,11 @@
"locationName": "replicationDetails",
"documentation": "<p>Specifies whether the bucket is configured to replicate one or more objects to buckets for other AWS accounts and, if so, which accounts.</p>"
},
"serverSideEncryption": {
"shape": "BucketServerSideEncryption",
"locationName": "serverSideEncryption",
"documentation": "<p>Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side encryption that's used.</p>"
},
"sharedAccess": {
"shape": "SharedAccess",
"locationName": "sharedAccess",
@ -2772,12 +2963,12 @@
"sizeInBytes": {
"shape": "__long",
"locationName": "sizeInBytes",
"documentation": "<p>The total storage size, in bytes, of the bucket.</p>"
"documentation": "<p>The total storage size, in bytes, of the bucket.</p> <p>If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.</p>"
},
"sizeInBytesCompressed": {
"shape": "__long",
"locationName": "sizeInBytesCompressed",
"documentation": "<p>The total compressed storage size, in bytes, of the bucket.</p>"
"documentation": "<p>The total compressed storage size, in bytes, of the bucket.</p> <p>If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.</p>"
},
"tags": {
"shape": "__listOfKeyValuePair",
@ -2850,18 +3041,34 @@
},
"documentation": "<p>Provides information about the permissions settings that determine whether an S3 bucket is publicly accessible.</p>"
},
"BucketServerSideEncryption": {
"type": "structure",
"members": {
"kmsMasterKeyId": {
"shape": "__string",
"locationName": "kmsMasterKeyId",
"documentation": "<p>The Amazon Resource Name (ARN) or unique identifier (key ID) for the AWS Key Management Service (AWS KMS) customer master key (CMK) that's used by default to encrypt objects that are added to the bucket. This value is null if the bucket uses an Amazon S3 managed key to encrypt new objects or the bucket doesn't encrypt new objects by default.</p>"
},
"type": {
"shape": "Type",
"locationName": "type",
"documentation": "<p>The type of server-side encryption that's used by default when storing new objects in the bucket. Possible values are:</p> <ul><li><p>AES256 - New objects are encrypted with an Amazon S3 managed key and use Amazon S3 managed encryption (SSE-S3).</p></li> <li><p>aws:kms - New objects are encrypted with an AWS KMS CMK, specified by the kmsMasterKeyId property, and use AWS managed AWS KMS encryption (AWS-KMS) or customer managed AWS KMS encryption (SSE-KMS).</p></li> <li><p>NONE - New objects aren't encrypted by default. Default encryption is disabled for the bucket.</p></li></ul>"
}
},
"documentation": "<p>Provides information about the default server-side encryption settings for an S3 bucket. For detailed information about these settings, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucket-encryption.html\">Setting default server-side encryption behavior for Amazon S3 buckets</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>"
},
"BucketSortCriteria": {
"type": "structure",
"members": {
"attributeName": {
"shape": "__string",
"locationName": "attributeName",
"documentation": "<p>The name of the property to sort the results by. This value can be the name of any property that Amazon Macie defines as bucket metadata, such as bucketName or accountId.</p>"
"documentation": "<p>The name of the bucket property to sort the results by. This value can be one of the following properties that Amazon Macie defines as bucket metadata: accountId, bucketName, classifiableObjectCount, classifiableSizeInBytes, objectCount, or sizeInBytes.</p>"
},
"orderBy": {
"shape": "OrderBy",
"locationName": "orderBy",
"documentation": "<p>The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.</p>"
"documentation": "<p>The sort order to apply to the results, based on the value specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.</p>"
}
},
"documentation": "<p>Specifies criteria for sorting the results of a query for information about S3 buckets.</p>"
@ -2882,7 +3089,7 @@
"columnName": {
"shape": "__string",
"locationName": "columnName",
"documentation": "<p>The name of the column that contains the data, if available.</p>"
"documentation": "<p>The name of the column that contains the data, if available. This value is also null if Amazon Macie detects sensitive data in the name of any column in the file.</p>"
},
"row": {
"shape": "__long",
@ -3236,7 +3443,7 @@
"account": {
"shape": "AccountDetail",
"locationName": "account",
"documentation": "<p>The details for the account to associate with the master account.</p>"
"documentation": "<p>The details for the account to associate with the administrator account.</p>"
},
"tags": {
"shape": "TagMap",
@ -3254,7 +3461,7 @@
"arn": {
"shape": "__string",
"locationName": "arn",
"documentation": "<p>The Amazon Resource Name (ARN) of the account that was associated with the master account.</p>"
"documentation": "<p>The Amazon Resource Name (ARN) of the account that was associated with the administrator account.</p>"
}
}
},
@ -3325,7 +3532,7 @@
},
"Currency": {
"type": "string",
"documentation": "<p>The type of currency that data for a usage metric is reported in. Possible values are:</p>",
"documentation": "<p>The type of currency that the data for an Amazon Macie usage metric is reported in. Possible values are:</p>",
"enum": [
"USD"
]
@ -3739,7 +3946,7 @@
"shape": "__string",
"location": "querystring",
"locationName": "adminAccountId",
"documentation": "<p>The AWS account ID of the delegated administrator account.</p>"
"documentation": "<p>The AWS account ID of the delegated Amazon Macie administrator account.</p>"
}
},
"required": [
@ -3750,6 +3957,14 @@
"type": "structure",
"members": {}
},
"DisassociateFromAdministratorAccountRequest": {
"type": "structure",
"members": {}
},
"DisassociateFromAdministratorAccountResponse": {
"type": "structure",
"members": {}
},
"DisassociateFromMasterAccountRequest": {
"type": "structure",
"members": {}
@ -3817,7 +4032,7 @@
"status": {
"shape": "MacieStatus",
"locationName": "status",
"documentation": "<p>Specifies the status for the account. To enable Amazon Macie and start all Amazon Macie activities for the account, set this value to ENABLED.</p>"
"documentation": "<p>Specifies the new status for the account. To enable Amazon Macie and start all Macie activities for the account, set this value to ENABLED.</p>"
}
}
},
@ -3860,7 +4075,7 @@
},
"ErrorCode": {
"type": "string",
"documentation": "<p>The source of an error, issue, or delay. Possible values are:</p>",
"documentation": "<p>The source of an issue or delay. Possible values are:</p>",
"enum": [
"ClientError",
"InternalError"
@ -4058,7 +4273,7 @@
},
"FindingPublishingFrequency": {
"type": "string",
"documentation": "<p>The frequency with which Amazon Macie publishes updates to policy findings for an account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events). Valid values are:</p>",
"documentation": "<p>The frequency with which Amazon Macie publishes updates to policy findings for an account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events). For more information, see <a href=\"https://docs.aws.amazon.com/macie/latest/user/findings-monitor.html\">Monitoring and processing findings</a> in the <i>Amazon Macie User Guide</i>. Valid values are:</p>",
"enum": [
"FIFTEEN_MINUTES",
"ONE_HOUR",
@ -4144,6 +4359,20 @@
},
"documentation": "<p>Provides information about a findings filter.</p>"
},
"GetAdministratorAccountRequest": {
"type": "structure",
"members": {}
},
"GetAdministratorAccountResponse": {
"type": "structure",
"members": {
"administrator": {
"shape": "Invitation",
"locationName": "administrator",
"documentation": "<p>The AWS account ID for the administrator account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.</p>"
}
}
},
"GetBucketStatisticsRequest": {
"type": "structure",
"members": {
@ -4170,7 +4399,7 @@
"bucketCountByEncryptionType": {
"shape": "BucketCountByEncryptionType",
"locationName": "bucketCountByEncryptionType",
"documentation": "<p>The total number of buckets, grouped by server-side encryption type. This object also reports the total number of buckets that don't encrypt objects by default.</p>"
"documentation": "<p>The total number of buckets, grouped by default server-side encryption type. This object also reports the total number of buckets that don't encrypt new objects by default.</p>"
},
"bucketCountBySharedAccessType": {
"shape": "BucketCountBySharedAccessType",
@ -4185,12 +4414,12 @@
"classifiableSizeInBytes": {
"shape": "__long",
"locationName": "classifiableSizeInBytes",
"documentation": "<p>The total storage size, in bytes, of all the objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.</p>"
"documentation": "<p>The total storage size, in bytes, of all the objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.</p> <p>If versioning is enabled for any of the buckets, Macie calculates this value based on the size of the latest version of each applicable object in those buckets. This value doesn't reflect the storage size of all versions of all applicable objects in the buckets.</p>"
},
"lastUpdated": {
"shape": "__timestampIso8601",
"locationName": "lastUpdated",
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved data about the buckets from Amazon S3.</p>"
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved both bucket and object metadata from Amazon S3 for the buckets.</p>"
},
"objectCount": {
"shape": "__long",
@ -4200,12 +4429,12 @@
"sizeInBytes": {
"shape": "__long",
"locationName": "sizeInBytes",
"documentation": "<p>The total storage size, in bytes, of the buckets.</p>"
"documentation": "<p>The total storage size, in bytes, of the buckets.</p> <p>If versioning is enabled for any of the buckets, Macie calculates this value based on the size of the latest version of each object in those buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.</p>"
},
"sizeInBytesCompressed": {
"shape": "__long",
"locationName": "sizeInBytesCompressed",
"documentation": "<p>The total compressed storage size, in bytes, of the buckets.</p>"
"documentation": "<p>The total compressed storage size, in bytes, of the buckets.</p> <p>If versioning is enabled for any of the buckets, Macie calculates this value based on the size of the latest version of each object in those buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.</p>"
},
"unclassifiableObjectCount": {
"shape": "ObjectLevelStatistics",
@ -4215,7 +4444,7 @@
"unclassifiableObjectSizeInBytes": {
"shape": "ObjectLevelStatistics",
"locationName": "unclassifiableObjectSizeInBytes",
"documentation": "<p>The total storage size, in bytes, of all the objects that Amazon Macie can't analyze in the buckets. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.</p>"
"documentation": "<p>The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the buckets. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.</p>"
}
}
},
@ -4404,6 +4633,20 @@
}
}
},
"GetFindingsPublicationConfigurationRequest": {
"type": "structure",
"members": {}
},
"GetFindingsPublicationConfigurationResponse": {
"type": "structure",
"members": {
"securityHubConfiguration": {
"shape": "SecurityHubConfiguration",
"locationName": "securityHubConfiguration",
"documentation": "<p>The configuration settings that determine which findings are published to AWS Security Hub.</p>"
}
}
},
"GetFindingsRequest": {
"type": "structure",
"members": {
@ -4461,22 +4704,22 @@
"findingPublishingFrequency": {
"shape": "FindingPublishingFrequency",
"locationName": "findingPublishingFrequency",
"documentation": "<p>The frequency with which Amazon Macie publishes updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).</p>"
"documentation": "<p>The frequency with which Macie publishes updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).</p>"
},
"serviceRole": {
"shape": "__string",
"locationName": "serviceRole",
"documentation": "<p>The Amazon Resource Name (ARN) of the service-linked role that allows Amazon Macie to monitor and analyze data in AWS resources for the account.</p>"
"documentation": "<p>The Amazon Resource Name (ARN) of the service-linked role that allows Macie to monitor and analyze data in AWS resources for the account.</p>"
},
"status": {
"shape": "MacieStatus",
"locationName": "status",
"documentation": "<p>The current status of the Amazon Macie account. Possible values are: PAUSED, the account is enabled but all Amazon Macie activities are suspended (paused) for the account; and, ENABLED, the account is enabled and all Amazon Macie activities are enabled for the account.</p>"
"documentation": "<p>The current status of the Macie account. Possible values are: PAUSED, the account is enabled but all Macie activities are suspended (paused) for the account; and, ENABLED, the account is enabled and all Macie activities are enabled for the account.</p>"
},
"updatedAt": {
"shape": "__timestampIso8601",
"locationName": "updatedAt",
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the Amazon Macie account.</p>"
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the Macie account.</p>"
}
}
},
@ -4490,7 +4733,7 @@
"master": {
"shape": "Invitation",
"locationName": "master",
"documentation": "<p>The AWS account ID for the master account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent and accepted to establish the relationship between the accounts.</p>"
"documentation": "<p>(Deprecated) The AWS account ID for the administrator account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.</p>"
}
}
},
@ -4516,6 +4759,11 @@
"locationName": "accountId",
"documentation": "<p>The AWS account ID for the account.</p>"
},
"administratorAccountId": {
"shape": "__string",
"locationName": "administratorAccountId",
"documentation": "<p>The AWS account ID for the administrator account.</p>"
},
"arn": {
"shape": "__string",
"locationName": "arn",
@ -4534,12 +4782,12 @@
"masterAccountId": {
"shape": "__string",
"locationName": "masterAccountId",
"documentation": "<p>The AWS account ID for the master account.</p>"
"documentation": "<p>(Deprecated) The AWS account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.</p>"
},
"relationshipStatus": {
"shape": "RelationshipStatus",
"locationName": "relationshipStatus",
"documentation": "<p>The current status of the relationship between the account and the master account.</p>"
"documentation": "<p>The current status of the relationship between the account and the administrator account.</p>"
},
"tags": {
"shape": "TagMap",
@ -4549,7 +4797,7 @@
"updatedAt": {
"shape": "__timestampIso8601",
"locationName": "updatedAt",
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the master account.</p>"
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account.</p>"
}
}
},
@ -4559,7 +4807,7 @@
"filterBy": {
"shape": "__listOfUsageStatisticsFilter",
"locationName": "filterBy",
"documentation": "<p>An array of objects, one for each condition to use to filter the query results. If the array contains more than one object, Amazon Macie uses an AND operator to join the conditions specified by the objects.</p>"
"documentation": "<p>An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.</p>"
},
"maxResults": {
"shape": "__integer",
@ -4575,6 +4823,11 @@
"shape": "UsageStatisticsSortBy",
"locationName": "sortBy",
"documentation": "<p>The criteria to use to sort the query results.</p>"
},
"timeRange": {
"shape": "TimeRange",
"locationName": "timeRange",
"documentation": "<p>The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value, Amazon Macie provides usage data for the preceding 30 days.</p>"
}
}
},
@ -4590,16 +4843,33 @@
"shape": "__listOfUsageRecord",
"locationName": "records",
"documentation": "<p>An array of objects that contains the results of the query. Each object contains the data for an account that meets the filter criteria specified in the request.</p>"
},
"timeRange": {
"shape": "TimeRange",
"locationName": "timeRange",
"documentation": "<p>The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.</p>"
}
}
},
"GetUsageTotalsRequest": {
"type": "structure",
"members": {}
"members": {
"timeRange": {
"shape": "__string",
"location": "querystring",
"locationName": "timeRange",
"documentation": "<p>The inclusive time period to retrieve the data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value for this parameter, Amazon Macie provides aggregated usage data for the preceding 30 days.</p>"
}
}
},
"GetUsageTotalsResponse": {
"type": "structure",
"members": {
"timeRange": {
"shape": "TimeRange",
"locationName": "timeRange",
"documentation": "<p>The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.</p>"
},
"usageTotals": {
"shape": "__listOfUsageTotal",
"locationName": "usageTotals",
@ -5277,7 +5547,7 @@
"shape": "__string",
"location": "querystring",
"locationName": "onlyAssociated",
"documentation": "<p>Specifies which accounts to include in the response, based on the status of an account's relationship with the master account. By default, the response includes only current member accounts. To include all accounts, set the value for this parameter to false.</p>"
"documentation": "<p>Specifies which accounts to include in the response, based on the status of an account's relationship with the administrator account. By default, the response includes only current member accounts. To include all accounts, set this value to false.</p>"
}
}
},
@ -5287,7 +5557,7 @@
"members": {
"shape": "__listOfMember",
"locationName": "members",
"documentation": "<p>An array of objects, one for each account that's associated with the master account and meets the criteria specified by the onlyAssociated request parameter.</p>"
"documentation": "<p>An array of objects, one for each account that's associated with the administrator account and meets the criteria specified by the onlyAssociated request parameter.</p>"
},
"nextToken": {
"shape": "__string",
@ -5373,6 +5643,11 @@
"locationName": "accountId",
"documentation": "<p>The AWS account ID for the account.</p>"
},
"administratorAccountId": {
"shape": "__string",
"locationName": "administratorAccountId",
"documentation": "<p>The AWS account ID for the administrator account.</p>"
},
"arn": {
"shape": "__string",
"locationName": "arn",
@ -5391,12 +5666,12 @@
"masterAccountId": {
"shape": "__string",
"locationName": "masterAccountId",
"documentation": "<p>The AWS account ID for the master account.</p>"
"documentation": "<p>(Deprecated) The AWS account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.</p>"
},
"relationshipStatus": {
"shape": "RelationshipStatus",
"locationName": "relationshipStatus",
"documentation": "<p>The current status of the relationship between the account and the master account.</p>"
"documentation": "<p>The current status of the relationship between the account and the administrator account.</p>"
},
"tags": {
"shape": "TagMap",
@ -5406,10 +5681,10 @@
"updatedAt": {
"shape": "__timestampIso8601",
"locationName": "updatedAt",
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the master account.</p>"
"documentation": "<p>The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account.</p>"
}
},
"documentation": "<p>Provides information about an account that's associated with an Amazon Macie master account.</p>"
"documentation": "<p>Provides information about an account that's associated with an Amazon Macie administrator account.</p>"
},
"MonthlySchedule": {
"type": "structure",
@ -5417,7 +5692,7 @@
"dayOfMonth": {
"shape": "__integer",
"locationName": "dayOfMonth",
"documentation": "<p>The numeric day of the month when Amazon Macie runs the job. This value can be an integer from 1 through 31.</p> <p>If this value exceeds the number of days in a certain month, Macie runs the job on the last day of that month. For example, if this value is 31 and a month has only 30 days, Macie runs the job on day 30 of that month.</p>"
"documentation": "<p>The numeric day of the month when Amazon Macie runs the job. This value can be an integer from 1 through 31.</p> <p>If this value exceeds the number of days in a certain month, Macie doesn't run the job that month. Macie runs the job only during months that have the specified day. For example, if this value is 31 and a month has only 30 days, Macie doesn't run the job that month. To run the job every month, specify a value that's less than 29.</p>"
}
},
"documentation": "<p>Specifies a monthly recurrence pattern for running a classification job.</p>"
@ -5428,17 +5703,17 @@
"customerManaged": {
"shape": "__long",
"locationName": "customerManaged",
"documentation": "<p>The total number of objects that are encrypted using a customer-managed key. The objects use customer-provided server-side (SSE-C) encryption.</p>"
"documentation": "<p>The total number of objects that are encrypted using a customer-managed key. The objects use customer-provided server-side encryption (SSE-C).</p>"
},
"kmsManaged": {
"shape": "__long",
"locationName": "kmsManaged",
"documentation": "<p>The total number of objects that are encrypted using an AWS Key Management Service (AWS KMS) customer master key (CMK). The objects use AWS managed AWS KMS (AWS-KMS) encryption or customer managed AWS KMS (SSE-KMS) encryption.</p>"
"documentation": "<p>The total number of objects that are encrypted using an AWS Key Management Service (AWS KMS) customer master key (CMK). The objects use AWS managed AWS KMS encryption (AWS-KMS) or customer managed AWS KMS encryption (SSE-KMS).</p>"
},
"s3Managed": {
"shape": "__long",
"locationName": "s3Managed",
"documentation": "<p>The total number of objects that are encrypted using an Amazon S3 managed key. The objects use Amazon S3 managed (SSE-S3) encryption.</p>"
"documentation": "<p>The total number of objects that are encrypted using an Amazon S3 managed key. The objects use Amazon S3 managed encryption (SSE-S3).</p>"
},
"unencrypted": {
"shape": "__long",
@ -5467,7 +5742,7 @@
"documentation": "<p>The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class or don't have a file name extension for a supported file or storage format.</p>"
}
},
"documentation": "<p>Provides information about the total storage size (in bytes) or number of objects that Amazon Macie can't analyze in one or more S3 buckets. In a BucketMetadata object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results.</p>"
"documentation": "<p>Provides information about the total storage size (in bytes) or number of objects that Amazon Macie can't analyze in one or more S3 buckets. In a BucketMetadata object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results. If versioning is enabled for a bucket, total storage size values are based on the size of the latest version of each applicable object in the bucket.</p>"
},
"Occurrences": {
"type": "structure",
@ -5480,7 +5755,7 @@
"lineRanges": {
"shape": "Ranges",
"locationName": "lineRanges",
"documentation": "<p>An array of objects, one for each occurrence of sensitive data in a Microsoft Word document or non-binary text file, such as an HTML, JSON, TXT, or XML file. Each object specifies the line that contains the data, and the position of the data on that line.</p> <p>This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the locations of: data in unstructured sections of an otherwise structured file, such as a comment in a file; and, data in a malformed file that Amazon Macie analyzes as plain text.</p>"
"documentation": "<p>An array of objects, one for each occurrence of sensitive data in a Microsoft Word document or non-binary text file, such as an HTML, JSON, TXT, or XML file. Each object specifies the line that contains the data, and the position of the data on that line.</p> <p>This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the locations of data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.</p>"
},
"offsetRanges": {
"shape": "Ranges",
@ -5574,6 +5849,26 @@
}
}
},
"PutFindingsPublicationConfigurationRequest": {
"type": "structure",
"members": {
"clientToken": {
"shape": "__string",
"locationName": "clientToken",
"documentation": "<p>A unique, case-sensitive token that you provide to ensure the idempotency of the request.</p>",
"idempotencyToken": true
},
"securityHubConfiguration": {
"shape": "SecurityHubConfiguration",
"locationName": "securityHubConfiguration",
"documentation": "<p>The configuration settings that determine which findings to publish to AWS Security Hub.</p>"
}
}
},
"PutFindingsPublicationConfigurationResponse": {
"type": "structure",
"members": {}
},
"Range": {
"type": "structure",
"members": {
@ -5608,7 +5903,7 @@
"jsonPath": {
"shape": "__string",
"locationName": "jsonPath",
"documentation": "<p>The path, as a JSONPath expression, to the field in the record that contains the data.</p> <p>If the name of an element exceeds 20 characters, Amazon Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.</p>"
"documentation": "<p>The path, as a JSONPath expression, to the field in the record that contains the data. If Amazon Macie detects sensitive data in the name of any element in the path, Macie omits this field.</p> <p>If the name of an element exceeds 20 characters, Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.</p>"
},
"recordIndex": {
"shape": "__long",
@ -5627,7 +5922,7 @@
},
"RelationshipStatus": {
"type": "string",
"documentation": "<p>The current status of the relationship between an account and an associated Amazon Macie master account (<i>inviter account</i>). Possible values are:</p>",
"documentation": "<p>The current status of the relationship between an account and an associated Amazon Macie administrator account (<i>inviter account</i>). Possible values are:</p>",
"enum": [
"Enabled",
"Paused",
@ -5852,7 +6147,7 @@
"serverSideEncryption": {
"shape": "ServerSideEncryption",
"locationName": "serverSideEncryption",
"documentation": "<p>The type of server-side encryption that's used for the object.</p>"
"documentation": "<p>The type of server-side encryption that's used to encrypt the object.</p>"
},
"size": {
"shape": "__long",
@ -5905,6 +6200,26 @@
},
"documentation": "<p>Specifies one or more property- and tag-based conditions that refine the scope of a classification job. These conditions define criteria that determine which objects a job analyzes. Exclude conditions take precedence over include conditions.</p>"
},
"SecurityHubConfiguration": {
"type": "structure",
"members": {
"publishClassificationFindings": {
"shape": "__boolean",
"locationName": "publishClassificationFindings",
"documentation": "<p>Specifies whether to publish sensitive data findings to AWS Security Hub. If you set this value to true, Amazon Macie automatically publishes all sensitive data findings that weren't suppressed by a findings filter. The default value is false.</p>"
},
"publishPolicyFindings": {
"shape": "__boolean",
"locationName": "publishPolicyFindings",
"documentation": "<p>Specifies whether to publish policy findings to AWS Security Hub. If you set this value to true, Amazon Macie automatically publishes all new and updated policy findings that weren't suppressed by a findings filter. The default value is true.</p>"
}
},
"documentation": "<p>Specifies configuration settings that determine which findings are published to AWS Security Hub automatically. For information about how Macie publishes findings to Security Hub, see <a href=\"https://docs.aws.amazon.com/macie/latest/user/securityhub-integration.html\">Amazon Macie integration with Security Hub</a> in the <i>Amazon Macie User Guide</i>.</p>",
"required": [
"publishPolicyFindings",
"publishClassificationFindings"
]
},
"SensitiveData": {
"type": "list",
"documentation": "<p>Provides information about the category and number of occurrences of sensitive data that produced a finding.</p>",
@ -5949,12 +6264,12 @@
"encryptionType": {
"shape": "EncryptionType",
"locationName": "encryptionType",
"documentation": "<p>The server-side encryption algorithm that's used when storing data in the bucket or object. If encryption is disabled for the bucket or object, this value is NONE.</p>"
"documentation": "<p>The server-side encryption algorithm that's used when storing data in the bucket or object. If default encryption is disabled for the bucket or the object isn't encrypted using server-side encryption, this value is NONE.</p>"
},
"kmsMasterKeyId": {
"shape": "__string",
"locationName": "kmsMasterKeyId",
"documentation": "<p>The unique identifier for the AWS Key Management Service (AWS KMS) master key that's used to encrypt the bucket or object. This value is null if AWS KMS isn't used to encrypt the bucket or object.</p>"
"documentation": "<p>The Amazon Resource Name (ARN) or unique identifier (key ID) for the AWS Key Management Service (AWS KMS) customer master key (CMK) that's used to encrypt data in the bucket or the object. If an AWS KMS CMK isn't used, this value is null.</p>"
}
},
"documentation": "<p>Provides information about the server-side encryption settings for an S3 bucket or S3 object.</p>"
@ -5978,7 +6293,7 @@
"documentation": "<p>The value for the metric specified by the UsageByAccount.type field in the response.</p>"
}
},
"documentation": "<p>Specifies a current quota for an account.</p>"
"documentation": "<p>Specifies a current quota for an Amazon Macie account.</p>"
},
"ServiceQuotaExceededException": {
"type": "structure",
@ -6300,6 +6615,22 @@
"httpStatusCode": 429
}
},
"TimeRange": {
"type": "string",
"documentation": "<p>An inclusive time period that Amazon Macie usage data applies to. Possible values are:</p>",
"enum": [
"MONTH_TO_DATE",
"PAST_30_DAYS"
]
},
"Type": {
"type": "string",
"enum": [
"NONE",
"AES256",
"aws:kms"
]
},
"Unit": {
"type": "string",
"enum": [
@ -6364,7 +6695,7 @@
"jobStatus": {
"shape": "JobStatus",
"locationName": "jobStatus",
"documentation": "<p>The new status for the job. Valid values are:</p> <ul><li><p>CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED.</p> <p>If you specify this value and the job's current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can't resume or restart a job after you cancel it.</p></li> <li><p>RUNNING - Resumes the job. This value is valid only if the job's current status is USER_PAUSED.</p> <p>If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.</p></li> <li><p>USER_PAUSED - Pauses the job temporarily. This value is valid only if the job's current status is IDLE or RUNNING. If you specify this value and the job's current status is RUNNING, Macie immediately begins to pause all processing tasks for the job.</p> <p>If you pause a one-time job and you don't resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don't resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.</p></li></ul>"
"documentation": "<p>The new status for the job. Valid values are:</p> <ul><li><p>CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED.</p> <p>If you specify this value and the job's current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can't resume or restart a job after you cancel it.</p></li> <li><p>RUNNING - Resumes the job. This value is valid only if the job's current status is USER_PAUSED.</p> <p>If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.</p></li> <li><p>USER_PAUSED - Pauses the job temporarily. This value is valid only if the job's current status is IDLE, PAUSED, or RUNNING. If you specify this value and the job's current status is RUNNING, Macie immediately begins to pause all processing tasks for the job.</p> <p>If you pause a one-time job and you don't resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don't resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.</p></li></ul>"
}
},
"required": [
@ -6441,7 +6772,7 @@
"status": {
"shape": "MacieStatus",
"locationName": "status",
"documentation": "<p>Specifies whether to change the status of the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.</p>"
"documentation": "<p>Specifies a new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.</p>"
}
}
},
@ -6479,7 +6810,7 @@
"autoEnable": {
"shape": "__boolean",
"locationName": "autoEnable",
"documentation": "<p>Specifies whether Amazon Macie is enabled automatically for each account, when the account is added to the AWS organization.</p>"
"documentation": "<p>Specifies whether to enable Amazon Macie automatically for each account, when the account is added to the AWS organization.</p>"
}
},
"required": [
@ -6511,10 +6842,10 @@
"type": {
"shape": "UsageType",
"locationName": "type",
"documentation": "<p>The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing sensitive data.</p>"
"documentation": "<p>The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing S3 objects to detect sensitive data.</p>"
}
},
"documentation": "<p>Provides data for a specific usage metric and the corresponding quota for an account. The value for the metric is an aggregated value that reports usage during the past 30 days.</p>"
"documentation": "<p>Provides data for a specific usage metric and the corresponding quota for an Amazon Macie account.</p>"
},
"UsageRecord": {
"type": "structure",
@ -6535,7 +6866,7 @@
"documentation": "<p>An array of objects that contains usage data and quotas for the account. Each object contains the data for a specific usage metric and the corresponding quota.</p>"
}
},
"documentation": "<p>Provides quota and aggregated usage data for an account.</p>"
"documentation": "<p>Provides quota and aggregated usage data for an Amazon Macie account.</p>"
},
"UsageStatisticsFilter": {
"type": "structure",
@ -6553,14 +6884,14 @@
"values": {
"shape": "__listOf__string",
"locationName": "values",
"documentation": "<p>An array that lists values to use in the condition, based on the value for the field specified by the key property. If the value for the key property is accountId, this array can specify multiple values. Otherwise, this array can specify only one value.</p> <p>Valid values for each supported field are:</p> <ul><li><p>accountId - The unique identifier for an AWS account.</p></li></ul> <ul><li><p>freeTrialStartDate - The date and time, in UTC and extended ISO 8601 format, when the free trial started for an account.</p></li></ul> <ul><li><p>serviceLimit - A Boolean (true or false) value that indicates whether an account has reached its monthly quota.</p></li></ul> <ul><li><p>total - A string that represents the current, estimated month-to-date cost for an account.</p></li></ul>"
"documentation": "<p>An array that lists values to use in the condition, based on the value for the field specified by the key property. If the value for the key property is accountId, this array can specify multiple values. Otherwise, this array can specify only one value.</p> <p>Valid values for each supported field are:</p> <ul><li><p>accountId - The unique identifier for an AWS account.</p></li></ul> <ul><li><p>freeTrialStartDate - The date and time, in UTC and extended ISO 8601 format, when the free trial started for an account.</p></li></ul> <ul><li><p>serviceLimit - A Boolean (true or false) value that indicates whether an account has reached its monthly quota.</p></li></ul> <ul><li><p>total - A string that represents the current estimated cost for an account.</p></li></ul>"
}
},
"documentation": "<p>Specifies a condition for filtering the results of a query for account quotas and usage data.</p>"
"documentation": "<p>Specifies a condition for filtering the results of a query for quota and usage data for one or more Amazon Macie accounts.</p>"
},
"UsageStatisticsFilterComparator": {
"type": "string",
"documentation": "<p>The operator to use in a condition that filters the results of a query for account quotas and usage data. Valid values are:</p>",
"documentation": "<p>The operator to use in a condition that filters the results of a query for Amazon Macie account quotas and usage data. Valid values are:</p>",
"enum": [
"GT",
"GTE",
@ -6573,7 +6904,7 @@
},
"UsageStatisticsFilterKey": {
"type": "string",
"documentation": "<p>The field to use in a condition that filters the results of a query for account quotas and usage data. Valid values are:</p>",
"documentation": "<p>The field to use in a condition that filters the results of a query for Amazon Macie account quotas and usage data. Valid values are:</p>",
"enum": [
"accountId",
"serviceLimit",
@ -6595,11 +6926,11 @@
"documentation": "<p>The sort order to apply to the results, based on the value for the field specified by the key property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.</p>"
}
},
"documentation": "<p>Specifies criteria for sorting the results of a query for account quotas and usage data.</p>"
"documentation": "<p>Specifies criteria for sorting the results of a query for Amazon Macie account quotas and usage data.</p>"
},
"UsageStatisticsSortKey": {
"type": "string",
"documentation": "<p>The field to use to sort the results of a query for account quotas and usage data. Valid values are:</p>",
"documentation": "<p>The field to use to sort the results of a query for Amazon Macie account quotas and usage data. Valid values are:</p>",
"enum": [
"accountId",
"total",
@ -6623,14 +6954,14 @@
"type": {
"shape": "UsageType",
"locationName": "type",
"documentation": "<p>The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing sensitive data.</p>"
"documentation": "<p>The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing S3 objects to detect sensitive data.</p>"
}
},
"documentation": "<p>Provides aggregated data for a usage metric. The value for the metric reports usage data for an account during the past 30 days.</p>"
"documentation": "<p>Provides aggregated data for an Amazon Macie usage metric. The value for the metric reports estimated usage data for an account for the preceding 30 days or the current calendar month to date, depending on the time period (timeRange) specified in the request.</p>"
},
"UsageType": {
"type": "string",
"documentation": "<p>The name of a usage metric for an account. Possible values are:</p>",
"documentation": "<p>The name of an Amazon Macie usage metric for an account. Possible values are:</p>",
"enum": [
"DATA_INVENTORY_EVALUATION",
"SENSITIVE_DATA_DISCOVERY"

26
botocore/data/managedblockchain/2018-09-24/service-2.json
View file

@ -72,7 +72,7 @@
{"shape":"InternalServiceErrorException"},
{"shape":"TooManyTagsException"}
],
"documentation":"<p>Creates a node on the specified blockchain network.</p> <p>Applies to Hyperledger Fabric and Ethereum.</p> <p>Ethereum on Managed Blockchain is in preview release and is subject to change.</p>"
"documentation":"<p>Creates a node on the specified blockchain network.</p> <p>Applies to Hyperledger Fabric and Ethereum.</p>"
},
"CreateProposal":{
"name":"CreateProposal",
@ -541,7 +541,7 @@
},
"Tags":{
"shape":"InputTagMap",
"documentation":"<p>Tags to assign to the network. Each tag consists of a key and optional value.</p> <p>When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 added to each resource.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>"
"documentation":"<p>Tags to assign to the network. Each tag consists of a key and optional value.</p> <p>When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>"
}
}
},
@ -587,7 +587,7 @@
},
"Tags":{
"shape":"InputTagMap",
"documentation":"<p>Tags to assign to the node. Each tag consists of a key and optional value.</p> <p>When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 added to each resource.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>"
"documentation":"<p>Tags to assign to the node. Each tag consists of a key and optional value.</p> <p>When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>"
}
}
},
@ -634,7 +634,7 @@
},
"Tags":{
"shape":"InputTagMap",
"documentation":"<p>Tags to assign to the proposal. Each tag consists of a key and optional value.</p> <p>When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 added to each resource. If the proposal is for a network invitation, the invitation inherits the tags added to the proposal.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>"
"documentation":"<p>Tags to assign to the proposal. Each tag consists of a key and optional value.</p> <p>When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource. If the proposal is for a network invitation, the invitation inherits the tags added to the proposal.</p> <p>For more information about tags, see <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/ethereum-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Ethereum Developer Guide</i>, or <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p>"
}
}
},
@ -1321,7 +1321,7 @@
},
"Tags":{
"shape":"InputTagMap",
"documentation":"<p>Tags assigned to the member. Tags consist of a key and optional value. For more information about tags, see <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p> <p>When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 added to each resource.</p>"
"documentation":"<p>Tags assigned to the member. Tags consist of a key and optional value. For more information about tags, see <a href=\"https://docs.aws.amazon.com/managed-blockchain/latest/hyperledger-fabric-dev/tagging-resources.html\">Tagging Resources</a> in the <i>Amazon Managed Blockchain Hyperledger Fabric Developer Guide</i>.</p> <p>When specifying tags during creation, you can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.</p>"
}
},
"documentation":"<p>Configuration properties of the member.</p> <p>Applies only to Hyperledger Fabric.</p>"
@ -1521,7 +1521,7 @@
"documentation":"<p>The Ethereum <code>CHAIN_ID</code> associated with the Ethereum network. Chain IDs are as follows:</p> <ul> <li> <p>mainnet = <code>1</code> </p> </li> <li> <p>rinkeby = <code>4</code> </p> </li> <li> <p>ropsten = <code>3</code> </p> </li> </ul>"
}
},
"documentation":"<p>Attributes of Ethereum for a network. Ethereum on Managed Blockchain is in preview release and is subject to change.</p>"
"documentation":"<p>Attributes of Ethereum for a network. </p>"
},
"NetworkFabricAttributes":{
"type":"structure",
@ -1557,7 +1557,7 @@
},
"Ethereum":{
"shape":"NetworkEthereumAttributes",
"documentation":"<p>Attributes of an Ethereum network for Managed Blockchain resources participating in an Ethereum network. Ethereum on Managed Blockchain is in preview release and is subject to change.</p>"
"documentation":"<p>Attributes of an Ethereum network for Managed Blockchain resources participating in an Ethereum network. </p>"
}
},
"documentation":"<p>Attributes relevant to the network for the blockchain framework that the network uses.</p>"
@ -1657,7 +1657,7 @@
},
"AvailabilityZone":{
"shape":"AvailabilityZoneString",
"documentation":"<p>The Availability Zone in which the node exists. Required for Ethereum nodes. Ethereum on Managed Blockchain is in preview release and is subject to change.</p>"
"documentation":"<p>The Availability Zone in which the node exists. Required for Ethereum nodes. </p>"
},
"FrameworkAttributes":{
"shape":"NodeFrameworkAttributes",
@ -1700,7 +1700,7 @@
},
"AvailabilityZone":{
"shape":"AvailabilityZoneString",
"documentation":"<p>The Availability Zone in which the node exists. Required for Ethereum nodes. Ethereum on Managed Blockchain is in preview release and is subject to change.</p>"
"documentation":"<p>The Availability Zone in which the node exists. Required for Ethereum nodes. </p>"
},
"LogPublishingConfiguration":{
"shape":"NodeLogPublishingConfiguration",
@ -1725,7 +1725,7 @@
"documentation":"<p>The endpoint on which the Ethereum node listens to run Ethereum JSON-RPC methods over WebSockets connections from a client. Use this endpoint in client code for smart contracts when using a WebSockets connection. Connections to this endpoint are authenticated using <a href=\"https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html\">Signature Version 4</a>.</p>"
}
},
"documentation":"<p>Attributes of an Ethereum node. Ethereum on Managed Blockchain is in preview release and is subject to change.</p>"
"documentation":"<p>Attributes of an Ethereum node.</p>"
},
"NodeFabricAttributes":{
"type":"structure",
@ -1764,7 +1764,7 @@
},
"Ethereum":{
"shape":"NodeEthereumAttributes",
"documentation":"<p>Attributes of Ethereum for a node on a Managed Blockchain network that uses Ethereum. Ethereum on Managed Blockchain is in preview release and is subject to change.</p>"
"documentation":"<p>Attributes of Ethereum for a node on a Managed Blockchain network that uses Ethereum. </p>"
}
},
"documentation":"<p>Attributes relevant to a node on a Managed Blockchain network for the blockchain framework that the network uses.</p>"
@ -2106,7 +2106,7 @@
},
"Tags":{
"shape":"InputTagMap",
"documentation":"<p>The tags to assign to the specified resource. Tag values can be empty, for example, <code>\"MyTagKey\" : \"\"</code>. You can specify multiple key-value pairs in a single request, with an overall maximum of 50 added to each resource.</p>"
"documentation":"<p>The tags to assign to the specified resource. Tag values can be empty, for example, <code>\"MyTagKey\" : \"\"</code>. You can specify multiple key-value pairs in a single request, with an overall maximum of 50 tags added to each resource.</p>"
}
}
},
@ -2330,5 +2330,5 @@
"documentation":"<p> The voting rules for the network to decide if a proposal is accepted </p> <p>Applies only to Hyperledger Fabric.</p>"
}
},
"documentation":"<p/> <p>Amazon Managed Blockchain is a fully managed service for creating and managing blockchain networks using open-source frameworks. Blockchain allows you to build applications where multiple parties can securely and transparently run transactions and share data without the need for a trusted, central authority.</p> <p>Managed Blockchain supports the Hyperledger Fabric and Ethereum open-source frameworks. Ethereum on Managed Blockchain is in preview release and is subject to change. Because of fundamental differences between the frameworks, some API actions or data types may only apply in the context of one framework and not the other. For example, actions related to Hyperledger Fabric network members such as <code>CreateMember</code> and <code>DeleteMember</code> do not apply to Ethereum.</p> <p>The description for each action indicates the framework or frameworks to which it applies. Data types and properties that apply only in the context of a particular framework are similarly indicated.</p>"
"documentation":"<p/> <p>Amazon Managed Blockchain is a fully managed service for creating and managing blockchain networks using open-source frameworks. Blockchain allows you to build applications where multiple parties can securely and transparently run transactions and share data without the need for a trusted, central authority.</p> <p>Managed Blockchain supports the Hyperledger Fabric and Ethereum open-source frameworks. Because of fundamental differences between the frameworks, some API actions or data types may only apply in the context of one framework and not the other. For example, actions related to Hyperledger Fabric network members such as <code>CreateMember</code> and <code>DeleteMember</code> do not apply to Ethereum.</p> <p>The description for each action indicates the framework or frameworks to which it applies. Data types and properties that apply only in the context of a particular framework are similarly indicated.</p>"
}

32
botocore/data/mediaconnect/2018-11-14/service-2.json
View file

@ -1225,6 +1225,11 @@
"locationName": "maxLatency",
"documentation": "The maximum latency in milliseconds for Zixi-based streams."
},
"MinLatency": {
"shape": "__integer",
"locationName": "minLatency",
"documentation": "The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender\u2019s minimum latency and the receiver\u2019s minimum latency."
},
"Name": {
"shape": "__string",
"locationName": "name",
@ -1524,7 +1529,6 @@
},
"documentation": "Information about the encryption of the flow.",
"required": [
"Algorithm",
"RoleArn"
]
},
@ -1801,7 +1805,8 @@
"type": "string",
"enum": [
"speke",
"static-key"
"static-key",
"srt-password"
]
},
"ListEntitlementsRequest": {
@ -2196,7 +2201,8 @@
"rtp-fec",
"rtp",
"zixi-pull",
"rist"
"rist",
"srt-listener"
]
},
"PurchaseOfferingRequest": {
@ -2569,6 +2575,11 @@
"locationName": "maxLatency",
"documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams."
},
"MinLatency": {
"shape": "__integer",
"locationName": "minLatency",
"documentation": "The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender\u2019s minimum latency and the receiver\u2019s minimum latency."
},
"Name": {
"shape": "__string",
"locationName": "name",
@ -2803,6 +2814,11 @@
"locationName": "maxLatency",
"documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams."
},
"MinLatency": {
"shape": "__integer",
"locationName": "minLatency",
"documentation": "The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender\u2019s minimum latency and the receiver\u2019s minimum latency."
},
"Protocol": {
"shape": "Protocol",
"locationName": "protocol",
@ -3007,6 +3023,11 @@
"locationName": "maxLatency",
"documentation": "The maximum latency in milliseconds for Zixi-based streams."
},
"MinLatency": {
"shape": "__integer",
"locationName": "minLatency",
"documentation": "The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender\u2019s minimum latency and the receiver\u2019s minimum latency."
},
"OutputArn": {
"shape": "__string",
"location": "uri",
@ -3132,6 +3153,11 @@
"locationName": "maxLatency",
"documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams."
},
"MinLatency": {
"shape": "__integer",
"locationName": "minLatency",
"documentation": "The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender\u2019s minimum latency and the receiver\u2019s minimum latency."
},
"Protocol": {
"shape": "Protocol",
"locationName": "protocol",

28
botocore/data/mediaconvert/2017-08-29/service-2.json
View file

@ -1651,7 +1651,7 @@
"documentation": "Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio."
},
"ExternalAudioFileInput": {
"shape": "__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE",
"shape": "__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE",
"locationName": "externalAudioFileInput",
"documentation": "Specifies audio data from an external file source."
},
@ -2431,6 +2431,7 @@
"STL",
"SRT",
"SMI",
"SMPTE_TT",
"TELETEXT",
"NULL_SOURCE",
"IMSC"
@ -6024,7 +6025,7 @@
"documentation": "Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs."
},
"FileInput": {
"shape": "__stringPatternS3MM2PPMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLOOGGGGaAHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLOOGGGGaA",
"shape": "__stringPatternS3MM2PPMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLOOGGGGaAHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLOOGGGGaA",
"locationName": "fileInput",
"documentation": "Specify the source file for your transcoding job. You can use multiple inputs in a single job. The service concatenates these inputs, in the order that you specify them in the job, to create the outputs. If your input format is IMF, specify your input by providing the path to your CPL. For example, \"s3://bucket/vf/cpl.xml\". If the CPL is in an incomplete IMP, make sure to use *Supplemental IMPs* (SupplementalImps) to specify any supplemental IMPs that contain assets referenced by the CPL."
},
@ -7584,7 +7585,7 @@
"documentation": "If your motion graphic asset is a .mov file, keep this setting unspecified. If your motion graphic asset is a series of .png files, specify the frame rate of the overlay in frames per second, as a fraction. For example, specify 24 fps as 24/1. Make sure that the number of images in your series matches the frame rate and your intended overlay duration. For example, if you want a 30-second overlay at 30 fps, you should have 900 .png images. This overlay frame rate doesn't need to match the frame rate of the underlying video."
},
"Input": {
"shape": "__stringMin14Max1285PatternS3Mov09PngHttpsMov09Png",
"shape": "__stringMin14PatternS3Mov09PngHttpsMov09Png",
"locationName": "input",
"documentation": "Specify the .mov file or series of .png files that you want to overlay on your video. For .png files, provide the file name of the first file in the series. Make sure that the names of the .png files end with sequential numbers that specify the order that they are played in. For example, overlay_000.png, overlay_001.png, overlay_002.png, and so on. The sequence must start at zero, and each image file name must have the same number of digits. Pad your initial file names with enough zeros to complete the sequence. For example, if the first image is overlay_0.png, there can be only 10 images in the sequence, with the last image being overlay_9.png. But if the first image is overlay_00.png, there can be 100 images in the sequence."
},
@ -8704,7 +8705,7 @@
"InputChannelsFineTune": {
"shape": "__listOf__doubleMinNegative60Max6",
"locationName": "inputChannelsFineTune",
"documentation": "Use this setting to specify your remix values when they have a decimal component, such as -10.312, 0.08, or 4.9. MediaConvert rounds your remixing values to the nearest thousandth."
"documentation": "Use this setting to specify your remix values when they have a decimal component, such as -10.312, 0.08, or 4.9. MediaConvert rounds your remixing values to the nearest thousandth."
}
},
"documentation": "OutputChannel mapping settings."
@ -11307,12 +11308,6 @@
"max": 11,
"pattern": "^((([0-1]\\d)|(2[0-3]))(:[0-5]\\d){2}([:;][0-5]\\d))$"
},
"__stringMin14Max1285PatternS3Mov09PngHttpsMov09Png": {
"type": "string",
"min": 14,
"max": 1285,
"pattern": "^((s3://(.*)(\\.mov|[0-9]+\\.png))|(https?://(.*)(\\.mov|[0-9]+\\.png)(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$"
},
"__stringMin14PatternS3BmpBMPPngPNGHttpsBmpBMPPngPNG": {
"type": "string",
"min": 14,
@ -11323,6 +11318,11 @@
"min": 14,
"pattern": "^((s3://(.*?)\\.(bmp|BMP|png|PNG|tga|TGA))|(https?://(.*?)\\.(bmp|BMP|png|PNG|tga|TGA)(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$"
},
"__stringMin14PatternS3Mov09PngHttpsMov09Png": {
"type": "string",
"min": 14,
"pattern": "^((s3://(.*)(\\.mov|[0-9]+\\.png))|(https?://(.*)(\\.mov|[0-9]+\\.png)(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$"
},
"__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIHttpsSccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMI": {
"type": "string",
"min": 14,
@ -11454,13 +11454,13 @@
"type": "string",
"pattern": "^s3:\\/\\/.*\\/(ASSETMAP.xml)?$"
},
"__stringPatternS3MM2PPMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLOOGGGGaAHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLOOGGGGaA": {
"__stringPatternS3MM2PPMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLOOGGGGaAHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLOOGGGGaA": {
"type": "string",
"pattern": "^((s3://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[pP]|[mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL]|[oO][gG][gGaA]))))|(https?://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL]|[oO][gG][gGaA])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$"
"pattern": "^((s3://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[pP]|[mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL]|[oO][gG][gGaA]))))|(https?://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[wW][eE][bB][mM]|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[xX][mM][lL]|[oO][gG][gGaA])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$"
},
"__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE": {
"__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE": {
"type": "string",
"pattern": "^((s3://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[pP]|[wW][eE][bB][mM]|[mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE]))))|(https?://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vV]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$"
"pattern": "^((s3://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[pP]|[wW][eE][bB][mM]|[mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE]))))|(https?://([^\\/]+\\/+)+([^\\/\\.]+|(([^\\/]*)\\.([mM]2[vV]|[mM][pP][eE][gG]|[mM][pP]3|[aA][vV][iI]|[mM][pP]4|[fF][lL][vV]|[mM][pP][tT]|[mM][pP][gG]|[mM]4[vV]|[tT][rR][pP]|[fF]4[vV]|[mM]2[tT][sS]|[tT][sS]|264|[hH]264|[mM][kK][vV]|[mM][kK][aA]|[mM][oO][vV]|[mM][tT][sS]|[mM]2[tT]|[wW][mM][vVaA]|[aA][sS][fF]|[vV][oO][bB]|3[gG][pP]|3[gG][pP][pP]|[mM][xX][fF]|[dD][iI][vV][xX]|[xX][vV][iI][dD]|[rR][aA][wW]|[dD][vV]|[gG][xX][fF]|[mM]1[vV]|3[gG]2|[vV][mM][fF]|[mM]3[uU]8|[lL][cC][hH]|[gG][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF]_[mM][pP][eE][gG]2|[mM][xX][fF][hH][dD]|[wW][aA][vV]|[yY]4[mM]|[aA][aA][cC]|[aA][iI][fF][fF]|[mM][pP]2|[aA][cC]3|[eE][cC]3|[dD][tT][sS][eE])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$"
},
"__stringPatternSNManifestConfirmConditionNotificationNS": {
"type": "string",

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

@ -554,6 +554,48 @@
],
"documentation": "Create a new program in the multiplex."
},
"CreatePartnerInput": {
"name": "CreatePartnerInput",
"http": {
"method": "POST",
"requestUri": "/prod/inputs/{inputId}/partners",
"responseCode": 201
},
"input": {
"shape": "CreatePartnerInputRequest"
},
"output": {
"shape": "CreatePartnerInputResponse",
"documentation": "Successfully created the input."
},
"errors": [
{
"shape": "BadRequestException",
"documentation": "This request was invalid"
},
{
"shape": "InternalServerErrorException",
"documentation": "Internal Service Error"
},
{
"shape": "ForbiddenException",
"documentation": "Access was denied"
},
{
"shape": "BadGatewayException",
"documentation": "Bad Gateway Error"
},
{
"shape": "GatewayTimeoutException",
"documentation": "Gateway Timeout Error"
},
{
"shape": "TooManyRequestsException",
"documentation": "Limit exceeded"
}
],
"documentation": "Create a partner input"
},
"CreateTags": {
"name": "CreateTags",
"http": {
@ -2841,6 +2883,16 @@
},
"documentation": "Ancillary Source Settings"
},
"ArchiveCdnSettings": {
"type": "structure",
"members": {
"ArchiveS3Settings": {
"shape": "ArchiveS3Settings",
"locationName": "archiveS3Settings"
}
},
"documentation": "Archive Cdn Settings"
},
"ArchiveContainerSettings": {
"type": "structure",
"members": {
@ -2858,6 +2910,11 @@
"ArchiveGroupSettings": {
"type": "structure",
"members": {
"ArchiveCdnSettings": {
"shape": "ArchiveCdnSettings",
"locationName": "archiveCdnSettings",
"documentation": "Parameters that control interactions with the CDN."
},
"Destination": {
"shape": "OutputLocationRef",
"locationName": "destination",
@ -2898,6 +2955,25 @@
"ContainerSettings"
]
},
"ArchiveS3LogUploads": {
"type": "string",
"documentation": "Archive S3 Log Uploads",
"enum": [
"DISABLED",
"ENABLED"
]
},
"ArchiveS3Settings": {
"type": "structure",
"members": {
"CannedAcl": {
"shape": "S3CannedAcl",
"locationName": "cannedAcl",
"documentation": "Specify the canned ACL to apply to each S3 request. Defaults to none."
}
},
"documentation": "Archive S3 Settings"
},
"AribDestinationSettings": {
"type": "structure",
"members": {
@ -4074,6 +4150,38 @@
"CaptionChannel"
]
},
"CaptionRectangle": {
"type": "structure",
"members": {
"Height": {
"shape": "__doubleMin0Max100",
"locationName": "height",
"documentation": "See the description in leftOffset.\nFor height, specify the entire height of the rectangle as a percentage of the underlying frame height. For example, \\\"80\\\" means the rectangle height is 80% of the underlying frame height. The topOffset and rectangleHeight must add up to 100% or less.\nThis field corresponds to tts:extent - Y in the TTML standard."
},
"LeftOffset": {
"shape": "__doubleMin0Max100",
"locationName": "leftOffset",
"documentation": "Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. (Make sure to leave the default if you don't have either of these formats in the output.) You can define a display rectangle for the captions that is smaller than the underlying video frame. You define the rectangle by specifying the position of the left edge, top edge, bottom edge, and right edge of the rectangle, all within the underlying video frame. The units for the measurements are percentages.\nIf you specify a value for one of these fields, you must specify a value for all of them.\nFor leftOffset, specify the position of the left edge of the rectangle, as a percentage of the underlying frame width, and relative to the left edge of the frame. For example, \\\"10\\\" means the measurement is 10% of the underlying frame width. The rectangle left edge starts at that position from the left edge of the frame.\nThis field corresponds to tts:origin - X in the TTML standard."
},
"TopOffset": {
"shape": "__doubleMin0Max100",
"locationName": "topOffset",
"documentation": "See the description in leftOffset.\nFor topOffset, specify the position of the top edge of the rectangle, as a percentage of the underlying frame height, and relative to the top edge of the frame. For example, \\\"10\\\" means the measurement is 10% of the underlying frame height. The rectangle top edge starts at that position from the top edge of the frame.\nThis field corresponds to tts:origin - Y in the TTML standard."
},
"Width": {
"shape": "__doubleMin0Max100",
"locationName": "width",
"documentation": "See the description in leftOffset.\nFor width, specify the entire width of the rectangle as a percentage of the underlying frame width. For example, \\\"80\\\" means the rectangle width is 80% of the underlying frame width. The leftOffset and rectangleWidth must add up to 100% or less.\nThis field corresponds to tts:extent - X in the TTML standard."
}
},
"documentation": "Caption Rectangle",
"required": [
"TopOffset",
"Height",
"Width",
"LeftOffset"
]
},
"CaptionSelector": {
"type": "structure",
"members": {
@ -4912,6 +5020,69 @@
},
"documentation": "Placeholder documentation for CreateMultiplexResultModel"
},
"CreatePartnerInput": {
"type": "structure",
"members": {
"RequestId": {
"shape": "__string",
"locationName": "requestId",
"documentation": "Unique identifier of the request to ensure the request is handled\nexactly once in case of retries.\n",
"idempotencyToken": true
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "A collection of key-value pairs."
}
},
"documentation": "Placeholder documentation for CreatePartnerInput"
},
"CreatePartnerInputRequest": {
"type": "structure",
"members": {
"InputId": {
"shape": "__string",
"location": "uri",
"locationName": "inputId",
"documentation": "Unique ID of the input."
},
"RequestId": {
"shape": "__string",
"locationName": "requestId",
"documentation": "Unique identifier of the request to ensure the request is handled\nexactly once in case of retries.\n",
"idempotencyToken": true
},
"Tags": {
"shape": "Tags",
"locationName": "tags",
"documentation": "A collection of key-value pairs."
}
},
"documentation": "A request to create a partner input",
"required": [
"InputId"
]
},
"CreatePartnerInputResponse": {
"type": "structure",
"members": {
"Input": {
"shape": "Input",
"locationName": "input"
}
},
"documentation": "Placeholder documentation for CreatePartnerInputResponse"
},
"CreatePartnerInputResultModel": {
"type": "structure",
"members": {
"Input": {
"shape": "Input",
"locationName": "input"
}
},
"documentation": "Placeholder documentation for CreatePartnerInputResultModel"
},
"CreateTagsRequest": {
"type": "structure",
"members": {
@ -5644,6 +5815,11 @@
"locationName": "inputDevices",
"documentation": "Settings for the input devices."
},
"InputPartnerIds": {
"shape": "__listOf__string",
"locationName": "inputPartnerIds",
"documentation": "A list of IDs for all Inputs which are partners of this one."
},
"InputSourceType": {
"shape": "InputSourceType",
"locationName": "inputSourceType",
@ -6579,6 +6755,11 @@
"EbuTtDDestinationSettings": {
"type": "structure",
"members": {
"CopyrightHolder": {
"shape": "__stringMax1000",
"locationName": "copyrightHolder",
"documentation": "Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. Complete this field if you want to include the name of the copyright holder in the copyright metadata tag in the TTML"
},
"FillLineGap": {
"shape": "EbuTtDFillLineGapControl",
"locationName": "fillLineGap",
@ -6927,6 +7108,16 @@
},
"documentation": "Placeholder documentation for ForbiddenException"
},
"FrameCaptureCdnSettings": {
"type": "structure",
"members": {
"FrameCaptureS3Settings": {
"shape": "FrameCaptureS3Settings",
"locationName": "frameCaptureS3Settings"
}
},
"documentation": "Frame Capture Cdn Settings"
},
"FrameCaptureGroupSettings": {
"type": "structure",
"members": {
@ -6934,6 +7125,11 @@
"shape": "OutputLocationRef",
"locationName": "destination",
"documentation": "The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling-) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling-). The final file names consist of the prefix from the destination field (for example, \"curling-\") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curling-low.00001.jpg"
},
"FrameCaptureCdnSettings": {
"shape": "FrameCaptureCdnSettings",
"locationName": "frameCaptureCdnSettings",
"documentation": "Parameters that control interactions with the CDN."
}
},
"documentation": "Frame Capture Group Settings",
@ -6966,6 +7162,25 @@
},
"documentation": "Frame Capture Output Settings"
},
"FrameCaptureS3LogUploads": {
"type": "string",
"documentation": "Frame Capture S3 Log Uploads",
"enum": [
"DISABLED",
"ENABLED"
]
},
"FrameCaptureS3Settings": {
"type": "structure",
"members": {
"CannedAcl": {
"shape": "S3CannedAcl",
"locationName": "cannedAcl",
"documentation": "Specify the canned ACL to apply to each S3 request. Defaults to none."
}
},
"documentation": "Frame Capture S3 Settings"
},
"FrameCaptureSettings": {
"type": "structure",
"members": {
@ -7427,7 +7642,7 @@
"Softness": {
"shape": "__integerMin0Max128",
"locationName": "softness",
"documentation": "Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image."
"documentation": "Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image. If not set to zero, must be greater than 15."
},
"SpatialAq": {
"shape": "H264SpatialAq",
@ -7930,6 +8145,10 @@
"shape": "HlsMediaStoreSettings",
"locationName": "hlsMediaStoreSettings"
},
"HlsS3Settings": {
"shape": "HlsS3Settings",
"locationName": "hlsS3Settings"
},
"HlsWebdavSettings": {
"shape": "HlsWebdavSettings",
"locationName": "hlsWebdavSettings"
@ -8392,6 +8611,25 @@
"ENABLED"
]
},
"HlsS3LogUploads": {
"type": "string",
"documentation": "Hls S3 Log Uploads",
"enum": [
"DISABLED",
"ENABLED"
]
},
"HlsS3Settings": {
"type": "structure",
"members": {
"CannedAcl": {
"shape": "S3CannedAcl",
"locationName": "cannedAcl",
"documentation": "Specify the canned ACL to apply to each S3 request. Defaults to none."
}
},
"documentation": "Hls S3 Settings"
},
"HlsSegmentationMode": {
"type": "string",
"documentation": "Hls Segmentation Mode",
@ -8547,6 +8785,11 @@
"locationName": "inputDevices",
"documentation": "Settings for the input devices."
},
"InputPartnerIds": {
"shape": "__listOf__string",
"locationName": "inputPartnerIds",
"documentation": "A list of IDs for all Inputs which are partners of this one."
},
"InputSourceType": {
"shape": "InputSourceType",
"locationName": "inputSourceType",
@ -12481,6 +12724,16 @@
"Destination"
]
},
"S3CannedAcl": {
"type": "string",
"documentation": "S3 Canned Acl",
"enum": [
"AUTHENTICATED_READ",
"BUCKET_OWNER_FULL_CONTROL",
"BUCKET_OWNER_READ",
"PUBLIC_READ"
]
},
"ScheduleAction": {
"type": "structure",
"members": {
@ -13542,6 +13795,11 @@
"TeletextSourceSettings": {
"type": "structure",
"members": {
"OutputRectangle": {
"shape": "CaptionRectangle",
"locationName": "outputRectangle",
"documentation": "Optionally defines a region where TTML style captions will be displayed"
},
"PageNumber": {
"shape": "__string",
"locationName": "pageNumber",
@ -13659,6 +13917,11 @@
"locationName": "targetCustomerId",
"documentation": "The AWS account ID (12 digits) for the recipient of the device transfer."
},
"TargetRegion": {
"shape": "__string",
"locationName": "targetRegion",
"documentation": "The target AWS region to transfer the device."
},
"TransferMessage": {
"shape": "__string",
"locationName": "transferMessage",
@ -13681,6 +13944,11 @@
"locationName": "targetCustomerId",
"documentation": "The AWS account ID (12 digits) for the recipient of the device transfer."
},
"TargetRegion": {
"shape": "__string",
"locationName": "targetRegion",
"documentation": "The target AWS region to transfer the device."
},
"TransferMessage": {
"shape": "__string",
"locationName": "transferMessage",
@ -14719,6 +14987,10 @@
"type": "double",
"documentation": "Placeholder documentation for __doubleMin0Max1"
},
"__doubleMin0Max100": {
"type": "double",
"documentation": "Placeholder documentation for __doubleMin0Max100"
},
"__doubleMin1": {
"type": "double",
"documentation": "Placeholder documentation for __doubleMin1"
@ -15394,6 +15666,11 @@
"type": "string",
"documentation": "Placeholder documentation for __string"
},
"__stringMax1000": {
"type": "string",
"max": 1000,
"documentation": "Placeholder documentation for __stringMax1000"
},
"__stringMax256": {
"type": "string",
"max": 256,

132
botocore/data/mediapackage-vod/2018-11-07/service-2.json
View file

@ -13,6 +13,42 @@
"uid": "mediapackage-vod-2018-11-07"
},
"operations": {
"ConfigureLogs": {
"documentation": "Changes the packaging group's properities to configure log subscription",
"errors": [
{
"shape": "UnprocessableEntityException"
},
{
"shape": "InternalServerErrorException"
},
{
"shape": "ForbiddenException"
},
{
"shape": "NotFoundException"
},
{
"shape": "ServiceUnavailableException"
},
{
"shape": "TooManyRequestsException"
}
],
"http": {
"method": "PUT",
"requestUri": "/packaging_groups/{id}/configure_logs",
"responseCode": 200
},
"input": {
"shape": "ConfigureLogsRequest"
},
"name": "ConfigureLogs",
"output": {
"documentation": "The updated MediaPackage VOD PackagingGroup resource.",
"shape": "ConfigureLogsResponse"
}
},
"CreateAsset": {
"documentation": "Creates a new MediaPackage VOD Asset resource.",
"errors": [
@ -742,6 +778,67 @@
],
"type": "structure"
},
"ConfigureLogsParameters": {
"documentation": "The configuration parameters for egress access logging.",
"members": {
"EgressAccessLogs": {
"locationName": "egressAccessLogs",
"shape": "EgressAccessLogs"
}
},
"type": "structure"
},
"ConfigureLogsRequest": {
"documentation": "The option to configure log subscription.",
"members": {
"EgressAccessLogs": {
"locationName": "egressAccessLogs",
"shape": "EgressAccessLogs"
},
"Id": {
"documentation": "The ID of a MediaPackage VOD PackagingGroup resource.",
"location": "uri",
"locationName": "id",
"shape": "__string"
}
},
"required": [
"Id"
],
"type": "structure"
},
"ConfigureLogsResponse": {
"members": {
"Arn": {
"documentation": "The ARN of the PackagingGroup.",
"locationName": "arn",
"shape": "__string"
},
"Authorization": {
"locationName": "authorization",
"shape": "Authorization"
},
"DomainName": {
"documentation": "The fully qualified domain name for Assets in the PackagingGroup.",
"locationName": "domainName",
"shape": "__string"
},
"EgressAccessLogs": {
"locationName": "egressAccessLogs",
"shape": "EgressAccessLogs"
},
"Id": {
"documentation": "The ID of the PackagingGroup.",
"locationName": "id",
"shape": "__string"
},
"Tags": {
"locationName": "tags",
"shape": "Tags"
}
},
"type": "structure"
},
"CreateAssetRequest": {
"documentation": "A new MediaPackage VOD Asset configuration.",
"members": {
@ -919,6 +1016,10 @@
"locationName": "authorization",
"shape": "Authorization"
},
"EgressAccessLogs": {
"locationName": "egressAccessLogs",
"shape": "EgressAccessLogs"
},
"Id": {
"documentation": "The ID of the PackagingGroup.",
"locationName": "id",
@ -950,6 +1051,10 @@
"locationName": "domainName",
"shape": "__string"
},
"EgressAccessLogs": {
"locationName": "egressAccessLogs",
"shape": "EgressAccessLogs"
},
"Id": {
"documentation": "The ID of the PackagingGroup.",
"locationName": "id",
@ -1239,6 +1344,10 @@
"locationName": "domainName",
"shape": "__string"
},
"EgressAccessLogs": {
"locationName": "egressAccessLogs",
"shape": "EgressAccessLogs"
},
"Id": {
"documentation": "The ID of the PackagingGroup.",
"locationName": "id",
@ -1251,6 +1360,17 @@
},
"type": "structure"
},
"EgressAccessLogs": {
"documentation": "Configure egress access logging.",
"members": {
"LogGroupName": {
"documentation": "Customize the log group name.",
"locationName": "logGroupName",
"shape": "__string"
}
},
"type": "structure"
},
"EgressEndpoint": {
"documentation": "The endpoint URL used to access an Asset using one PackagingConfiguration.",
"members": {
@ -1711,6 +1831,10 @@
"locationName": "domainName",
"shape": "__string"
},
"EgressAccessLogs": {
"locationName": "egressAccessLogs",
"shape": "EgressAccessLogs"
},
"Id": {
"documentation": "The ID of the PackagingGroup.",
"locationName": "id",
@ -1730,6 +1854,10 @@
"locationName": "authorization",
"shape": "Authorization"
},
"EgressAccessLogs": {
"locationName": "egressAccessLogs",
"shape": "EgressAccessLogs"
},
"Id": {
"documentation": "The ID of the PackagingGroup.",
"locationName": "id",
@ -1982,6 +2110,10 @@
"locationName": "domainName",
"shape": "__string"
},
"EgressAccessLogs": {
"locationName": "egressAccessLogs",
"shape": "EgressAccessLogs"
},
"Id": {
"documentation": "The ID of the PackagingGroup.",
"locationName": "id",

24
botocore/data/mediatailor/2018-04-23/paginators-1.json
View file

@ -5,6 +5,30 @@
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Items"
},
"GetChannelSchedule": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Items"
},
"ListChannels": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Items"
},
"ListSourceLocations": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Items"
},
"ListVodSources": {
"input_token": "NextToken",
"limit_key": "MaxResults",
"output_token": "NextToken",
"result_key": "Items"
}
}
}

3437
botocore/data/mediatailor/2018-04-23/service-2.json
View file

@ -1,764 +1,2691 @@
{
"documentation": "<p>Use the AWS Elemental MediaTailor SDK to configure scalable ad insertion for your live and VOD content. With AWS Elemental MediaTailor, you can serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the AWS Elemental MediaTailor User Guide.<p>Through the SDK, you manage AWS Elemental MediaTailor configurations the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).</p>",
"metadata": {
"apiVersion": "2018-04-23",
"endpointPrefix": "api.mediatailor",
"jsonVersion": "1.1",
"protocol": "rest-json",
"serviceAbbreviation": "MediaTailor",
"serviceFullName": "AWS MediaTailor",
"serviceId": "MediaTailor",
"signatureVersion": "v4",
"signingName": "mediatailor",
"uid": "mediatailor-2018-04-23"
},
"operations": {
"DeletePlaybackConfiguration": {
"documentation": "<p>Deletes the playback configuration for the specified name. </p>",
"errors": [],
"http": {
"method": "DELETE",
"requestUri": "/playbackConfiguration/{Name}",
"responseCode": 204
},
"input": {
"shape": "DeletePlaybackConfigurationRequest"
},
"name": "DeletePlaybackConfiguration",
"output": {
"documentation": "<p>The request was successful and there is no content in the response. </p>",
"shape": "DeletePlaybackConfigurationResponse"
}
},
"GetPlaybackConfiguration": {
"documentation": "<p>Returns the playback configuration for the specified name. </p>",
"errors": [],
"http": {
"method": "GET",
"requestUri": "/playbackConfiguration/{Name}",
"responseCode": 200
},
"input": {
"shape": "GetPlaybackConfigurationRequest"
},
"name": "GetPlaybackConfiguration",
"output": {
"documentation": "<p>Success.</p>",
"shape": "GetPlaybackConfigurationResponse"
}
},
"ListPlaybackConfigurations": {
"documentation": "<p>Returns a list of the playback configurations defined in AWS Elemental MediaTailor. You can specify a maximum number of configurations to return at a time. The default maximum is 50. Results are returned in pagefuls. If MediaTailor has more configurations than the specified maximum, it provides parameters in the response that you can use to retrieve the next pageful. </p>",
"errors": [],
"http": {
"method": "GET",
"requestUri": "/playbackConfigurations",
"responseCode": 200
},
"input": {
"shape": "ListPlaybackConfigurationsRequest"
},
"name": "ListPlaybackConfigurations",
"output": {
"documentation": "<p>Success.</p>",
"shape": "ListPlaybackConfigurationsResponse"
}
},
"ListTagsForResource": {
"documentation": "<p>Returns a list of the tags assigned to the specified playback configuration resource. </p>",
"errors": [
{
"documentation": "<p>Invalid request parameters.</p>",
"shape": "BadRequestException"
}
],
"http": {
"method": "GET",
"requestUri": "/tags/{ResourceArn}",
"responseCode": 200
},
"input": {
"shape": "ListTagsForResourceRequest"
},
"name": "ListTagsForResource",
"output": {
"documentation": "<p>Success. </p>",
"shape": "ListTagsForResourceResponse"
}
},
"PutPlaybackConfiguration": {
"documentation": "<p>Adds a new playback configuration to AWS Elemental MediaTailor. </p>",
"errors": [],
"http": {
"method": "PUT",
"requestUri": "/playbackConfiguration",
"responseCode": 200
},
"input": {
"shape": "PutPlaybackConfigurationRequest"
},
"name": "PutPlaybackConfiguration",
"output": {
"documentation": "<p>Success.</p>",
"shape": "PutPlaybackConfigurationResponse"
}
},
"TagResource": {
"documentation": "<p>Adds tags to the specified playback configuration resource. You can specify one or more tags to add. </p>",
"errors": [
{
"documentation": "<p>Invalid request parameters.</p>",
"shape": "BadRequestException"
}
],
"http": {
"method": "POST",
"requestUri": "/tags/{ResourceArn}",
"responseCode": 204
},
"input": {
"shape": "TagResourceRequest"
},
"name": "TagResource"
},
"UntagResource": {
"documentation": "<p>Removes tags from the specified playback configuration resource. You can specify one or more tags to remove. </p>",
"errors": [
{
"documentation": "<p>Invalid request parameters.</p>",
"shape": "BadRequestException"
}
],
"http": {
"method": "DELETE",
"requestUri": "/tags/{ResourceArn}",
"responseCode": 204
},
"input": {
"shape": "UntagResourceRequest"
},
"name": "UntagResource"
"documentation": "<p>Use the AWS Elemental MediaTailor SDKs and CLI to configure scalable ad insertion and linear channels. With MediaTailor, you can assemble existing content into a linear stream and serve targeted ads to viewers while maintaining broadcast quality in over-the-top (OTT) video applications. For information about using the service, including detailed information about the settings covered in this guide, see the <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/\">AWS Elemental MediaTailor User Guide</a>.</p> <p>Through the SDKs and the CLI you manage AWS Elemental MediaTailor configurations and channels the same as you do through the console. For example, you specify ad insertion behavior and mapping information for the origin server and the ad decision server (ADS).</p>",
"metadata": {
"apiVersion": "2018-04-23",
"endpointPrefix": "api.mediatailor",
"jsonVersion": "1.1",
"protocol": "rest-json",
"serviceAbbreviation": "MediaTailor",
"serviceFullName": "AWS MediaTailor",
"serviceId": "MediaTailor",
"signatureVersion": "v4",
"signingName": "mediatailor",
"uid": "mediatailor-2018-04-23"
},
"operations": {
"CreateChannel": {
"documentation": "<p>Creates a channel.</p>",
"errors": [],
"http": {
"method": "POST",
"requestUri": "/channel/{channelName}",
"responseCode": 200
},
"input": {
"shape": "CreateChannelRequest"
},
"name": "CreateChannel",
"output": {
"documentation": "<p>Success.</p>",
"shape": "CreateChannelResponse"
}
},
"CreateProgram": {
"documentation": "<p>Creates a program.</p>",
"errors": [],
"http": {
"method": "POST",
"requestUri": "/channel/{channelName}/program/{programName}",
"responseCode": 200
},
"input": {
"shape": "CreateProgramRequest"
},
"name": "CreateProgram",
"output": {
"documentation": "<p>Success.</p>",
"shape": "CreateProgramResponse"
}
},
"CreateSourceLocation": {
"documentation": "<p>Creates a source location on a specific channel.</p>",
"errors": [],
"http": {
"method": "POST",
"requestUri": "/sourceLocation/{sourceLocationName}",
"responseCode": 200
},
"input": {
"shape": "CreateSourceLocationRequest"
},
"name": "CreateSourceLocation",
"output": {
"documentation": "<p>Success.</p>",
"shape": "CreateSourceLocationResponse"
}
},
"CreateVodSource": {
"documentation": "<p>Creates name for a specific VOD source in a source location.</p>",
"errors": [],
"http": {
"method": "POST",
"requestUri": "/sourceLocation/{sourceLocationName}/vodSource/{vodSourceName}",
"responseCode": 200
},
"input": {
"shape": "CreateVodSourceRequest"
},
"name": "CreateVodSource",
"output": {
"documentation": "<p>Success.</p>",
"shape": "CreateVodSourceResponse"
}
},
"DeleteChannel": {
"documentation": "<p>Deletes a channel. You must stop the channel before it can be deleted.</p>",
"errors": [],
"http": {
"method": "DELETE",
"requestUri": "/channel/{channelName}",
"responseCode": 200
},
"input": {
"shape": "DeleteChannelRequest"
},
"name": "DeleteChannel",
"output": {
"documentation": "<p>Success.</p>",
"shape": "DeleteChannelResponse"
}
},
"DeleteChannelPolicy": {
"documentation": "<p>Deletes a channel's IAM policy.</p>",
"errors": [],
"http": {
"method": "DELETE",
"requestUri": "/channel/{channelName}/policy",
"responseCode": 200
},
"input": {
"shape": "DeleteChannelPolicyRequest"
},
"name": "DeleteChannelPolicy",
"output": {
"documentation": "<p>Success.</p>",
"shape": "DeleteChannelPolicyResponse"
}
},
"DeletePlaybackConfiguration": {
"documentation": "<p>Deletes the playback configuration for the specified name.</p> ",
"errors": [],
"http": {
"method": "DELETE",
"requestUri": "/playbackConfiguration/{Name}",
"responseCode": 204
},
"input": {
"shape": "DeletePlaybackConfigurationRequest"
},
"name": "DeletePlaybackConfiguration",
"output": {
"documentation": "<p>The request was successful and there is no content in the response.</p>",
"shape": "DeletePlaybackConfigurationResponse"
}
},
"DeleteProgram": {
"documentation": "<p>Deletes a specific program on a specific channel.</p>",
"errors": [],
"http": {
"method": "DELETE",
"requestUri": "/channel/{channelName}/program/{programName}",
"responseCode": 200
},
"input": {
"shape": "DeleteProgramRequest"
},
"name": "DeleteProgram",
"output": {
"documentation": "<p>Success.</p>",
"shape": "DeleteProgramResponse"
}
},
"DeleteSourceLocation": {
"documentation": "<p>Deletes a source location on a specific channel.</p>",
"errors": [],
"http": {
"method": "DELETE",
"requestUri": "/sourceLocation/{sourceLocationName}",
"responseCode": 200
},
"input": {
"shape": "DeleteSourceLocationRequest"
},
"name": "DeleteSourceLocation",
"output": {
"documentation": "<p>Success.</p>",
"shape": "DeleteSourceLocationResponse"
}
},
"DeleteVodSource": {
"documentation": "<p>Deletes a specific VOD source in a specific source location.</p>",
"errors": [],
"http": {
"method": "DELETE",
"requestUri": "/sourceLocation/{sourceLocationName}/vodSource/{vodSourceName}",
"responseCode": 200
},
"input": {
"shape": "DeleteVodSourceRequest"
},
"name": "DeleteVodSource",
"output": {
"documentation": "<p>Success.</p>",
"shape": "DeleteVodSourceResponse"
}
},
"DescribeChannel": {
"documentation": "<p>Describes the properties of a specific channel.</p>",
"errors": [],
"http": {
"method": "GET",
"requestUri": "/channel/{channelName}",
"responseCode": 200
},
"input": {
"shape": "DescribeChannelRequest"
},
"name": "DescribeChannel",
"output": {
"documentation": "<p>Success.</p>",
"shape": "DescribeChannelResponse"
}
},
"DescribeProgram": {
"documentation": "<p>Retrieves the properties of the requested program.</p>",
"errors": [],
"http": {
"method": "GET",
"requestUri": "/channel/{channelName}/program/{programName}",
"responseCode": 200
},
"input": {
"shape": "DescribeProgramRequest"
},
"name": "DescribeProgram",
"output": {
"documentation": "<p>Success.</p>",
"shape": "DescribeProgramResponse"
}
},
"DescribeSourceLocation": {
"documentation": "<p>Retrieves the properties of the requested source location.</p>",
"errors": [],
"http": {
"method": "GET",
"requestUri": "/sourceLocation/{sourceLocationName}",
"responseCode": 200
},
"input": {
"shape": "DescribeSourceLocationRequest"
},
"name": "DescribeSourceLocation",
"output": {
"documentation": "<p>Success.</p>",
"shape": "DescribeSourceLocationResponse"
}
},
"DescribeVodSource": {
"documentation": "<p>Provides details about a specific VOD source in a specific source location.</p>",
"errors": [],
"http": {
"method": "GET",
"requestUri": "/sourceLocation/{sourceLocationName}/vodSource/{vodSourceName}",
"responseCode": 200
},
"input": {
"shape": "DescribeVodSourceRequest"
},
"name": "DescribeVodSource",
"output": {
"documentation": "<p>Success.</p>",
"shape": "DescribeVodSourceResponse"
}
},
"GetChannelPolicy": {
"documentation": "<p>Retrieves information about a channel's IAM policy.</p>",
"errors": [],
"http": {
"method": "GET",
"requestUri": "/channel/{channelName}/policy",
"responseCode": 200
},
"input": {
"shape": "GetChannelPolicyRequest"
},
"name": "GetChannelPolicy",
"output": {
"documentation": "<p>Success.</p>",
"shape": "GetChannelPolicyResponse"
}
},
"GetChannelSchedule": {
"documentation": "<p>Retrieves information about your channel's schedule.</p>",
"errors": [],
"http": {
"method": "GET",
"requestUri": "/channel/{channelName}/schedule",
"responseCode": 200
},
"input": {
"shape": "GetChannelScheduleRequest"
},
"name": "GetChannelSchedule",
"output": {
"documentation": "<p>Success.</p>",
"shape": "GetChannelScheduleResponse"
}
},
"GetPlaybackConfiguration": {
"documentation": "<p>Returns the playback configuration for the specified name.</p> ",
"errors": [],
"http": {
"method": "GET",
"requestUri": "/playbackConfiguration/{Name}",
"responseCode": 200
},
"input": {
"shape": "GetPlaybackConfigurationRequest"
},
"name": "GetPlaybackConfiguration",
"output": {
"documentation": "<p>Success.</p>",
"shape": "GetPlaybackConfigurationResponse"
}
},
"ListChannels": {
"documentation": "<p>Retrieves a list of channels that are associated with this account.</p>",
"errors": [],
"http": {
"method": "GET",
"requestUri": "/channels",
"responseCode": 200
},
"input": {
"shape": "ListChannelsRequest"
},
"name": "ListChannels",
"output": {
"documentation": "<p>Success.</p>",
"shape": "ListChannelsResponse"
}
},
"ListPlaybackConfigurations": {
"documentation": "<p>Returns a list of the playback configurations defined in AWS Elemental MediaTailor. You can specify a maximum number of configurations to return at a time. The default maximum is 50. Results are returned in pagefuls. If MediaTailor has more configurations than the specified maximum, it provides parameters in the response that you can use to retrieve the next pageful.</p> ",
"errors": [],
"http": {
"method": "GET",
"requestUri": "/playbackConfigurations",
"responseCode": 200
},
"input": {
"shape": "ListPlaybackConfigurationsRequest"
},
"name": "ListPlaybackConfigurations",
"output": {
"documentation": "<p>Success.</p>",
"shape": "ListPlaybackConfigurationsResponse"
}
},
"ListSourceLocations": {
"documentation": "<p>Retrieves a list of source locations.</p>",
"errors": [],
"http": {
"method": "GET",
"requestUri": "/sourceLocations",
"responseCode": 200
},
"input": {
"shape": "ListSourceLocationsRequest"
},
"name": "ListSourceLocations",
"output": {
"documentation": "<p>Success.</p>",
"shape": "ListSourceLocationsResponse"
}
},
"ListTagsForResource": {
"documentation": "<p>Returns a list of the tags assigned to the specified playback configuration resource.</p> ",
"errors": [
{
"documentation": "<p>Invalid request parameters.</p>",
"shape": "BadRequestException"
}
},
"shapes": {
"AdMarkerPassthrough" : {
"type" : "structure",
"members" : {
"Enabled" : {
"documentation": "<p>For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.</p><p>No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.</p>",
"shape" : "__boolean"
}
},
"documentation" : "<p>The configuration for Ad Marker Passthrough. Ad marker passthrough can be used to pass ad markers from the origin to the customized manifest.</p>"
},
"AvailSuppression": {
"type": "structure",
"documentation" : "<p>The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.</p>",
"members": {
"Mode": {
"documentation": "Sets the mode for avail suppression, also known as ad suppression. By default, ad suppression is off and all ad breaks are filled by MediaTailor with ads or slate.",
"shape": "Mode"
},
"Value": {
"documentation": "The avail suppression value is a live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. ",
"shape": "__string"
}
}
],
"http": {
"method": "GET",
"requestUri": "/tags/{ResourceArn}",
"responseCode": 200
},
"input": {
"shape": "ListTagsForResourceRequest"
},
"name": "ListTagsForResource",
"output": {
"documentation": "<p>Success.</p>",
"shape": "ListTagsForResourceResponse"
}
},
"ListVodSources": {
"documentation": "<p>Lists all the VOD sources in a source location.</p>",
"errors": [],
"http": {
"method": "GET",
"requestUri": "/sourceLocation/{sourceLocationName}/vodSources",
"responseCode": 200
},
"input": {
"shape": "ListVodSourcesRequest"
},
"name": "ListVodSources",
"output": {
"documentation": "<p>Success.</p>",
"shape": "ListVodSourcesResponse"
}
},
"PutChannelPolicy": {
"documentation": "<p>Creates an IAM policy for the channel.</p>",
"errors": [],
"http": {
"method": "PUT",
"requestUri": "/channel/{channelName}/policy",
"responseCode": 200
},
"input": {
"shape": "PutChannelPolicyRequest"
},
"name": "PutChannelPolicy",
"output": {
"documentation": "<p>Success.</p>",
"shape": "PutChannelPolicyResponse"
}
},
"PutPlaybackConfiguration": {
"documentation": "<p>Adds a new playback configuration to AWS Elemental MediaTailor.</p> ",
"errors": [],
"http": {
"method": "PUT",
"requestUri": "/playbackConfiguration",
"responseCode": 200
},
"input": {
"shape": "PutPlaybackConfigurationRequest"
},
"name": "PutPlaybackConfiguration",
"output": {
"documentation": "<p>Success.</p>",
"shape": "PutPlaybackConfigurationResponse"
}
},
"StartChannel": {
"documentation": "<p>Starts a specific channel.</p>",
"errors": [],
"http": {
"method": "PUT",
"requestUri": "/channel/{channelName}/start",
"responseCode": 200
},
"input": {
"shape": "StartChannelRequest"
},
"name": "StartChannel",
"output": {
"documentation": "<p>Success.</p>",
"shape": "StartChannelResponse"
}
},
"StopChannel": {
"documentation": "<p>Stops a specific channel.</p>",
"errors": [],
"http": {
"method": "PUT",
"requestUri": "/channel/{channelName}/stop",
"responseCode": 200
},
"input": {
"shape": "StopChannelRequest"
},
"name": "StopChannel",
"output": {
"documentation": "<p>Success.</p>",
"shape": "StopChannelResponse"
}
},
"TagResource": {
"documentation": "<p>Adds tags to the specified playback configuration resource. You can specify one or more tags to add.</p> ",
"errors": [
{
"documentation": "<p>Invalid request parameters.</p>",
"shape": "BadRequestException"
}
],
"http": {
"method": "POST",
"requestUri": "/tags/{ResourceArn}",
"responseCode": 204
},
"input": {
"shape": "TagResourceRequest"
},
"name": "TagResource"
},
"UntagResource": {
"documentation": "<p>Removes tags from the specified playback configuration resource. You can specify one or more tags to remove.</p> ",
"errors": [
{
"documentation": "<p>Invalid request parameters.</p>",
"shape": "BadRequestException"
}
],
"http": {
"method": "DELETE",
"requestUri": "/tags/{ResourceArn}",
"responseCode": 204
},
"input": {
"shape": "UntagResourceRequest"
},
"name": "UntagResource"
},
"UpdateChannel": {
"documentation": "<p>Updates an existing channel.</p>",
"errors": [],
"http": {
"method": "PUT",
"requestUri": "/channel/{channelName}",
"responseCode": 200
},
"input": {
"shape": "UpdateChannelRequest"
},
"name": "UpdateChannel",
"output": {
"documentation": "<p>Success.</p>",
"shape": "UpdateChannelResponse"
}
},
"UpdateSourceLocation": {
"documentation": "<p>Updates a source location on a specific channel.</p>",
"errors": [],
"http": {
"method": "PUT",
"requestUri": "/sourceLocation/{sourceLocationName}",
"responseCode": 200
},
"input": {
"shape": "UpdateSourceLocationRequest"
},
"name": "UpdateSourceLocation",
"output": {
"documentation": "<p>Success.</p>",
"shape": "UpdateSourceLocationResponse"
}
},
"UpdateVodSource": {
"documentation": "<p>Updates a specific VOD source in a specific source location.</p>",
"errors": [],
"http": {
"method": "PUT",
"requestUri": "/sourceLocation/{sourceLocationName}/vodSource/{vodSourceName}",
"responseCode": 200
},
"input": {
"shape": "UpdateVodSourceRequest"
},
"name": "UpdateVodSource",
"output": {
"documentation": "<p>Success.</p>",
"shape": "UpdateVodSourceResponse"
}
}
},
"shapes": {
"AccessConfiguration": {
"documentation": "<p>Access configuration parameters.</p>",
"members": {
"AccessType": {
"documentation": "<p>The type of authentication used to access content from HttpConfiguration::BaseUrl on your source location. Accepted value: S3_SIGV4.</p> <p>S3_SIGV4 - AWS Signature Version 4 authentication for Amazon S3 hosted virtual-style access. If your source location base URL is an Amazon S3 bucket, MediaTailor can use AWS Signature Version 4 (SigV4) authentication to access the bucket where your source content is stored. Your MediaTailor source location baseURL must follow the S3 virtual hosted-style request URL format. For example, https://bucket-name.s3.Region.amazonaws.com/key-name.</p> <p>Before you can use S3_SIGV4, you must meet these requirements:</p> <p>\u2022 You must allow MediaTailor to access your S3 bucket by granting mediatailor.amazonaws.com principal access in IAM. For information about configuring access in IAM, see Access management in the IAM User Guide.</p> <p>\u2022 The mediatailor.amazonaws.com service principal must have permissions to read all top level manifests referenced by the VodSource packaging configurations.</p> <p>\u2022 The caller of the API must have s3:GetObject IAM permissions to read all top level manifests referenced by your MediaTailor VodSource packaging configurations.</p>",
"shape": "AccessType"
}
},
"type": "structure"
},
"AccessType": {
"enum": [
"S3_SIGV4"
],
"type": "string"
},
"AdBreak": {
"documentation": "<p>Ad break configuration parameters.</p>",
"members": {
"MessageType": {
"documentation": "<p>The SCTE-35 ad insertion type. Accepted value: SPLICE_INSERT.</p>",
"shape": "MessageType"
},
"BadRequestException": {
"documentation": "<p>Invalid request parameters.</p>",
"error": {
"httpStatusCode": 400
},
"exception": true,
"members": {
"Message": {
"shape": "__string"
}
},
"type": "structure"
},
"Bumper": {
"type": "structure",
"documentation": "<p>The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. </p>",
"members": {
"EndUrl": {
"documentation": "<p>The URL for the end bumper asset. </p>",
"shape": "__string"
},
"StartUrl": {
"documentation": "<p>The URL for the start bumper asset. </p>",
"shape": "__string"
}
}
"OffsetMillis": {
"documentation": "<p>How long (in milliseconds) after the beginning of the program that an ad starts. This value must fall within 100ms of a segment boundary, otherwise the ad break will be skipped.</p>",
"shape": "__long"
},
"CdnConfiguration": {
"documentation": "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. </p>",
"members": {
"AdSegmentUrlPrefix": {
"documentation": "<p>A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the following origin: ads.mediatailor.&lt;region>.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.</p>",
"shape": "__string"
},
"ContentSegmentUrlPrefix": {
"documentation": "<p>A content delivery network (CDN) to cache content segments, so that content requests don’t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"DashConfiguration": {
"documentation": "<p>The configuration for DASH content. </p>",
"members": {
"ManifestEndpointPrefix": {
"documentation": "<p>The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations. </p>",
"shape": "__string"
},
"MpdLocation": {
"documentation": "<p>The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value. </p>",
"shape": "__string"
},
"OriginManifestType": {
"documentation": "<p>The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD. </p>",
"shape": "OriginManifestType"
}
},
"type": "structure"
},
"DashConfigurationForPut": {
"documentation": "<p>The configuration for DASH PUT operations. </p>",
"members": {
"MpdLocation": {
"documentation": "<p>The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value. </p>",
"shape": "__string"
},
"OriginManifestType": {
"documentation": "<p>The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD. </p>",
"shape": "OriginManifestType"
}
},
"type": "structure"
},
"DeletePlaybackConfigurationRequest": {
"members": {
"Name": {
"documentation": "<p>The identifier for the playback configuration.</p>",
"location": "uri",
"locationName": "Name",
"shape": "__string"
}
},
"required": [
"Name"
],
"type": "structure"
},
"DeletePlaybackConfigurationResponse": {
"members": {},
"type": "structure"
},
"Empty": {
"members": {},
"type": "structure"
},
"GetPlaybackConfigurationRequest": {
"members": {
"Name": {
"documentation": "<p>The identifier for the playback configuration.</p>",
"location": "uri",
"locationName": "Name",
"shape": "__string"
}
},
"required": [
"Name"
],
"type": "structure"
},
"GetPlaybackConfigurationResponse": {
"members": {
"AdDecisionServerUrl": {
"documentation": "<p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.</p>",
"shape": "__string"
},
"AvailSuppression": {
"shape": "AvailSuppression",
"documentation": "<p>The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.</p>"
},
"Bumper": {
"shape": "Bumper",
"documentation": "<p>The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. </p>"
},
"CdnConfiguration": {
"documentation": "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. </p>",
"shape": "CdnConfiguration"
},
"DashConfiguration": {
"documentation": "<p>The configuration for DASH content. </p>",
"shape": "DashConfiguration"
},
"HlsConfiguration": {
"documentation": "<p>The configuration for HLS content. </p>",
"shape": "HlsConfiguration"
},
"LivePreRollConfiguration" : {
"shape" : "LivePreRollConfiguration",
"documentation" : "<p>The configuration for pre-roll ad insertion.</p>"
},
"ManifestProcessingRules": {
"shape" : "ManifestProcessingRules",
"documentation" : "<p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>"
},
"Name": {
"documentation": "<p>The identifier for the playback configuration.</p>",
"shape": "__string"
},
"PersonalizationThresholdSeconds" : {
"documentation": "<p>The maximum duration of underfilled ad time (in seconds) allowed in an ad break.</p>",
"shape" : "__integerMin1"
},
"PlaybackConfigurationArn": {
"documentation": "<p>The Amazon Resource Name (ARN) for the playback configuration. </p>",
"shape": "__string"
},
"PlaybackEndpointPrefix": {
"documentation": "<p>The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting. </p>",
"shape": "__string"
},
"SessionInitializationEndpointPrefix": {
"documentation": "<p>The URL that the player uses to initialize a session that uses client-side reporting. </p>",
"shape": "__string"
},
"SlateAdUrl": {
"documentation": "<p>The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video. </p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags assigned to the playback configuration. </p>",
"locationName": "tags",
"shape": "__mapOf__string"
},
"TranscodeProfileName": {
"documentation": "<p>The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.</p>",
"shape": "__string"
},
"VideoContentSourceUrl": {
"documentation": "<p>The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"HlsConfiguration": {
"documentation": "<p>The configuration for HLS content. </p>",
"members": {
"ManifestEndpointPrefix": {
"documentation": "<p>The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"ListPlaybackConfigurationsRequest": {
"members": {
"MaxResults": {
"documentation": "<p>Maximum number of records to return. </p>",
"location": "querystring",
"locationName": "MaxResults",
"shape": "__integerMin1Max100"
},
"NextToken": {
"documentation": "<p>Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>",
"location": "querystring",
"locationName": "NextToken",
"shape": "__string"
}
},
"type": "structure"
},
"ListPlaybackConfigurationsResponse": {
"members": {
"Items": {
"documentation": "<p>Array of playback configurations. This might be all the available configurations or a subset, depending on the settings that you provide and the total number of configurations stored. </p>",
"shape": "__listOfPlaybackConfigurations"
},
"NextToken": {
"documentation": "<p>Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"ListTagsForResourceRequest": {
"members": {
"ResourceArn": {
"documentation": "<p>The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request. </p>",
"location": "uri",
"locationName": "ResourceArn",
"shape": "__string"
}
},
"required": [
"ResourceArn"
],
"type": "structure"
},
"ListTagsForResourceResponse": {
"members": {
"Tags": {
"documentation": "<p>A comma-separated list of tag key:value pairs. For example: \n {\n \"Key1\": \"Value1\",\n \"Key2\": \"Value2\"\n }\n </p>",
"locationName": "tags",
"shape": "__mapOf__string"
}
},
"type": "structure"
"Slate": {
"documentation": "<p>Ad break slate configuration.</p>",
"shape": "SlateSource"
},
"SpliceInsertMessage": {
"documentation": "<p>This defines the SCTE-35 splice_insert() message inserted around the ad. For information about using splice_insert(), see the SCTE-35 specficiaiton, section 9.7.3.1.</p>",
"shape": "SpliceInsertMessage"
}
},
"type": "structure"
},
"AdMarkerPassthrough": {
"documentation": "<p>For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.</p> <p>No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.</p>",
"members": {
"Enabled": {
"documentation": "<p>Enables ad marker passthrough for your configuration.</p>",
"shape": "__boolean"
}
},
"type": "structure"
},
"AvailSuppression": {
"documentation": "<p>The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html\">Ad Suppression</a>.</p>",
"members": {
"Mode": {
"documentation": "<p>Sets the ad suppression mode. By default, ad suppression is off and all ad breaks are filled with ads or slate. When Mode is set to BEHIND_LIVE_EDGE, ad suppression is active and MediaTailor won't fill ad breaks on or behind the ad suppression Value time in the manifest lookback window.</p>",
"shape": "Mode"
},
"Value": {
"documentation": "<p>A live edge offset time in HH:MM:SS. MediaTailor won't fill ad breaks on or behind this time in the manifest lookback window. If Value is set to 00:00:00, it is in sync with the live edge, and MediaTailor won't fill any ad breaks on or behind the live edge. If you set a Value time, MediaTailor won't fill any ad breaks on or behind this time in the manifest lookback window. For example, if you set 00:45:00, then MediaTailor will fill ad breaks that occur within 45 minutes behind the live edge, but won't fill ad breaks on or behind 45 minutes behind the live edge.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"BadRequestException": {
"documentation": "Invalid request parameters.",
"error": {
"httpStatusCode": 400
},
"exception": true,
"members": {
"Message": {
"shape": "__string"
}
},
"type": "structure"
},
"Bumper": {
"documentation": "<p>The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html\">Bumpers</a>.</p>",
"members": {
"EndUrl": {
"documentation": "<p>The URL for the end bumper asset.</p>",
"shape": "__string"
},
"StartUrl": {
"documentation": "<p>The URL for the start bumper asset.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"CdnConfiguration": {
"documentation": "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>",
"members": {
"AdSegmentUrlPrefix": {
"documentation": "<p>A non-default content delivery network (CDN) to serve ad segments. By default, AWS Elemental MediaTailor uses Amazon CloudFront with default cache settings as its CDN for ad segments. To set up an alternate CDN, create a rule in your CDN for the origin ads.mediatailor.&amp;lt;region&gt;.amazonaws.com. Then specify the rule's name in this AdSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for ad segments.</p>",
"shape": "__string"
},
"ContentSegmentUrlPrefix": {
"documentation": "<p>A content delivery network (CDN) to cache content segments, so that content requests don\u2019t always have to go to the origin server. First, create a rule in your CDN for the content segment origin server. Then specify the rule's name in this ContentSegmentUrlPrefix. When AWS Elemental MediaTailor serves a manifest, it reports your CDN as the source for content segments.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"Channel": {
"documentation": "<p>The configuration parameters for a channel.</p>",
"members": {
"Arn": {
"documentation": "<p>The ARN of the channel.</p>",
"shape": "__string"
},
"ChannelName": {
"documentation": "<p>The name of the channel.</p>",
"shape": "__string"
},
"ChannelState": {
"documentation": "<p>Returns the state whether the channel is running or not.</p>",
"shape": "__string"
},
"CreationTime": {
"documentation": "<p>The timestamp of when the channel was created.</p>",
"shape": "__timestampUnix"
},
"LastModifiedTime": {
"documentation": "<p>The timestamp of when the channel was last modified.</p>",
"shape": "__timestampUnix"
},
"Outputs": {
"documentation": "<p>The channel's output properties.</p>",
"shape": "ResponseOutputs"
},
"PlaybackMode": {
"documentation": "<p>The type of playback mode for this channel. Possible values: ONCE or LOOP.</p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags to assign to the channel.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
}
},
"required": [
"ChannelState",
"ChannelName",
"Outputs",
"Arn",
"PlaybackMode"
],
"type": "structure"
},
"ChannelState": {
"enum": [
"RUNNING",
"STOPPED"
],
"type": "string"
},
"ConfigurationAliasesRequest": {
"documentation": "<p>The predefined aliases for dynamic variables.</p>",
"key": {
"documentation": "<p>The dynamic variable that has aliases.</p>",
"shape": "__string"
},
"type": "map",
"value": {
"documentation": "<p>Map of aliases to the value to be used at request time.</p>",
"shape": "__mapOf__string"
}
},
"ConfigurationAliasesResponse": {
"documentation": "<p>The predefined aliases for dynamic variables.</p>",
"key": {
"documentation": "<p>The dynamic variable that has aliases.</p>",
"shape": "__string"
},
"type": "map",
"value": {
"documentation": "<p>Map of aliases to the value to be used at request time.</p>",
"shape": "__mapOf__string"
}
},
"CreateChannelRequest": {
"members": {
"ChannelName": {
"documentation": "<p>The identifier for the channel you are working on.</p>",
"location": "uri",
"locationName": "channelName",
"shape": "__string"
},
"Outputs": {
"documentation": "<p>The channel's output properties.</p>",
"shape": "RequestOutputs"
},
"PlaybackMode": {
"documentation": "<p>The type of playback mode for this channel. The only supported value is LOOP.</p>",
"shape": "PlaybackMode"
},
"Tags": {
"documentation": "<p>The tags to assign to the channel.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
}
},
"required": [
"ChannelName",
"Outputs",
"PlaybackMode"
],
"type": "structure"
},
"CreateChannelResponse": {
"members": {
"Arn": {
"documentation": "<p>The ARN of the channel.</p>",
"shape": "__string"
},
"ChannelName": {
"documentation": "<p>The name of the channel.</p>",
"shape": "__string"
},
"ChannelState": {
"documentation": "<p>Indicates whether the channel is in a running state or not.</p>",
"shape": "ChannelState"
},
"CreationTime": {
"documentation": "<p>The timestamp of when the channel was created.</p>",
"shape": "__timestampUnix"
},
"LastModifiedTime": {
"documentation": "<p>The timestamp of when the channel was last modified.</p>",
"shape": "__timestampUnix"
},
"Outputs": {
"documentation": "<p>The channel's output properties.</p>",
"shape": "ResponseOutputs"
},
"PlaybackMode": {
"documentation": "<p>The type of playback for this channel. The only supported value is LOOP.</p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags assigned to the channel.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
}
},
"type": "structure"
},
"CreateProgramRequest": {
"members": {
"AdBreaks": {
"documentation": "<p>The ad break configuration settings.</p>",
"shape": "__listOfAdBreak"
},
"ChannelName": {
"documentation": "<p>The identifier for the channel you are working on.</p>",
"location": "uri",
"locationName": "channelName",
"shape": "__string"
},
"ProgramName": {
"documentation": "<p>The identifier for the program you are working on.</p>",
"location": "uri",
"locationName": "programName",
"shape": "__string"
},
"ScheduleConfiguration": {
"documentation": "<p>The schedule configuration settings.</p>",
"shape": "ScheduleConfiguration"
},
"SourceLocationName": {
"documentation": "<p>The name of the source location.</p>",
"shape": "__string"
},
"VodSourceName": {
"documentation": "<p>The name that's used to refer to a VOD source.</p>",
"shape": "__string"
}
},
"required": [
"ChannelName",
"ProgramName",
"VodSourceName",
"ScheduleConfiguration",
"SourceLocationName"
],
"type": "structure"
},
"CreateProgramResponse": {
"members": {
"AdBreaks": {
"documentation": "<p>The ad break configuration settings.</p>",
"shape": "__listOfAdBreak"
},
"Arn": {
"documentation": "<p>The ARN of the program.</p>",
"shape": "__string"
},
"ChannelName": {
"documentation": "<p>The name of the channel that the program belongs to.</p>",
"shape": "__string"
},
"CreationTime": {
"documentation": "<p>The timestamp of when the program was created.</p>",
"shape": "__timestampUnix"
},
"ProgramName": {
"documentation": "<p>The name of the program.</p>",
"shape": "__string"
},
"SourceLocationName": {
"documentation": "<p>The source location name.</p>",
"shape": "__string"
},
"VodSourceName": {
"documentation": "<p>The name that's used to refer to a VOD source.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"CreateSourceLocationRequest": {
"members": {
"AccessConfiguration": {
"documentation": "<p>Access configuration parameters. Configures the type of authentication used to access content from your source location.</p>",
"shape": "AccessConfiguration"
},
"DefaultSegmentDeliveryConfiguration": {
"documentation": "<p>The optional configuration for the server that serves segments.</p>",
"shape": "DefaultSegmentDeliveryConfiguration"
},
"HttpConfiguration": {
"documentation": "<p>The source's HTTP package configurations.</p>",
"shape": "HttpConfiguration"
},
"SourceLocationName": {
"documentation": "<p>The identifier for the source location you are working on.</p>",
"location": "uri",
"locationName": "sourceLocationName",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags to assign to the source location.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
}
},
"required": [
"SourceLocationName",
"HttpConfiguration"
],
"type": "structure"
},
"CreateSourceLocationResponse": {
"members": {
"AccessConfiguration": {
"documentation": "<p>The access configuration for the source location.</p>",
"shape": "AccessConfiguration"
},
"Arn": {
"documentation": "<p>The ARN of the source location.</p>",
"shape": "__string"
},
"CreationTime": {
"documentation": "<p>The timestamp that indicates when the source location was created.</p>",
"shape": "__timestampUnix"
},
"DefaultSegmentDeliveryConfiguration": {
"documentation": "<p>The default segment delivery configuration settings.</p>",
"shape": "DefaultSegmentDeliveryConfiguration"
},
"HttpConfiguration": {
"documentation": "<p>The HTTP package configuration settings for the source location.</p>",
"shape": "HttpConfiguration"
},
"LastModifiedTime": {
"documentation": "<p>The timestamp that indicates when the source location was last modified.</p>",
"shape": "__timestampUnix"
},
"SourceLocationName": {
"documentation": "<p>The name of the source location.</p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags assigned to the source location.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
}
},
"type": "structure"
},
"CreateVodSourceRequest": {
"members": {
"HttpPackageConfigurations": {
"documentation": "<p>An array of HTTP package configuration parameters for this VOD source.</p>",
"shape": "HttpPackageConfigurations"
},
"SourceLocationName": {
"documentation": "<p>The identifier for the source location you are working on.</p>",
"location": "uri",
"locationName": "sourceLocationName",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags to assign to the VOD source.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
},
"VodSourceName": {
"documentation": "<p>The identifier for the VOD source you are working on.</p>",
"location": "uri",
"locationName": "vodSourceName",
"shape": "__string"
}
},
"required": [
"SourceLocationName",
"VodSourceName",
"HttpPackageConfigurations"
],
"type": "structure"
},
"CreateVodSourceResponse": {
"members": {
"Arn": {
"documentation": "<p>The ARN of the VOD source.</p>",
"shape": "__string"
},
"CreationTime": {
"documentation": "<p>The timestamp that indicates when the VOD source was created.</p>",
"shape": "__timestampUnix"
},
"HttpPackageConfigurations": {
"documentation": "<p>The HTTP package configurations.</p>",
"shape": "HttpPackageConfigurations"
},
"LastModifiedTime": {
"documentation": "<p>The ARN for the VOD source.</p>",
"shape": "__timestampUnix"
},
"SourceLocationName": {
"documentation": "<p>The name of the source location associated with the VOD source.</p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags assigned to the VOD source.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
},
"VodSourceName": {
"documentation": "<p>The name of the VOD source.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"DashConfiguration": {
"documentation": "<p>The configuration for DASH content.</p>",
"members": {
"ManifestEndpointPrefix": {
"documentation": "<p>The URL generated by MediaTailor to initiate a playback session. The session uses server-side reporting. This setting is ignored in PUT operations.</p>",
"shape": "__string"
},
"MpdLocation": {
"documentation": "<p>The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.</p>",
"shape": "__string"
},
"OriginManifestType": {
"enum": [
"SINGLE_PERIOD",
"MULTI_PERIOD"
],
"type": "string"
},
"ManifestProcessingRules" : {
"type" : "structure",
"documentation" : "<p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>",
"members" : {
"AdMarkerPassthrough" : {
"shape" : "AdMarkerPassthrough"
}
}
},
"Mode": {
"enum": [
"OFF",
"BEHIND_LIVE_EDGE"
],
"type": "string"
},
"PlaybackConfiguration": {
"documentation": "<p>The AWSMediaTailor configuration.</p>",
"members": {
"AdDecisionServerUrl": {
"documentation": "<p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.</p>",
"shape": "__string"
},
"AvailSuppression":{
"documentation": "<p>The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.</p>",
"shape": "AvailSuppression"
},
"Bumper": {
"shape": "Bumper",
"documentation": "<p>The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. </p>"
},
"CdnConfiguration": {
"documentation": "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. </p>",
"shape": "CdnConfiguration"
},
"DashConfiguration": {
"documentation": "<p>The configuration for DASH content. </p>",
"shape": "DashConfiguration"
},
"HlsConfiguration": {
"documentation": "<p>The configuration for HLS content. </p>",
"shape": "HlsConfiguration"
},
"ManifestProcessingRules": {
"shape" : "ManifestProcessingRules",
"documentation" : "<p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>"
},
"Name": {
"documentation": "<p>The identifier for the playback configuration.</p>",
"shape": "__string"
},
"PlaybackConfigurationArn": {
"documentation": "<p>The Amazon Resource Name (ARN) for the playback configuration. </p>",
"shape": "__string"
},
"PlaybackEndpointPrefix": {
"documentation": "<p>The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting. </p>",
"shape": "__string"
},
"SessionInitializationEndpointPrefix": {
"documentation": "<p>The URL that the player uses to initialize a session that uses client-side reporting. </p>",
"shape": "__string"
},
"SlateAdUrl": {
"documentation": "<p>The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video. </p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags assigned to the playback configuration. </p>",
"locationName": "tags",
"shape": "__mapOf__string"
},
"TranscodeProfileName": {
"documentation": "<p>The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.</p>",
"shape": "__string"
},
"PersonalizationThresholdSeconds" : {
"documentation": "<p>The maximum duration of underfilled ad time (in seconds) allowed in an ad break.</p>",
"shape" : "__integerMin1"
},
"VideoContentSourceUrl": {
"documentation": "<p>The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"LivePreRollConfiguration" : {
"type" : "structure",
"members" : {
"AdDecisionServerUrl" : {
"shape" : "__string",
"documentation" : "<p>The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.</p>"
},
"MaxDurationSeconds" : {
"shape" : "__integer",
"documentation" : "The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns."
}
},
"documentation" : "<p>The configuration for pre-roll ad insertion.</p>"
},
"PutPlaybackConfigurationRequest": {
"members": {
"AdDecisionServerUrl": {
"documentation": "<p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.</p>",
"shape": "__string"
},
"AvailSuppression" : {
"shape" : "AvailSuppression",
"documentation": "<p>The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.</p>"
},
"Bumper": {
"shape": "Bumper",
"documentation": "<p>The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. </p>"
},
"CdnConfiguration": {
"documentation": "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. </p>",
"shape": "CdnConfiguration"
},
"DashConfiguration": {
"documentation": "<p>The configuration for DASH content. </p>",
"shape": "DashConfigurationForPut"
},
"LivePreRollConfiguration" : {
"shape" : "LivePreRollConfiguration",
"documentation" : "<p>The configuration for pre-roll ad insertion.</p>"
},
"ManifestProcessingRules": {
"shape" : "ManifestProcessingRules",
"documentation": "<p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>"
},
"Name": {
"documentation": "<p>The identifier for the playback configuration.</p>",
"shape": "__string"
},
"PersonalizationThresholdSeconds" : {
"documentation": "<p>The maximum duration of underfilled ad time (in seconds) allowed in an ad break.</p>",
"shape" : "__integerMin1"
},
"SlateAdUrl": {
"documentation": "<p>The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video. </p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags to assign to the playback configuration. </p>",
"locationName": "tags",
"shape": "__mapOf__string"
},
"TranscodeProfileName": {
"documentation": "<p>The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.</p>",
"shape": "__string"
},
"VideoContentSourceUrl": {
"documentation": "<p>The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"PutPlaybackConfigurationResponse": {
"members": {
"AdDecisionServerUrl": {
"documentation": "<p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.</p>",
"shape": "__string"
},
"AvailSuppression" : {
"shape" : "AvailSuppression",
"documentation": "<p>The configuration for Avail Suppression. Ad suppression can be used to turn off ad personalization in a long manifest, or if a viewer joins mid-break.</p>"
},
"Bumper": {
"shape": "Bumper",
"documentation": "<p>The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. </p>"
},
"CdnConfiguration": {
"documentation": "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management. </p>",
"shape": "CdnConfiguration"
},
"DashConfiguration": {
"documentation": "<p>The configuration for DASH content. </p>",
"shape": "DashConfiguration"
},
"HlsConfiguration": {
"documentation": "<p>The configuration for HLS content. </p>",
"shape": "HlsConfiguration"
},
"LivePreRollConfiguration" : {
"shape" : "LivePreRollConfiguration",
"documentation" : "<p>The configuration for pre-roll ad insertion.</p>"
},
"ManifestProcessingRules": {
"shape" : "ManifestProcessingRules",
"documentation": "The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor."
},
"Name": {
"documentation": "<p>The identifier for the playback configuration.</p>",
"shape": "__string"
},
"PersonalizationThresholdSeconds" : {
"documentation": "<p>The maximum duration of underfilled ad time (in seconds) allowed in an ad break.</p>",
"shape" : "__integerMin1"
},
"PlaybackConfigurationArn": {
"documentation": "<p>The Amazon Resource Name (ARN) for the playback configuration. </p>",
"shape": "__string"
},
"PlaybackEndpointPrefix": {
"documentation": "<p>The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting. </p>",
"shape": "__string"
},
"SessionInitializationEndpointPrefix": {
"documentation": "<p>The URL that the player uses to initialize a session that uses client-side reporting. </p>",
"shape": "__string"
},
"SlateAdUrl": {
"documentation": "<p>The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video. </p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags assigned to the playback configuration. </p>",
"locationName": "tags",
"shape": "__mapOf__string"
},
"TranscodeProfileName": {
"documentation": "<p>The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.</p>",
"shape": "__string"
},
"VideoContentSourceUrl": {
"documentation": "<p>The URL prefix for the master playlist for the stream, minus the asset ID. The maximum length is 512 characters.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"TagResourceRequest": {
"members": {
"ResourceArn": {
"documentation": "<p>The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request. </p>",
"location": "uri",
"locationName": "ResourceArn",
"shape": "__string"
},
"Tags": {
"documentation": "<p>A comma-separated list of tag key:value pairs. For example: \n {\n \"Key1\": \"Value1\",\n \"Key2\": \"Value2\"\n }\n </p>",
"locationName": "tags",
"shape": "__mapOf__string"
}
},
"required": [
"ResourceArn",
"Tags"
],
"type": "structure"
},
"TagsModel": {
"documentation": "<p>A set of tags assigned to a resource. </p>",
"members": {
"Tags": {
"documentation": "<p>A comma-separated list of tag key:value pairs. For example: \n {\n \"Key1\": \"Value1\",\n \"Key2\": \"Value2\"\n }\n </p>",
"locationName": "tags",
"shape": "__mapOf__string"
}
},
"required": [
"Tags"
],
"type": "structure"
},
"UntagResourceRequest": {
"members": {
"ResourceArn": {
"documentation": "<p>The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request. </p>",
"location": "uri",
"locationName": "ResourceArn",
"shape": "__string"
},
"TagKeys": {
"documentation": "<p>A comma-separated list of the tag keys to remove from the playback configuration. </p>",
"location": "querystring",
"locationName": "tagKeys",
"shape": "__listOf__string"
}
},
"required": [
"ResourceArn",
"TagKeys"
],
"type": "structure"
},
"__boolean": {
"type": "boolean"
},
"__double": {
"type": "double"
},
"__integer": {
"type": "integer"
},
"__integerMin1": {
"type": "integer",
"min": 1
},
"__integerMin1Max100": {
"max": 100,
"min": 1,
"type": "integer"
},
"__listOfPlaybackConfigurations": {
"member": {
"shape": "PlaybackConfiguration"
},
"type": "list"
},
"__listOf__string": {
"member": {
"shape": "__string"
},
"type": "list"
},
"__long": {
"type": "long"
},
"__mapOf__string": {
"key": {
"shape": "__string"
},
"type": "map",
"value": {
"shape": "__string"
}
},
"__string": {
"type": "string"
},
"__timestampIso8601": {
"timestampFormat": "iso8601",
"type": "timestamp"
},
"__timestampUnix": {
"timestampFormat": "unixTimestamp",
"type": "timestamp"
"documentation": "<p>The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.</p>",
"shape": "OriginManifestType"
}
},
"type": "structure"
},
"DashConfigurationForPut": {
"documentation": "<p>The configuration for DASH PUT operations.</p>",
"members": {
"MpdLocation": {
"documentation": "<p>The setting that controls whether MediaTailor includes the Location tag in DASH manifests. MediaTailor populates the Location tag with the URL for manifest update requests, to be used by players that don't support sticky redirects. Disable this if you have CDN routing rules set up for accessing MediaTailor manifests, and you are either using client-side reporting or your players support sticky HTTP redirects. Valid values are DISABLED and EMT_DEFAULT. The EMT_DEFAULT setting enables the inclusion of the tag and is the default value.</p>",
"shape": "__string"
},
"OriginManifestType": {
"documentation": "<p>The setting that controls whether MediaTailor handles manifests from the origin server as multi-period manifests or single-period manifests. If your origin server produces single-period manifests, set this to SINGLE_PERIOD. The default setting is MULTI_PERIOD. For multi-period manifests, omit this setting or set it to MULTI_PERIOD.</p>",
"shape": "OriginManifestType"
}
},
"type": "structure"
},
"DashPlaylistSettings": {
"documentation": "<p>Dash manifest configuration parameters.</p>",
"members": {
"ManifestWindowSeconds": {
"documentation": "<p>The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.</p>",
"shape": "__integer"
},
"MinBufferTimeSeconds": {
"documentation": "<p>Minimum amount of content (measured in seconds) that a player must keep available in the buffer. Minimum value: 2 seconds. Maximum value: 60 seconds.</p>",
"shape": "__integer"
},
"MinUpdatePeriodSeconds": {
"documentation": "<p>Minimum amount of time (in seconds) that the player should wait before requesting updates to the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.</p>",
"shape": "__integer"
},
"SuggestedPresentationDelaySeconds": {
"documentation": "<p>Amount of time (in seconds) that the player should be from the live point at the end of the manifest. Minimum value: 2 seconds. Maximum value: 60 seconds.</p>",
"shape": "__integer"
}
},
"type": "structure"
},
"DefaultSegmentDeliveryConfiguration": {
"documentation": "<p>The optional configuration for a server that serves segments. Use this if you want the segment delivery server to be different from the source location server. For example, you can configure your source location server to be an origination server, such as MediaPackage, and the segment delivery server to be a content delivery network (CDN), such as CloudFront. If you don't specify a segment delivery server, then the source location server is used.</p>",
"members": {
"BaseUrl": {
"documentation": "<p>The hostname of the server that will be used to serve segments. This string must include the protocol, such as <b>https://</b>.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"DeleteChannelPolicyRequest": {
"members": {
"ChannelName": {
"documentation": "<p>The identifier for the channel you are working on.</p>",
"location": "uri",
"locationName": "channelName",
"shape": "__string"
}
},
"required": [
"ChannelName"
],
"type": "structure"
},
"DeleteChannelPolicyResponse": {
"members": {},
"type": "structure"
},
"DeleteChannelRequest": {
"members": {
"ChannelName": {
"documentation": "<p>The identifier for the channel you are working on.</p>",
"location": "uri",
"locationName": "channelName",
"shape": "__string"
}
},
"required": [
"ChannelName"
],
"type": "structure"
},
"DeleteChannelResponse": {
"members": {},
"type": "structure"
},
"DeletePlaybackConfigurationRequest": {
"members": {
"Name": {
"documentation": "<p>The identifier for the playback configuration.</p>",
"location": "uri",
"locationName": "Name",
"shape": "__string"
}
},
"required": [
"Name"
],
"type": "structure"
},
"DeletePlaybackConfigurationResponse": {
"members": {},
"type": "structure"
},
"DeleteProgramRequest": {
"members": {
"ChannelName": {
"documentation": "<p>The identifier for the channel you are working on.</p>",
"location": "uri",
"locationName": "channelName",
"shape": "__string"
},
"ProgramName": {
"documentation": "<p>The identifier for the program you are working on.</p>",
"location": "uri",
"locationName": "programName",
"shape": "__string"
}
},
"required": [
"ChannelName",
"ProgramName"
],
"type": "structure"
},
"DeleteProgramResponse": {
"members": {},
"type": "structure"
},
"DeleteSourceLocationRequest": {
"members": {
"SourceLocationName": {
"documentation": "<p>The identifier for the source location you are working on.</p>",
"location": "uri",
"locationName": "sourceLocationName",
"shape": "__string"
}
},
"required": [
"SourceLocationName"
],
"type": "structure"
},
"DeleteSourceLocationResponse": {
"members": {},
"type": "structure"
},
"DeleteVodSourceRequest": {
"members": {
"SourceLocationName": {
"documentation": "<p>The identifier for the source location you are working on.</p>",
"location": "uri",
"locationName": "sourceLocationName",
"shape": "__string"
},
"VodSourceName": {
"documentation": "<p>The identifier for the VOD source you are working on.</p>",
"location": "uri",
"locationName": "vodSourceName",
"shape": "__string"
}
},
"required": [
"SourceLocationName",
"VodSourceName"
],
"type": "structure"
},
"DeleteVodSourceResponse": {
"members": {},
"type": "structure"
},
"DescribeChannelRequest": {
"members": {
"ChannelName": {
"documentation": "<p>The identifier for the channel you are working on.</p>",
"location": "uri",
"locationName": "channelName",
"shape": "__string"
}
},
"required": [
"ChannelName"
],
"type": "structure"
},
"DescribeChannelResponse": {
"members": {
"Arn": {
"documentation": "<p>The ARN of the channel.</p>",
"shape": "__string"
},
"ChannelName": {
"documentation": "<p>The name of the channel.</p>",
"shape": "__string"
},
"ChannelState": {
"documentation": "<p>Indicates whether the channel is in a running state or not.</p>",
"shape": "ChannelState"
},
"CreationTime": {
"documentation": "<p>The timestamp of when the channel was created.</p>",
"shape": "__timestampUnix"
},
"LastModifiedTime": {
"documentation": "<p>The timestamp of when the channel was last modified.</p>",
"shape": "__timestampUnix"
},
"Outputs": {
"documentation": "<p>The channel's output properties.</p>",
"shape": "ResponseOutputs"
},
"PlaybackMode": {
"documentation": "<p>The type of playback for this channel. The only supported value is LOOP.</p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags assigned to the channel.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
}
},
"type": "structure"
},
"DescribeProgramRequest": {
"members": {
"ChannelName": {
"documentation": "<p>The identifier for the channel you are working on.</p>",
"location": "uri",
"locationName": "channelName",
"shape": "__string"
},
"ProgramName": {
"documentation": "<p>The identifier for the program you are working on.</p>",
"location": "uri",
"locationName": "programName",
"shape": "__string"
}
},
"required": [
"ChannelName",
"ProgramName"
],
"type": "structure"
},
"DescribeProgramResponse": {
"members": {
"AdBreaks": {
"documentation": "<p>The ad break configuration settings.</p>",
"shape": "__listOfAdBreak"
},
"Arn": {
"documentation": "<p>The ARN of the program.</p>",
"shape": "__string"
},
"ChannelName": {
"documentation": "<p>The name of the channel that the program belongs to.</p>",
"shape": "__string"
},
"CreationTime": {
"documentation": "<p>The timestamp of when the program was created.</p>",
"shape": "__timestampUnix"
},
"ProgramName": {
"documentation": "<p>The name of the program.</p>",
"shape": "__string"
},
"SourceLocationName": {
"documentation": "<p>The source location name.</p>",
"shape": "__string"
},
"VodSourceName": {
"documentation": "<p>The name that's used to refer to a VOD source.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"DescribeSourceLocationRequest": {
"members": {
"SourceLocationName": {
"documentation": "<p>The identifier for the source location you are working on.</p>",
"location": "uri",
"locationName": "sourceLocationName",
"shape": "__string"
}
},
"required": [
"SourceLocationName"
],
"type": "structure"
},
"DescribeSourceLocationResponse": {
"members": {
"AccessConfiguration": {
"documentation": "<p>The access configuration for the source location.</p>",
"shape": "AccessConfiguration"
},
"Arn": {
"documentation": "<p>The ARN of the source location.</p>",
"shape": "__string"
},
"CreationTime": {
"documentation": "<p>The timestamp that indicates when the source location was created.</p>",
"shape": "__timestampUnix"
},
"DefaultSegmentDeliveryConfiguration": {
"documentation": "<p>The default segment delivery configuration settings.</p>",
"shape": "DefaultSegmentDeliveryConfiguration"
},
"HttpConfiguration": {
"documentation": "<p>The HTTP package configuration settings for the source location.</p>",
"shape": "HttpConfiguration"
},
"LastModifiedTime": {
"documentation": "<p>The timestamp that indicates when the source location was last modified.</p>",
"shape": "__timestampUnix"
},
"SourceLocationName": {
"documentation": "<p>The name of the source location.</p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags assigned to the source location.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
}
},
"type": "structure"
},
"DescribeVodSourceRequest": {
"members": {
"SourceLocationName": {
"documentation": "<p>The identifier for the source location you are working on.</p>",
"location": "uri",
"locationName": "sourceLocationName",
"shape": "__string"
},
"VodSourceName": {
"documentation": "<p>The identifier for the VOD source you are working on.</p>",
"location": "uri",
"locationName": "vodSourceName",
"shape": "__string"
}
},
"required": [
"SourceLocationName",
"VodSourceName"
],
"type": "structure"
},
"DescribeVodSourceResponse": {
"members": {
"Arn": {
"documentation": "<p>The ARN of the VOD source.</p>",
"shape": "__string"
},
"CreationTime": {
"documentation": "<p>The timestamp that indicates when the VOD source was created.</p>",
"shape": "__timestampUnix"
},
"HttpPackageConfigurations": {
"documentation": "<p>The HTTP package configurations.</p>",
"shape": "HttpPackageConfigurations"
},
"LastModifiedTime": {
"documentation": "<p>The ARN for the VOD source.</p>",
"shape": "__timestampUnix"
},
"SourceLocationName": {
"documentation": "<p>The name of the source location associated with the VOD source.</p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags assigned to the VOD source.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
},
"VodSourceName": {
"documentation": "<p>The name of the VOD source.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"GetChannelPolicyRequest": {
"members": {
"ChannelName": {
"documentation": "<p>The identifier for the channel you are working on.</p>",
"location": "uri",
"locationName": "channelName",
"shape": "__string"
}
},
"required": [
"ChannelName"
],
"type": "structure"
},
"GetChannelPolicyResponse": {
"members": {
"Policy": {
"documentation": "<p>The IAM policy for the channel.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"GetChannelScheduleRequest": {
"members": {
"ChannelName": {
"documentation": "<p>The identifier for the channel you are working on.</p>",
"location": "uri",
"locationName": "channelName",
"shape": "__string"
},
"DurationMinutes": {
"documentation": "<p>The schedule duration in minutes. The maximum duration is 4320 minutes (three days).</p>",
"location": "querystring",
"locationName": "durationMinutes",
"shape": "__string"
},
"MaxResults": {
"documentation": "<p>Upper bound on number of records to return. The maximum number of results is 100.</p>",
"location": "querystring",
"locationName": "maxResults",
"shape": "MaxResults"
},
"NextToken": {
"documentation": "<p>Pagination token from the GET list request. Use the token to fetch the next page of results.</p>",
"location": "querystring",
"locationName": "nextToken",
"shape": "__string"
}
},
"required": [
"ChannelName"
],
"type": "structure"
},
"GetChannelScheduleResponse": {
"members": {
"Items": {
"documentation": "<p>An array of schedule entries for the channel.</p>",
"shape": "__listOfScheduleEntry"
},
"NextToken": {
"documentation": "<p>Pagination token from the GET list request. Use the token to fetch the next page of results.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"GetPlaybackConfigurationRequest": {
"members": {
"Name": {
"documentation": "<p>The identifier for the playback configuration.</p>",
"location": "uri",
"locationName": "Name",
"shape": "__string"
}
},
"required": [
"Name"
],
"type": "structure"
},
"GetPlaybackConfigurationResponse": {
"members": {
"AdDecisionServerUrl": {
"documentation": "<p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.</p>",
"shape": "__string"
},
"AvailSuppression": {
"documentation": "<p>The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html\">Ad Suppression</a>.</p>",
"shape": "AvailSuppression"
},
"Bumper": {
"documentation": "<p>The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html\">Bumpers</a>.</p>",
"shape": "Bumper"
},
"CdnConfiguration": {
"documentation": "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>",
"shape": "CdnConfiguration"
},
"ConfigurationAliases": {
"documentation": "<p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html\">Domain Variables</a>.</p>",
"shape": "ConfigurationAliasesResponse"
},
"DashConfiguration": {
"documentation": "<p>The configuration for DASH content.</p>",
"shape": "DashConfiguration"
},
"HlsConfiguration": {
"documentation": "<p>The configuration for HLS content.</p>",
"shape": "HlsConfiguration"
},
"LivePreRollConfiguration": {
"documentation": "<p>The configuration for pre-roll ad insertion.</p>",
"shape": "LivePreRollConfiguration"
},
"ManifestProcessingRules": {
"documentation": "<p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>",
"shape": "ManifestProcessingRules"
},
"Name": {
"documentation": "<p>The identifier for the playback configuration.</p>",
"shape": "__string"
},
"PersonalizationThresholdSeconds": {
"documentation": "<p>Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to <i>ad replacement</i> in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html\">Ad Behavior in AWS Elemental MediaTailor</a>.</p>",
"shape": "__integerMin1"
},
"PlaybackConfigurationArn": {
"documentation": "<p>The Amazon Resource Name (ARN) for the playback configuration.</p>",
"shape": "__string"
},
"PlaybackEndpointPrefix": {
"documentation": "<p>The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.</p>",
"shape": "__string"
},
"SessionInitializationEndpointPrefix": {
"documentation": "<p>The URL that the player uses to initialize a session that uses client-side reporting.</p>",
"shape": "__string"
},
"SlateAdUrl": {
"documentation": "<p>The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.</p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags assigned to the playback configuration.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
},
"TranscodeProfileName": {
"documentation": "<p>The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.</p>",
"shape": "__string"
},
"VideoContentSourceUrl": {
"documentation": "<p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"HlsConfiguration": {
"documentation": "<p>The configuration for HLS content.</p>",
"members": {
"ManifestEndpointPrefix": {
"documentation": "<p>The URL that is used to initiate a playback session for devices that support Apple HLS. The session uses server-side reporting.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"HlsPlaylistSettings": {
"documentation": "<p>HLS playlist configuration parameters.</p>",
"members": {
"ManifestWindowSeconds": {
"documentation": "<p>The total duration (in seconds) of each manifest. Minimum value: 30 seconds. Maximum value: 3600 seconds.</p>",
"shape": "__integer"
}
},
"type": "structure"
},
"HttpConfiguration": {
"documentation": "<p>The HTTP configuration for the source location.</p>",
"members": {
"BaseUrl": {
"documentation": "<p>The base URL for the source location host server. This string must include the protocol, such as <b>https://</b>.</p>",
"shape": "__string"
}
},
"required": [
"BaseUrl"
],
"type": "structure"
},
"HttpPackageConfiguration": {
"documentation": "<p>The HTTP package configuration properties for the requested VOD source.</p>",
"members": {
"Path": {
"documentation": "<p>The relative path to the URL for this VOD source. This is combined with SourceLocation::HttpConfiguration::BaseUrl to form a valid URL.</p>",
"shape": "__string"
},
"SourceGroup": {
"documentation": "<p>The name of the source group. This has to match one of the Channel::Outputs::SourceGroup.</p>",
"shape": "__string"
},
"Type": {
"documentation": "<p>The streaming protocol for this package configuration. Supported values are HLS and DASH.</p>",
"shape": "Type"
}
},
"required": [
"Path",
"Type",
"SourceGroup"
],
"type": "structure"
},
"HttpPackageConfigurations": {
"documentation": "<p>The VOD source's HTTP package configuration settings.</p>",
"member": {
"shape": "HttpPackageConfiguration"
},
"type": "list"
},
"ListChannelsRequest": {
"members": {
"MaxResults": {
"documentation": "<p>Upper bound on number of records to return. The maximum number of results is 100.</p>",
"location": "querystring",
"locationName": "maxResults",
"shape": "MaxResults"
},
"NextToken": {
"documentation": "<p>Pagination token from the GET list request. Use the token to fetch the next page of results.</p>",
"location": "querystring",
"locationName": "nextToken",
"shape": "__string"
}
},
"type": "structure"
},
"ListChannelsResponse": {
"members": {
"Items": {
"documentation": "<p>An array of channels that are associated with this account.</p>",
"shape": "__listOfChannel"
},
"NextToken": {
"documentation": "<p>Pagination token returned by the list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"ListPlaybackConfigurationsRequest": {
"members": {
"MaxResults": {
"documentation": "<p>Maximum number of records to return.</p>",
"location": "querystring",
"locationName": "MaxResults",
"shape": "MaxResults"
},
"NextToken": {
"documentation": "<p>Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>",
"location": "querystring",
"locationName": "NextToken",
"shape": "__string"
}
},
"type": "structure"
},
"ListPlaybackConfigurationsResponse": {
"members": {
"Items": {
"documentation": "<p>Array of playback configurations. This might be all the available configurations or a subset, depending on the settings that you provide and the total number of configurations stored.</p>",
"shape": "__listOfPlaybackConfiguration"
},
"NextToken": {
"documentation": "<p>Pagination token returned by the GET list request when results exceed the maximum allowed. Use the token to fetch the next page of results.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"ListSourceLocationsRequest": {
"members": {
"MaxResults": {
"documentation": "<p>Upper bound on number of records to return. The maximum number of results is 100.</p>",
"location": "querystring",
"locationName": "maxResults",
"shape": "MaxResults"
},
"NextToken": {
"documentation": "<p>Pagination token from the GET list request. Use the token to fetch the next page of results.</p>",
"location": "querystring",
"locationName": "nextToken",
"shape": "__string"
}
},
"type": "structure"
},
"ListSourceLocationsResponse": {
"members": {
"Items": {
"documentation": "<p>An array of source locations.</p>",
"shape": "__listOfSourceLocation"
},
"NextToken": {
"documentation": "<p>Pagination token from the list request. Use the token to fetch the next page of results.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"ListTagsForResourceRequest": {
"members": {
"ResourceArn": {
"documentation": "<p>The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request.</p>",
"location": "uri",
"locationName": "ResourceArn",
"shape": "__string"
}
},
"required": [
"ResourceArn"
],
"type": "structure"
},
"ListTagsForResourceResponse": {
"members": {
"Tags": {
"documentation": "<p>A comma-separated list of tag key:value pairs.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
}
},
"type": "structure"
},
"ListVodSourcesRequest": {
"members": {
"MaxResults": {
"documentation": "<p>Upper bound on number of records to return. The maximum number of results is 100.</p>",
"location": "querystring",
"locationName": "maxResults",
"shape": "MaxResults"
},
"NextToken": {
"documentation": "<p>Pagination token from the GET list request. Use the token to fetch the next page of results.</p>",
"location": "querystring",
"locationName": "nextToken",
"shape": "__string"
},
"SourceLocationName": {
"documentation": "<p>The identifier for the source location you are working on.</p>",
"location": "uri",
"locationName": "sourceLocationName",
"shape": "__string"
}
},
"required": [
"SourceLocationName"
],
"type": "structure"
},
"ListVodSourcesResponse": {
"members": {
"Items": {
"documentation": "<p>Lists the VOD sources.</p>",
"shape": "__listOfVodSource"
},
"NextToken": {
"documentation": "<p>Pagination token from the list request. Use the token to fetch the next page of results.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"LivePreRollConfiguration": {
"documentation": "<p>The configuration for pre-roll ad insertion.</p>",
"members": {
"AdDecisionServerUrl": {
"documentation": "<p>The URL for the ad decision server (ADS) for pre-roll ads. This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.</p>",
"shape": "__string"
},
"MaxDurationSeconds": {
"documentation": "The maximum allowed duration for the pre-roll ad avail. AWS Elemental MediaTailor won't play pre-roll ads to exceed this duration, regardless of the total duration of ads that the ADS returns.",
"shape": "__integer"
}
},
"type": "structure"
},
"ManifestProcessingRules": {
"documentation": "<p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>",
"members": {
"AdMarkerPassthrough": {
"documentation": "<p>For HLS, when set to true, MediaTailor passes through EXT-X-CUE-IN, EXT-X-CUE-OUT, and EXT-X-SPLICEPOINT-SCTE35 ad markers from the origin manifest to the MediaTailor personalized manifest.</p> <p>No logic is applied to these ad markers. For example, if EXT-X-CUE-OUT has a value of 60, but no ads are filled for that ad break, MediaTailor will not set the value to 0.</p>",
"shape": "AdMarkerPassthrough"
}
},
"type": "structure"
},
"MaxResults": {
"max": 100,
"min": 1,
"type": "integer"
},
"MessageType": {
"enum": [
"SPLICE_INSERT"
],
"type": "string"
},
"Mode": {
"enum": [
"OFF",
"BEHIND_LIVE_EDGE"
],
"type": "string"
},
"OriginManifestType": {
"enum": [
"SINGLE_PERIOD",
"MULTI_PERIOD"
],
"type": "string"
},
"PlaybackConfiguration": {
"documentation": "<p>Creates a playback configuration. For information about MediaTailor configurations, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/configurations.html\">Working with configurations in AWS Elemental MediaTailor</a>.</p>",
"members": {
"AdDecisionServerUrl": {
"documentation": "<p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.</p>",
"shape": "__string"
},
"AvailSuppression": {
"documentation": "<p>The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html\">Ad Suppression</a>.</p>",
"shape": "AvailSuppression"
},
"Bumper": {
"documentation": "<p>The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html\">Bumpers</a>.</p>",
"shape": "Bumper"
},
"CdnConfiguration": {
"documentation": "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>",
"shape": "CdnConfiguration"
},
"ConfigurationAliases": {
"documentation": "<p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html\">Domain Variables</a>.</p>",
"shape": "ConfigurationAliasesResponse"
},
"DashConfiguration": {
"documentation": "<p>The configuration for a DASH source.</p>",
"shape": "DashConfiguration"
},
"HlsConfiguration": {
"documentation": "<p>The configuration for HLS content.</p>",
"shape": "HlsConfiguration"
},
"LivePreRollConfiguration": {
"documentation": "<p>The configuration for pre-roll ad insertion.</p>",
"shape": "LivePreRollConfiguration"
},
"ManifestProcessingRules": {
"documentation": "<p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>",
"shape": "ManifestProcessingRules"
},
"Name": {
"documentation": "<p>The identifier for the playback configuration.</p>",
"shape": "__string"
},
"PersonalizationThresholdSeconds": {
"documentation": "<p>Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to <i>ad replacement</i> in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html\">Ad Behavior in AWS Elemental MediaTailor</a>.</p>",
"shape": "__integerMin1"
},
"PlaybackConfigurationArn": {
"documentation": "<p>The Amazon Resource Name (ARN) for the playback configuration.</p>",
"shape": "__string"
},
"PlaybackEndpointPrefix": {
"documentation": "<p>The URL that the player accesses to get a manifest from AWS Elemental MediaTailor.</p>",
"shape": "__string"
},
"SessionInitializationEndpointPrefix": {
"documentation": "<p>The URL that the player uses to initialize a session that uses client-side reporting.</p>",
"shape": "__string"
},
"SlateAdUrl": {
"documentation": "<p>The URL for a video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.</p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags to assign to the playback configuration.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
},
"TranscodeProfileName": {
"documentation": "<p>The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.</p>",
"shape": "__string"
},
"VideoContentSourceUrl": {
"documentation": "<p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"PlaybackMode": {
"enum": [
"LOOP"
],
"type": "string"
},
"PutChannelPolicyRequest": {
"members": {
"ChannelName": {
"documentation": "<p>The identifier for the channel you are working on.</p>",
"location": "uri",
"locationName": "channelName",
"shape": "__string"
},
"Policy": {
"documentation": "<p>Adds an IAM role that determines the permissions of your channel.</p>",
"shape": "__string"
}
},
"required": [
"ChannelName",
"Policy"
],
"type": "structure"
},
"PutChannelPolicyResponse": {
"members": {},
"type": "structure"
},
"PutPlaybackConfigurationRequest": {
"members": {
"AdDecisionServerUrl": {
"documentation": "<p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing you can provide a static VAST URL. The maximum length is 25,000 characters.</p>",
"shape": "__string"
},
"AvailSuppression": {
"documentation": "<p>The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html\">Ad Suppression</a>.</p>",
"shape": "AvailSuppression"
},
"Bumper": {
"documentation": "<p>The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html\">Bumpers</a>.</p>",
"shape": "Bumper"
},
"CdnConfiguration": {
"documentation": "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>",
"shape": "CdnConfiguration"
},
"ConfigurationAliases": {
"documentation": "<p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html\">Domain Variables</a>.</p> ",
"shape": "ConfigurationAliasesRequest"
},
"DashConfiguration": {
"documentation": "<p>The configuration for DASH content.</p>",
"shape": "DashConfigurationForPut"
},
"LivePreRollConfiguration": {
"documentation": "<p>The configuration for pre-roll ad insertion.</p>",
"shape": "LivePreRollConfiguration"
},
"ManifestProcessingRules": {
"documentation": "<p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>",
"shape": "ManifestProcessingRules"
},
"Name": {
"documentation": "<p>The identifier for the playback configuration.</p>",
"shape": "__string"
},
"PersonalizationThresholdSeconds": {
"documentation": "<p>Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to <i>ad replacement</i> in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html\">Ad Behavior in AWS Elemental MediaTailor</a>.</p>",
"shape": "__integerMin1"
},
"SlateAdUrl": {
"documentation": "<p>The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID configurations. For VPAID, the slate is required because MediaTailor provides it in the slots that are designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.</p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags to assign to the playback configuration.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
},
"TranscodeProfileName": {
"documentation": "<p>The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.</p>",
"shape": "__string"
},
"VideoContentSourceUrl": {
"documentation": "<p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"PutPlaybackConfigurationResponse": {
"members": {
"AdDecisionServerUrl": {
"documentation": "<p>The URL for the ad decision server (ADS). This includes the specification of static parameters and placeholders for dynamic parameters. AWS Elemental MediaTailor substitutes player-specific and session-specific parameters as needed when calling the ADS. Alternately, for testing, you can provide a static VAST URL. The maximum length is 25,000 characters.</p>",
"shape": "__string"
},
"AvailSuppression": {
"documentation": "<p>The configuration for avail suppression, also known as ad suppression. For more information about ad suppression, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html\">Ad Suppression</a>.</p>",
"shape": "AvailSuppression"
},
"Bumper": {
"documentation": "<p>The configuration for bumpers. Bumpers are short audio or video clips that play at the start or before the end of an ad break. To learn more about bumpers, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/bumpers.html\">Bumpers</a>.</p>",
"shape": "Bumper"
},
"CdnConfiguration": {
"documentation": "<p>The configuration for using a content delivery network (CDN), like Amazon CloudFront, for content and ad segment management.</p>",
"shape": "CdnConfiguration"
},
"ConfigurationAliases": {
"documentation": "<p>The player parameters and aliases used as dynamic variables during session initialization. For more information, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/variables-domain.html\">Domain Variables</a>.</p>",
"shape": "ConfigurationAliasesResponse"
},
"DashConfiguration": {
"documentation": "<p>The configuration for DASH content.</p>",
"shape": "DashConfiguration"
},
"HlsConfiguration": {
"documentation": "<p>The configuration for HLS content.</p>",
"shape": "HlsConfiguration"
},
"LivePreRollConfiguration": {
"documentation": "<p>The configuration for pre-roll ad insertion.</p>",
"shape": "LivePreRollConfiguration"
},
"ManifestProcessingRules": {
"documentation": "<p>The configuration for manifest processing rules. Manifest processing rules enable customization of the personalized manifests created by MediaTailor.</p>",
"shape": "ManifestProcessingRules"
},
"Name": {
"documentation": "<p>The identifier for the playback configuration.</p>",
"shape": "__string"
},
"PersonalizationThresholdSeconds": {
"documentation": "<p>Defines the maximum duration of underfilled ad time (in seconds) allowed in an ad break. If the duration of underfilled ad time exceeds the personalization threshold, then the personalization of the ad break is abandoned and the underlying content is shown. This feature applies to <i>ad replacement</i> in live and VOD streams, rather than ad insertion, because it relies on an underlying content stream. For more information about ad break behavior, including ad replacement and insertion, see <a href=\"https://docs.aws.amazon.com/mediatailor/latest/ug/ad-behavior.html\">Ad Behavior in AWS Elemental MediaTailor</a>.</p>",
"shape": "__integerMin1"
},
"PlaybackConfigurationArn": {
"documentation": "<p>The Amazon Resource Name (ARN) for the playback configuration.</p>",
"shape": "__string"
},
"PlaybackEndpointPrefix": {
"documentation": "<p>The URL that the player accesses to get a manifest from AWS Elemental MediaTailor. This session will use server-side reporting.</p>",
"shape": "__string"
},
"SessionInitializationEndpointPrefix": {
"documentation": "<p>The URL that the player uses to initialize a session that uses client-side reporting.</p>",
"shape": "__string"
},
"SlateAdUrl": {
"documentation": "<p>The URL for a high-quality video asset to transcode and use to fill in time that's not used by ads. AWS Elemental MediaTailor shows the slate to fill in gaps in media content. Configuring the slate is optional for non-VPAID playback configurations. For VPAID, the slate is required because MediaTailor provides it in the slots designated for dynamic ad content. The slate must be a high-quality asset that contains both audio and video.</p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags assigned to the playback configuration.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
},
"TranscodeProfileName": {
"documentation": "<p>The name that is used to associate this playback configuration with a custom transcode profile. This overrides the dynamic transcoding defaults of MediaTailor. Use this only if you have already set up custom profiles with the help of AWS Support.</p>",
"shape": "__string"
},
"VideoContentSourceUrl": {
"documentation": "<p>The URL prefix for the parent manifest for the stream, minus the asset ID. The maximum length is 512 characters.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"RelativePosition": {
"enum": [
"BEFORE_PROGRAM",
"AFTER_PROGRAM"
],
"type": "string"
},
"RequestOutputItem": {
"documentation": "<p>The ouput configuration for this channel.</p>",
"members": {
"DashPlaylistSettings": {
"documentation": "<p>DASH manifest configuration parameters.</p>",
"shape": "DashPlaylistSettings"
},
"HlsPlaylistSettings": {
"documentation": "<p>HLS playlist configuration parameters.</p>",
"shape": "HlsPlaylistSettings"
},
"ManifestName": {
"documentation": "<p>The name of the manifest for the channel. The name appears in the PlaybackUrl.</p>",
"shape": "__string"
},
"SourceGroup": {
"documentation": "<p>A string used to match which HttpPackageConfiguration is used for each VodSource.</p>",
"shape": "__string"
}
},
"required": [
"ManifestName",
"SourceGroup"
],
"type": "structure"
},
"RequestOutputs": {
"documentation": "<p>An object that represents an object in the CreateChannel request.</p>",
"member": {
"shape": "RequestOutputItem"
},
"type": "list"
},
"ResponseOutputItem": {
"documentation": "<p>This response includes only the \"property\" : \"type\" property.</p>",
"members": {
"DashPlaylistSettings": {
"documentation": "<p>DASH manifest configuration settings.</p>",
"shape": "DashPlaylistSettings"
},
"HlsPlaylistSettings": {
"documentation": "<p>HLS manifest configuration settings.</p>",
"shape": "HlsPlaylistSettings"
},
"ManifestName": {
"documentation": "<p>The name of the manifest for the channel that will appear in the channel output's playback URL.</p>",
"shape": "__string"
},
"PlaybackUrl": {
"documentation": "<p>The URL used for playback by content players.</p>",
"shape": "__string"
},
"SourceGroup": {
"documentation": "<p>A string used to associate a package configuration source group with a channel output.</p>",
"shape": "__string"
}
},
"required": [
"ManifestName",
"PlaybackUrl",
"SourceGroup"
],
"type": "structure"
},
"ResponseOutputs": {
"member": {
"shape": "ResponseOutputItem"
},
"type": "list"
},
"ScheduleConfiguration": {
"documentation": "<p>Schedule configuration parameters. A channel must be stopped before changes can be made to the schedule.</p>",
"members": {
"Transition": {
"documentation": "<p>Program transition configurations.</p>",
"shape": "Transition"
}
},
"required": [
"Transition"
],
"type": "structure"
},
"ScheduleEntry": {
"documentation": "<p>The properties for a schedule.</p>",
"members": {
"ApproximateDurationSeconds": {
"documentation": "<p>The approximate duration of this program, in seconds.</p>",
"shape": "__long"
},
"ApproximateStartTime": {
"documentation": "<p>The approximate time that the program will start playing.</p>",
"shape": "__timestampUnix"
},
"Arn": {
"documentation": "<p>The ARN of the program.</p>",
"shape": "__string"
},
"ChannelName": {
"documentation": "<p>The name of the channel that uses this schedule.</p>",
"shape": "__string"
},
"ProgramName": {
"documentation": "<p>The name of the program.</p>",
"shape": "__string"
},
"SourceLocationName": {
"documentation": "<p>The name of the source location.</p>",
"shape": "__string"
},
"VodSourceName": {
"documentation": "<p>The name of the VOD source.</p>",
"shape": "__string"
}
},
"required": [
"VodSourceName",
"ChannelName",
"SourceLocationName",
"Arn",
"ProgramName"
],
"type": "structure"
},
"SlateSource": {
"documentation": "<p>Slate VOD source configuration.</p>",
"members": {
"SourceLocationName": {
"documentation": "<p>The name of the source location where the slate VOD source is stored.</p>",
"shape": "__string"
},
"VodSourceName": {
"documentation": "<p>The slate VOD source name. The VOD source must already exist in a source location before it can be used for slate.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"SourceLocation": {
"documentation": "<p>This response includes only the \"type\" : \"object\" property.</p>",
"members": {
"AccessConfiguration": {
"documentation": "<p>The access configuration for the source location.</p>",
"shape": "AccessConfiguration"
},
"Arn": {
"documentation": "<p>The ARN of the SourceLocation.</p>",
"shape": "__string"
},
"CreationTime": {
"documentation": "<p>The timestamp that indicates when the source location was created.</p>",
"shape": "__timestampUnix"
},
"DefaultSegmentDeliveryConfiguration": {
"documentation": "<p>The default segment delivery configuration.</p>",
"shape": "DefaultSegmentDeliveryConfiguration"
},
"HttpConfiguration": {
"documentation": "<p>The HTTP configuration for the source location.</p>",
"shape": "HttpConfiguration"
},
"LastModifiedTime": {
"documentation": "<p>The timestamp that indicates when the source location was last modified.</p>",
"shape": "__timestampUnix"
},
"SourceLocationName": {
"documentation": "<p>The name of the source location.</p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags assigned to the source location.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
}
},
"required": [
"SourceLocationName",
"HttpConfiguration",
"Arn"
],
"type": "structure"
},
"SpliceInsertMessage": {
"documentation": "<p>Splice insert message configuration.</p>",
"members": {
"AvailNum": {
"documentation": "<p>This is written to splice_insert.avail_num, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.</p>",
"shape": "__integer"
},
"AvailsExpected": {
"documentation": "<p>This is written to splice_insert.avails_expected, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.</p>",
"shape": "__integer"
},
"SpliceEventId": {
"documentation": "<p>This is written to splice_insert.splice_event_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 1.</p>",
"shape": "__integer"
},
"UniqueProgramId": {
"documentation": "<p>This is written to splice_insert.unique_program_id, as defined in section 9.7.3.1 of the SCTE-35 specification. The default value is 0. Values must be between 0 and 256, inclusive.</p>",
"shape": "__integer"
}
},
"type": "structure"
},
"StartChannelRequest": {
"members": {
"ChannelName": {
"documentation": "<p>The identifier for the channel you are working on.</p>",
"location": "uri",
"locationName": "channelName",
"shape": "__string"
}
},
"required": [
"ChannelName"
],
"type": "structure"
},
"StartChannelResponse": {
"members": {},
"type": "structure"
},
"StopChannelRequest": {
"members": {
"ChannelName": {
"documentation": "<p>The identifier for the channel you are working on.</p>",
"location": "uri",
"locationName": "channelName",
"shape": "__string"
}
},
"required": [
"ChannelName"
],
"type": "structure"
},
"StopChannelResponse": {
"members": {},
"type": "structure"
},
"TagResourceRequest": {
"members": {
"ResourceArn": {
"documentation": "<p>The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request.</p>",
"location": "uri",
"locationName": "ResourceArn",
"shape": "__string"
},
"Tags": {
"documentation": "<p>A comma-separated list of tag key:value pairs.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
}
},
"required": [
"ResourceArn",
"Tags"
],
"type": "structure"
},
"Transition": {
"documentation": "<p>Program transition configuration.</p>",
"members": {
"RelativePosition": {
"documentation": "<p>The position where this program will be inserted relative to the RelativeProgram. Possible values are: AFTER_PROGRAM, and BEFORE_PROGRAM.</p>",
"shape": "RelativePosition"
},
"RelativeProgram": {
"documentation": "<p>The name of the program that this program will be inserted next to, as defined by RelativePosition.</p>",
"shape": "__string"
},
"Type": {
"documentation": "<p>When the program should be played. RELATIVE means that programs will be played back-to-back.</p>",
"shape": "__string"
}
},
"required": [
"Type",
"RelativePosition"
],
"type": "structure"
},
"Type": {
"enum": [
"DASH",
"HLS"
],
"type": "string"
},
"UntagResourceRequest": {
"members": {
"ResourceArn": {
"documentation": "<p>The Amazon Resource Name (ARN) for the playback configuration. You can get this from the response to any playback configuration request.</p>",
"location": "uri",
"locationName": "ResourceArn",
"shape": "__string"
},
"TagKeys": {
"documentation": "<p>A comma-separated list of the tag keys to remove from the playback configuration.</p>",
"location": "querystring",
"locationName": "tagKeys",
"shape": "__listOf__string"
}
},
"required": [
"ResourceArn",
"TagKeys"
],
"type": "structure"
},
"UpdateChannelRequest": {
"members": {
"ChannelName": {
"documentation": "<p>The identifier for the channel you are working on.</p>",
"location": "uri",
"locationName": "channelName",
"shape": "__string"
},
"Outputs": {
"documentation": "<p>The channel's output properties.</p>",
"shape": "RequestOutputs"
}
},
"required": [
"ChannelName",
"Outputs"
],
"type": "structure"
},
"UpdateChannelResponse": {
"members": {
"Arn": {
"documentation": "<p>The ARN of the channel.</p>",
"shape": "__string"
},
"ChannelName": {
"documentation": "<p>The name of the channel.</p>",
"shape": "__string"
},
"ChannelState": {
"documentation": "<p>Indicates whether the channel is in a running state or not.</p>",
"shape": "ChannelState"
},
"CreationTime": {
"documentation": "<p>The timestamp of when the channel was created.</p>",
"shape": "__timestampUnix"
},
"LastModifiedTime": {
"documentation": "<p>The timestamp of when the channel was last modified.</p>",
"shape": "__timestampUnix"
},
"Outputs": {
"documentation": "<p>The channel's output properties.</p>",
"shape": "ResponseOutputs"
},
"PlaybackMode": {
"documentation": "<p>The type of playback for this channel. The only supported value is LOOP.</p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags assigned to the channel.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
}
},
"type": "structure"
},
"UpdateSourceLocationRequest": {
"members": {
"AccessConfiguration": {
"documentation": "<p>Access configuration parameters. Configures the type of authentication used to access content from your source location.</p>",
"shape": "AccessConfiguration"
},
"DefaultSegmentDeliveryConfiguration": {
"documentation": "<p>The optional configuration for the host server that serves segments.</p>",
"shape": "DefaultSegmentDeliveryConfiguration"
},
"HttpConfiguration": {
"documentation": "<p>The HTTP configuration for the source location.</p>",
"shape": "HttpConfiguration"
},
"SourceLocationName": {
"documentation": "<p>The identifier for the source location you are working on.</p>",
"location": "uri",
"locationName": "sourceLocationName",
"shape": "__string"
}
},
"required": [
"SourceLocationName",
"HttpConfiguration"
],
"type": "structure"
},
"UpdateSourceLocationResponse": {
"members": {
"AccessConfiguration": {
"documentation": "<p>The access configuration for the source location.</p>",
"shape": "AccessConfiguration"
},
"Arn": {
"documentation": "<p>The ARN of the source location.</p>",
"shape": "__string"
},
"CreationTime": {
"documentation": "<p>The timestamp that indicates when the source location was created.</p>",
"shape": "__timestampUnix"
},
"DefaultSegmentDeliveryConfiguration": {
"documentation": "<p>The default segment delivery configuration settings.</p>",
"shape": "DefaultSegmentDeliveryConfiguration"
},
"HttpConfiguration": {
"documentation": "<p>The HTTP package configuration settings for the source location.</p>",
"shape": "HttpConfiguration"
},
"LastModifiedTime": {
"documentation": "<p>The timestamp that indicates when the source location was last modified.</p>",
"shape": "__timestampUnix"
},
"SourceLocationName": {
"documentation": "<p>The name of the source location.</p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags assigned to the source location.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
}
},
"type": "structure"
},
"UpdateVodSourceRequest": {
"members": {
"HttpPackageConfigurations": {
"documentation": "<p>An array of HTTP package configurations for the VOD source on this account.</p>",
"shape": "HttpPackageConfigurations"
},
"SourceLocationName": {
"documentation": "<p>The identifier for the source location you are working on.</p>",
"location": "uri",
"locationName": "sourceLocationName",
"shape": "__string"
},
"VodSourceName": {
"documentation": "<p>The identifier for the VOD source you are working on.</p>",
"location": "uri",
"locationName": "vodSourceName",
"shape": "__string"
}
},
"required": [
"SourceLocationName",
"VodSourceName",
"HttpPackageConfigurations"
],
"type": "structure"
},
"UpdateVodSourceResponse": {
"members": {
"Arn": {
"documentation": "<p>The ARN of the VOD source.</p>",
"shape": "__string"
},
"CreationTime": {
"documentation": "<p>The timestamp that indicates when the VOD source was created.</p>",
"shape": "__timestampUnix"
},
"HttpPackageConfigurations": {
"documentation": "<p>The HTTP package configurations.</p>",
"shape": "HttpPackageConfigurations"
},
"LastModifiedTime": {
"documentation": "<p>The ARN for the VOD source.</p>",
"shape": "__timestampUnix"
},
"SourceLocationName": {
"documentation": "<p>The name of the source location associated with the VOD source.</p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags assigned to the VOD source.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
},
"VodSourceName": {
"documentation": "<p>The name of the VOD source.</p>",
"shape": "__string"
}
},
"type": "structure"
},
"VodSource": {
"documentation": "<p>VOD source configuration parameters.</p>",
"members": {
"Arn": {
"documentation": "<p>The ARN for the VOD source.</p>",
"shape": "__string"
},
"CreationTime": {
"documentation": "<p>The timestamp that indicates when the VOD source was created.</p>",
"shape": "__timestampUnix"
},
"HttpPackageConfigurations": {
"documentation": "<p>The HTTP package configurations for the VOD source.</p>",
"shape": "HttpPackageConfigurations"
},
"LastModifiedTime": {
"documentation": "<p>The timestamp that indicates when the VOD source was last modified.</p>",
"shape": "__timestampUnix"
},
"SourceLocationName": {
"documentation": "<p>The name of the source location that the VOD source is associated with.</p>",
"shape": "__string"
},
"Tags": {
"documentation": "<p>The tags assigned to the VOD source.</p>",
"locationName": "tags",
"shape": "__mapOf__string"
},
"VodSourceName": {
"documentation": "<p>The name of the VOD source.</p>",
"shape": "__string"
}
},
"required": [
"VodSourceName",
"SourceLocationName",
"HttpPackageConfigurations",
"Arn"
],
"type": "structure"
},
"__boolean": {
"type": "boolean"
},
"__integer": {
"type": "integer"
},
"__integerMin1": {
"min": 1,
"type": "integer"
},
"__listOfAdBreak": {
"member": {
"shape": "AdBreak"
},
"type": "list"
},
"__listOfChannel": {
"member": {
"shape": "Channel"
},
"type": "list"
},
"__listOfPlaybackConfiguration": {
"member": {
"shape": "PlaybackConfiguration"
},
"type": "list"
},
"__listOfScheduleEntry": {
"member": {
"shape": "ScheduleEntry"
},
"type": "list"
},
"__listOfSourceLocation": {
"member": {
"shape": "SourceLocation"
},
"type": "list"
},
"__listOfVodSource": {
"member": {
"shape": "VodSource"
},
"type": "list"
},
"__listOf__string": {
"member": {
"shape": "__string"
},
"type": "list"
},
"__long": {
"type": "long"
},
"__mapOf__string": {
"key": {
"shape": "__string"
},
"type": "map",
"value": {
"shape": "__string"
}
},
"__string": {
"type": "string"
},
"__timestampUnix": {
"timestampFormat": "unixTimestamp",
"type": "timestamp"
}
}
}

27
botocore/data/mwaa/2020-07-01/service-2.json
View file

@ -309,6 +309,10 @@
"shape":"MaxWorkers",
"documentation":"<p>The maximum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers and the Fargate containers that run your tasks up to the number you specify in this field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra containers leaving the one worker that is included with your environment.</p>"
},
"MinWorkers":{
"shape":"MinWorkers",
"documentation":"<p>The minimum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers and the Fargate containers that run your tasks up to the number you specify in the <code>MaxWorkers</code> field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra containers leaving the worker count you specify in the <code>MinWorkers</code> field.</p>"
},
"Name":{
"shape":"EnvironmentName",
"documentation":"<p>The name of your MWAA environment.</p>",
@ -474,7 +478,11 @@
},
"MaxWorkers":{
"shape":"MaxWorkers",
"documentation":"<p>The Maximum Workers of the Amazon MWAA Environment.</p>"
"documentation":"<p>The maximum number of workers to run in your Amazon MWAA Environment.</p>"
},
"MinWorkers":{
"shape":"MinWorkers",
"documentation":"<p>The minimum number of workers to run in your Amazon MWAA Environment.</p>"
},
"Name":{
"shape":"EnvironmentName",
@ -557,7 +565,9 @@
"AVAILABLE",
"UPDATING",
"DELETING",
"DELETED"
"DELETED",
"UNAVAILABLE",
"UPDATE_FAILED"
]
},
"ErrorCode":{"type":"string"},
@ -772,6 +782,11 @@
},
"documentation":"<p>Internal only API.</p>"
},
"MinWorkers":{
"type":"integer",
"box":true,
"min":1
},
"ModuleLoggingConfiguration":{
"type":"structure",
"members":{
@ -873,7 +888,7 @@
"type":"string",
"max":1224,
"min":1,
"pattern":"^arn:aws(-[a-z]+)?:s3:::airflow-[a-z0-9.\\-]+$"
"pattern":"^arn:aws(-[a-z]+)?:s3:::[a-z0-9.\\-]+$"
},
"S3ObjectVersion":{
"type":"string",
@ -1087,7 +1102,11 @@
},
"MaxWorkers":{
"shape":"MaxWorkers",
"documentation":"<p>The Maximum Workers to update of your Amazon MWAA environment.</p>"
"documentation":"<p>The maximum number of workers to update of your Amazon MWAA environment.</p>"
},
"MinWorkers":{
"shape":"MinWorkers",
"documentation":"<p>The minimum number of workers to update of your Amazon MWAA environment.</p>"
},
"Name":{
"shape":"EnvironmentName",

34
botocore/data/network-firewall/2020-11-12/service-2.json
View file

@ -46,7 +46,8 @@
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidTokenException"},
{"shape":"InvalidOperationException"}
{"shape":"InvalidOperationException"},
{"shape":"InsufficientCapacityException"}
],
"documentation":"<p>Associates the specified subnets in the Amazon VPC to the firewall. You can specify one subnet for each of the Availability Zones that the VPC spans. </p> <p>This request creates an AWS Network Firewall firewall endpoint in each of the subnets. To enable the firewall's protections, you must also modify the VPC's route tables for each subnet's Availability Zone, to redirect the traffic that's coming into and going out of the zone through the firewall endpoint. </p>"
},
@ -147,6 +148,7 @@
"input":{"shape":"DeleteResourcePolicyRequest"},
"output":{"shape":"DeleteResourcePolicyResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalServerError"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"}
@ -228,6 +230,7 @@
"input":{"shape":"DescribeResourcePolicyRequest"},
"output":{"shape":"DescribeResourcePolicyResponse"},
"errors":[
{"shape":"InvalidRequestException"},
{"shape":"InternalServerError"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"}
@ -322,7 +325,8 @@
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"ResourceNotFoundException"}
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Retrieves the tags associated with the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.</p> <p>You can tag the AWS resources that you manage through AWS Network Firewall: firewalls, firewall policies, and rule groups. </p>"
},
@ -790,7 +794,7 @@
},
"Rules":{
"shape":"RulesString",
"documentation":"<p>The name of a file containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups. </p> <note> <p>You must provide either this rules setting or a populated <code>RuleGroup</code> setting, but not both. </p> </note> <p>You can provide your rule group specification in a file through this setting when you create or update your rule group. The call response returns a <a>RuleGroup</a> object that Network Firewall has populated from your file. Network Firewall uses the file contents to populate the rule group rules, but does not maintain a reference to the file or use the file in any way after performing the create or update. If you call <a>DescribeRuleGroup</a> to retrieve the rule group, Network Firewall returns rules settings inside a <a>RuleGroup</a> object. </p>"
"documentation":"<p>A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups. </p> <note> <p>You must provide either this rules setting or a populated <code>RuleGroup</code> setting, but not both. </p> </note> <p>You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a <a>RuleGroup</a> object that Network Firewall has populated from your string. </p>"
},
"Type":{
"shape":"RuleGroupType",
@ -1252,7 +1256,7 @@
},
"StatelessFragmentDefaultActions":{
"shape":"StatelessActions",
"documentation":"<p>The actions to take on a fragmented packet if it doesn't match any of the stateless rules in the policy. If you want non-matching fragmented packets to be forwarded for stateful inspection, specify <code>aws:forward_to_sfe</code>. </p> <p>You must specify one of the standard actions: <code>aws:pass</code>, <code>aws:drop</code>, or <code>aws:forward_to_sfe</code>. In addition, you can specify custom actions that are compatible with your standard section choice.</p> <p>For example, you could specify <code>[\"aws:pass\"]</code> or you could specify <code>[\"aws:pass\", “customActionName”]</code>. For information about compatibility, see the custom action descriptions under <a>CustomAction</a>.</p>"
"documentation":"<p>The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols. If you want non-matching fragmented UDP packets to be forwarded for stateful inspection, specify <code>aws:forward_to_sfe</code>. </p> <p>You must specify one of the standard actions: <code>aws:pass</code>, <code>aws:drop</code>, or <code>aws:forward_to_sfe</code>. In addition, you can specify custom actions that are compatible with your standard section choice.</p> <p>For example, you could specify <code>[\"aws:pass\"]</code> or you could specify <code>[\"aws:pass\", “customActionName”]</code>. For information about compatibility, see the custom action descriptions under <a>CustomAction</a>.</p>"
},
"StatelessCustomActions":{
"shape":"CustomActions",
@ -1384,7 +1388,7 @@
"members":{
"Protocol":{
"shape":"StatefulRuleProtocol",
"documentation":"<p>The protocol to inspect for. To match with any protocol, specify <code>ANY</code>. </p>"
"documentation":"<p>The protocol to inspect for. To specify all, you can use <code>IP</code>, because all traffic on AWS and on the internet is IP.</p>"
},
"Source":{
"shape":"Source",
@ -1717,10 +1721,14 @@
"members":{
"SyncStatus":{
"shape":"PerObjectSyncStatus",
"documentation":"<p/>"
"documentation":"<p>Indicates whether this object is in sync with the version indicated in the update token.</p>"
},
"UpdateToken":{
"shape":"UpdateToken",
"documentation":"<p>The current version of the object that is either in sync or pending synchronization. </p>"
}
},
"documentation":"<p/>"
"documentation":"<p>Provides configuration status for a single policy or rule group that is used for a firewall endpoint. Network Firewall provides each endpoint with the rules that are configured in the firewall policy. Each time you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the rules in the endpoint, so it can properly filter network traffic. This is part of a <a>SyncState</a> for a firewall.</p>"
},
"PerObjectSyncStatus":{
"type":"string",
@ -2021,7 +2029,7 @@
"members":{
"RulesString":{
"shape":"RulesString",
"documentation":"<p>Stateful inspection criteria, provided in Suricata compatible intrusion prevention system (IPS) rules. Suricata is an open-source network IPS that includes a standard rule-based language for network traffic inspection.</p> <p>These rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting.</p> <p>You can provide the rules from a file that you've stored in an Amazon S3 bucket, or by providing the rules in a Suricata rules string. To import from Amazon S3, provide the fully qualified name of the file that contains the rules definitions. To provide a Suricata rule string, provide the complete, Suricata compatible rule.</p>"
"documentation":"<p>Stateful inspection criteria, provided in Suricata compatible intrusion prevention system (IPS) rules. Suricata is an open-source network IPS that includes a standard rule-based language for network traffic inspection.</p> <p>These rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting.</p>"
},
"RulesSourceList":{
"shape":"RulesSourceList",
@ -2048,18 +2056,18 @@
"members":{
"Targets":{
"shape":"RuleTargets",
"documentation":"<p>The domains that you want to inspect for in your traffic flows. To provide multiple domains, separate them with commas.</p>"
"documentation":"<p>The domains that you want to inspect for in your traffic flows. To provide multiple domains, separate them with commas. Valid domain specifications are the following:</p> <ul> <li> <p>Explicit names. For example, <code>abc.example.com</code> matches only the domain <code>abc.example.com</code>.</p> </li> <li> <p>Names that use a domain wildcard, which you indicate with an initial '<code>.</code>'. For example,<code>.example.com</code> matches <code>example.com</code> and matches all subdomains of <code>example.com</code>, such as <code>abc.example.com</code> and <code>www.example.com</code>. </p> </li> </ul>"
},
"TargetTypes":{
"shape":"TargetTypes",
"documentation":"<p/>"
"documentation":"<p>The protocols you want to inspect. Specify <code>TLS_SNI</code> for <code>HTTPS</code>. Specity <code>HTTP_HOST</code> for <code>HTTP</code>. You can specify either or both. </p>"
},
"GeneratedRulesType":{
"shape":"GeneratedRulesType",
"documentation":"<p>Whether you want to allow or deny access to the domains in your target list.</p>"
}
},
"documentation":"<p>Stateful inspection criteria for a domain list rule group. </p>"
"documentation":"<p>Stateful inspection criteria for a domain list rule group. </p> <p>For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.</p> <p>By default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the <code>HOME_NET</code> rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see <a>RuleVariables</a> in this guide and <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/stateful-rule-groups-domain-names.html\">Stateful domain list rule groups in AWS Network Firewall</a> in the <i>Network Firewall Developer Guide</i> </p>"
},
"RulesString":{
"type":"string",
@ -2646,7 +2654,7 @@
},
"Rules":{
"shape":"RulesString",
"documentation":"<p>The name of a file containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups. </p> <note> <p>You must provide either this rules setting or a populated <code>RuleGroup</code> setting, but not both. </p> </note> <p>You can provide your rule group specification in a file through this setting when you create or update your rule group. The call response returns a <a>RuleGroup</a> object that Network Firewall has populated from your file. Network Firewall uses the file contents to populate the rule group rules, but does not maintain a reference to the file or use the file in any way after performing the create or update. If you call <a>DescribeRuleGroup</a> to retrieve the rule group, Network Firewall returns rules settings inside a <a>RuleGroup</a> object. </p>"
"documentation":"<p>A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups. </p> <note> <p>You must provide either this rules setting or a populated <code>RuleGroup</code> setting, but not both. </p> </note> <p>You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call response returns a <a>RuleGroup</a> object that Network Firewall has populated from your string. </p>"
},
"Type":{
"shape":"RuleGroupType",
@ -2748,5 +2756,5 @@
"member":{"shape":"VpcId"}
}
},
"documentation":"<p>This is the API Reference for AWS Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types, and errors. </p> <ul> <li> <p>The REST API requires you to handle connection details, such as calculating signatures, handling request retries, and error handling. For general information about using the AWS REST APIs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-apis.html\">AWS APIs</a>. </p> <p>To access Network Firewall using the REST API endpoint: <code>https://network-firewall.&lt;region&gt;.amazonaws.com </code> </p> </li> <li> <p>Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see <a href=\"http://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p> </li> <li> <p>For descriptions of Network Firewall features, including and step-by-step instructions on how to use them through the Network Firewall console, see the <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/\">Network Firewall Developer Guide</a>.</p> </li> </ul> <p>Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or AWS Direct Connect. Network Firewall uses rules that are compatible with Suricata, a free, open source intrusion detection system (IDS) engine. For information about Suricata, see the <a href=\"https://suricata-ids.org/\">Suricata website</a>.</p> <p>You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples: </p> <ul> <li> <p>Allow domains or IP addresses for known AWS service endpoints, such as Amazon S3, and block all other forms of traffic.</p> </li> <li> <p>Use custom lists of known bad domains to limit the types of domain names that your applications can access.</p> </li> <li> <p>Perform deep packet inspection on traffic entering or leaving your VPC.</p> </li> <li> <p>Rate limit traffic going from AWS to on-premises IP destinations.</p> </li> <li> <p>Use stateful protocol detection to filter protocols like HTTPS, regardless of the port used.</p> </li> </ul> <p>To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in Network Firewall. For information about using Amazon VPC, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/\">Amazon VPC User Guide</a>.</p> <p>To start using Network Firewall, do the following: </p> <ol> <li> <p>(Optional) If you don't already have a VPC that you want to protect, create it in Amazon VPC. </p> </li> <li> <p>In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a subnet for the sole use of Network Firewall. </p> </li> <li> <p>In Network Firewall, create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have. </p> </li> <li> <p>In Network Firewall, create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior. </p> </li> <li> <p>In Network Firewall, create a firewall and specify your new firewall policy and VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you specify, with the behavior that's defined in the firewall policy.</p> </li> <li> <p>In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.</p> </li> </ol>"
"documentation":"<p>This is the API Reference for AWS Network Firewall. This guide is for developers who need detailed information about the Network Firewall API actions, data types, and errors. </p> <ul> <li> <p>The REST API requires you to handle connection details, such as calculating signatures, handling request retries, and error handling. For general information about using the AWS REST APIs, see <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-apis.html\">AWS APIs</a>. </p> <p>To access Network Firewall using the REST API endpoint: <code>https://network-firewall.&lt;region&gt;.amazonaws.com </code> </p> </li> <li> <p>Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see <a href=\"http://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p> </li> <li> <p>For descriptions of Network Firewall features, including and step-by-step instructions on how to use them through the Network Firewall console, see the <a href=\"https://docs.aws.amazon.com/network-firewall/latest/developerguide/\">Network Firewall Developer Guide</a>.</p> </li> </ul> <p>Network Firewall is a stateful, managed, network firewall and intrusion detection and prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the perimeter of your VPC. This includes filtering traffic going to and coming from an internet gateway, NAT gateway, or over VPN or AWS Direct Connect. Network Firewall uses rules that are compatible with Suricata, a free, open source intrusion detection system (IDS) engine. For information about Suricata, see the <a href=\"https://suricata-ids.org/\">Suricata website</a>.</p> <p>You can use Network Firewall to monitor and protect your VPC traffic in a number of ways. The following are just a few examples: </p> <ul> <li> <p>Allow domains or IP addresses for known AWS service endpoints, such as Amazon S3, and block all other forms of traffic.</p> </li> <li> <p>Use custom lists of known bad domains to limit the types of domain names that your applications can access.</p> </li> <li> <p>Perform deep packet inspection on traffic entering or leaving your VPC.</p> </li> <li> <p>Use stateful protocol detection to filter protocols like HTTPS, regardless of the port used.</p> </li> </ul> <p>To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in Network Firewall. For information about using Amazon VPC, see <a href=\"https://docs.aws.amazon.com/vpc/latest/userguide/\">Amazon VPC User Guide</a>.</p> <p>To start using Network Firewall, do the following: </p> <ol> <li> <p>(Optional) If you don't already have a VPC that you want to protect, create it in Amazon VPC. </p> </li> <li> <p>In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a subnet for the sole use of Network Firewall. </p> </li> <li> <p>In Network Firewall, create stateless and stateful rule groups, to define the components of the network traffic filtering behavior that you want your firewall to have. </p> </li> <li> <p>In Network Firewall, create a firewall policy that uses your rule groups and specifies additional default traffic filtering behavior. </p> </li> <li> <p>In Network Firewall, create a firewall and specify your new firewall policy and VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you specify, with the behavior that's defined in the firewall policy.</p> </li> <li> <p>In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall endpoints.</p> </li> </ol>"
}

14
botocore/data/organizations/2016-11-28/service-2.json
View file

@ -1320,6 +1320,10 @@
"INTERNAL_FAILURE",
"GOVCLOUD_ACCOUNT_ALREADY_EXISTS",
"MISSING_BUSINESS_VALIDATION",
"FAILED_BUSINESS_VALIDATION",
"PENDING_BUSINESS_VALIDATION",
"INVALID_IDENTITY_FOR_BUSINESS_VALIDATION",
"UNKNOWN_BUSINESS_VALIDATION",
"MISSING_PAYMENT_INSTRUMENT"
]
},
@ -1411,7 +1415,7 @@
},
"FailureReason":{
"shape":"CreateAccountFailureReason",
"documentation":"<p>If the request failed, a description of the reason for the failure.</p> <ul> <li> <p>ACCOUNT_LIMIT_EXCEEDED: The account could not be created because you have reached the limit on the number of accounts in your organization.</p> </li> <li> <p>CONCURRENT_ACCOUNT_MODIFICATION: You already submitted a request with the same information.</p> </li> <li> <p>EMAIL_ALREADY_EXISTS: The account could not be created because another AWS account with that email address already exists.</p> </li> <li> <p>GOVCLOUD_ACCOUNT_ALREADY_EXISTS: The account in the AWS GovCloud (US) Region could not be created because this Region already includes an account with that email address.</p> </li> <li> <p>INVALID_ADDRESS: The account could not be created because the address you provided is not valid.</p> </li> <li> <p>INVALID_EMAIL: The account could not be created because the email address you provided is not valid.</p> </li> <li> <p>INTERNAL_FAILURE: The account could not be created because of an internal failure. Try again later. If the problem persists, contact Customer Support.</p> </li> <li> <p>MISSING_BUSINESS_VALIDATION: The AWS account that owns your organization has not received Business Validation.</p> </li> <li> <p> MISSING_PAYMENT_INSTRUMENT: You must configure the management account with a valid payment method, such as a credit card.</p> </li> </ul>"
"documentation":"<p>If the request failed, a description of the reason for the failure.</p> <ul> <li> <p>ACCOUNT_LIMIT_EXCEEDED: The account could not be created because you have reached the limit on the number of accounts in your organization.</p> </li> <li> <p>CONCURRENT_ACCOUNT_MODIFICATION: You already submitted a request with the same information.</p> </li> <li> <p>EMAIL_ALREADY_EXISTS: The account could not be created because another AWS account with that email address already exists.</p> </li> <li> <p>FAILED_BUSINESS_VALIDATION: The AWS account that owns your organization failed to receive business license validation.</p> </li> <li> <p>GOVCLOUD_ACCOUNT_ALREADY_EXISTS: The account in the AWS GovCloud (US) Region could not be created because this Region already includes an account with that email address.</p> </li> <li> <p>IDENTITY_INVALID_BUSINESS_VALIDATION: The AWS account that owns your organization can't complete business license validation because it doesn't have valid identity data.</p> </li> <li> <p>INVALID_ADDRESS: The account could not be created because the address you provided is not valid.</p> </li> <li> <p>INVALID_EMAIL: The account could not be created because the email address you provided is not valid.</p> </li> <li> <p>INTERNAL_FAILURE: The account could not be created because of an internal failure. Try again later. If the problem persists, contact Customer Support.</p> </li> <li> <p>MISSING_BUSINESS_VALIDATION: The AWS account that owns your organization has not received Business Validation.</p> </li> <li> <p> MISSING_PAYMENT_INSTRUMENT: You must configure the management account with a valid payment method, such as a credit card.</p> </li> <li> <p>PENDING_BUSINESS_VALIDATION: The AWS account that owns your organization is still in the process of completing business license validation.</p> </li> <li> <p>UNKNOWN_BUSINESS_VALIDATION: The AWS account that owns your organization has an unknown issue with business license validation.</p> </li> </ul>"
}
},
"documentation":"<p>Contains the status about a <a>CreateAccount</a> or <a>CreateGovCloudAccount</a> request to create an AWS account or an AWS GovCloud (US) account in an organization.</p>"
@ -2078,7 +2082,7 @@
"Message":{"shape":"ExceptionMessage"},
"Reason":{"shape":"HandshakeConstraintViolationExceptionReason"}
},
"documentation":"<p>The requested operation would violate the constraint identified in the reason code.</p> <note> <p>Some of the reasons in the following list might not be applicable to this specific API or operation:</p> </note> <ul> <li> <p>ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. Note that deleted and closed accounts still count toward your limit.</p> <important> <p>If you get this exception immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support</a>.</p> </important> </li> <li> <p>ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the invited account is already a member of an organization.</p> </li> <li> <p>HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send in one day.</p> </li> <li> <p>INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You can't issue new invitations to join an organization while it's in the process of enabling all features. You can resume inviting accounts after you finalize the process when all accounts have agreed to the change.</p> </li> <li> <p>ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid because the organization has already enabled all features.</p> </li> <li> <p>ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed because the account is from a different marketplace than the accounts in the organization. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be from the same marketplace.</p> </li> <li> <p>ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED: You attempted to change the membership of an account too quickly after its previous change.</p> </li> <li> <p>PAYMENT_INSTRUMENT_REQUIRED: You can't complete the operation with an account that doesn't have a payment instrument, such as a credit card, associated with it.</p> </li> </ul>",
"documentation":"<p>The requested operation would violate the constraint identified in the reason code.</p> <note> <p>Some of the reasons in the following list might not be applicable to this specific API or operation:</p> </note> <ul> <li> <p>ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. Note that deleted and closed accounts still count toward your limit.</p> <important> <p>If you get this exception immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support</a>.</p> </important> </li> <li> <p>ALREADY_IN_AN_ORGANIZATION: The handshake request is invalid because the invited account is already a member of an organization.</p> </li> <li> <p>HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send in one day.</p> </li> <li> <p>INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES: You can't issue new invitations to join an organization while it's in the process of enabling all features. You can resume inviting accounts after you finalize the process when all accounts have agreed to the change.</p> </li> <li> <p>ORGANIZATION_ALREADY_HAS_ALL_FEATURES: The handshake request is invalid because the organization has already enabled all features.</p> </li> <li> <p>ORGANIZATION_IS_ALREADY_PENDING_ALL_FEATURES_MIGRATION: The handshake request is invalid because the organization has already started the process to enable all features.</p> </li> <li> <p>ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD: The request failed because the account is from a different marketplace than the accounts in the organization. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be from the same marketplace.</p> </li> <li> <p>ORGANIZATION_MEMBERSHIP_CHANGE_RATE_LIMIT_EXCEEDED: You attempted to change the membership of an account too quickly after its previous change.</p> </li> <li> <p>PAYMENT_INSTRUMENT_REQUIRED: You can't complete the operation with an account that doesn't have a payment instrument, such as a credit card, associated with it.</p> </li> </ul>",
"exception":true
},
"HandshakeConstraintViolationExceptionReason":{
@ -2088,6 +2092,7 @@
"HANDSHAKE_RATE_LIMIT_EXCEEDED",
"ALREADY_IN_AN_ORGANIZATION",
"ORGANIZATION_ALREADY_HAS_ALL_FEATURES",
"ORGANIZATION_IS_ALREADY_PENDING_ALL_FEATURES_MIGRATION",
"INVITE_DISABLED_DURING_ENABLE_ALL_FEATURES",
"PAYMENT_INSTRUMENT_REQUIRED",
"ORGANIZATION_FROM_DIFFERENT_SELLER_OF_RECORD",
@ -2239,7 +2244,7 @@
"Message":{"shape":"ExceptionMessage"},
"Reason":{"shape":"InvalidInputExceptionReason"}
},
"documentation":"<p>The requested operation failed because you provided invalid values for one or more of the request parameters. This exception includes a reason that contains additional information about the violated limit:</p> <note> <p>Some of the reasons in the following list might not be applicable to this specific API or operation.</p> </note> <ul> <li> <p>DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.</p> </li> <li> <p>IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.</p> </li> <li> <p>INPUT_REQUIRED: You must include a value for all required parameters.</p> </li> <li> <p>INVALID_ENUM: You specified an invalid value.</p> </li> <li> <p>INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.</p> </li> <li> <p>INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.</p> </li> <li> <p>INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.</p> </li> <li> <p>INVALID_PAGINATION_TOKEN: Get the value for the <code>NextToken</code> parameter from the response to a previous call of the operation.</p> </li> <li> <p>INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.</p> </li> <li> <p>INVALID_PATTERN: You provided a value that doesn't match the required pattern.</p> </li> <li> <p>INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.</p> </li> <li> <p>INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix <code>AWSServiceRoleFor</code>.</p> </li> <li> <p>INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.</p> </li> <li> <p>INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID. </p> </li> <li> <p>INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.</p> </li> <li> <p>MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.</p> </li> <li> <p>MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.</p> </li> <li> <p>MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.</p> </li> <li> <p>MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.</p> </li> <li> <p>MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.</p> </li> <li> <p>MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.</p> </li> <li> <p>TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.</p> </li> <li> <p>UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.</p> </li> </ul>",
"documentation":"<p>The requested operation failed because you provided invalid values for one or more of the request parameters. This exception includes a reason that contains additional information about the violated limit:</p> <note> <p>Some of the reasons in the following list might not be applicable to this specific API or operation.</p> </note> <ul> <li> <p>DUPLICATE_TAG_KEY: Tag keys must be unique among the tags attached to the same entity.</p> </li> <li> <p>IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.</p> </li> <li> <p>INPUT_REQUIRED: You must include a value for all required parameters.</p> </li> <li> <p>INVALID_EMAIL_ADDRESS_TARGET: You specified an invalid email address for the invited account owner.</p> </li> <li> <p>INVALID_ENUM: You specified an invalid value.</p> </li> <li> <p>INVALID_ENUM_POLICY_TYPE: You specified an invalid policy type string.</p> </li> <li> <p>INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.</p> </li> <li> <p>INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.</p> </li> <li> <p>INVALID_PAGINATION_TOKEN: Get the value for the <code>NextToken</code> parameter from the response to a previous call of the operation.</p> </li> <li> <p>INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.</p> </li> <li> <p>INVALID_PATTERN: You provided a value that doesn't match the required pattern.</p> </li> <li> <p>INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.</p> </li> <li> <p>INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix <code>AWSServiceRoleFor</code>.</p> </li> <li> <p>INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.</p> </li> <li> <p>INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID. </p> </li> <li> <p>INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.</p> </li> <li> <p>MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.</p> </li> <li> <p>MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.</p> </li> <li> <p>MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.</p> </li> <li> <p>MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.</p> </li> <li> <p>MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.</p> </li> <li> <p>MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.</p> </li> <li> <p>TARGET_NOT_SUPPORTED: You can't perform the specified operation on that target entity.</p> </li> <li> <p>UNRECOGNIZED_SERVICE_PRINCIPAL: You specified a service principal that isn't recognized.</p> </li> </ul>",
"exception":true
},
"InvalidInputExceptionReason":{
@ -2267,7 +2272,8 @@
"INVALID_ROLE_NAME",
"INVALID_SYSTEM_TAGS_PARAMETER",
"DUPLICATE_TAG_KEY",
"TARGET_NOT_SUPPORTED"
"TARGET_NOT_SUPPORTED",
"INVALID_EMAIL_ADDRESS_TARGET"
]
},
"InviteAccountToOrganizationRequest":{

41
botocore/data/personalize-events/2018-03-22/service-2.json
View file

@ -22,7 +22,7 @@
"errors":[
{"shape":"InvalidInputException"}
],
"documentation":"<p>Records user interaction event data. For more information see <a>event-record-api</a>.</p>"
"documentation":"<p>Records user interaction event data. For more information see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html\">Recording Events</a>.</p>"
},
"PutItems":{
"name":"PutItems",
@ -33,9 +33,10 @@
"input":{"shape":"PutItemsRequest"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Adds one or more items to an Items dataset. For more information see <a>importing-items</a>.</p>"
"documentation":"<p>Adds one or more items to an Items dataset. For more information see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html\">Importing Items Incrementally</a>. </p>"
},
"PutUsers":{
"name":"PutUsers",
@ -46,9 +47,10 @@
"input":{"shape":"PutUsersRequest"},
"errors":[
{"shape":"InvalidInputException"},
{"shape":"ResourceNotFoundException"}
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceInUseException"}
],
"documentation":"<p>Adds one or more users to a Users dataset. For more information see <a>importing-users</a>.</p>"
"documentation":"<p>Adds one or more users to a Users dataset. For more information see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html\">Importing Users Incrementally</a>.</p>"
}
},
"shapes":{
@ -139,11 +141,11 @@
},
"properties":{
"shape":"ItemProperties",
"documentation":"<p>A string map of item-specific metadata. Each element in the map consists of a key-value pair. For example, </p> <p> <code>{\"numberOfRatings\": \"12\"}</code> </p> <p>The keys use camel case names that match the fields in the Items schema. In the above example, the <code>numberOfRatings</code> would match the 'NUMBER_OF_RATINGS' field defined in the Items schema.</p>",
"documentation":"<p>A string map of item-specific metadata. Each element in the map consists of a key-value pair. For example, <code>{\"numberOfRatings\": \"12\"}</code>.</p> <p>The keys use camel case names that match the fields in the schema for the Items dataset. In the previous example, the <code>numberOfRatings</code> matches the 'NUMBER_OF_RATINGS' field defined in the Items schema. For categorical string data, to include multiple categories for a single item, separate each category with a pipe separator (<code>|</code>). For example, <code>\\\"Horror|Action\\\"</code>.</p>",
"jsonvalue":true
}
},
"documentation":"<p>Represents item metadata added to an Items dataset using the <code>PutItems</code> API.</p>"
"documentation":"<p>Represents item metadata added to an Items dataset using the <code>PutItems</code> API. For more information see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/importing-items.html\">Importing Items Incrementally</a>. </p>"
},
"ItemId":{
"type":"string",
@ -158,7 +160,7 @@
},
"ItemProperties":{
"type":"string",
"max":1024,
"max":4096,
"min":1
},
"PutEventsRequest":{
@ -179,7 +181,7 @@
},
"sessionId":{
"shape":"StringType",
"documentation":"<p>The session ID associated with the user's visit. Your application generates the sessionId when a user first visits your website or uses your application. Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information see <a>event-record-api</a>.</p>"
"documentation":"<p>The session ID associated with the user's visit. Your application generates the sessionId when a user first visits your website or uses your application. Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information, see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html\">Recording Events</a>.</p>"
},
"eventList":{
"shape":"EventList",
@ -196,7 +198,7 @@
"members":{
"datasetArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Number (ARN) of the Items dataset you are adding the item or items to.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the Items dataset you are adding the item or items to.</p>"
},
"items":{
"shape":"ItemList",
@ -213,7 +215,7 @@
"members":{
"datasetArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Number (ARN) of the Users dataset you are adding the user or users to.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the Users dataset you are adding the user or users to.</p>"
},
"users":{
"shape":"UserList",
@ -226,6 +228,15 @@
"max":40,
"min":1
},
"ResourceInUseException":{
"type":"structure",
"members":{
"message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The specified resource is in use.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
@ -250,11 +261,11 @@
},
"properties":{
"shape":"UserProperties",
"documentation":"<p>A string map of user-specific metadata. Each element in the map consists of a key-value pair. For example, </p> <p> <code>{\"numberOfVideosWatched\": \"45\"}</code> </p> <p>The keys use camel case names that match the fields in the Users schema. In the above example, the <code>numberOfVideosWatched</code> would match the 'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema.</p>",
"documentation":"<p>A string map of user-specific metadata. Each element in the map consists of a key-value pair. For example, <code>{\"numberOfVideosWatched\": \"45\"}</code>.</p> <p>The keys use camel case names that match the fields in the schema for the Users dataset. In the previous example, the <code>numberOfVideosWatched</code> matches the 'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema. For categorical string data, to include multiple categories for a single user, separate each category with a pipe separator (<code>|</code>). For example, <code>\\\"Member|Frequent shopper\\\"</code>.</p>",
"jsonvalue":true
}
},
"documentation":"<p>Represents user metadata added to a Users dataset using the <code>PutUsers</code> API.</p>"
"documentation":"<p>Represents user metadata added to a Users dataset using the <code>PutUsers</code> API. For more information see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html\">Importing Users Incrementally</a>.</p>"
},
"UserId":{
"type":"string",
@ -269,9 +280,9 @@
},
"UserProperties":{
"type":"string",
"max":1024,
"max":4096,
"min":1
}
},
"documentation":"<p>Amazon Personalize can consume real-time user event data, such as <i>stream</i> or <i>click</i> data, and use it for model training either alone or combined with historical data. For more information see <a>recording-events</a>.</p>"
"documentation":"<p>Amazon Personalize can consume real-time user event data, such as <i>stream</i> or <i>click</i> data, and use it for model training either alone or combined with historical data. For more information see <a href=\"https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html\">Recording Events</a>.</p>"
}

32
botocore/data/pinpoint/2016-12-01/service-2.json
View file

@ -6457,9 +6457,21 @@
"shape": "MessageType",
"documentation": "<p>The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).</p>"
},
"OriginationNumber": {
"shape": "__string",
"documentation": "<p>The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.</p>"
},
"SenderId": {
"shape": "__string",
"documentation": "<p>The sender ID to display on recipients' devices when they receive the SMS message.</p>"
},
"EntityId": {
"shape": "__string",
"documentation": "<p>The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.</p>"
},
"TemplateId": {
"shape": "__string",
"documentation": "<p>The template ID received from the regulatory body for sending SMS in your country.</p>"
}
},
"documentation": "<p>Specifies the content and settings for an SMS message that's sent to recipients of a campaign.</p>"
@ -11048,9 +11060,21 @@
"shape": "MessageType",
"documentation": "<p>The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).</p>"
},
"OriginationNumber": {
"shape": "__string",
"documentation": "<p>The long code to send the SMS message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.</p>"
},
"SenderId": {
"shape": "__string",
"documentation": "<p>The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see <a href=\"https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html\">Supported Countries and Regions</a> in the Amazon Pinpoint User Guide.</p>"
},
"EntityId": {
"shape": "__string",
"documentation": "<p>The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.</p>"
},
"TemplateId": {
"shape": "__string",
"documentation": "<p>The template ID received from the regulatory body for sending SMS in your country.</p>"
}
},
"documentation": "<p>Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.</p>"
@ -12265,6 +12289,14 @@
"Substitutions": {
"shape": "MapOfListOf__string",
"documentation": "<p>The message variables to use in the SMS message. You can override the default variables with individual address variables.</p>"
},
"EntityId": {
"shape": "__string",
"documentation": "<p>The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.</p>"
},
"TemplateId": {
"shape": "__string",
"documentation": "<p>The template ID received from the regulatory body for sending SMS in your country.</p>"
}
},
"documentation": "<p>Specifies the default settings for a one-time SMS message that's sent directly to an endpoint.</p>"

17
botocore/data/qldb-session/2019-07-11/service-2.json
View file

@ -27,7 +27,8 @@
{"shape":"InvalidSessionException"},
{"shape":"OccConflictException"},
{"shape":"RateExceededException"},
{"shape":"LimitExceededException"}
{"shape":"LimitExceededException"},
{"shape":"CapacityExceededException"}
],
"documentation":"<p>Sends a command to an Amazon QLDB ledger.</p> <note> <p>Instead of interacting directly with this API, we recommend using the QLDB driver or the QLDB shell to execute data transactions on a ledger.</p> <ul> <li> <p>If you are working with an AWS SDK, use the QLDB driver. The driver provides a high-level abstraction layer above this <i>QLDB Session</i> data plane and manages <code>SendCommand</code> API calls for you. For information and a list of supported programming languages, see <a href=\"https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started-driver.html\">Getting started with the driver</a> in the <i>Amazon QLDB Developer Guide</i>.</p> </li> <li> <p>If you are working with the AWS Command Line Interface (AWS CLI), use the QLDB shell. The shell is a command line interface that uses the QLDB driver to interact with a ledger. For information, see <a href=\"https://docs.aws.amazon.com/qldb/latest/developerguide/data-shell.html\">Accessing Amazon QLDB using the QLDB shell</a>.</p> </li> </ul> </note>"
}
@ -58,6 +59,14 @@
"documentation":"<p>Returned if the request is malformed or contains an error such as an invalid parameter value or a missing required parameter.</p>",
"exception":true
},
"CapacityExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>Returned when the request exceeds the processing capacity of the ledger.</p>",
"exception":true
},
"CommitDigest":{"type":"blob"},
"CommitTransactionRequest":{
"type":"structure",
@ -198,11 +207,11 @@
"members":{
"ReadIOs":{
"shape":"ReadIOs",
"documentation":"<p>The number of read I/O requests that the command performed.</p>"
"documentation":"<p>The number of read I/O requests that the command made.</p>"
},
"WriteIOs":{
"shape":"WriteIOs",
"documentation":"<p>The number of write I/O requests that the command performed.</p>"
"documentation":"<p>The number of write I/O requests that the command made.</p>"
}
},
"documentation":"<p>Contains I/O usage metrics for a command that was invoked.</p>"
@ -413,7 +422,7 @@
"members":{
"ProcessingTimeMilliseconds":{
"shape":"ProcessingTimeMilliseconds",
"documentation":"<p>The amount of time that was taken for the command to finish processing, measured in milliseconds.</p>"
"documentation":"<p>The amount of time that QLDB spent on processing the command, measured in milliseconds.</p>"
}
},
"documentation":"<p>Contains server-side performance information for a command. Amazon QLDB captures timing information between the times when it receives the request and when it sends the corresponding response.</p>"

87
botocore/data/quicksight/2018-04-01/paginators-1.json
View file

@ -1,3 +1,88 @@
{
"pagination": {}
"pagination": {
"ListAnalyses": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "AnalysisSummaryList"
},
"ListDashboardVersions": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "DashboardVersionSummaryList"
},
"ListDashboards": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "DashboardSummaryList"
},
"ListDataSets": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "DataSetSummaries"
},
"ListDataSources": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "DataSources"
},
"ListIngestions": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "Ingestions"
},
"ListNamespaces": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "Namespaces"
},
"ListTemplateAliases": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "TemplateAliasList"
},
"ListTemplateVersions": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "TemplateVersionSummaryList"
},
"ListTemplates": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "TemplateSummaryList"
},
"ListThemeVersions": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "ThemeVersionSummaryList"
},
"ListThemes": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "ThemeSummaryList"
},
"SearchAnalyses": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "AnalysisSummaryList"
},
"SearchDashboards": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "DashboardSummaryList"
}
}
}

91
botocore/data/quicksight/2018-04-01/paginators-1.sdk-extras.json Normal file
View file

@ -0,0 +1,91 @@
{
"version": 1.0,
"merge": {
"pagination": {
"ListAnalyses": {
"non_aggregate_keys": [
"Status",
"RequestId"
]
},
"ListDashboardVersions": {
"non_aggregate_keys": [
"Status",
"RequestId"
]
},
"ListTemplateAliases": {
"non_aggregate_keys": [
"Status",
"RequestId"
]
},
"ListTemplateVersions": {
"non_aggregate_keys": [
"Status",
"RequestId"
]
},
"ListTemplates": {
"non_aggregate_keys": [
"Status",
"RequestId"
]
},
"ListThemeVersions": {
"non_aggregate_keys": [
"Status",
"RequestId"
]
},
"ListThemes": {
"non_aggregate_keys": [
"Status",
"RequestId"
]
},
"SearchAnalyses": {
"non_aggregate_keys": [
"Status",
"RequestId"
]
},
"SearchDashboards": {
"non_aggregate_keys": [
"Status",
"RequestId"
]
},
"ListNamespaces": {
"non_aggregate_keys": [
"Status",
"RequestId"
]
},
"ListIngestions": {
"non_aggregate_keys": [
"Status",
"RequestId"
]
},
"ListDataSources": {
"non_aggregate_keys": [
"Status",
"RequestId"
]
},
"ListDataSets": {
"non_aggregate_keys": [
"Status",
"RequestId"
]
},
"ListDashboards": {
"non_aggregate_keys": [
"Status",
"RequestId"
]
}
}
}
}

72
botocore/data/quicksight/2018-04-01/service-2.json
View file

@ -2042,8 +2042,7 @@
"AnalysisName":{
"type":"string",
"max":2048,
"min":1,
"pattern":"[\\u0020-\\u00FF]+"
"min":1
},
"AnalysisSearchFilter":{
"type":"structure",
@ -2066,7 +2065,8 @@
"AnalysisSearchFilterList":{
"type":"list",
"member":{"shape":"AnalysisSearchFilter"},
"max":1
"max":1,
"min":1
},
"AnalysisSourceEntity":{
"type":"structure",
@ -2801,6 +2801,10 @@
"shape":"ColumnGroupList",
"documentation":"<p>Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.</p>"
},
"FieldFolders":{
"shape":"FieldFolderMap",
"documentation":"<p>The folder that contains fields and nested subfolders for your dataset.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A list of resource permissions on the dataset.</p>"
@ -2874,7 +2878,7 @@
},
"Type":{
"shape":"DataSourceType",
"documentation":"<p>The type of the data source. Currently, the supported types for this operation are: <code>ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA</code>. Use <code>ListDataSources</code> to return a list of all data sources.</p>"
"documentation":"<p>The type of the data source. Currently, the supported types for this operation are: <code>ATHENA, AURORA, AURORA_POSTGRESQL, AMAZON_ELASTICSEARCH, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA</code>. Use <code>ListDataSources</code> to return a list of all data sources.</p> <p> <code>AMAZON_ELASTICSEARCH</code> is for Amazon managed Elasticsearch Service.</p>"
},
"DataSourceParameters":{
"shape":"DataSourceParameters",
@ -3608,8 +3612,7 @@
"DashboardName":{
"type":"string",
"max":2048,
"min":1,
"pattern":"[\\u0020-\\u00FF]+"
"min":1
},
"DashboardPublishOptions":{
"type":"structure",
@ -3651,7 +3654,8 @@
"DashboardSearchFilterList":{
"type":"list",
"member":{"shape":"DashboardSearchFilter"},
"max":1
"max":1,
"min":1
},
"DashboardSourceEntity":{
"type":"structure",
@ -3873,6 +3877,10 @@
"shape":"ColumnGroupList",
"documentation":"<p>Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.</p>"
},
"FieldFolders":{
"shape":"FieldFolderMap",
"documentation":"<p>The folder that contains fields and nested subfolders for your dataset.</p>"
},
"RowLevelPermissionDataSet":{
"shape":"RowLevelPermissionDataSet",
"documentation":"<p>The row-level security configuration for the dataset.</p>"
@ -6005,6 +6013,34 @@
"max":4096,
"min":1
},
"FieldFolder":{
"type":"structure",
"members":{
"description":{
"shape":"FieldFolderDescription",
"documentation":"<p>The description for a field folder.</p>"
},
"columns":{
"shape":"FolderColumnList",
"documentation":"<p>A folder has a list of columns. A column can only be in one folder.</p>"
}
},
"documentation":"<p>A FieldFolder element is a folder that contains fields and nested subfolders.</p>"
},
"FieldFolderDescription":{
"type":"string",
"max":500
},
"FieldFolderMap":{
"type":"map",
"key":{"shape":"FieldFolderPath"},
"value":{"shape":"FieldFolder"}
},
"FieldFolderPath":{
"type":"string",
"max":1000,
"min":1
},
"FileFormat":{
"type":"string",
"enum":[
@ -6031,6 +6067,11 @@
"type":"string",
"enum":["StringEquals"]
},
"FolderColumnList":{
"type":"list",
"member":{"shape":"String"},
"max":5000
},
"GeoSpatialColumnGroup":{
"type":"structure",
"required":[
@ -8585,18 +8626,18 @@
"members":{
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace associated with the row-level permissions dataset.</p>"
"documentation":"<p>The namespace associated with the dataset that contains permissions for RLS.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the permission dataset.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.</p>"
},
"PermissionPolicy":{
"shape":"RowLevelPermissionPolicy",
"documentation":"<p>Permission policy.</p>"
"documentation":"<p>The type of permissions to use when interpretting the permissions for RLS. <code>DENY_ACCESS</code> is included for backward compatibility only.</p>"
}
},
"documentation":"<p>The row-level security configuration for the dataset.</p>"
"documentation":"<p>Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html\">Using Row-Level Security (RLS) to Restrict Access to a Dataset</a> in the <i>Amazon QuickSight User Guide</i>.</p> <p>The option to deny permissions by setting <code>PermissionPolicy</code> to <code>DENY_ACCESS</code> is not supported for new RLS datasets.</p>"
},
"RowLevelPermissionPolicy":{
"type":"string",
@ -8635,7 +8676,7 @@
"members":{
"DataSourceArn":{
"shape":"Arn",
"documentation":"<p>The amazon Resource Name (ARN) for the data source.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) for the data source.</p>"
},
"UploadSettings":{
"shape":"UploadSettings",
@ -9108,8 +9149,7 @@
"TemplateName":{
"type":"string",
"max":2048,
"min":1,
"pattern":"[\\u0020-\\u00FF]+"
"min":1
},
"TemplateSourceAnalysis":{
"type":"structure",
@ -10221,6 +10261,10 @@
"shape":"ColumnGroupList",
"documentation":"<p>Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.</p>"
},
"FieldFolders":{
"shape":"FieldFolderMap",
"documentation":"<p>The folder that contains fields and nested subfolders for your dataset.</p>"
},
"RowLevelPermissionDataSet":{
"shape":"RowLevelPermissionDataSet",
"documentation":"<p>The row-level security configuration for the data you want to create.</p>"

6
botocore/data/rds/2014-10-31/paginators-1.json
View file

@ -210,6 +210,12 @@
"limit_key": "MaxRecords",
"output_token": "Marker",
"result_key": "ExportTasks"
},
"DescribeDBProxyEndpoints": {
"input_token": "Marker",
"limit_key": "MaxRecords",
"output_token": "Marker",
"result_key": "DBProxyEndpoints"
}
}
}

483
botocore/data/rds/2014-10-31/service-2.json
View file

@ -454,6 +454,26 @@
],
"documentation":"<p>Creates a new DB proxy.</p>"
},
"CreateDBProxyEndpoint":{
"name":"CreateDBProxyEndpoint",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"CreateDBProxyEndpointRequest"},
"output":{
"shape":"CreateDBProxyEndpointResponse",
"resultWrapper":"CreateDBProxyEndpointResult"
},
"errors":[
{"shape":"InvalidSubnet"},
{"shape":"DBProxyNotFoundFault"},
{"shape":"DBProxyEndpointAlreadyExistsFault"},
{"shape":"DBProxyEndpointQuotaExceededFault"},
{"shape":"InvalidDBProxyStateFault"}
],
"documentation":"<p> Creates a <code>DBProxyEndpoint</code>. Only applies to proxies that are associated with Aurora DB clusters. You can use DB proxy endpoints to specify read/write or read-only access to the DB cluster. You can also use DB proxy endpoints to access a DB proxy through a different VPC than the proxy's default VPC. </p>"
},
"CreateDBSecurityGroup":{
"name":"CreateDBSecurityGroup",
"http":{
@ -720,7 +740,24 @@
{"shape":"DBProxyNotFoundFault"},
{"shape":"InvalidDBProxyStateFault"}
],
"documentation":"<p>Deletes an existing proxy.</p>"
"documentation":"<p>Deletes an existing DB proxy.</p>"
},
"DeleteDBProxyEndpoint":{
"name":"DeleteDBProxyEndpoint",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DeleteDBProxyEndpointRequest"},
"output":{
"shape":"DeleteDBProxyEndpointResponse",
"resultWrapper":"DeleteDBProxyEndpointResult"
},
"errors":[
{"shape":"DBProxyEndpointNotFoundFault"},
{"shape":"InvalidDBProxyEndpointStateFault"}
],
"documentation":"<p>Deletes a <code>DBProxyEndpoint</code>. Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy's default VPC.</p>"
},
"DeleteDBSecurityGroup":{
"name":"DeleteDBSecurityGroup",
@ -1115,6 +1152,23 @@
],
"documentation":"<p>Returns information about DB proxies.</p>"
},
"DescribeDBProxyEndpoints":{
"name":"DescribeDBProxyEndpoints",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"DescribeDBProxyEndpointsRequest"},
"output":{
"shape":"DescribeDBProxyEndpointsResponse",
"resultWrapper":"DescribeDBProxyEndpointsResult"
},
"errors":[
{"shape":"DBProxyNotFoundFault"},
{"shape":"DBProxyEndpointNotFoundFault"}
],
"documentation":"<p>Returns information about DB proxy endpoints.</p>"
},
"DescribeDBProxyTargetGroups":{
"name":"DescribeDBProxyTargetGroups",
"http":{
@ -1487,6 +1541,25 @@
],
"documentation":"<p>Forces a failover for a DB cluster.</p> <p>A failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary instance (the cluster writer).</p> <p>Amazon Aurora will automatically fail over to an Aurora Replica, if one exists, when the primary instance fails. You can force a failover when you want to simulate a failure of a primary instance for testing. Because each instance in a DB cluster has its own endpoint address, you will need to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.</p> <p>For more information on Amazon Aurora, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html\"> What Is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide.</i> </p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>"
},
"FailoverGlobalCluster":{
"name":"FailoverGlobalCluster",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"FailoverGlobalClusterMessage"},
"output":{
"shape":"FailoverGlobalClusterResult",
"resultWrapper":"FailoverGlobalClusterResult"
},
"errors":[
{"shape":"GlobalClusterNotFoundFault"},
{"shape":"InvalidGlobalClusterStateFault"},
{"shape":"InvalidDBClusterStateFault"},
{"shape":"DBClusterNotFoundFault"}
],
"documentation":"<p>Initiates the failover process for an Aurora global database (<a>GlobalCluster</a>).</p> <p>A failover for an Aurora global database promotes one of secondary read-only DB clusters to be the primary DB cluster and demotes the primary DB cluster to being a secondary (read-only) DB cluster. In other words, the role of the current primary DB cluster and the selected (target) DB cluster are switched. The selected secondary DB cluster assumes full read/write capabilities for the Aurora global database.</p> <p>For more information about failing over an Amazon Aurora global database, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.managed-failover\">Managed planned failover for Amazon Aurora global databases</a> in the <i>Amazon Aurora User Guide.</i> </p> <note> <p>This action applies to <a>GlobalCluster</a> (Aurora global databases) only. Use this action only on healthy Aurora global databases with running Aurora DB clusters and no Region-wide outages, to test disaster recovery scenarios or to reconfigure your Aurora global database topology. </p> </note>"
},
"ImportInstallationMedia":{
"name":"ImportInstallationMedia",
"http":{
@ -1709,6 +1782,25 @@
],
"documentation":"<p>Changes the settings for an existing DB proxy.</p>"
},
"ModifyDBProxyEndpoint":{
"name":"ModifyDBProxyEndpoint",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ModifyDBProxyEndpointRequest"},
"output":{
"shape":"ModifyDBProxyEndpointResponse",
"resultWrapper":"ModifyDBProxyEndpointResult"
},
"errors":[
{"shape":"DBProxyEndpointNotFoundFault"},
{"shape":"DBProxyEndpointAlreadyExistsFault"},
{"shape":"InvalidDBProxyEndpointStateFault"},
{"shape":"InvalidDBProxyStateFault"}
],
"documentation":"<p>Changes the settings for an existing DB proxy endpoint.</p>"
},
"ModifyDBProxyTargetGroup":{
"name":"ModifyDBProxyTargetGroup",
"http":{
@ -2751,6 +2843,12 @@
"locationName":"AvailableProcessorFeature"
}
},
"AwsBackupRecoveryPointArn":{
"type":"string",
"max":350,
"min":43,
"pattern":"^arn:aws[a-z-]*:backup:[-a-z0-9]+:[0-9]{12}:[-a-z]+:([a-z0-9\\-]+:)?[a-z][a-z0-9\\-]{0,255}$"
},
"BacktrackDBClusterMessage":{
"type":"structure",
"required":[
@ -3312,7 +3410,7 @@
},
"EnableCloudwatchLogsExports":{
"shape":"LogTypeList",
"documentation":"<p>The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p> <p> <b>Aurora MySQL</b> </p> <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>. </p> <p> <b>Aurora PostgreSQL</b> </p> <p>Possible values are <code>postgresql</code> and <code>upgrade</code>. </p>"
"documentation":"<p>The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch\">Publishing Database Logs to Amazon CloudWatch Logs</a> in the <i>Amazon Aurora User Guide</i>.</p> <p> <b>Aurora MySQL</b> </p> <p>Possible values are <code>audit</code>, <code>error</code>, <code>general</code>, and <code>slowquery</code>. </p> <p> <b>Aurora PostgreSQL</b> </p> <p>Possible value is <code>postgresql</code>. </p>"
},
"EngineMode":{
"shape":"String",
@ -3348,7 +3446,7 @@
},
"EnableGlobalWriteForwarding":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether to enable write operations to be forwarded from this cluster to the primary cluster in an Aurora global database. The resulting changes are replicated back to this cluster. This parameter only applies to DB clusters that are secondary clusters in an Aurora global database. By default, Aurora disallows write operations for secondary clusters.</p>"
"documentation":"<p>A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (<a>GlobalCluster</a>). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.</p> <p>You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the <a>FailoverGlobalCluster</a> API operation, but it does nothing until then. </p>"
}
},
"documentation":"<p/>"
@ -3802,6 +3900,46 @@
"DBParameterGroup":{"shape":"DBParameterGroup"}
}
},
"CreateDBProxyEndpointRequest":{
"type":"structure",
"required":[
"DBProxyName",
"DBProxyEndpointName",
"VpcSubnetIds"
],
"members":{
"DBProxyName":{
"shape":"DBProxyName",
"documentation":"<p>The name of the DB proxy associated with the DB proxy endpoint that you create.</p>"
},
"DBProxyEndpointName":{
"shape":"DBProxyEndpointName",
"documentation":"<p>The name of the DB proxy endpoint to create.</p>"
},
"VpcSubnetIds":{
"shape":"StringList",
"documentation":"<p>The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.</p>"
},
"VpcSecurityGroupIds":{
"shape":"StringList",
"documentation":"<p>The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.</p>"
},
"TargetRole":{
"shape":"DBProxyEndpointTargetRole",
"documentation":"<p>A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. The default is <code>READ_WRITE</code>.</p>"
},
"Tags":{"shape":"TagList"}
}
},
"CreateDBProxyEndpointResponse":{
"type":"structure",
"members":{
"DBProxyEndpoint":{
"shape":"DBProxyEndpoint",
"documentation":"<p>The <code>DBProxyEndpoint</code> object that is created by the API operation. The DB proxy endpoint that you create might provide capabilities such as read/write or read-only operations, or using a different VPC than the proxy's default VPC.</p>"
}
}
},
"CreateDBProxyRequest":{
"type":"structure",
"required":[
@ -4573,6 +4711,12 @@
},
"exception":true
},
"DBClusterIdentifier":{
"type":"string",
"max":255,
"min":1,
"pattern":"[A-Za-z][0-9A-Za-z-:._]*"
},
"DBClusterList":{
"type":"list",
"member":{
@ -4831,7 +4975,11 @@
},
"Engine":{
"shape":"String",
"documentation":"<p>Specifies the name of the database engine.</p>"
"documentation":"<p>Specifies the name of the database engine for this DB cluster snapshot.</p>"
},
"EngineMode":{
"shape":"String",
"documentation":"<p>Provides the engine mode of the database engine for this DB cluster snapshot.</p>"
},
"AllocatedStorage":{
"shape":"Integer",
@ -4855,7 +5003,7 @@
},
"MasterUsername":{
"shape":"String",
"documentation":"<p>Provides the master username for the DB cluster snapshot.</p>"
"documentation":"<p>Provides the master username for this DB cluster snapshot.</p>"
},
"EngineVersion":{
"shape":"String",
@ -5329,6 +5477,10 @@
"CustomerOwnedIpEnabled":{
"shape":"BooleanOptional",
"documentation":"<p>Specifies whether a customer-owned IP address (CoIP) is enabled for an RDS on Outposts DB instance.</p> <p>A <i>CoIP </i>provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.</p> <p>For more information about RDS on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html\">Working with Amazon RDS on AWS Outposts</a> in the <i>Amazon RDS User Guide</i>.</p> <p>For more information about CoIPs, see <a href=\"https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing\">Customer-owned IP addresses</a> in the <i>AWS Outposts User Guide</i>.</p>"
},
"AwsBackupRecoveryPointArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the recovery point in AWS Backup.</p>"
}
},
"documentation":"<p>Contains the details of an Amazon RDS DB instance. </p> <p>This data type is used as a response element in the <code>DescribeDBInstances</code> action. </p>",
@ -5798,6 +5950,10 @@
"shape":"String",
"documentation":"<p>The engine family applies to MySQL and PostgreSQL for both RDS and Aurora.</p>"
},
"VpcId":{
"shape":"String",
"documentation":"<p>Provides the VPC ID of the DB proxy.</p>"
},
"VpcSecurityGroupIds":{
"shape":"StringList",
"documentation":"<p>Provides a list of VPC security groups that the proxy belongs to.</p>"
@ -5816,7 +5972,7 @@
},
"Endpoint":{
"shape":"String",
"documentation":"<p>The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.</p>"
"documentation":"<p>The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.</p>"
},
"RequireTLS":{
"shape":"Boolean",
@ -5847,16 +6003,136 @@
},
"documentation":"<p>The specified proxy name must be unique for all proxies owned by your AWS account in the specified AWS Region.</p>",
"error":{
"code":"DBProxyTargetExistsFault",
"code":"DBProxyAlreadyExistsFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DBProxyEndpoint":{
"type":"structure",
"members":{
"DBProxyEndpointName":{
"shape":"String",
"documentation":"<p>The name for the DB proxy endpoint. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.</p>"
},
"DBProxyEndpointArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) for the DB proxy endpoint.</p>"
},
"DBProxyName":{
"shape":"String",
"documentation":"<p>The identifier for the DB proxy that is associated with this DB proxy endpoint.</p>"
},
"Status":{
"shape":"DBProxyEndpointStatus",
"documentation":"<p>The current status of this DB proxy endpoint. A status of <code>available</code> means the endpoint is ready to handle requests. Other values indicate that you must wait for the endpoint to be ready, or take some action to resolve an issue.</p>"
},
"VpcId":{
"shape":"String",
"documentation":"<p>Provides the VPC ID of the DB proxy endpoint.</p>"
},
"VpcSecurityGroupIds":{
"shape":"StringList",
"documentation":"<p>Provides a list of VPC security groups that the DB proxy endpoint belongs to.</p>"
},
"VpcSubnetIds":{
"shape":"StringList",
"documentation":"<p>The EC2 subnet IDs for the DB proxy endpoint.</p>"
},
"Endpoint":{
"shape":"String",
"documentation":"<p>The endpoint that you can use to connect to the DB proxy. You include the endpoint value in the connection string for a database client application.</p>"
},
"CreatedDate":{
"shape":"TStamp",
"documentation":"<p>The date and time when the DB proxy endpoint was first created.</p>"
},
"TargetRole":{
"shape":"DBProxyEndpointTargetRole",
"documentation":"<p>A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.</p>"
},
"IsDefault":{
"shape":"Boolean",
"documentation":"<p>A value that indicates whether this endpoint is the default endpoint for the associated DB proxy. Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.</p>"
}
},
"documentation":"<p>The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one endpoint for each DB proxy. For Aurora DB clusters, you can associate additional endpoints with the same DB proxy. These endpoints can be read/write or read-only. They can also reside in different VPCs than the associated DB proxy.</p> <p>This data type is used as a response element in the <code>DescribeDBProxyEndpoints</code> operation.</p>"
},
"DBProxyEndpointAlreadyExistsFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your AWS account in the specified AWS Region.</p>",
"error":{
"code":"DBProxyEndpointAlreadyExistsFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DBProxyEndpointList":{
"type":"list",
"member":{"shape":"DBProxyEndpoint"}
},
"DBProxyEndpointName":{
"type":"string",
"max":63,
"min":1,
"pattern":"[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*"
},
"DBProxyEndpointNotFoundFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The DB proxy endpoint doesn't exist.</p>",
"error":{
"code":"DBProxyEndpointNotFoundFault",
"httpStatusCode":404,
"senderFault":true
},
"exception":true
},
"DBProxyEndpointQuotaExceededFault":{
"type":"structure",
"members":{
},
"documentation":"<p>The DB proxy already has the maximum number of endpoints.</p>",
"error":{
"code":"DBProxyEndpointQuotaExceededFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"DBProxyEndpointStatus":{
"type":"string",
"enum":[
"available",
"modifying",
"incompatible-network",
"insufficient-resource-limits",
"creating",
"deleting"
]
},
"DBProxyEndpointTargetRole":{
"type":"string",
"enum":[
"READ_WRITE",
"READ_ONLY"
]
},
"DBProxyList":{
"type":"list",
"member":{"shape":"DBProxy"}
},
"DBProxyName":{
"type":"string",
"max":63,
"min":1,
"pattern":"[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*"
},
"DBProxyNotFoundFault":{
"type":"structure",
"members":{
@ -5922,6 +6198,10 @@
"shape":"TargetType",
"documentation":"<p>Specifies the kind of database, such as an RDS DB instance or an Aurora DB cluster, that the target represents.</p>"
},
"Role":{
"shape":"TargetRole",
"documentation":"<p>A value that indicates whether the target of the proxy can be used for read/write or read-only operations.</p>"
},
"TargetHealth":{
"shape":"TargetHealth",
"documentation":"<p>Information about the connection health of the RDS Proxy target.</p>"
@ -6612,6 +6892,25 @@
},
"documentation":"<p/>"
},
"DeleteDBProxyEndpointRequest":{
"type":"structure",
"required":["DBProxyEndpointName"],
"members":{
"DBProxyEndpointName":{
"shape":"DBProxyEndpointName",
"documentation":"<p>The name of the DB proxy endpoint to delete.</p>"
}
}
},
"DeleteDBProxyEndpointResponse":{
"type":"structure",
"members":{
"DBProxyEndpoint":{
"shape":"DBProxyEndpoint",
"documentation":"<p>The data structure representing the details of the DB proxy endpoint that you delete.</p>"
}
}
},
"DeleteDBProxyRequest":{
"type":"structure",
"required":["DBProxyName"],
@ -7206,7 +7505,7 @@
"members":{
"DBProxyName":{
"shape":"String",
"documentation":"<p>The name of the DB proxy.</p>"
"documentation":"<p>The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your AWS account ID.</p>"
},
"Filters":{
"shape":"FilterList",
@ -7235,6 +7534,44 @@
}
}
},
"DescribeDBProxyEndpointsRequest":{
"type":"structure",
"members":{
"DBProxyName":{
"shape":"DBProxyName",
"documentation":"<p>The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.</p>"
},
"DBProxyEndpointName":{
"shape":"DBProxyEndpointName",
"documentation":"<p>The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.</p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>This parameter is not currently supported.</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>"
},
"MaxRecords":{
"shape":"MaxRecords",
"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>"
}
}
},
"DescribeDBProxyEndpointsResponse":{
"type":"structure",
"members":{
"DBProxyEndpoints":{
"shape":"DBProxyEndpointList",
"documentation":"<p>The list of <code>ProxyEndpoint</code> objects returned by the API operation.</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>"
}
}
},
"DescribeDBProxyTargetGroupsRequest":{
"type":"structure",
"required":["DBProxyName"],
@ -8359,6 +8696,56 @@
"DBCluster":{"shape":"DBCluster"}
}
},
"FailoverGlobalClusterMessage":{
"type":"structure",
"required":[
"GlobalClusterIdentifier",
"TargetDbClusterIdentifier"
],
"members":{
"GlobalClusterIdentifier":{
"shape":"GlobalClusterIdentifier",
"documentation":"<p>Identifier of the Aurora global database (<a>GlobalCluster</a>) that should be failed over. The identifier is the unique key assigned by the user when the Aurora global database was created. In other words, it's the name of the Aurora global database that you want to fail over. </p> <p>Constraints:</p> <ul> <li> <p>Must match the identifier of an existing <a>GlobalCluster</a> (Aurora global database).</p> </li> </ul>"
},
"TargetDbClusterIdentifier":{
"shape":"DBClusterIdentifier",
"documentation":"<p>Identifier of the secondary Aurora DB cluster that you want to promote to primary for the Aurora global database (<a>GlobalCluster</a>.) Use the Amazon Resource Name (ARN) for the identifier so that Aurora can locate the cluster in its AWS Region. </p>"
}
}
},
"FailoverGlobalClusterResult":{
"type":"structure",
"members":{
"GlobalCluster":{"shape":"GlobalCluster"}
}
},
"FailoverState":{
"type":"structure",
"members":{
"Status":{
"shape":"FailoverStatus",
"documentation":"<p>The current status of the Aurora global database (<a>GlobalCluster</a>). Possible values are as follows: </p> <ul> <li> <p>pending &#x96; A request to fail over the Aurora global database (<a>GlobalCluster</a>) has been received by the service. The <code>GlobalCluster</code>'s primary DB cluster and the specified secondary DB cluster are being verified before the failover process can start.</p> </li> <li> <p>failing-over &#x96; This status covers the range of Aurora internal operations that take place during the failover process, such as demoting the primary Aurora DB cluster, promoting the secondary Aurora DB, and synchronizing replicas. </p> </li> <li> <p>cancelling &#x96; The request to fail over the Aurora global database (<a>GlobalCluster</a>) was cancelled and the primary Aurora DB cluster and the selected secondary Aurora DB cluster are returning to their previous states. </p> </li> </ul>"
},
"FromDbClusterArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being demoted, and which is associated with this state. </p>"
},
"ToDbClusterArn":{
"shape":"String",
"documentation":"<p>The Amazon Resource Name (ARN) of the Aurora DB cluster that is currently being promoted, and which is associated with this state.</p>"
}
},
"documentation":"<p>Contains the state of scheduled or in-process failover operations on an Aurora global database (<a>GlobalCluster</a>). This Data type is empty unless a failover operation is scheduled or is currently underway on the Aurora global database. </p>",
"wrapper":true
},
"FailoverStatus":{
"type":"string",
"enum":[
"pending",
"failing-over",
"cancelling"
]
},
"FeatureNameList":{
"type":"list",
"member":{"shape":"String"}
@ -8437,6 +8824,10 @@
"GlobalClusterMembers":{
"shape":"GlobalClusterMemberList",
"documentation":"<p> The list of cluster IDs for secondary clusters within the global database cluster. Currently limited to 1 item. </p>"
},
"FailoverState":{
"shape":"FailoverState",
"documentation":"<p>A data object containing all properties for the current state of an in-process or pending failover process for this Aurora global database. This object is empty unless the <a>FailoverGlobalCluster</a> API operation has been called on this Aurora global database (<a>GlobalCluster</a>). </p>"
}
},
"documentation":"<p>A data type representing an Aurora global database.</p>",
@ -8454,6 +8845,12 @@
},
"exception":true
},
"GlobalClusterIdentifier":{
"type":"string",
"max":255,
"min":1,
"pattern":"[A-Za-z][0-9A-Za-z-:._]*"
},
"GlobalClusterList":{
"type":"list",
"member":{
@ -8850,6 +9247,18 @@
},
"exception":true
},
"InvalidDBProxyEndpointStateFault":{
"type":"structure",
"members":{
},
"documentation":"<p>You can't perform this operation while the DB proxy endpoint is in a particular state.</p>",
"error":{
"code":"InvalidDBProxyEndpointStateFault",
"httpStatusCode":400,
"senderFault":true
},
"exception":true
},
"InvalidDBProxyStateFault":{
"type":"structure",
"members":{
@ -9266,7 +9675,7 @@
},
"EnableGlobalWriteForwarding":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether to enable write operations to be forwarded from this cluster to the primary cluster in an Aurora global database. The resulting changes are replicated back to this cluster. This parameter only applies to DB clusters that are secondary clusters in an Aurora global database. By default, Aurora disallows write operations for secondary clusters.</p>"
"documentation":"<p>A value that indicates whether to enable this DB cluster to forward write operations to the primary cluster of an Aurora global database (<a>GlobalCluster</a>). By default, write operations are not allowed on Aurora DB clusters that are secondary clusters in an Aurora global database.</p> <p>You can set this value only on Aurora DB clusters that are members of an Aurora global database. With this parameter enabled, a secondary cluster can forward writes to the current primary cluster and the resulting changes are replicated back to this cluster. For the primary DB cluster of an Aurora global database, this value is used immediately if the primary is demoted by the <a>FailoverGlobalCluster</a> API operation, but it does nothing until then. </p>"
}
},
"documentation":"<p/>"
@ -9506,6 +9915,10 @@
"EnableCustomerOwnedIp":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance.</p> <p>A <i>CoIP</i> provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network.</p> <p>For more information about RDS on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html\">Working with Amazon RDS on AWS Outposts</a> in the <i>Amazon RDS User Guide</i>.</p> <p>For more information about CoIPs, see <a href=\"https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing\">Customer-owned IP addresses</a> in the <i>AWS Outposts User Guide</i>.</p>"
},
"AwsBackupRecoveryPointArn":{
"shape":"AwsBackupRecoveryPointArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the recovery point in AWS Backup.</p>"
}
},
"documentation":"<p/>"
@ -9534,6 +9947,33 @@
},
"documentation":"<p/>"
},
"ModifyDBProxyEndpointRequest":{
"type":"structure",
"required":["DBProxyEndpointName"],
"members":{
"DBProxyEndpointName":{
"shape":"DBProxyEndpointName",
"documentation":"<p>The name of the DB proxy sociated with the DB proxy endpoint that you want to modify.</p>"
},
"NewDBProxyEndpointName":{
"shape":"DBProxyEndpointName",
"documentation":"<p>The new identifier for the <code>DBProxyEndpoint</code>. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.</p>"
},
"VpcSecurityGroupIds":{
"shape":"StringList",
"documentation":"<p>The VPC security group IDs for the DB proxy endpoint. When the DB proxy endpoint uses a different VPC than the original proxy, you also specify a different set of security group IDs than for the original proxy.</p>"
}
}
},
"ModifyDBProxyEndpointResponse":{
"type":"structure",
"members":{
"DBProxyEndpoint":{
"shape":"DBProxyEndpoint",
"documentation":"<p>The <code>DBProxyEndpoint</code> object representing the new settings for the DB proxy endpoint.</p>"
}
}
},
"ModifyDBProxyRequest":{
"type":"structure",
"required":["DBProxyName"],
@ -12650,13 +13090,22 @@
"UNREACHABLE",
"CONNECTION_FAILED",
"AUTH_FAILURE",
"PENDING_PROXY_CAPACITY"
"PENDING_PROXY_CAPACITY",
"INVALID_REPLICATION_STATE"
]
},
"TargetList":{
"type":"list",
"member":{"shape":"DBProxyTarget"}
},
"TargetRole":{
"type":"string",
"enum":[
"READ_WRITE",
"READ_ONLY",
"UNKNOWN"
]
},
"TargetState":{
"type":"string",
"enum":[
@ -12704,7 +13153,19 @@
},
"IsMajorVersionUpgrade":{
"shape":"Boolean",
"documentation":"<p>A value that indicates whether a database engine is upgraded to a major version.</p>"
"documentation":"<p>A value that indicates whether upgrading to the target version requires upgrading the major version of the database engine.</p>"
},
"SupportedEngineModes":{
"shape":"EngineModeList",
"documentation":"<p>A list of the supported DB engine modes for the target engine version.</p>"
},
"SupportsParallelQuery":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether you can use Aurora parallel query with the target engine version.</p>"
},
"SupportsGlobalDatabases":{
"shape":"BooleanOptional",
"documentation":"<p>A value that indicates whether you can use Aurora global databases with the target engine version.</p>"
}
},
"documentation":"<p>The version of the database engine that a DB instance can be upgraded to.</p>"

63
botocore/data/redshift-data/2019-12-20/service-2.json
View file

@ -66,7 +66,8 @@
"output":{"shape":"ExecuteStatementOutput"},
"errors":[
{"shape":"ValidationException"},
{"shape":"ExecuteStatementException"}
{"shape":"ExecuteStatementException"},
{"shape":"ActiveStatementsExceededException"}
],
"documentation":"<p>Runs an SQL statement, which can be data manipulation language (DML) or data definition language (DDL). This statement must be a single SQL statement. Depending on the authorization method, use one of the following combinations of request parameters: </p> <ul> <li> <p>AWS Secrets Manager - specify the Amazon Resource Name (ARN) of the secret and the cluster identifier that matches the cluster in the secret. </p> </li> <li> <p>Temporary credentials - specify the cluster identifier, the database name, and the database user name. Permission to call the <code>redshift:GetClusterCredentials</code> operation is required to use this method. </p> </li> </ul>"
},
@ -143,6 +144,14 @@
}
},
"shapes":{
"ActiveStatementsExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"String"}
},
"documentation":"<p>The number of active statements exceeds the limit.</p>",
"exception":true
},
"Blob":{"type":"blob"},
"Boolean":{
"type":"boolean",
@ -287,6 +296,10 @@
"shape":"String",
"documentation":"<p>The error message from the cluster if the SQL statement encountered an error while running. </p>"
},
"HasResultSet":{
"shape":"Boolean",
"documentation":"<p>A value that indicates whether the statement has a result set. The result set can be empty. </p>"
},
"Id":{
"shape":"UUID",
"documentation":"<p>The identifier of the SQL statement described. This value is a universally unique identifier (UUID) generated by Amazon Redshift Data API. </p>"
@ -327,15 +340,22 @@
},
"DescribeTableRequest":{
"type":"structure",
"required":["ClusterIdentifier"],
"required":[
"ClusterIdentifier",
"Database"
],
"members":{
"ClusterIdentifier":{
"shape":"Location",
"documentation":"<p>The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials. </p>"
},
"ConnectedDatabase":{
"shape":"String",
"documentation":"<p>A database name. The connected database is specified when you connect with your authentication credentials. </p>"
},
"Database":{
"shape":"String",
"documentation":"<p>The name of the database. This parameter is required when authenticating using temporary credentials.</p>"
"documentation":"<p>The name of the database that contains the tables to be described. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>"
},
"DbUser":{
"shape":"String",
@ -494,7 +514,8 @@
"documentation":"<p>A value of the string data type. </p>"
}
},
"documentation":"<p>A data value in a column. </p>"
"documentation":"<p>A data value in a column. </p>",
"union":true
},
"FieldList":{
"type":"list",
@ -604,9 +625,13 @@
"shape":"Location",
"documentation":"<p>The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials. </p>"
},
"ConnectedDatabase":{
"shape":"String",
"documentation":"<p>A database name. The connected database is specified when you connect with your authentication credentials. </p>"
},
"Database":{
"shape":"String",
"documentation":"<p>The name of the database. This parameter is required when authenticating using temporary credentials. </p>"
"documentation":"<p>The name of the database that contains the schemas to list. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>"
},
"DbUser":{
"shape":"String",
@ -659,6 +684,10 @@
"shape":"String",
"documentation":"<p>A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned NextToken value in the next NextToken parameter and retrying the command. If the NextToken field is empty, all response records have been retrieved for the request. </p>"
},
"RoleLevel":{
"shape":"Boolean",
"documentation":"<p>A value that filters which statements to return in the response. If true, all statements run by the caller's IAM role are returned. If false, only statements run by the caller's IAM role in the current IAM session are returned. The default is true. </p>"
},
"StatementName":{
"shape":"StatementNameString",
"documentation":"<p>The name of the SQL statement specified as input to <code>ExecuteStatement</code> to identify the query. You can list multiple statements by providing a prefix that matches the beginning of the statement name. For example, to list myStatement1, myStatement2, myStatement3, and so on, then provide the a value of <code>myStatement</code>. Data API does a case-sensitive match of SQL statement names to the prefix value you provide. </p>"
@ -694,9 +723,13 @@
"shape":"Location",
"documentation":"<p>The cluster identifier. This parameter is required when authenticating using either AWS Secrets Manager or temporary credentials. </p>"
},
"ConnectedDatabase":{
"shape":"String",
"documentation":"<p>A database name. The connected database is specified when you connect with your authentication credentials. </p>"
},
"Database":{
"shape":"String",
"documentation":"<p>The name of the database. This parameter is required when authenticating using temporary credentials.</p>"
"documentation":"<p>The name of the database that contains the tables to list. If <code>ConnectedDatabase</code> is not specified, this is also the database to connect to with your authentication credentials.</p>"
},
"DbUser":{
"shape":"String",
@ -739,7 +772,11 @@
},
"Location":{"type":"string"},
"Long":{"type":"long"},
"PageSize":{"type":"integer"},
"PageSize":{
"type":"integer",
"max":1000,
"min":0
},
"ResourceNotFoundException":{
"type":"structure",
"required":[
@ -816,13 +853,13 @@
"StatusString":{
"type":"string",
"enum":[
"ABORTED",
"ALL",
"FAILED",
"FINISHED",
"SUBMITTED",
"PICKED",
"STARTED",
"SUBMITTED"
"FINISHED",
"ABORTED",
"FAILED",
"ALL"
]
},
"String":{"type":"string"},
@ -863,5 +900,5 @@
},
"bool":{"type":"boolean"}
},
"documentation":"<p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run individual SQL statements, which are committed if the statement succeeds. </p>"
"documentation":"<p>You can use the Amazon Redshift Data API to run queries on Amazon Redshift tables. You can run individual SQL statements, which are committed if the statement succeeds. </p> <p>For more information about the Amazon Redshift Data API, see <a href=\"https://docs.aws.amazon.com/redshift/latest/mgmt/data-api.html\">Using the Amazon Redshift Data API</a> in the <i>Amazon Redshift Cluster Management Guide</i>. </p>"
}

49
botocore/data/redshift/2012-12-01/service-2.json
View file

@ -2231,6 +2231,10 @@
"ClusterNamespaceArn":{
"shape":"String",
"documentation":"<p>The namespace Amazon Resource Name (ARN) of the cluster.</p>"
},
"TotalStorageCapacityInMegaBytes":{
"shape":"LongOptional",
"documentation":"<p>The total storage capacity of the cluster in megabytes. </p>"
}
},
"documentation":"<p>Describes a cluster.</p>",
@ -2982,7 +2986,7 @@
},
"AutomatedSnapshotRetentionPeriod":{
"shape":"IntegerOptional",
"documentation":"<p>The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. </p> <p>Default: <code>1</code> </p> <p>Constraints: Must be a value from 0 to 35.</p>"
"documentation":"<p>The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. </p> <p>You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.</p> <p>Default: <code>1</code> </p> <p>Constraints: Must be a value from 0 to 35.</p>"
},
"ManualSnapshotRetentionPeriod":{
"shape":"IntegerOptional",
@ -5653,7 +5657,7 @@
},
"AutomatedSnapshotRetentionPeriod":{
"shape":"IntegerOptional",
"documentation":"<p>The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. </p> <p>If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.</p> <p>Default: Uses existing setting.</p> <p>Constraints: Must be a value from 0 to 35.</p>"
"documentation":"<p>The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. </p> <p>If you decrease the automated snapshot retention period from its current value, existing automated snapshots that fall outside of the new retention period will be immediately deleted.</p> <p>You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.</p> <p>Default: Uses existing setting.</p> <p>Constraints: Must be a value from 0 to 35.</p>"
},
"ManualSnapshotRetentionPeriod":{
"shape":"IntegerOptional",
@ -5958,6 +5962,35 @@
}
}
},
"NetworkInterface":{
"type":"structure",
"members":{
"NetworkInterfaceId":{
"shape":"String",
"documentation":"<p>The network interface identifier. </p>"
},
"SubnetId":{
"shape":"String",
"documentation":"<p>The subnet identifier. </p>"
},
"PrivateIpAddress":{
"shape":"String",
"documentation":"<p>The IPv4 address of the network interface within the subnet. </p>"
},
"AvailabilityZone":{
"shape":"String",
"documentation":"<p>The Availability Zone. </p>"
}
},
"documentation":"<p>Describes a network interface. </p>"
},
"NetworkInterfaceList":{
"type":"list",
"member":{
"shape":"NetworkInterface",
"locationName":"NetworkInterface"
}
},
"NodeConfigurationOption":{
"type":"structure",
"members":{
@ -6124,7 +6157,7 @@
},
"ParameterValue":{
"shape":"String",
"documentation":"<p>The value of the parameter.</p>"
"documentation":"<p>The value of the parameter. If <code>ParameterName</code> is <code>wlm_json_configuration</code>, then the maximum size of <code>ParameterValue</code> is 8000 characters.</p>"
},
"Description":{
"shape":"String",
@ -6760,7 +6793,7 @@
},
"AutomatedSnapshotRetentionPeriod":{
"shape":"IntegerOptional",
"documentation":"<p>The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. </p> <p>Default: The value selected for the cluster from which the snapshot was taken.</p> <p>Constraints: Must be a value from 0 to 35.</p>"
"documentation":"<p>The number of days that automated snapshots are retained. If the value is 0, automated snapshots are disabled. Even if automated snapshots are disabled, you can still create manual snapshots when you want with <a>CreateClusterSnapshot</a>. </p> <p>You can't disable automated snapshots for RA3 node types. Set the automated retention period from 1-35 days.</p> <p>Default: The value selected for the cluster from which the snapshot was taken.</p> <p>Constraints: Must be a value from 0 to 35.</p>"
},
"ManualSnapshotRetentionPeriod":{
"shape":"IntegerOptional",
@ -8280,6 +8313,14 @@
"VpcEndpointId":{
"shape":"String",
"documentation":"<p>The connection endpoint ID for connecting an Amazon Redshift cluster through the proxy.</p>"
},
"VpcId":{
"shape":"String",
"documentation":"<p>The VPC identifier that the endpoint is associated. </p>"
},
"NetworkInterfaces":{
"shape":"NetworkInterfaceList",
"documentation":"<p>One or more network interfaces of the endpoint. Also known as an interface endpoint. </p>"
}
},
"documentation":"<p>The connection endpoint for connecting an Amazon Redshift cluster through the proxy.</p>"

721
botocore/data/s3/2006-03-01/service-2.json
View file

File diff suppressed because one or more lines are too long

9
botocore/data/s3control/2018-08-20/paginators-1.json
View file

@ -1,3 +1,10 @@
{
"pagination": {}
"pagination": {
"ListAccessPointsForObjectLambda": {
"input_token": "NextToken",
"output_token": "NextToken",
"limit_key": "MaxResults",
"result_key": "ObjectLambdaAccessPointList"
}
}
}

677
botocore/data/s3control/2018-08-20/service-2.json
View file

@ -23,7 +23,24 @@
"xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"}
},
"output":{"shape":"CreateAccessPointResult"},
"documentation":"<p>Creates an access point and associates it with the specified bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html\">Managing Data Access with Amazon S3 Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p/> <p> <b>Using this action with Amazon S3 on Outposts</b> </p> <p>This action: </p> <ul> <li> <p>Requires a virtual private cloud (VPC) configuration as S3 on Outposts only supports VPC style access points.</p> </li> <li> <p>Does not support ACL on S3 on Outposts buckets.</p> </li> <li> <p>Does not support Public Access on S3 on Outposts buckets.</p> </li> <li> <p>Does not support object lock for S3 on Outposts buckets.</p> </li> </ul> <p>For more information, see <a href=\"AmazonS3/latest/dev/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon Simple Storage Service Developer Guide </i>.</p> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html#API_control_CreateAccessPoint_Examples\">Examples</a> section.</p> <p/> <p>The following actions are related to <code>CreateAccessPoint</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html\">GetAccessPoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html\">DeleteAccessPoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html\">ListAccessPoints</a> </p> </li> </ul>",
"documentation":"<p>Creates an access point and associates it with the specified bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html\">Managing Data Access with Amazon S3 Access Points</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <p/> <note> <p>S3 on Outposts only supports VPC-style Access Points. </p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\"> Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only Access Points</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> </note> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html#API_control_CreateAccessPoint_Examples\">Examples</a> section.</p> <p/> <p>The following actions are related to <code>CreateAccessPoint</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPoint.html\">GetAccessPoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPoint.html\">DeleteAccessPoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPoints.html\">ListAccessPoints</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
},
"CreateAccessPointForObjectLambda":{
"name":"CreateAccessPointForObjectLambda",
"http":{
"method":"PUT",
"requestUri":"/v20180820/accesspointforobjectlambda/{name}"
},
"input":{
"shape":"CreateAccessPointForObjectLambdaRequest",
"locationName":"CreateAccessPointForObjectLambdaRequest",
"xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"}
},
"output":{"shape":"CreateAccessPointForObjectLambdaResult"},
"documentation":"<p>Creates an Object Lambda Access Point. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html\">Transforming objects with Object Lambda Access Points</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <p>The following actions are related to <code>CreateAccessPointForObjectLambda</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html\">DeleteAccessPointForObjectLambda</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html\">GetAccessPointForObjectLambda</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html\">ListAccessPointsForObjectLambda</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -40,7 +57,7 @@
{"shape":"BucketAlreadyExists"},
{"shape":"BucketAlreadyOwnedByYou"}
],
"documentation":"<note> <p>This API operation creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html\">Create Bucket</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>Not every string is an acceptable bucket name. For information on bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/BucketRestrictions.html#bucketnamingrules\">Working with Amazon S3 Buckets</a>.</p> <p>S3 on Outposts buckets do not support </p> <ul> <li> <p>ACLs. Instead, configure access point policies to manage access to buckets.</p> </li> <li> <p>Public access. </p> </li> <li> <p>Object Lock</p> </li> <li> <p>Bucket Location constraint</p> </li> </ul> <p>For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and <code>x-amz-outpost-id</code> in your API request, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html#API_control_CreateBucket_Examples\">Examples</a> section.</p> <p>The following actions are related to <code>CreateBucket</code> for Amazon S3 on Outposts:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html\">PutObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html\">GetBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html\">DeleteBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html\">CreateAccessPoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html\">PutAccessPointPolicy</a> </p> </li> </ul>",
"documentation":"<note> <p>This action creates an Amazon S3 on Outposts bucket. To create an S3 bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html\">Create Bucket</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Creates a new Outposts bucket. By creating the bucket, you become the bucket owner. To create an Outposts bucket, you must have S3 on Outposts. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in <i>Amazon Simple Storage Service User Guide</i>.</p> <p>Not every string is an acceptable bucket name. For information on bucket naming restrictions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/BucketRestrictions.html#bucketnamingrules\">Working with Amazon S3 Buckets</a>.</p> <p>S3 on Outposts buckets support:</p> <ul> <li> <p>Tags</p> </li> <li> <p>LifecycleConfigurations for deleting expired objects</p> </li> </ul> <p>For a complete list of restrictions and Amazon S3 feature limitations on S3 on Outposts, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3OnOutpostsRestrictionsLimitations.html\"> Amazon S3 on Outposts Restrictions and Limitations</a>.</p> <p>For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and <code>x-amz-outpost-id</code> in your API request, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html#API_control_CreateBucket_Examples\">Examples</a> section.</p> <p>The following actions are related to <code>CreateBucket</code> for Amazon S3 on Outposts:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html\">PutObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html\">GetBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html\">DeleteBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPoint.html\">CreateAccessPoint</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicy.html\">PutAccessPointPolicy</a> </p> </li> </ul>",
"httpChecksumRequired":true
},
"CreateJob":{
@ -61,7 +78,7 @@
{"shape":"IdempotencyException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>You can use S3 Batch Operations to perform large-scale batch operations on Amazon S3 objects. Batch Operations can run a single operation on lists of Amazon S3 objects that you specify. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html\">S3 Batch Operations</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>This operation creates a S3 Batch Operations job.</p> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html\">DescribeJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html\">ListJobs</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html\">UpdateJobPriority</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html\">UpdateJobStatus</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_JobOperation.html\">JobOperation</a> </p> </li> </ul>",
"documentation":"<p>You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html\">S3 Batch Operations</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <p>This action creates a S3 Batch Operations job.</p> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html\">DescribeJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html\">ListJobs</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html\">UpdateJobPriority</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html\">UpdateJobStatus</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_JobOperation.html\">JobOperation</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -78,6 +95,18 @@
"hostPrefix":"{AccountId}."
}
},
"DeleteAccessPointForObjectLambda":{
"name":"DeleteAccessPointForObjectLambda",
"http":{
"method":"DELETE",
"requestUri":"/v20180820/accesspointforobjectlambda/{name}"
},
"input":{"shape":"DeleteAccessPointForObjectLambdaRequest"},
"documentation":"<p>Deletes the specified Object Lambda Access Point.</p> <p>The following actions are related to <code>DeleteAccessPointForObjectLambda</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html\">CreateAccessPointForObjectLambda</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html\">GetAccessPointForObjectLambda</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html\">ListAccessPointsForObjectLambda</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
},
"DeleteAccessPointPolicy":{
"name":"DeleteAccessPointPolicy",
"http":{
@ -90,6 +119,18 @@
"hostPrefix":"{AccountId}."
}
},
"DeleteAccessPointPolicyForObjectLambda":{
"name":"DeleteAccessPointPolicyForObjectLambda",
"http":{
"method":"DELETE",
"requestUri":"/v20180820/accesspointforobjectlambda/{name}/policy"
},
"input":{"shape":"DeleteAccessPointPolicyForObjectLambdaRequest"},
"documentation":"<p>Removes the resource policy for an Object Lambda Access Point.</p> <p>The following actions are related to <code>DeleteAccessPointPolicyForObjectLambda</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html\">GetAccessPointPolicyForObjectLambda</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html\">PutAccessPointPolicyForObjectLambda</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
},
"DeleteBucket":{
"name":"DeleteBucket",
"http":{
@ -97,7 +138,7 @@
"requestUri":"/v20180820/bucket/{name}"
},
"input":{"shape":"DeleteBucketRequest"},
"documentation":"<note> <p>This API operation deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html\">DeleteBucket</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html#API_control_DeleteBucket_Examples\">Examples</a> section.</p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html\">CreateBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html\">GetBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html\">DeleteObject</a> </p> </li> </ul>",
"documentation":"<note> <p>This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html\">DeleteBucket</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in <i>Amazon Simple Storage Service User Guide</i>.</p> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html#API_control_DeleteBucket_Examples\">Examples</a> section.</p> <p class=\"title\"> <b>Related Resources</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html\">CreateBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html\">GetBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html\">DeleteObject</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -109,7 +150,7 @@
"requestUri":"/v20180820/bucket/{name}/lifecycleconfiguration"
},
"input":{"shape":"DeleteBucketLifecycleConfigurationRequest"},
"documentation":"<note> <p>This API action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html\">DeleteBucketLifecycle</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>To use this operation, you must have permission to perform the <code>s3-outposts:DeleteLifecycleConfiguration</code> action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others.</p> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html#API_control_DeleteBucketLifecycleConfiguration_Examples\">Examples</a> section.</p> <p>For more information about object expiration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions\">Elements to Describe Lifecycle Actions</a>.</p> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html\">PutBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html\">GetBucketLifecycleConfiguration</a> </p> </li> </ul>",
"documentation":"<note> <p>This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html\">DeleteBucketLifecycle</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in <i>Amazon Simple Storage Service User Guide</i>.</p> <p>To use this action, you must have permission to perform the <code>s3-outposts:DeleteLifecycleConfiguration</code> action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others.</p> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html#API_control_DeleteBucketLifecycleConfiguration_Examples\">Examples</a> section.</p> <p>For more information about object expiration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions\">Elements to Describe Lifecycle Actions</a>.</p> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html\">PutBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html\">GetBucketLifecycleConfiguration</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -121,7 +162,7 @@
"requestUri":"/v20180820/bucket/{name}/policy"
},
"input":{"shape":"DeleteBucketPolicyRequest"},
"documentation":"<note> <p>This API operation deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketPolicy.html\">DeleteBucketPolicy</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the <code>s3-outposts:DeleteBucketPolicy</code> permissions on the specified Outposts bucket and belong to the bucket owner's account to use this operation. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>If you don't have <code>DeleteBucketPolicy</code> permissions, Amazon S3 returns a <code>403 Access Denied</code> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code> error. </p> <important> <p>As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.</p> </important> <p>For more information about bucket policies, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html\">Using Bucket Policies and User Policies</a>. </p> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html#API_control_DeleteBucketPolicy_Examples\">Examples</a> section.</p> <p>The following actions are related to <code>DeleteBucketPolicy</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html\">GetBucketPolicy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html\">PutBucketPolicy</a> </p> </li> </ul>",
"documentation":"<note> <p>This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketPolicy.html\">DeleteBucketPolicy</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>This implementation of the DELETE action uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the <code>s3-outposts:DeleteBucketPolicy</code> permissions on the specified Outposts bucket and belong to the bucket owner's account to use this action. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in <i>Amazon Simple Storage Service User Guide</i>.</p> <p>If you don't have <code>DeleteBucketPolicy</code> permissions, Amazon S3 returns a <code>403 Access Denied</code> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code> error. </p> <important> <p>As a security precaution, the root user of the AWS account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.</p> </important> <p>For more information about bucket policies, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html\">Using Bucket Policies and User Policies</a>. </p> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html#API_control_DeleteBucketPolicy_Examples\">Examples</a> section.</p> <p>The following actions are related to <code>DeleteBucketPolicy</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html\">GetBucketPolicy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html\">PutBucketPolicy</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -134,7 +175,7 @@
"responseCode":204
},
"input":{"shape":"DeleteBucketTaggingRequest"},
"documentation":"<note> <p>This operation deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html\">DeleteBucketTagging</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Deletes the tags from the Outposts bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>To use this operation, you must have permission to perform the <code>PutBucketTagging</code> action. By default, the bucket owner has this permission and can grant this permission to others. </p> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html#API_control_DeleteBucketTagging_Examples\">Examples</a> section.</p> <p>The following actions are related to <code>DeleteBucketTagging</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html\">GetBucketTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html\">PutBucketTagging</a> </p> </li> </ul>",
"documentation":"<note> <p>This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html\">DeleteBucketTagging</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Deletes the tags from the Outposts bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in <i>Amazon Simple Storage Service User Guide</i>.</p> <p>To use this action, you must have permission to perform the <code>PutBucketTagging</code> action. By default, the bucket owner has this permission and can grant this permission to others. </p> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html#API_control_DeleteBucketTagging_Examples\">Examples</a> section.</p> <p>The following actions are related to <code>DeleteBucketTagging</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html\">GetBucketTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html\">PutBucketTagging</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -152,7 +193,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"NotFoundException"}
],
"documentation":"<p>Removes the entire tag set from the specified S3 Batch Operations job. To use this operation, you must have permission to perform the <code>s3:DeleteJobTagging</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags\">Controlling access and labeling jobs using tags</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html\">CreateJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html\">GetJobTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html\">PutJobTagging</a> </p> </li> </ul>",
"documentation":"<p>Removes the entire tag set from the specified S3 Batch Operations job. To use this operation, you must have permission to perform the <code>s3:DeleteJobTagging</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags\">Controlling access and labeling jobs using tags</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html\">CreateJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html\">GetJobTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html\">PutJobTagging</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -176,7 +217,7 @@
"requestUri":"/v20180820/storagelens/{storagelensid}"
},
"input":{"shape":"DeleteStorageLensConfigurationRequest"},
"documentation":"<p>Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html\">Assessing your storage activity and usage with Amazon S3 Storage Lens </a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <note> <p>To use this action, you must have permission to perform the <code>s3:DeleteStorageLensConfiguration</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html\">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> </note>",
"documentation":"<p>Deletes the Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html\">Assessing your storage activity and usage with Amazon S3 Storage Lens </a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <note> <p>To use this action, you must have permission to perform the <code>s3:DeleteStorageLensConfiguration</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html\">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> </note>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -189,7 +230,7 @@
},
"input":{"shape":"DeleteStorageLensConfigurationTaggingRequest"},
"output":{"shape":"DeleteStorageLensConfigurationTaggingResult"},
"documentation":"<p>Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html\">Assessing your storage activity and usage with Amazon S3 Storage Lens </a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <note> <p>To use this action, you must have permission to perform the <code>s3:DeleteStorageLensConfigurationTagging</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html\">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> </note>",
"documentation":"<p>Deletes the Amazon S3 Storage Lens configuration tags. For more information about S3 Storage Lens, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html\">Assessing your storage activity and usage with Amazon S3 Storage Lens </a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <note> <p>To use this action, you must have permission to perform the <code>s3:DeleteStorageLensConfigurationTagging</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html\">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> </note>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -208,7 +249,7 @@
{"shape":"NotFoundException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Retrieves the configuration parameters and status for a Batch Operations job. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html\">S3 Batch Operations</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html\">CreateJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html\">ListJobs</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html\">UpdateJobPriority</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html\">UpdateJobStatus</a> </p> </li> </ul>",
"documentation":"<p>Retrieves the configuration parameters and status for a Batch Operations job. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html\">S3 Batch Operations</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html\">CreateJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html\">ListJobs</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html\">UpdateJobPriority</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html\">UpdateJobStatus</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -226,6 +267,32 @@
"hostPrefix":"{AccountId}."
}
},
"GetAccessPointConfigurationForObjectLambda":{
"name":"GetAccessPointConfigurationForObjectLambda",
"http":{
"method":"GET",
"requestUri":"/v20180820/accesspointforobjectlambda/{name}/configuration"
},
"input":{"shape":"GetAccessPointConfigurationForObjectLambdaRequest"},
"output":{"shape":"GetAccessPointConfigurationForObjectLambdaResult"},
"documentation":"<p>Returns configuration for an Object Lambda Access Point.</p> <p>The following actions are related to <code>GetAccessPointConfigurationForObjectLambda</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointConfigurationForObjectLambda.html\">PutAccessPointConfigurationForObjectLambda</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
},
"GetAccessPointForObjectLambda":{
"name":"GetAccessPointForObjectLambda",
"http":{
"method":"GET",
"requestUri":"/v20180820/accesspointforobjectlambda/{name}"
},
"input":{"shape":"GetAccessPointForObjectLambdaRequest"},
"output":{"shape":"GetAccessPointForObjectLambdaResult"},
"documentation":"<p>Returns configuration information about the specified Object Lambda Access Point</p> <p>The following actions are related to <code>GetAccessPointForObjectLambda</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html\">CreateAccessPointForObjectLambda</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html\">DeleteAccessPointForObjectLambda</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListAccessPointsForObjectLambda.html\">ListAccessPointsForObjectLambda</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
},
"GetAccessPointPolicy":{
"name":"GetAccessPointPolicy",
"http":{
@ -239,6 +306,19 @@
"hostPrefix":"{AccountId}."
}
},
"GetAccessPointPolicyForObjectLambda":{
"name":"GetAccessPointPolicyForObjectLambda",
"http":{
"method":"GET",
"requestUri":"/v20180820/accesspointforobjectlambda/{name}/policy"
},
"input":{"shape":"GetAccessPointPolicyForObjectLambdaRequest"},
"output":{"shape":"GetAccessPointPolicyForObjectLambdaResult"},
"documentation":"<p>Returns the resource policy for an Object Lambda Access Point.</p> <p>The following actions are related to <code>GetAccessPointPolicyForObjectLambda</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.html\">DeleteAccessPointPolicyForObjectLambda</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutAccessPointPolicyForObjectLambda.html\">PutAccessPointPolicyForObjectLambda</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
},
"GetAccessPointPolicyStatus":{
"name":"GetAccessPointPolicyStatus",
"http":{
@ -247,7 +327,20 @@
},
"input":{"shape":"GetAccessPointPolicyStatusRequest"},
"output":{"shape":"GetAccessPointPolicyStatusResult"},
"documentation":"<p>Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html\">Managing Data Access with Amazon S3 Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"documentation":"<p>Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html\">Managing Data Access with Amazon S3 Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
},
"GetAccessPointPolicyStatusForObjectLambda":{
"name":"GetAccessPointPolicyStatusForObjectLambda",
"http":{
"method":"GET",
"requestUri":"/v20180820/accesspointforobjectlambda/{name}/policyStatus"
},
"input":{"shape":"GetAccessPointPolicyStatusForObjectLambdaRequest"},
"output":{"shape":"GetAccessPointPolicyStatusForObjectLambdaResult"},
"documentation":"<p>Returns the status of the resource policy associated with an Object Lambda Access Point.</p>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -260,7 +353,7 @@
},
"input":{"shape":"GetBucketRequest"},
"output":{"shape":"GetBucketResult"},
"documentation":"<p>Gets an Amazon S3 on Outposts bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html\"> Using Amazon S3 on Outposts</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the <code>s3-outposts:GetBucket</code> permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. </p> <p> If you don't have <code>s3-outposts:GetBucket</code> permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>403 Access Denied</code> error.</p> <p>The following actions are related to <code>GetBucket</code> for Amazon S3 on Outposts:</p> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html#API_control_GetBucket_Examples\">Examples</a> section.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html\">PutObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html\">CreateBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html\">DeleteBucket</a> </p> </li> </ul>",
"documentation":"<p>Gets an Amazon S3 on Outposts bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\"> Using Amazon S3 on Outposts</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <p>If you are using an identity other than the root user of the AWS account that owns the Outposts bucket, the calling identity must have the <code>s3-outposts:GetBucket</code> permissions on the specified Outposts bucket and belong to the Outposts bucket owner's account in order to use this action. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. </p> <p> If you don't have <code>s3-outposts:GetBucket</code> permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>403 Access Denied</code> error.</p> <p>The following actions are related to <code>GetBucket</code> for Amazon S3 on Outposts:</p> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucket.html#API_control_GetBucket_Examples\">Examples</a> section.</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html\">PutObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html\">CreateBucket</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucket.html\">DeleteBucket</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -273,7 +366,7 @@
},
"input":{"shape":"GetBucketLifecycleConfigurationRequest"},
"output":{"shape":"GetBucketLifecycleConfigurationResult"},
"documentation":"<note> <p>This operation gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html\">GetBucketLifecycleConfiguration</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Returns the lifecycle configuration information set on the Outposts bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html\">Using Amazon S3 on Outposts</a> and for information about lifecycle configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html\"> Object Lifecycle Management</a> in <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>To use this operation, you must have permission to perform the <code>s3-outposts:GetLifecycleConfiguration</code> action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html#API_control_GetBucketLifecycleConfiguration_Examples\">Examples</a> section.</p> <p> <code>GetBucketLifecycleConfiguration</code> has the following special error:</p> <ul> <li> <p>Error code: <code>NoSuchLifecycleConfiguration</code> </p> <ul> <li> <p>Description: The lifecycle configuration does not exist.</p> </li> <li> <p>HTTP Status Code: 404 Not Found</p> </li> <li> <p>SOAP Fault Code Prefix: Client</p> </li> </ul> </li> </ul> <p>The following actions are related to <code>GetBucketLifecycleConfiguration</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html\">PutBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html\">DeleteBucketLifecycleConfiguration</a> </p> </li> </ul>",
"documentation":"<note> <p>This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html\">GetBucketLifecycleConfiguration</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Returns the lifecycle configuration information set on the Outposts bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> and for information about lifecycle configuration, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html\"> Object Lifecycle Management</a> in <i>Amazon Simple Storage Service User Guide</i>.</p> <p>To use this action, you must have permission to perform the <code>s3-outposts:GetLifecycleConfiguration</code> action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\">Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html#API_control_GetBucketLifecycleConfiguration_Examples\">Examples</a> section.</p> <p> <code>GetBucketLifecycleConfiguration</code> has the following special error:</p> <ul> <li> <p>Error code: <code>NoSuchLifecycleConfiguration</code> </p> <ul> <li> <p>Description: The lifecycle configuration does not exist.</p> </li> <li> <p>HTTP Status Code: 404 Not Found</p> </li> <li> <p>SOAP Fault Code Prefix: Client</p> </li> </ul> </li> </ul> <p>The following actions are related to <code>GetBucketLifecycleConfiguration</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html\">PutBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html\">DeleteBucketLifecycleConfiguration</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -286,7 +379,7 @@
},
"input":{"shape":"GetBucketPolicyRequest"},
"output":{"shape":"GetBucketPolicyResult"},
"documentation":"<note> <p>This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicy.html\">GetBucketPolicy</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Returns the policy of a specified Outposts bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the <code>GetBucketPolicy</code> permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.</p> <p>Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have <code>s3-outposts:GetBucketPolicy</code> permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>403 Access Denied</code> error.</p> <important> <p>As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.</p> </important> <p>For more information about bucket policies, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html\">Using Bucket Policies and User Policies</a>.</p> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html#API_control_GetBucketPolicy_Examples\">Examples</a> section.</p> <p>The following actions are related to <code>GetBucketPolicy</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html\">PutBucketPolicy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html\">DeleteBucketPolicy</a> </p> </li> </ul>",
"documentation":"<note> <p>This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicy.html\">GetBucketPolicy</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Returns the policy of a specified Outposts bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <p>If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the <code>GetBucketPolicy</code> permissions on the specified bucket and belong to the bucket owner's account in order to use this action.</p> <p>Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have <code>s3-outposts:GetBucketPolicy</code> permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>403 Access Denied</code> error.</p> <important> <p>As a security precaution, the root user of the AWS account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.</p> </important> <p>For more information about bucket policies, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html\">Using Bucket Policies and User Policies</a>.</p> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html#API_control_GetBucketPolicy_Examples\">Examples</a> section.</p> <p>The following actions are related to <code>GetBucketPolicy</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html\">GetObject</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html\">PutBucketPolicy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html\">DeleteBucketPolicy</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -299,7 +392,7 @@
},
"input":{"shape":"GetBucketTaggingRequest"},
"output":{"shape":"GetBucketTaggingResult"},
"documentation":"<note> <p>This operation gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html\">GetBucketTagging</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Returns the tag set associated with the Outposts bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>To use this operation, you must have permission to perform the <code>GetBucketTagging</code> action. By default, the bucket owner has this permission and can grant this permission to others.</p> <p> <code>GetBucketTagging</code> has the following special error:</p> <ul> <li> <p>Error code: <code>NoSuchTagSetError</code> </p> <ul> <li> <p>Description: There is no tag set associated with the bucket.</p> </li> </ul> </li> </ul> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html#API_control_GetBucketTagging_Examples\">Examples</a> section.</p> <p>The following actions are related to <code>GetBucketTagging</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html\">PutBucketTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html\">DeleteBucketTagging</a> </p> </li> </ul>",
"documentation":"<note> <p>This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html\">GetBucketTagging</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Returns the tag set associated with the Outposts bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <p>To use this action, you must have permission to perform the <code>GetBucketTagging</code> action. By default, the bucket owner has this permission and can grant this permission to others.</p> <p> <code>GetBucketTagging</code> has the following special error:</p> <ul> <li> <p>Error code: <code>NoSuchTagSetError</code> </p> <ul> <li> <p>Description: There is no tag set associated with the bucket.</p> </li> </ul> </li> </ul> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html#API_control_GetBucketTagging_Examples\">Examples</a> section.</p> <p>The following actions are related to <code>GetBucketTagging</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html\">PutBucketTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html\">DeleteBucketTagging</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -317,7 +410,7 @@
{"shape":"TooManyRequestsException"},
{"shape":"NotFoundException"}
],
"documentation":"<p>Returns the tags on an S3 Batch Operations job. To use this operation, you must have permission to perform the <code>s3:GetJobTagging</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags\">Controlling access and labeling jobs using tags</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html\">CreateJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html\">PutJobTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html\">DeleteJobTagging</a> </p> </li> </ul>",
"documentation":"<p>Returns the tags on an S3 Batch Operations job. To use this operation, you must have permission to perform the <code>s3:GetJobTagging</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags\">Controlling access and labeling jobs using tags</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html\">CreateJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutJobTagging.html\">PutJobTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html\">DeleteJobTagging</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -346,7 +439,7 @@
},
"input":{"shape":"GetStorageLensConfigurationRequest"},
"output":{"shape":"GetStorageLensConfigurationResult"},
"documentation":"<p>Gets the Amazon S3 Storage Lens configuration. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html\">Assessing your storage activity and usage with Amazon S3 Storage Lens </a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <note> <p>To use this action, you must have permission to perform the <code>s3:GetStorageLensConfiguration</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html\">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> </note>",
"documentation":"<p>Gets the Amazon S3 Storage Lens configuration. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html\">Assessing your storage activity and usage with Amazon S3 Storage Lens </a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <note> <p>To use this action, you must have permission to perform the <code>s3:GetStorageLensConfiguration</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html\">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> </note>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -359,7 +452,7 @@
},
"input":{"shape":"GetStorageLensConfigurationTaggingRequest"},
"output":{"shape":"GetStorageLensConfigurationTaggingResult"},
"documentation":"<p>Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html\">Assessing your storage activity and usage with Amazon S3 Storage Lens </a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <note> <p>To use this action, you must have permission to perform the <code>s3:GetStorageLensConfigurationTagging</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html\">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> </note>",
"documentation":"<p>Gets the tags of Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html\">Assessing your storage activity and usage with Amazon S3 Storage Lens </a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <note> <p>To use this action, you must have permission to perform the <code>s3:GetStorageLensConfigurationTagging</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html\">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> </note>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -377,6 +470,19 @@
"hostPrefix":"{AccountId}."
}
},
"ListAccessPointsForObjectLambda":{
"name":"ListAccessPointsForObjectLambda",
"http":{
"method":"GET",
"requestUri":"/v20180820/accesspointforobjectlambda"
},
"input":{"shape":"ListAccessPointsForObjectLambdaRequest"},
"output":{"shape":"ListAccessPointsForObjectLambdaResult"},
"documentation":"<p>Returns a list of the access points associated with the Object Lambda Access Point. You can retrieve up to 1000 access points per call. If there are more than 1,000 access points (or the number specified in <code>maxResults</code>, whichever is less), the response will include a continuation token that you can use to list the additional access points.</p> <p>The following actions are related to <code>ListAccessPointsForObjectLambda</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateAccessPointForObjectLambda.html\">CreateAccessPointForObjectLambda</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointForObjectLambda.html\">DeleteAccessPointForObjectLambda</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointForObjectLambda.html\">GetAccessPointForObjectLambda</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
},
"ListJobs":{
"name":"ListJobs",
"http":{
@ -390,7 +496,7 @@
{"shape":"InternalServiceException"},
{"shape":"InvalidNextTokenException"}
],
"documentation":"<p>Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html\">S3 Batch Operations</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>Related actions include:</p> <p/> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html\">CreateJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html\">DescribeJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html\">UpdateJobPriority</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html\">UpdateJobStatus</a> </p> </li> </ul>",
"documentation":"<p>Lists current S3 Batch Operations jobs and jobs that have ended within the last 30 days for the AWS account making the request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html\">S3 Batch Operations</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <p>Related actions include:</p> <p/> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html\">CreateJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html\">DescribeJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobPriority.html\">UpdateJobPriority</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html\">UpdateJobStatus</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -403,7 +509,7 @@
},
"input":{"shape":"ListRegionalBucketsRequest"},
"output":{"shape":"ListRegionalBucketsResult"},
"documentation":"<p>Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and <code>x-amz-outpost-id</code> in your request, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListRegionalBuckets.html#API_control_ListRegionalBuckets_Examples\">Examples</a> section.</p>",
"documentation":"<p>Returns a list of all Outposts buckets in an Outpost that are owned by the authenticated sender of the request. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <p>For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and <code>x-amz-outpost-id</code> in your request, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListRegionalBuckets.html#API_control_ListRegionalBuckets_Examples\">Examples</a> section.</p>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -416,7 +522,23 @@
},
"input":{"shape":"ListStorageLensConfigurationsRequest"},
"output":{"shape":"ListStorageLensConfigurationsResult"},
"documentation":"<p>Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html\">Assessing your storage activity and usage with Amazon S3 Storage Lens </a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <note> <p>To use this action, you must have permission to perform the <code>s3:ListStorageLensConfigurations</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html\">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> </note>",
"documentation":"<p>Gets a list of Amazon S3 Storage Lens configurations. For more information about S3 Storage Lens, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html\">Assessing your storage activity and usage with Amazon S3 Storage Lens </a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <note> <p>To use this action, you must have permission to perform the <code>s3:ListStorageLensConfigurations</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html\">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> </note>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
},
"PutAccessPointConfigurationForObjectLambda":{
"name":"PutAccessPointConfigurationForObjectLambda",
"http":{
"method":"PUT",
"requestUri":"/v20180820/accesspointforobjectlambda/{name}/configuration"
},
"input":{
"shape":"PutAccessPointConfigurationForObjectLambdaRequest",
"locationName":"PutAccessPointConfigurationForObjectLambdaRequest",
"xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"}
},
"documentation":"<p>Replaces configuration for an Object Lambda Access Point.</p> <p>The following actions are related to <code>PutAccessPointConfigurationForObjectLambda</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointConfigurationForObjectLambda.html\">GetAccessPointConfigurationForObjectLambda</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -437,6 +559,22 @@
"hostPrefix":"{AccountId}."
}
},
"PutAccessPointPolicyForObjectLambda":{
"name":"PutAccessPointPolicyForObjectLambda",
"http":{
"method":"PUT",
"requestUri":"/v20180820/accesspointforobjectlambda/{name}/policy"
},
"input":{
"shape":"PutAccessPointPolicyForObjectLambdaRequest",
"locationName":"PutAccessPointPolicyForObjectLambdaRequest",
"xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"}
},
"documentation":"<p>Creates or replaces resource policy for an Object Lambda Access Point. For an example policy, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-create.html#olap-create-cli\">Creating Object Lambda Access Points</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <p>The following actions are related to <code>PutAccessPointPolicyForObjectLambda</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteAccessPointPolicyForObjectLambda.html\">DeleteAccessPointPolicyForObjectLambda</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetAccessPointPolicyForObjectLambda.html\">GetAccessPointPolicyForObjectLambda</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
},
"PutBucketLifecycleConfiguration":{
"name":"PutBucketLifecycleConfiguration",
"http":{
@ -444,7 +582,7 @@
"requestUri":"/v20180820/bucket/{name}/lifecycleconfiguration"
},
"input":{"shape":"PutBucketLifecycleConfigurationRequest"},
"documentation":"<note> <p>This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html\">PutBucketLifecycleConfiguration</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Creates a new lifecycle configuration for the Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html\">Managing Lifecycle Permissions for Amazon S3 on Outposts</a>.</p> <p/> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html#API_control_PutBucketLifecycleConfiguration_Examples\">Examples</a> section.</p> <p>The following actions are related to <code>PutBucketLifecycleConfiguration</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html\">GetBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html\">DeleteBucketLifecycleConfiguration</a> </p> </li> </ul>",
"documentation":"<note> <p>This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html\">PutBucketLifecycleConfiguration</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.</p> <p/> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketLifecycleConfiguration.html#API_control_PutBucketLifecycleConfiguration_Examples\">Examples</a> section.</p> <p>The following actions are related to <code>PutBucketLifecycleConfiguration</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketLifecycleConfiguration.html\">GetBucketLifecycleConfiguration</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketLifecycleConfiguration.html\">DeleteBucketLifecycleConfiguration</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
},
@ -461,7 +599,7 @@
"locationName":"PutBucketPolicyRequest",
"xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"}
},
"documentation":"<note> <p>This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketPolicy.html\">PutBucketPolicy</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>If you are using an identity other than the root user of the AWS account that owns the Outposts bucket, the calling identity must have the <code>PutBucketPolicy</code> permissions on the specified Outposts bucket and belong to the bucket owner's account in order to use this operation.</p> <p>If you don't have <code>PutBucketPolicy</code> permissions, Amazon S3 returns a <code>403 Access Denied</code> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code> error.</p> <important> <p> As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. </p> </important> <p>For more information about bucket policies, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html\">Using Bucket Policies and User Policies</a>.</p> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html#API_control_PutBucketPolicy_Examples\">Examples</a> section.</p> <p>The following actions are related to <code>PutBucketPolicy</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html\">GetBucketPolicy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html\">DeleteBucketPolicy</a> </p> </li> </ul>",
"documentation":"<note> <p>This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketPolicy.html\">PutBucketPolicy</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <p>If you are using an identity other than the root user of the AWS account that owns the Outposts bucket, the calling identity must have the <code>PutBucketPolicy</code> permissions on the specified Outposts bucket and belong to the bucket owner's account in order to use this action.</p> <p>If you don't have <code>PutBucketPolicy</code> permissions, Amazon S3 returns a <code>403 Access Denied</code> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a <code>405 Method Not Allowed</code> error.</p> <important> <p> As a security precaution, the root user of the AWS account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action. </p> </important> <p>For more information about bucket policies, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html\">Using Bucket Policies and User Policies</a>.</p> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketPolicy.html#API_control_PutBucketPolicy_Examples\">Examples</a> section.</p> <p>The following actions are related to <code>PutBucketPolicy</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketPolicy.html\">GetBucketPolicy</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketPolicy.html\">DeleteBucketPolicy</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
},
@ -474,7 +612,7 @@
"requestUri":"/v20180820/bucket/{name}/tagging"
},
"input":{"shape":"PutBucketTaggingRequest"},
"documentation":"<note> <p>This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html\">PutBucketTagging</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Sets the tags for an Outposts bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html\">Cost Allocation and Tagging</a>.</p> <note> <p>Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html\"> Using Cost Allocation in Amazon S3 Bucket Tags</a>.</p> </note> <p>To use this operation, you must have permissions to perform the <code>s3-outposts:PutBucketTagging</code> action. The Outposts bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\"> Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-access-control.html\">Managing Access Permissions to Your Amazon S3 Resources</a>.</p> <p> <code>PutBucketTagging</code> has the following special errors:</p> <ul> <li> <p>Error code: <code>InvalidTagError</code> </p> <ul> <li> <p>Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html\"> User-Defined Tag Restrictions</a> and <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html\"> AWS-Generated Cost Allocation Tag Restrictions</a>.</p> </li> </ul> </li> <li> <p>Error code: <code>MalformedXMLError</code> </p> <ul> <li> <p>Description: The XML provided does not match the schema.</p> </li> </ul> </li> <li> <p>Error code: <code>OperationAbortedError </code> </p> <ul> <li> <p>Description: A conflicting conditional operation is currently in progress against this resource. Try again.</p> </li> </ul> </li> <li> <p>Error code: <code>InternalError</code> </p> <ul> <li> <p>Description: The service was unable to apply the provided tag to the bucket.</p> </li> </ul> </li> </ul> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html#API_control_PutBucketTagging_Examples\">Examples</a> section.</p> <p>The following actions are related to <code>PutBucketTagging</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html\">GetBucketTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html\">DeleteBucketTagging</a> </p> </li> </ul>",
"documentation":"<note> <p>This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html\">PutBucketTagging</a> in the <i>Amazon Simple Storage Service API</i>. </p> </note> <p>Sets the tags for an S3 on Outposts bucket. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html\">Using Amazon S3 on Outposts</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <p>Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html\">Cost allocation and tagging</a>.</p> <note> <p>Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/CostAllocTagging.html\"> Using cost allocation in Amazon S3 bucket tags</a>.</p> </note> <p>To use this action, you must have permissions to perform the <code>s3-outposts:PutBucketTagging</code> action. The Outposts bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources\"> Permissions Related to Bucket Subresource Operations</a> and <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html\">Managing access permissions to your Amazon S3 resources</a>.</p> <p> <code>PutBucketTagging</code> has the following special errors:</p> <ul> <li> <p>Error code: <code>InvalidTagError</code> </p> <ul> <li> <p>Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html\"> User-Defined Tag Restrictions</a> and <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html\"> AWS-Generated Cost Allocation Tag Restrictions</a>.</p> </li> </ul> </li> <li> <p>Error code: <code>MalformedXMLError</code> </p> <ul> <li> <p>Description: The XML provided does not match the schema.</p> </li> </ul> </li> <li> <p>Error code: <code>OperationAbortedError </code> </p> <ul> <li> <p>Description: A conflicting conditional action is currently in progress against this resource. Try again.</p> </li> </ul> </li> <li> <p>Error code: <code>InternalError</code> </p> <ul> <li> <p>Description: The service was unable to apply the provided tag to the bucket.</p> </li> </ul> </li> </ul> <p>All Amazon S3 on Outposts REST API requests for this action require an additional parameter of <code>x-amz-outpost-id</code> to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of <code>s3-control</code>. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the <code>x-amz-outpost-id</code> derived using the access point ARN, see the <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_PutBucketTagging.html#API_control_PutBucketTagging_Examples\">Examples</a> section.</p> <p>The following actions are related to <code>PutBucketTagging</code>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetBucketTagging.html\">GetBucketTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteBucketTagging.html\">DeleteBucketTagging</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
},
@ -498,7 +636,7 @@
{"shape":"NotFoundException"},
{"shape":"TooManyTagsException"}
],
"documentation":"<p>Sets the supplied tag-set on an S3 Batch Operations job.</p> <p>A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html\">GetJobTagging</a>, modify that tag set, and use this action to replace the tag set with the one you modified. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags\">Controlling access and labeling jobs using tags</a> in the <i>Amazon Simple Storage Service Developer Guide</i>. </p> <p/> <note> <ul> <li> <p>If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you are charged for a Tier 1 Request (PUT). For more information, see <a href=\"http://aws.amazon.com/s3/pricing/\">Amazon S3 pricing</a>.</p> </li> <li> <p>For deleting existing tags for your Batch Operations job, a <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html\">DeleteJobTagging</a> request is preferred because it achieves the same result without incurring charges.</p> </li> <li> <p>A few things to consider about using tags:</p> <ul> <li> <p>Amazon S3 limits the maximum number of tags to 50 tags per job.</p> </li> <li> <p>You can associate up to 50 tags with a job as long as they have unique tag keys.</p> </li> <li> <p>A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length.</p> </li> <li> <p>The key and values are case sensitive.</p> </li> <li> <p>For tagging-related restrictions related to characters and encodings, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html\">User-Defined Tag Restrictions</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p> </li> </ul> </li> </ul> </note> <p/> <p>To use this operation, you must have permission to perform the <code>s3:PutJobTagging</code> action.</p> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html\">CreatJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html\">GetJobTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html\">DeleteJobTagging</a> </p> </li> </ul>",
"documentation":"<p>Sets the supplied tag-set on an S3 Batch Operations job.</p> <p>A tag is a key-value pair. You can associate S3 Batch Operations tags with any job by sending a PUT request against the tagging subresource that is associated with the job. To modify the existing tag set, you can either replace the existing tag set entirely, or make changes within the existing tag set by retrieving the existing tag set using <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html\">GetJobTagging</a>, modify that tag set, and use this action to replace the tag set with the one you modified. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-managing-jobs.html#batch-ops-job-tags\">Controlling access and labeling jobs using tags</a> in the <i>Amazon Simple Storage Service User Guide</i>. </p> <p/> <note> <ul> <li> <p>If you send this request with an empty tag set, Amazon S3 deletes the existing tag set on the Batch Operations job. If you use this method, you are charged for a Tier 1 Request (PUT). For more information, see <a href=\"http://aws.amazon.com/s3/pricing/\">Amazon S3 pricing</a>.</p> </li> <li> <p>For deleting existing tags for your Batch Operations job, a <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html\">DeleteJobTagging</a> request is preferred because it achieves the same result without incurring charges.</p> </li> <li> <p>A few things to consider about using tags:</p> <ul> <li> <p>Amazon S3 limits the maximum number of tags to 50 tags per job.</p> </li> <li> <p>You can associate up to 50 tags with a job as long as they have unique tag keys.</p> </li> <li> <p>A tag key can be up to 128 Unicode characters in length, and tag values can be up to 256 Unicode characters in length.</p> </li> <li> <p>The key and values are case sensitive.</p> </li> <li> <p>For tagging-related restrictions related to characters and encodings, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html\">User-Defined Tag Restrictions</a> in the <i>AWS Billing and Cost Management User Guide</i>.</p> </li> </ul> </li> </ul> </note> <p/> <p>To use this action, you must have permission to perform the <code>s3:PutJobTagging</code> action.</p> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html\">CreatJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_GetJobTagging.html\">GetJobTagging</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DeleteJobTagging.html\">DeleteJobTagging</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -526,7 +664,7 @@
"locationName":"PutStorageLensConfigurationRequest",
"xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"}
},
"documentation":"<p>Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html\">Working with Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <note> <p>To use this action, you must have permission to perform the <code>s3:PutStorageLensConfiguration</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html\">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> </note>",
"documentation":"<p>Puts an Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html\">Working with Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <note> <p>To use this action, you must have permission to perform the <code>s3:PutStorageLensConfiguration</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html\">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> </note>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -543,7 +681,7 @@
"xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"}
},
"output":{"shape":"PutStorageLensConfigurationTaggingResult"},
"documentation":"<p>Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html\">Assessing your storage activity and usage with Amazon S3 Storage Lens </a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <note> <p>To use this action, you must have permission to perform the <code>s3:PutStorageLensConfigurationTagging</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html\">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> </note>",
"documentation":"<p>Put or replace tags on an existing Amazon S3 Storage Lens configuration. For more information about S3 Storage Lens, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens.html\">Assessing your storage activity and usage with Amazon S3 Storage Lens </a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <note> <p>To use this action, you must have permission to perform the <code>s3:PutStorageLensConfigurationTagging</code> action. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/storage_lens_iam_permissions.html\">Setting permissions to use Amazon S3 Storage Lens</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> </note>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -562,7 +700,7 @@
{"shape":"NotFoundException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Updates an existing S3 Batch Operations job's priority. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html\">S3 Batch Operations</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html\">CreateJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html\">ListJobs</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html\">DescribeJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html\">UpdateJobStatus</a> </p> </li> </ul>",
"documentation":"<p>Updates an existing S3 Batch Operations job's priority. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html\">S3 Batch Operations</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html\">CreateJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html\">ListJobs</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html\">DescribeJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html\">UpdateJobStatus</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -582,7 +720,7 @@
{"shape":"JobStatusException"},
{"shape":"InternalServiceException"}
],
"documentation":"<p>Updates the status for the specified job. Use this operation to confirm that you want to run a job or to cancel an existing job. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html\">S3 Batch Operations</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html\">CreateJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html\">ListJobs</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html\">DescribeJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html\">UpdateJobStatus</a> </p> </li> </ul>",
"documentation":"<p>Updates the status for the specified job. Use this action to confirm that you want to run a job or to cancel an existing job. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-basics.html\">S3 Batch Operations</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p> <p/> <p>Related actions include:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateJob.html\">CreateJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_ListJobs.html\">ListJobs</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_DescribeJob.html\">DescribeJob</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_UpdateJobStatus.html\">UpdateJobStatus</a> </p> </li> </ul>",
"endpoint":{
"hostPrefix":"{AccountId}."
}
@ -672,6 +810,22 @@
},
"documentation":"<p>A container for the activity metrics.</p>"
},
"AwsLambdaTransformation":{
"type":"structure",
"required":["FunctionArn"],
"members":{
"FunctionArn":{
"shape":"FunctionArnString",
"documentation":"<p>The Amazon Resource Name (ARN) of the AWS Lambda function.</p>"
},
"FunctionPayload":{
"shape":"AwsLambdaTransformationPayload",
"documentation":"<p>Additional JSON that provides supplemental data to the Lambda function used to transform objects.</p>"
}
},
"documentation":"<p>AWS Lambda function used to transform objects through an Object Lambda Access Point.</p>"
},
"AwsLambdaTransformationPayload":{"type":"string"},
"AwsOrgArn":{
"type":"string",
"max":1024,
@ -761,6 +915,42 @@
"ConfirmRemoveSelfBucketAccess":{"type":"boolean"},
"ConfirmationRequired":{"type":"boolean"},
"ContinuationToken":{"type":"string"},
"CreateAccessPointForObjectLambdaRequest":{
"type":"structure",
"required":[
"AccountId",
"Name",
"Configuration"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The AWS account ID for owner of the specified Object Lambda Access Point.</p>",
"hostLabel":true,
"location":"header",
"locationName":"x-amz-account-id"
},
"Name":{
"shape":"ObjectLambdaAccessPointName",
"documentation":"<p>The name you want to assign to this Object Lambda Access Point.</p>",
"location":"uri",
"locationName":"name"
},
"Configuration":{
"shape":"ObjectLambdaConfiguration",
"documentation":"<p>Object Lambda Access Point configuration as a JSON document.</p>"
}
}
},
"CreateAccessPointForObjectLambdaResult":{
"type":"structure",
"members":{
"ObjectLambdaAccessPointArn":{
"shape":"ObjectLambdaAccessPointArn",
"documentation":"<p>Specifies the ARN for the Object Lambda Access Point.</p>"
}
}
},
"CreateAccessPointRequest":{
"type":"structure",
"required":[
@ -920,7 +1110,7 @@
},
"Operation":{
"shape":"JobOperation",
"documentation":"<p>The operation that you want this job to perform on every object listed in the manifest. For more information about the available operations, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html\">Operations</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
"documentation":"<p>The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-actions.html\">Operations</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>"
},
"Report":{
"shape":"JobReport",
@ -946,7 +1136,7 @@
},
"RoleArn":{
"shape":"IAMRoleArn",
"documentation":"<p>The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that Batch Operations will use to run this job's operation on every object in the manifest.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) for the AWS Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.</p>"
},
"Tags":{
"shape":"S3TagSet",
@ -967,6 +1157,50 @@
"Date":{"type":"timestamp"},
"Days":{"type":"integer"},
"DaysAfterInitiation":{"type":"integer"},
"DeleteAccessPointForObjectLambdaRequest":{
"type":"structure",
"required":[
"AccountId",
"Name"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The account ID for the account that owns the specified Object Lambda Access Point.</p>",
"hostLabel":true,
"location":"header",
"locationName":"x-amz-account-id"
},
"Name":{
"shape":"ObjectLambdaAccessPointName",
"documentation":"<p>The name of the access point you want to delete.</p>",
"location":"uri",
"locationName":"name"
}
}
},
"DeleteAccessPointPolicyForObjectLambdaRequest":{
"type":"structure",
"required":[
"AccountId",
"Name"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The account ID for the account that owns the specified Object Lambda Access Point.</p>",
"hostLabel":true,
"location":"header",
"locationName":"x-amz-account-id"
},
"Name":{
"shape":"ObjectLambdaAccessPointName",
"documentation":"<p>The name of the Object Lambda Access Point you want to delete the policy for.</p>",
"location":"uri",
"locationName":"name"
}
}
},
"DeleteAccessPointPolicyRequest":{
"type":"structure",
"required":[
@ -1197,7 +1431,7 @@
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p/>",
"documentation":"<p>The AWS account ID associated with the S3 Batch Operations job.</p>",
"hostLabel":true,
"location":"header",
"locationName":"x-amz-account-id"
@ -1259,6 +1493,107 @@
"min":1,
"pattern":"(arn:(aws[a-zA-Z-]*)?:lambda:)?([a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\\d{1}:)?(\\d{12}:)?(function:)?([a-zA-Z0-9-_]+)(:(\\$LATEST|[a-zA-Z0-9-_]+))?"
},
"GetAccessPointConfigurationForObjectLambdaRequest":{
"type":"structure",
"required":[
"AccountId",
"Name"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The account ID for the account that owns the specified Object Lambda Access Point.</p>",
"hostLabel":true,
"location":"header",
"locationName":"x-amz-account-id"
},
"Name":{
"shape":"ObjectLambdaAccessPointName",
"documentation":"<p>The name of the Object Lambda Access Point you want to return the configuration for.</p>",
"location":"uri",
"locationName":"name"
}
}
},
"GetAccessPointConfigurationForObjectLambdaResult":{
"type":"structure",
"members":{
"Configuration":{
"shape":"ObjectLambdaConfiguration",
"documentation":"<p>Object Lambda Access Point configuration document.</p>"
}
}
},
"GetAccessPointForObjectLambdaRequest":{
"type":"structure",
"required":[
"AccountId",
"Name"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The account ID for the account that owns the specified Object Lambda Access Point.</p>",
"hostLabel":true,
"location":"header",
"locationName":"x-amz-account-id"
},
"Name":{
"shape":"ObjectLambdaAccessPointName",
"documentation":"<p>The name of the Object Lambda Access Point.</p>",
"location":"uri",
"locationName":"name"
}
}
},
"GetAccessPointForObjectLambdaResult":{
"type":"structure",
"members":{
"Name":{
"shape":"ObjectLambdaAccessPointName",
"documentation":"<p>The name of the Object Lambda Access Point.</p>"
},
"PublicAccessBlockConfiguration":{
"shape":"PublicAccessBlockConfiguration",
"documentation":"<p>Configuration to block all public access. This setting is turned on and can not be edited. </p>"
},
"CreationDate":{
"shape":"CreationDate",
"documentation":"<p>The date and time when the specified Object Lambda Access Point was created.</p>"
}
}
},
"GetAccessPointPolicyForObjectLambdaRequest":{
"type":"structure",
"required":[
"AccountId",
"Name"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The account ID for the account that owns the specified Object Lambda Access Point.</p>",
"hostLabel":true,
"location":"header",
"locationName":"x-amz-account-id"
},
"Name":{
"shape":"ObjectLambdaAccessPointName",
"documentation":"<p>The name of the Object Lambda Access Point.</p>",
"location":"uri",
"locationName":"name"
}
}
},
"GetAccessPointPolicyForObjectLambdaResult":{
"type":"structure",
"members":{
"Policy":{
"shape":"ObjectLambdaPolicy",
"documentation":"<p>Object Lambda Access Point resource policy document.</p>"
}
}
},
"GetAccessPointPolicyRequest":{
"type":"structure",
"required":[
@ -1290,6 +1625,34 @@
}
}
},
"GetAccessPointPolicyStatusForObjectLambdaRequest":{
"type":"structure",
"required":[
"AccountId",
"Name"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The account ID for the account that owns the specified Object Lambda Access Point.</p>",
"hostLabel":true,
"location":"header",
"locationName":"x-amz-account-id"
},
"Name":{
"shape":"ObjectLambdaAccessPointName",
"documentation":"<p>The name of the Object Lambda Access Point.</p>",
"location":"uri",
"locationName":"name"
}
}
},
"GetAccessPointPolicyStatusForObjectLambdaResult":{
"type":"structure",
"members":{
"PolicyStatus":{"shape":"PolicyStatus"}
}
},
"GetAccessPointPolicyStatusRequest":{
"type":"structure",
"required":[
@ -1977,7 +2340,7 @@
"box":true
}
},
"documentation":"<p>The operation that you want this job to perform on every object listed in the manifest. For more information about the available operations, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html\">Operations</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
"documentation":"<p>The operation that you want this job to perform on every object listed in the manifest. For more information about the available operations, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-operations.html\">Operations</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>"
},
"JobPriority":{
"type":"integer",
@ -2205,6 +2568,44 @@
"locationName":"Rule"
}
},
"ListAccessPointsForObjectLambdaRequest":{
"type":"structure",
"required":["AccountId"],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The account ID for the account that owns the specified Object Lambda Access Point.</p>",
"hostLabel":true,
"location":"header",
"locationName":"x-amz-account-id"
},
"NextToken":{
"shape":"NonEmptyMaxLength1024String",
"documentation":"<p>If the list has more access points than can be returned in one call to this API, this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of access points that you want to include in the list. If there are more than this number of access points, then the response will include a continuation token in the <code>NextToken</code> field that you can use to retrieve the next page of access points.</p>",
"location":"querystring",
"locationName":"maxResults"
}
}
},
"ListAccessPointsForObjectLambdaResult":{
"type":"structure",
"members":{
"ObjectLambdaAccessPointList":{
"shape":"ObjectLambdaAccessPointList",
"documentation":"<p>Returns list of Object Lambda Access Points.</p>"
},
"NextToken":{
"shape":"NonEmptyMaxLength1024String",
"documentation":"<p>If the list has more access points than can be returned in one call to this API, this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.</p>"
}
}
},
"ListAccessPointsRequest":{
"type":"structure",
"required":["AccountId"],
@ -2255,7 +2656,7 @@
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p/>",
"documentation":"<p>The AWS account ID associated with the S3 Batch Operations job.</p>",
"hostLabel":true,
"location":"header",
"locationName":"x-amz-account-id"
@ -2488,6 +2889,134 @@
"documentation":"<p/>",
"exception":true
},
"ObjectLambdaAccessPoint":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"ObjectLambdaAccessPointName",
"documentation":"<p>The name of the Object Lambda Access Point.</p>"
},
"ObjectLambdaAccessPointArn":{
"shape":"ObjectLambdaAccessPointArn",
"documentation":"<p>Specifies the ARN for the Object Lambda Access Point.</p>"
}
},
"documentation":"<p>An access point with an attached AWS Lambda function used to access transformed data from an Amazon S3 bucket.</p>"
},
"ObjectLambdaAccessPointArn":{
"type":"string",
"max":2048,
"min":1,
"pattern":"arn:[^:]+:s3-object-lambda:[^:]*:\\d{12}:accesspoint/.*"
},
"ObjectLambdaAccessPointList":{
"type":"list",
"member":{
"shape":"ObjectLambdaAccessPoint",
"locationName":"ObjectLambdaAccessPoint"
}
},
"ObjectLambdaAccessPointName":{
"type":"string",
"max":45,
"min":3,
"pattern":"^[a-z0-9]([a-z0-9\\-]*[a-z0-9])?$"
},
"ObjectLambdaAllowedFeature":{
"type":"string",
"enum":[
"GetObject-Range",
"GetObject-PartNumber"
]
},
"ObjectLambdaAllowedFeaturesList":{
"type":"list",
"member":{
"shape":"ObjectLambdaAllowedFeature",
"locationName":"AllowedFeature"
}
},
"ObjectLambdaConfiguration":{
"type":"structure",
"required":[
"SupportingAccessPoint",
"TransformationConfigurations"
],
"members":{
"SupportingAccessPoint":{
"shape":"ObjectLambdaSupportingAccessPointArn",
"documentation":"<p>Standard access point associated with the Object Lambda Access Point.</p>"
},
"CloudWatchMetricsEnabled":{
"shape":"Boolean",
"documentation":"<p>A container for whether the CloudWatch metrics configuration is enabled.</p>"
},
"AllowedFeatures":{
"shape":"ObjectLambdaAllowedFeaturesList",
"documentation":"<p>A container for allowed features. Valid inputs are <code>GetObject-Range</code> and <code>GetObject-PartNumber</code>.</p>"
},
"TransformationConfigurations":{
"shape":"ObjectLambdaTransformationConfigurationsList",
"documentation":"<p>A container for transformation configurations for an Object Lambda Access Point.</p>"
}
},
"documentation":"<p>A configuration used when creating an Object Lambda Access Point.</p>"
},
"ObjectLambdaContentTransformation":{
"type":"structure",
"members":{
"AwsLambda":{
"shape":"AwsLambdaTransformation",
"documentation":"<p>A container for an AWS Lambda function.</p>"
}
},
"documentation":"<p>A container for AwsLambdaTransformation.</p>",
"union":true
},
"ObjectLambdaPolicy":{"type":"string"},
"ObjectLambdaSupportingAccessPointArn":{
"type":"string",
"max":2048,
"min":1,
"pattern":"arn:[^:]+:s3:[^:]*:\\d{12}:accesspoint/.*"
},
"ObjectLambdaTransformationConfiguration":{
"type":"structure",
"required":[
"Actions",
"ContentTransformation"
],
"members":{
"Actions":{
"shape":"ObjectLambdaTransformationConfigurationActionsList",
"documentation":"<p>A container for the action of an Object Lambda Access Point configuration.</p>"
},
"ContentTransformation":{
"shape":"ObjectLambdaContentTransformation",
"documentation":"<p>A container for the content transformation of an Object Lambda Access Point configuration.</p>"
}
},
"documentation":"<p>A configuration used when creating an Object Lambda Access Point transformation.</p>"
},
"ObjectLambdaTransformationConfigurationAction":{
"type":"string",
"enum":["GetObject"]
},
"ObjectLambdaTransformationConfigurationActionsList":{
"type":"list",
"member":{
"shape":"ObjectLambdaTransformationConfigurationAction",
"locationName":"Action"
}
},
"ObjectLambdaTransformationConfigurationsList":{
"type":"list",
"member":{
"shape":"ObjectLambdaTransformationConfiguration",
"locationName":"TransformationConfiguration"
}
},
"ObjectLockEnabledForBucket":{"type":"boolean"},
"OperationName":{
"type":"string",
@ -2516,7 +3045,7 @@
"locationName":"IsPublic"
}
},
"documentation":"<p>Indicates whether this access point policy is public. For more information about how Amazon S3 evaluates policies to determine whether they are public, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status\">The Meaning of \"Public\"</a> in the <i>Amazon Simple Storage Service Developer Guide</i>. </p>"
"documentation":"<p>Indicates whether this access point policy is public. For more information about how Amazon S3 evaluates policies to determine whether they are public, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status\">The Meaning of \"Public\"</a> in the <i>Amazon Simple Storage Service User Guide</i>. </p>"
},
"Prefix":{"type":"string"},
"PrefixLevel":{
@ -2568,6 +3097,60 @@
"documentation":"<p>The <code>PublicAccessBlock</code> configuration that you want to apply to this Amazon S3 account. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status\">The Meaning of \"Public\"</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p> <p>This is not supported for Amazon S3 on Outposts.</p>"
},
"PublicAccessBlockEnabled":{"type":"boolean"},
"PutAccessPointConfigurationForObjectLambdaRequest":{
"type":"structure",
"required":[
"AccountId",
"Name",
"Configuration"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The account ID for the account that owns the specified Object Lambda Access Point.</p>",
"hostLabel":true,
"location":"header",
"locationName":"x-amz-account-id"
},
"Name":{
"shape":"ObjectLambdaAccessPointName",
"documentation":"<p>The name of the Object Lambda Access Point.</p>",
"location":"uri",
"locationName":"name"
},
"Configuration":{
"shape":"ObjectLambdaConfiguration",
"documentation":"<p>Object Lambda Access Point configuration document.</p>"
}
}
},
"PutAccessPointPolicyForObjectLambdaRequest":{
"type":"structure",
"required":[
"AccountId",
"Name",
"Policy"
],
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p>The account ID for the account that owns the specified Object Lambda Access Point.</p>",
"hostLabel":true,
"location":"header",
"locationName":"x-amz-account-id"
},
"Name":{
"shape":"ObjectLambdaAccessPointName",
"documentation":"<p>The name of the Object Lambda Access Point.</p>",
"location":"uri",
"locationName":"name"
},
"Policy":{
"shape":"ObjectLambdaPolicy",
"documentation":"<p>Object Lambda Access Point resource policy document.</p>"
}
}
},
"PutAccessPointPolicyRequest":{
"type":"structure",
"required":[
@ -2591,7 +3174,7 @@
},
"Policy":{
"shape":"Policy",
"documentation":"<p>The policy that you want to apply to the specified access point. For more information about access point policies, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/access-points.html\">Managing data access with Amazon S3 Access Points</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
"documentation":"<p>The policy that you want to apply to the specified access point. For more information about access point policies, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html\">Managing data access with Amazon S3 Access Points</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>"
}
}
},
@ -3253,7 +3836,7 @@
"documentation":"<p>The Object Lock retention mode to be applied to all objects in the Batch Operations job.</p>"
}
},
"documentation":"<p>Contains the S3 Object Lock retention mode to be applied to all objects in the S3 Batch Operations job. If you don't provide <code>Mode</code> and <code>RetainUntilDate</code> data types in your operation, you will remove the retention from your objects. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html\">Using S3 Object Lock retention with S3 Batch Operations</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
"documentation":"<p>Contains the S3 Object Lock retention mode to be applied to all objects in the S3 Batch Operations job. If you don't provide <code>Mode</code> and <code>RetainUntilDate</code> data types in your operation, you will remove the retention from your objects. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html\">Using S3 Object Lock retention with S3 Batch Operations</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>"
},
"S3SSEAlgorithm":{
"type":"string",
@ -3281,7 +3864,7 @@
"documentation":"<p>Contains the Object Lock legal hold status to be applied to all objects in the Batch Operations job.</p>"
}
},
"documentation":"<p>Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes every object to the underlying <code>PutObjectLegalHold</code> API. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-legal-hold.html\">Using S3 Object Lock legal hold with S3 Batch Operations</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
"documentation":"<p>Contains the configuration for an S3 Object Lock legal hold operation that an S3 Batch Operations job passes every object to the underlying <code>PutObjectLegalHold</code> API. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-legal-hold.html\">Using S3 Object Lock legal hold with S3 Batch Operations</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>"
},
"S3SetObjectRetentionOperation":{
"type":"structure",
@ -3294,10 +3877,10 @@
},
"Retention":{
"shape":"S3Retention",
"documentation":"<p>Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html\">Using S3 Object Lock retention with S3 Batch Operations</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
"documentation":"<p>Contains the Object Lock retention mode to be applied to all objects in the Batch Operations job. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html\">Using S3 Object Lock retention with S3 Batch Operations</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>"
}
},
"documentation":"<p>Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes every object to the underlying <code>PutObjectRetention</code> API. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html\">Using S3 Object Lock retention with S3 Batch Operations</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
"documentation":"<p>Contains the configuration parameters for the Object Lock retention action for an S3 Batch Operations job. Batch Operations passes every object to the underlying <code>PutObjectRetention</code> API. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/batch-ops-retention-date.html\">Using S3 Object Lock retention with S3 Batch Operations</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>"
},
"S3SetObjectTaggingOperation":{
"type":"structure",
@ -3532,12 +4115,12 @@
"type":"string",
"max":1024,
"min":1,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:=+\\-@%]*)$"
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@%]*)$"
},
"TagValueString":{
"type":"string",
"max":1024,
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:=+\\-@%]*)$"
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:\\/=+\\-@%]*)$"
},
"Tagging":{
"type":"structure",
@ -3583,7 +4166,7 @@
"documentation":"<p>The storage class to which you want the object to transition.</p>"
}
},
"documentation":"<p>Specifies when an object transitions to a specified storage class. For more information about Amazon S3 Lifecycle configuration rules, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html\"> Transitioning objects using Amazon S3 Lifecycle</a> in the <i>Amazon Simple Storage Service Developer Guide</i>.</p>"
"documentation":"<p>Specifies when an object transitions to a specified storage class. For more information about Amazon S3 Lifecycle configuration rules, see <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-transition-general-considerations.html\"> Transitioning objects using Amazon S3 Lifecycle</a> in the <i>Amazon Simple Storage Service User Guide</i>.</p>"
},
"TransitionList":{
"type":"list",
@ -3612,7 +4195,7 @@
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p/>",
"documentation":"<p>The AWS account ID associated with the S3 Batch Operations job.</p>",
"hostLabel":true,
"location":"header",
"locationName":"x-amz-account-id"
@ -3658,7 +4241,7 @@
"members":{
"AccountId":{
"shape":"AccountId",
"documentation":"<p/>",
"documentation":"<p>The AWS account ID associated with the S3 Batch Operations job.</p>",
"hostLabel":true,
"location":"header",
"locationName":"x-amz-account-id"
@ -3717,5 +4300,5 @@
"min":1
}
},
"documentation":"<p> AWS S3 Control provides access to Amazon S3 control plane operations. </p>"
"documentation":"<p> AWS S3 Control provides access to Amazon S3 control plane actions. </p>"
}

11
botocore/data/sagemaker-runtime/2017-05-13/service-2.json
View file

@ -115,6 +115,12 @@
"location":"header",
"locationName":"X-Amzn-SageMaker-Target-Variant"
},
"TargetContainerHostname":{
"shape":"TargetContainerHostnameHeader",
"documentation":"<p>If the endpoint hosts multiple containers and is configured to use direct invocation, this parameter specifies the host name of the container to invoke.</p>",
"location":"header",
"locationName":"X-Amzn-SageMaker-Target-Container-Hostname"
},
"InferenceId":{
"shape":"InferenceId",
"documentation":"<p>If you provide a value, it is added to the captured data when you enable data capture on the endpoint. For information about data capture, see <a href=\"https://docs.aws.amazon.com/sagemaker/latest/dg/model-monitor-data-capture.html\">Capture Data</a>.</p>",
@ -191,6 +197,11 @@
"synthetic":true
},
"StatusCode":{"type":"integer"},
"TargetContainerHostnameHeader":{
"type":"string",
"max":63,
"pattern":"^[a-zA-Z0-9](-*[a-zA-Z0-9])*"
},
"TargetModelHeader":{
"type":"string",
"max":1024,

170
botocore/data/sagemaker/2017-07-24/service-2.json
View file

File diff suppressed because one or more lines are too long

289
botocore/data/secretsmanager/2017-10-17/service-2.json
View file

@ -61,9 +61,10 @@
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServiceError"},
{"shape":"InvalidRequestException"}
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"}
],
"documentation":"<p>Deletes the resource-based permission policy attached to the secret.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:DeleteResourcePolicy</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To attach a resource policy to a secret, use <a>PutResourcePolicy</a>.</p> </li> <li> <p>To retrieve the current resource-based policy that's attached to a secret, use <a>GetResourcePolicy</a>.</p> </li> <li> <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p> </li> </ul>"
"documentation":"<p>Deletes the resource-based permission policy attached to the secret.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:DeleteResourcePolicy</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To attach a resource policy to a secret, use <a>PutResourcePolicy</a>.</p> </li> <li> <p>To retrieve the current resource-based policy attached to a secret, use <a>GetResourcePolicy</a>.</p> </li> <li> <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p> </li> </ul>"
},
"DeleteSecret":{
"name":"DeleteSecret",
@ -79,7 +80,7 @@
{"shape":"InvalidRequestException"},
{"shape":"InternalServiceError"}
],
"documentation":"<p>Deletes an entire secret and all of its versions. You can optionally include a recovery window during which you can restore the secret. If you don't specify a recovery window value, the operation defaults to 30 days. Secrets Manager attaches a <code>DeletionDate</code> stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently.</p> <p>At any time before recovery window ends, you can use <a>RestoreSecret</a> to remove the <code>DeletionDate</code> and cancel the deletion of the secret.</p> <p>You cannot access the encrypted secret information in any secret that is scheduled for deletion. If you need to access that information, you must cancel the deletion with <a>RestoreSecret</a> and then retrieve the information.</p> <note> <ul> <li> <p>There is no explicit operation to delete a version of a secret. Instead, remove all staging labels from the <code>VersionStage</code> field of a version. That marks the version as deprecated and allows Secrets Manager to delete it as needed. Versions that do not have any staging labels do not show up in <a>ListSecretVersionIds</a> unless you specify <code>IncludeDeprecated</code>.</p> </li> <li> <p>The permanent secret deletion at the end of the waiting period is performed as a background task with low priority. There is no guarantee of a specific time after the recovery window for the actual delete operation to occur.</p> </li> </ul> </note> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:DeleteSecret</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To create a secret, use <a>CreateSecret</a>.</p> </li> <li> <p>To cancel deletion of a version of a secret before the recovery window has expired, use <a>RestoreSecret</a>.</p> </li> </ul>"
"documentation":"<p>Deletes an entire secret and all of the versions. You can optionally include a recovery window during which you can restore the secret. If you don't specify a recovery window value, the operation defaults to 30 days. Secrets Manager attaches a <code>DeletionDate</code> stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently.</p> <p>At any time before recovery window ends, you can use <a>RestoreSecret</a> to remove the <code>DeletionDate</code> and cancel the deletion of the secret.</p> <p>You cannot access the encrypted secret information in any secret scheduled for deletion. If you need to access that information, you must cancel the deletion with <a>RestoreSecret</a> and then retrieve the information.</p> <note> <ul> <li> <p>There is no explicit operation to delete a version of a secret. Instead, remove all staging labels from the <code>VersionStage</code> field of a version. That marks the version as deprecated and allows Secrets Manager to delete it as needed. Versions without any staging labels do not show up in <a>ListSecretVersionIds</a> unless you specify <code>IncludeDeprecated</code>.</p> </li> <li> <p>The permanent secret deletion at the end of the waiting period is performed as a background task with low priority. There is no guarantee of a specific time after the recovery window for the actual delete operation to occur.</p> </li> </ul> </note> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:DeleteSecret</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To create a secret, use <a>CreateSecret</a>.</p> </li> <li> <p>To cancel deletion of a version of a secret before the recovery window has expired, use <a>RestoreSecret</a>.</p> </li> </ul>"
},
"DescribeSecret":{
"name":"DescribeSecret",
@ -188,7 +189,7 @@
{"shape":"InvalidRequestException"},
{"shape":"PublicPolicyException"}
],
"documentation":"<p>Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name (ARN) in the policy statement's <code>Resources</code> element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions that are permitted by all of the relevant policies. For more information, see <a href=\"http://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html\">Using Resource-Based Policies for AWS Secrets Manager</a>. For the complete description of the AWS policy syntax and grammar, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html\">IAM JSON Policy Reference</a> in the <i>IAM User Guide</i>.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:PutResourcePolicy</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To retrieve the resource policy attached to a secret, use <a>GetResourcePolicy</a>.</p> </li> <li> <p>To delete the resource-based policy that's attached to a secret, use <a>DeleteResourcePolicy</a>.</p> </li> <li> <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p> </li> </ul>"
"documentation":"<p>Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name (ARN) in the policy statement's <code>Resources</code> element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions that are permitted by all of the relevant policies. For more information, see <a href=\"http://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access_resource-based-policies.html\">Using Resource-Based Policies for AWS Secrets Manager</a>. For the complete description of the AWS policy syntax and grammar, see <a href=\"https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies.html\">IAM JSON Policy Reference</a> in the <i>IAM User Guide</i>.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:PutResourcePolicy</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To retrieve the resource policy attached to a secret, use <a>GetResourcePolicy</a>.</p> </li> <li> <p>To delete the resource-based policy attached to a secret, use <a>DeleteResourcePolicy</a>.</p> </li> <li> <p>To list all of the currently available secrets, use <a>ListSecrets</a>.</p> </li> </ul>"
},
"PutSecretValue":{
"name":"PutSecretValue",
@ -207,7 +208,39 @@
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServiceError"}
],
"documentation":"<p>Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and attaches it to the secret. The version can contain a new <code>SecretString</code> value or a new <code>SecretBinary</code> value. You can also specify the staging labels that are initially attached to the new version.</p> <note> <p>The Secrets Manager console uses only the <code>SecretString</code> field. To add binary data to a secret with the <code>SecretBinary</code> field you must use the AWS CLI or one of the AWS SDKs.</p> </note> <ul> <li> <p>If this operation creates the first version for the secret then Secrets Manager automatically attaches the staging label <code>AWSCURRENT</code> to the new version.</p> </li> <li> <p>If another version of this secret already exists, then this operation does not automatically move any staging labels other than those that you explicitly specify in the <code>VersionStages</code> parameter.</p> </li> <li> <p>If this operation moves the staging label <code>AWSCURRENT</code> from another version to this version (because you included it in the <code>StagingLabels</code> parameter) then Secrets Manager also automatically moves the staging label <code>AWSPREVIOUS</code> to the version that <code>AWSCURRENT</code> was removed from.</p> </li> <li> <p>This operation is idempotent. If a version with a <code>VersionId</code> with the same value as the <code>ClientRequestToken</code> parameter already exists and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot modify an existing version; you can only create new ones.</p> </li> </ul> <note> <ul> <li> <p>If you call an operation to encrypt or decrypt the <code>SecretString</code> or <code>SecretBinary</code> for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS creating the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.</p> </li> <li> <p>If the secret resides in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the <code>KMSKeyId</code>. If you call an API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code> using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.</p> </li> </ul> </note> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:PutSecretValue</p> </li> <li> <p>kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To retrieve the encrypted value you store in the version of a secret, use <a>GetSecretValue</a>.</p> </li> <li> <p>To create a secret, use <a>CreateSecret</a>.</p> </li> <li> <p>To get the details for a secret, use <a>DescribeSecret</a>.</p> </li> <li> <p>To list the versions attached to a secret, use <a>ListSecretVersionIds</a>.</p> </li> </ul>"
"documentation":"<p>Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and attaches it to the secret. The version can contain a new <code>SecretString</code> value or a new <code>SecretBinary</code> value. You can also specify the staging labels that are initially attached to the new version.</p> <note> <p>The Secrets Manager console uses only the <code>SecretString</code> field. To add binary data to a secret with the <code>SecretBinary</code> field you must use the AWS CLI or one of the AWS SDKs.</p> </note> <ul> <li> <p>If this operation creates the first version for the secret then Secrets Manager automatically attaches the staging label <code>AWSCURRENT</code> to the new version.</p> </li> <li> <p>If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label <code>AWSCURRENT</code> to this new version.</p> </li> <li> <p>If this operation moves the staging label <code>AWSCURRENT</code> from another version to this version, then Secrets Manager also automatically moves the staging label <code>AWSPREVIOUS</code> to the version that <code>AWSCURRENT</code> was removed from.</p> </li> <li> <p>This operation is idempotent. If a version with a <code>VersionId</code> with the same value as the <code>ClientRequestToken</code> parameter already exists and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot modify an existing version; you can only create new ones.</p> </li> </ul> <note> <ul> <li> <p>If you call an operation to encrypt or decrypt the <code>SecretString</code> or <code>SecretBinary</code> for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS creating the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.</p> </li> <li> <p>If the secret resides in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the <code>KMSKeyId</code>. If you call an API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code> using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.</p> </li> </ul> </note> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:PutSecretValue</p> </li> <li> <p>kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To retrieve the encrypted value you store in the version of a secret, use <a>GetSecretValue</a>.</p> </li> <li> <p>To create a secret, use <a>CreateSecret</a>.</p> </li> <li> <p>To get the details for a secret, use <a>DescribeSecret</a>.</p> </li> <li> <p>To list the versions attached to a secret, use <a>ListSecretVersionIds</a>.</p> </li> </ul>"
},
"RemoveRegionsFromReplication":{
"name":"RemoveRegionsFromReplication",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"RemoveRegionsFromReplicationRequest"},
"output":{"shape":"RemoveRegionsFromReplicationResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"InternalServiceError"}
],
"documentation":"<p>Remove regions from replication.</p>"
},
"ReplicateSecretToRegions":{
"name":"ReplicateSecretToRegions",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ReplicateSecretToRegionsRequest"},
"output":{"shape":"ReplicateSecretToRegionsResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"InternalServiceError"}
],
"documentation":"<p>Converts an existing secret to a multi-Region secret and begins replication the secret to a list of new regions. </p>"
},
"RestoreSecret":{
"name":"RestoreSecret",
@ -241,6 +274,22 @@
],
"documentation":"<p>Configures and starts the asynchronous process of rotating this secret. If you include the configuration parameters, the operation sets those values for the secret and then immediately starts a rotation. If you do not include the configuration parameters, the operation starts a rotation with the values already stored in the secret. After the rotation completes, the protected service and its clients all use the new version of the secret. </p> <p>This required configuration information includes the ARN of an AWS Lambda function and the time between scheduled rotations. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the protected service to match. After testing the new credentials, the function marks the new secret with the staging label <code>AWSCURRENT</code> so that your clients all immediately begin to use the new version. For more information about rotating secrets and how to configure a Lambda function to rotate the secrets for your protected service, see <a href=\"https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html\">Rotating Secrets in AWS Secrets Manager</a> in the <i>AWS Secrets Manager User Guide</i>.</p> <p>Secrets Manager schedules the next rotation when the previous one completes. Secrets Manager schedules the date by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour and influenced by a variety of factors that help distribute load.</p> <p>The rotation function must end with the versions of the secret in one of two states:</p> <ul> <li> <p>The <code>AWSPENDING</code> and <code>AWSCURRENT</code> staging labels are attached to the same version of the secret, or</p> </li> <li> <p>The <code>AWSPENDING</code> staging label is not attached to any version of the secret.</p> </li> </ul> <p>If the <code>AWSPENDING</code> staging label is present but not attached to the same version as <code>AWSCURRENT</code> then any later invocation of <code>RotateSecret</code> assumes that a previous rotation request is still in progress and returns an error.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p>secretsmanager:RotateSecret</p> </li> <li> <p>lambda:InvokeFunction (on the function specified in the secret's metadata)</p> </li> </ul> <p> <b>Related operations</b> </p> <ul> <li> <p>To list the secrets in your account, use <a>ListSecrets</a>.</p> </li> <li> <p>To get the details for a version of a secret, use <a>DescribeSecret</a>.</p> </li> <li> <p>To create a new version of a secret, use <a>CreateSecret</a>.</p> </li> <li> <p>To attach staging labels to or remove staging labels from a version of a secret, use <a>UpdateSecretVersionStage</a>.</p> </li> </ul>"
},
"StopReplicationToReplica":{
"name":"StopReplicationToReplica",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"StopReplicationToReplicaRequest"},
"output":{"shape":"StopReplicationToReplicaResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidRequestException"},
{"shape":"InvalidParameterException"},
{"shape":"InternalServiceError"}
],
"documentation":"<p>Removes the secret from replication and promotes the secret to a regional secret in the replica Region.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
@ -324,10 +373,15 @@
{"shape":"InternalServiceError"},
{"shape":"InvalidRequestException"}
],
"documentation":"<p>Validates the JSON text of the resource-based policy document attached to the specified secret. The JSON request string input and response output displays formatted code with white space and line breaks for better readability. Submit your input as a single line JSON string. A resource-based policy is optional.</p>"
"documentation":"<p>Validates that the resource policy does not grant a wide range of IAM principals access to your secret. The JSON request string input and response output displays formatted code with white space and line breaks for better readability. Submit your input as a single line JSON string. A resource-based policy is optional for secrets.</p> <p>The API performs three checks when validating the secret:</p> <ul> <li> <p>Sends a call to <a href=\"https://aws.amazon.com/blogs/security/protect-sensitive-data-in-the-cloud-with-automated-reasoning-zelkova/\">Zelkova</a>, an automated reasoning engine, to ensure your Resource Policy does not allow broad access to your secret.</p> </li> <li> <p>Checks for correct syntax in a policy.</p> </li> <li> <p>Verifies the policy does not lock out a caller.</p> </li> </ul> <p> <b>Minimum Permissions</b> </p> <p>You must have the permissions required to access the following APIs:</p> <ul> <li> <p> <code>secretsmanager:PutResourcePolicy</code> </p> </li> <li> <p> <code>secretsmanager:ValidateResourcePolicy</code> </p> </li> </ul>"
}
},
"shapes":{
"AddReplicaRegionListType":{
"type":"list",
"member":{"shape":"ReplicaRegionType"},
"min":1
},
"AutomaticallyRotateAfterDaysType":{
"type":"long",
"max":1000,
@ -376,7 +430,7 @@
},
"ClientRequestToken":{
"shape":"ClientRequestTokenType",
"documentation":"<p>(Optional) If you include <code>SecretString</code> or <code>SecretBinary</code>, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version. </p> <note> <p>If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> yourself for the new version and include the value in the request.</p> </note> <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a <a href=\"https://wikipedia.org/wiki/Universally_unique_identifier\">UUID-type</a> value to ensure uniqueness of your versions within the specified secret. </p> <ul> <li> <p>If the <code>ClientRequestToken</code> value isn't already associated with a version of the secret then a new version of the secret is created. </p> </li> <li> <p>If a version with this value already exists and the version <code>SecretString</code> and <code>SecretBinary</code> values are the same as those in the request, then the request is ignored.</p> </li> <li> <p>If a version with this value already exists and that version's <code>SecretString</code> and <code>SecretBinary</code> values are different from those in the request then the request fails because you cannot modify an existing version. Instead, use <a>PutSecretValue</a> to create a new version.</p> </li> </ul> <p>This value becomes the <code>VersionId</code> of the new version.</p>",
"documentation":"<p>(Optional) If you include <code>SecretString</code> or <code>SecretBinary</code>, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version. </p> <note> <p>If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a <code>ClientRequestToken</code> yourself for the new version and include the value in the request.</p> </note> <p>This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a <a href=\"https://wikipedia.org/wiki/Universally_unique_identifier\">UUID-type</a> value to ensure uniqueness of your versions within the specified secret. </p> <ul> <li> <p>If the <code>ClientRequestToken</code> value isn't already associated with a version of the secret then a new version of the secret is created. </p> </li> <li> <p>If a version with this value already exists and the version <code>SecretString</code> and <code>SecretBinary</code> values are the same as those in the request, then the request is ignored.</p> </li> <li> <p>If a version with this value already exists and that version's <code>SecretString</code> and <code>SecretBinary</code> values are different from those in the request, then the request fails because you cannot modify an existing version. Instead, use <a>PutSecretValue</a> to create a new version.</p> </li> </ul> <p>This value becomes the <code>VersionId</code> of the new version.</p>",
"idempotencyToken":true
},
"Description":{
@ -398,6 +452,14 @@
"Tags":{
"shape":"TagListType",
"documentation":"<p>(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use <a>UntagResource</a>.</p> <important> <ul> <li> <p>Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".</p> </li> <li> <p>If you check tags in IAM policy <code>Condition</code> elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an <code>Access Denied</code> error.</p> </li> </ul> </important> <p>This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json\">Using JSON for Parameters</a> in the <i>AWS CLI User Guide</i>. For example:</p> <p> <code>[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]</code> </p> <p>If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text. </p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per secret—50</p> </li> <li> <p>Maximum key length—127 Unicode characters in UTF-8</p> </li> <li> <p>Maximum value length—255 Unicode characters in UTF-8</p> </li> <li> <p>Tag keys and values are case sensitive.</p> </li> <li> <p>Do not use the <code>aws:</code> prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.</p> </li> <li> <p>If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.</p> </li> </ul>"
},
"AddReplicaRegions":{
"shape":"AddReplicaRegionListType",
"documentation":"<p>(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in the parameter.</p>"
},
"ForceOverwriteReplicaSecret":{
"shape":"BooleanType",
"documentation":"<p>(Optional) If set, the replication overwrites a secret with the same name in the destination region.</p>"
}
}
},
@ -415,6 +477,10 @@
"VersionId":{
"shape":"SecretVersionIdType",
"documentation":"<p>The unique identifier associated with the version of the secret you just created.</p>"
},
"ReplicationStatus":{
"shape":"ReplicationStatusListType",
"documentation":"<p>Describes a list of replication status objects as <code>InProgress</code>, <code>Failed</code> or <code>InSync</code>.</p>"
}
}
},
@ -456,16 +522,16 @@
"members":{
"SecretId":{
"shape":"SecretIdType",
"documentation":"<p>Specifies the secret that you want to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
"documentation":"<p>Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
},
"RecoveryWindowInDays":{
"shape":"RecoveryWindowInDaysType",
"documentation":"<p>(Optional) Specifies the number of days that Secrets Manager waits before it can delete the secret. You can't use both this parameter and the <code>ForceDeleteWithoutRecovery</code> parameter in the same API call.</p> <p>This value can range from 7 to 30 days. The default value is 30.</p>",
"documentation":"<p>(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the secret. You can't use both this parameter and the <code>ForceDeleteWithoutRecovery</code> parameter in the same API call.</p> <p>This value can range from 7 to 30 days with a default value of 30.</p>",
"box":true
},
"ForceDeleteWithoutRecovery":{
"shape":"BooleanType",
"documentation":"<p>(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the <code>RecoveryWindowInDays</code> parameter in the same API call.</p> <p>An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.</p> <important> <p>Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that AWS would normally impose with the <code>RecoveryWindowInDays</code> parameter. If you delete a secret with the <code>ForceDeleteWithouRecovery</code> parameter, then you have no opportunity to recover the secret. It is permanently lost.</p> </important>",
"documentation":"<p>(Optional) Specifies that the secret is to be deleted without any recovery window. You can't use both this parameter and the <code>RecoveryWindowInDays</code> parameter in the same API call.</p> <p>An asynchronous background process performs the actual deletion, so there can be a short delay before the operation completes. If you write code to delete and then immediately recreate a secret with the same name, ensure that your code includes appropriate back off and retry logic.</p> <important> <p>Use this parameter with caution. This parameter causes the operation to skip the normal waiting period before the permanent deletion that AWS would normally impose with the <code>RecoveryWindowInDays</code> parameter. If you delete a secret with the <code>ForceDeleteWithouRecovery</code> parameter, then you have no opportunity to recover the secret. You lose the secret permanently.</p> </important> <important> <p>If you use this parameter and include a previously deleted or nonexistent secret, the operation does not return the error <code>ResourceNotFoundException</code> in order to correctly handle retries.</p> </important>",
"box":true
}
}
@ -479,7 +545,7 @@
},
"Name":{
"shape":"SecretNameType",
"documentation":"<p>The friendly name of the secret that is now scheduled for deletion.</p>"
"documentation":"<p>The friendly name of the secret currently scheduled for deletion.</p>"
},
"DeletionDate":{
"shape":"DeletionDateType",
@ -530,11 +596,11 @@
},
"RotationRules":{
"shape":"RotationRulesType",
"documentation":"<p>A structure that contains the rotation configuration for this secret.</p>"
"documentation":"<p>A structure with the rotation configuration for this secret.</p>"
},
"LastRotatedDate":{
"shape":"LastRotatedDateType",
"documentation":"<p>The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret has never rotated.</p>",
"documentation":"<p>The last date and time that the rotation process for this secret was invoked.</p> <p>The most recent date and time that the Secrets Manager rotation process successfully completed. If the secret doesn't rotate, Secrets Manager returns a null value.</p>",
"box":true
},
"LastChangedDate":{
@ -566,8 +632,16 @@
},
"CreatedDate":{
"shape":"TimestampType",
"documentation":"<p>The date that the secret was created.</p>",
"documentation":"<p>The date you created the secret.</p>",
"box":true
},
"PrimaryRegion":{
"shape":"RegionType",
"documentation":"<p>Specifies the primary region for secret replication. </p>"
},
"ReplicationStatus":{
"shape":"ReplicationStatusListType",
"documentation":"<p>Describes a list of replication status objects as <code>InProgress</code>, <code>Failed</code> or <code>InSync</code>.<code>P</code> </p>"
}
}
},
@ -602,10 +676,10 @@
},
"Values":{
"shape":"FilterValuesStringList",
"documentation":"<p>Filters your list of secrets by a specific value.</p>"
"documentation":"<p>Filters your list of secrets by a specific value.</p> <p>You can prefix your search value with an exclamation mark (<code>!</code>) in order to perform negation filters. </p>"
}
},
"documentation":"<p>Allows you to filter your list of secrets.</p>"
"documentation":"<p>Allows you to add filters when you use the search function in Secrets Manager.</p>"
},
"FilterNameStringType":{
"type":"string",
@ -614,14 +688,14 @@
"name",
"tag-key",
"tag-value",
"primary-region",
"all"
]
},
"FilterValueStringType":{
"type":"string",
"max":512,
"min":1,
"pattern":"[a-zA-Z0-9 :_@\\/\\+\\=\\.\\-]+"
"pattern":"^\\!?[a-zA-Z0-9 :_@\\/\\+\\=\\.\\-]*$"
},
"FilterValuesStringList":{
"type":"list",
@ -724,11 +798,11 @@
},
"VersionId":{
"shape":"SecretVersionIdType",
"documentation":"<p>Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify this parameter then don't specify <code>VersionStage</code>. If you don't specify either a <code>VersionStage</code> or <code>VersionId</code> then the default is to perform the operation on the version with the <code>VersionStage</code> value of <code>AWSCURRENT</code>.</p> <p>This value is typically a <a href=\"https://wikipedia.org/wiki/Universally_unique_identifier\">UUID-type</a> value with 32 hexadecimal digits.</p>"
"documentation":"<p>Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify both this parameter and <code>VersionStage</code>, the two parameters must refer to the same secret version. If you don't specify either a <code>VersionStage</code> or <code>VersionId</code> then the default is to perform the operation on the version with the <code>VersionStage</code> value of <code>AWSCURRENT</code>.</p> <p>This value is typically a <a href=\"https://wikipedia.org/wiki/Universally_unique_identifier\">UUID-type</a> value with 32 hexadecimal digits.</p>"
},
"VersionStage":{
"shape":"SecretVersionStageType",
"documentation":"<p>Specifies the secret version that you want to retrieve by the staging label attached to the version.</p> <p>Staging labels are used to keep track of different versions during the rotation process. If you use this parameter then don't specify <code>VersionId</code>. If you don't specify either a <code>VersionStage</code> or <code>VersionId</code>, then the default is to perform the operation on the version with the <code>VersionStage</code> value of <code>AWSCURRENT</code>.</p>"
"documentation":"<p>Specifies the secret version that you want to retrieve by the staging label attached to the version.</p> <p>Staging labels are used to keep track of different versions during the rotation process. If you specify both this parameter and <code>VersionId</code>, the two parameters must refer to the same secret version . If you don't specify either a <code>VersionStage</code> or <code>VersionId</code>, then the default is to perform the operation on the version with the <code>VersionStage</code> value of <code>AWSCURRENT</code>.</p>"
}
}
},
@ -901,7 +975,7 @@
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The policy document that you provided isn't valid.</p>",
"documentation":"<p>You provided a resource-based policy with syntax errors.</p>",
"exception":true
},
"MaxResultsType":{
@ -947,7 +1021,7 @@
"members":{
"Message":{"shape":"ErrorMessage"}
},
"documentation":"<p>The resource policy did not prevent broad access to the secret.</p>",
"documentation":"<p>The BlockPublicPolicy parameter is set to true and the resource policy did not prevent broad access to the secret.</p>",
"exception":true
},
"PutResourcePolicyRequest":{
@ -959,15 +1033,15 @@
"members":{
"SecretId":{
"shape":"SecretIdType",
"documentation":"<p>Specifies the secret that you want to attach the resource-based policy to. You can specify either the ARN or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
"documentation":"<p>Specifies the secret that you want to attach the resource-based policy. You can specify either the ARN or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
},
"ResourcePolicy":{
"shape":"NonEmptyResourcePolicyType",
"documentation":"<p>A JSON-formatted string that's constructed according to the grammar and syntax for an AWS resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see <a href=\"http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json\">Using JSON for Parameters</a> in the <i>AWS CLI User Guide</i>.</p>"
"documentation":"<p>A JSON-formatted string constructed according to the grammar and syntax for an AWS resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see <a href=\"http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json\">Using JSON for Parameters</a> in the <i>AWS CLI User Guide</i>.</p>"
},
"BlockPublicPolicy":{
"shape":"BooleanType",
"documentation":"<p>Makes an optional API call to Zelkova to validate the Resource Policy to prevent broad access to your secret.</p>",
"documentation":"<p>(Optional) If you set the parameter, <code>BlockPublicPolicy</code> to true, then you block resource-based policies that allow broad access to the secret.</p>",
"box":true
}
}
@ -981,7 +1055,7 @@
},
"Name":{
"shape":"NameType",
"documentation":"<p>The friendly name of the secret that the retrieved by the resource-based policy.</p>"
"documentation":"<p>The friendly name of the secret retrieved by the resource-based policy.</p>"
}
}
},
@ -1040,6 +1114,125 @@
"sensitive":true
},
"RecoveryWindowInDaysType":{"type":"long"},
"RegionType":{
"type":"string",
"max":128,
"min":1,
"pattern":"^([a-z]+-)+\\d+$"
},
"RemoveRegionsFromReplicationRequest":{
"type":"structure",
"required":[
"SecretId",
"RemoveReplicaRegions"
],
"members":{
"SecretId":{
"shape":"SecretIdType",
"documentation":"<p>Remove a secret by <code>SecretId</code> from replica Regions.</p>"
},
"RemoveReplicaRegions":{
"shape":"RemoveReplicaRegionListType",
"documentation":"<p>Remove replication from specific Regions.</p>"
}
}
},
"RemoveRegionsFromReplicationResponse":{
"type":"structure",
"members":{
"ARN":{
"shape":"SecretARNType",
"documentation":"<p>The secret <code>ARN</code> removed from replication regions.</p>"
},
"ReplicationStatus":{
"shape":"ReplicationStatusListType",
"documentation":"<p>Describes the remaining replication status after you remove regions from the replication list.</p>"
}
}
},
"RemoveReplicaRegionListType":{
"type":"list",
"member":{"shape":"RegionType"},
"min":1
},
"ReplicaRegionType":{
"type":"structure",
"members":{
"Region":{
"shape":"RegionType",
"documentation":"<p>Describes a single instance of Region objects.</p>"
},
"KmsKeyId":{
"shape":"KmsKeyIdType",
"documentation":"<p>Can be an <code>ARN</code>, <code>Key ID</code>, or <code>Alias</code>. </p>"
}
},
"documentation":"<p>(Optional) Custom type consisting of a <code>Region</code> (required) and the <code>KmsKeyId</code> which can be an <code>ARN</code>, <code>Key ID</code>, or <code>Alias</code>.</p>"
},
"ReplicateSecretToRegionsRequest":{
"type":"structure",
"required":[
"SecretId",
"AddReplicaRegions"
],
"members":{
"SecretId":{
"shape":"SecretIdType",
"documentation":"<p>Use the <code>Secret Id</code> to replicate a secret to regions.</p>"
},
"AddReplicaRegions":{
"shape":"AddReplicaRegionListType",
"documentation":"<p>Add Regions to replicate the secret.</p>"
},
"ForceOverwriteReplicaSecret":{
"shape":"BooleanType",
"documentation":"<p>(Optional) If set, Secrets Manager replication overwrites a secret with the same name in the destination region.</p>"
}
}
},
"ReplicateSecretToRegionsResponse":{
"type":"structure",
"members":{
"ARN":{
"shape":"SecretARNType",
"documentation":"<p>Replicate a secret based on the <code>ReplicaRegionType</code>&gt; consisting of a Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias. </p>"
},
"ReplicationStatus":{
"shape":"ReplicationStatusListType",
"documentation":"<p>Describes the secret replication status as <code>PENDING</code>, <code>SUCCESS</code> or <code>FAIL</code>.</p>"
}
}
},
"ReplicationStatusListType":{
"type":"list",
"member":{"shape":"ReplicationStatusType"}
},
"ReplicationStatusType":{
"type":"structure",
"members":{
"Region":{
"shape":"RegionType",
"documentation":"<p>The Region where replication occurs.</p>"
},
"KmsKeyId":{
"shape":"KmsKeyIdType",
"documentation":"<p>Can be an <code>ARN</code>, <code>Key ID</code>, or <code>Alias</code>. </p>"
},
"Status":{
"shape":"StatusType",
"documentation":"<p>The status can be <code>InProgress</code>, <code>Failed</code>, or <code>InSync</code>.</p>"
},
"StatusMessage":{
"shape":"StatusMessageType",
"documentation":"<p>Status message such as \"<i>Secret with this name already exists in this region</i>\".</p>"
},
"LastAccessedDate":{
"shape":"LastAccessedDateType",
"documentation":"<p>The date that you last accessed the secret in the Region. </p>"
}
},
"documentation":"<p>A replication object consisting of a <code>RegionReplicationStatus</code> object and includes a Region, KMSKeyId, status, and status message.</p>"
},
"RequireEachIncludedTypeType":{"type":"boolean"},
"ResourceExistsException":{
"type":"structure",
@ -1188,7 +1381,7 @@
},
"LastRotatedDate":{
"shape":"LastRotatedDateType",
"documentation":"<p>The last date and time that the rotation process for this secret was invoked.</p>",
"documentation":"<p>The most recent date and time that the Secrets Manager rotation process was successfully completed. This value is null if the secret hasn't ever rotated.</p>",
"box":true
},
"LastChangedDate":{
@ -1221,6 +1414,10 @@
"shape":"TimestampType",
"documentation":"<p>The date and time when a secret was created.</p>",
"box":true
},
"PrimaryRegion":{
"shape":"RegionType",
"documentation":"<p>The Region where Secrets Manager originated the secret.</p>"
}
},
"documentation":"<p>A structure that contains the details about a secret. It does not include the encrypted <code>SecretString</code> and <code>SecretBinary</code> values. To get those values, use the <a>GetSecretValue</a> operation.</p>"
@ -1296,6 +1493,38 @@
"desc"
]
},
"StatusMessageType":{
"type":"string",
"max":4096,
"min":1
},
"StatusType":{
"type":"string",
"enum":[
"InSync",
"Failed",
"InProgress"
]
},
"StopReplicationToReplicaRequest":{
"type":"structure",
"required":["SecretId"],
"members":{
"SecretId":{
"shape":"SecretIdType",
"documentation":"<p>Response to <code>StopReplicationToReplica</code> of a secret, based on the <code>SecretId</code>.</p>"
}
}
},
"StopReplicationToReplicaResponse":{
"type":"structure",
"members":{
"ARN":{
"shape":"SecretARNType",
"documentation":"<p>Response <code>StopReplicationToReplica</code> of a secret, based on the <code>ARN,</code>.</p>"
}
}
},
"Tag":{
"type":"structure",
"members":{
@ -1336,7 +1565,7 @@
},
"Tags":{
"shape":"TagListType",
"documentation":"<p>The tags to attach to the secret. Each element in the list consists of a <code>Key</code> and a <code>Value</code>.</p> <p>This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json\">Using JSON for Parameters</a> in the <i>AWS CLI User Guide</i>. For the AWS CLI, you can also use the syntax: <code>--Tags Key=\"Key1\",Value=\"Value1\",Key=\"Key2\",Value=\"Value2\"[,…]</code> </p>"
"documentation":"<p>The tags to attach to the secret. Each element in the list consists of a <code>Key</code> and a <code>Value</code>.</p> <p>This parameter to the API requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json\">Using JSON for Parameters</a> in the <i>AWS CLI User Guide</i>. For the AWS CLI, you can also use the syntax: <code>--Tags Key=\"Key1\",Value=\"Value1\" Key=\"Key2\",Value=\"Value2\"[,…]</code> </p>"
}
}
},
@ -1457,11 +1686,11 @@
"members":{
"SecretId":{
"shape":"SecretIdType",
"documentation":"<p> The identifier for the secret that you want to validate a resource policy. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
"documentation":"<p> (Optional) The identifier of the secret with the resource-based policy you want to validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.</p> <note> <p>If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.</p> <p>If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you <i>must</i> not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a <i>ResourceNotFoundException</i> or an <i>AccessDeniedException</i> error, depending on your permissions.</p> </note>"
},
"ResourcePolicy":{
"shape":"NonEmptyResourcePolicyType",
"documentation":"<p>Identifies the Resource Policy attached to the secret.</p>"
"documentation":"<p>A JSON-formatted string constructed according to the grammar and syntax for an AWS resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see <a href=\"http://docs.aws.amazon.com/cli/latest/userguide/cli-using-param.html#cli-using-param-json\">Using JSON for Parameters</a> in the <i>AWS CLI User Guide</i>.publi</p>"
}
}
},

394
botocore/data/securityhub/2018-10-26/service-2.json
View file

@ -75,7 +75,7 @@
{"shape":"LimitExceededException"},
{"shape":"InvalidAccessException"}
],
"documentation":"<p>Imports security findings generated from an integrated third-party product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub.</p> <p>The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.</p> <p>After a finding is created, <code>BatchImportFindings</code> cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.</p> <ul> <li> <p> <code>Note</code> </p> </li> <li> <p> <code>UserDefinedFields</code> </p> </li> <li> <p> <code>VerificationState</code> </p> </li> <li> <p> <code>Workflow</code> </p> </li> </ul> <p> <code>BatchImportFindings</code> can be used to update the following finding fields and objects only if they have not been updated using <code>BatchUpdateFindings</code>. After they are updated using <code>BatchUpdateFindings</code>, these fields cannot be updated using <code>BatchImportFindings</code>.</p> <ul> <li> <p> <code>Confidence</code> </p> </li> <li> <p> <code>Criticality</code> </p> </li> <li> <p> <code>RelatedFindings</code> </p> </li> <li> <p> <code>Severity</code> </p> </li> <li> <p> <code>Types</code> </p> </li> </ul>"
"documentation":"<p>Imports security findings generated from an integrated product into Security Hub. This action is requested by the integrated product to import its findings into Security Hub.</p> <p>The maximum allowed size for a finding is 240 Kb. An error is returned for any finding larger than 240 Kb.</p> <p>After a finding is created, <code>BatchImportFindings</code> cannot be used to update the following finding fields and objects, which Security Hub customers use to manage their investigation workflow.</p> <ul> <li> <p> <code>Note</code> </p> </li> <li> <p> <code>UserDefinedFields</code> </p> </li> <li> <p> <code>VerificationState</code> </p> </li> <li> <p> <code>Workflow</code> </p> </li> </ul> <p>Finding providers also should not use <code>BatchImportFindings</code> to update the following attributes.</p> <ul> <li> <p> <code>Confidence</code> </p> </li> <li> <p> <code>Criticality</code> </p> </li> <li> <p> <code>RelatedFindings</code> </p> </li> <li> <p> <code>Severity</code> </p> </li> <li> <p> <code>Types</code> </p> </li> </ul> <p>Instead, finding providers use <code>FindingProviderFields</code> to provide values for these attributes.</p>"
},
"BatchUpdateFindings":{
"name":"BatchUpdateFindings",
@ -290,7 +290,7 @@
{"shape":"InvalidAccessException"},
{"shape":"InvalidInputException"}
],
"documentation":"<p>Returns information about the available products that you can subscribe to and integrate with Security Hub in order to consolidate findings.</p>"
"documentation":"<p>Returns information about product integrations in Security Hub.</p> <p>You can optionally provide an integration ARN. If you provide an integration ARN, then the results only include that integration.</p> <p>If you do not provide an integration ARN, then the results include all of the available product integrations. </p>"
},
"DescribeStandards":{
"name":"DescribeStandards",
@ -879,7 +879,7 @@
"documentation":"<p>Included if <code>ActionType</code> is <code>PORT_PROBE</code>. Provides details about the port probe that was detected. </p>"
}
},
"documentation":"<p>Provides details about one of the following actions that were detected for the finding:</p> <ul> <li> <p>A remote IP address issued an AWS API call</p> </li> <li> <p>A DNS request was received</p> </li> <li> <p>A remote IP address attempted to connect to an EC2 instance</p> </li> <li> <p>A remote IP address attempted a port probe on an EC2 instance</p> </li> </ul>"
"documentation":"<p>Provides details about one of the following actions that affects or that was taken on a resource:</p> <ul> <li> <p>A remote IP address issued an AWS API call</p> </li> <li> <p>A DNS request was received</p> </li> <li> <p>A remote IP address attempted to connect to an EC2 instance</p> </li> <li> <p>A remote IP address attempted a port probe on an EC2 instance</p> </li> </ul>"
},
"ActionLocalIpDetails":{
"type":"structure",
@ -5434,6 +5434,28 @@
"type":"list",
"member":{"shape":"AwsRedshiftClusterVpcSecurityGroup"}
},
"AwsS3AccountPublicAccessBlockDetails":{
"type":"structure",
"members":{
"BlockPublicAcls":{
"shape":"Boolean",
"documentation":"<p>Indicates whether to reject calls to update an S3 bucket if the calls include a public access control list (ACL).</p>"
},
"BlockPublicPolicy":{
"shape":"Boolean",
"documentation":"<p>Indicates whether to reject calls to update the access policy for an S3 bucket or access point if the policy allows public access.</p>"
},
"IgnorePublicAcls":{
"shape":"Boolean",
"documentation":"<p>Indicates whether Amazon S3 ignores public ACLs that are associated with an S3 bucket.</p>"
},
"RestrictPublicBuckets":{
"shape":"Boolean",
"documentation":"<p>Indicates whether to restrict access to an access point or S3 bucket that has a public policy to only AWS service principals and authorized users within the S3 bucket owner's account.</p>"
}
},
"documentation":"<p>provides information about the Amazon S3 Public Access Block configuration for accounts.</p>"
},
"AwsS3BucketDetails":{
"type":"structure",
"members":{
@ -5452,6 +5474,10 @@
"ServerSideEncryptionConfiguration":{
"shape":"AwsS3BucketServerSideEncryptionConfiguration",
"documentation":"<p>The encryption rules that are applied to the S3 bucket.</p>"
},
"PublicAccessBlockConfiguration":{
"shape":"AwsS3AccountPublicAccessBlockDetails",
"documentation":"<p>Provides information about the Amazon S3 Public Access Block configuration for the S3 bucket.</p>"
}
},
"documentation":"<p>The details of an Amazon S3 bucket.</p>"
@ -5580,10 +5606,8 @@
"ProductArn",
"GeneratorId",
"AwsAccountId",
"Types",
"CreatedAt",
"UpdatedAt",
"Severity",
"Title",
"Description",
"Resources"
@ -5727,7 +5751,11 @@
},
"Action":{
"shape":"Action",
"documentation":"<p>Provides details about an action that was detected for the finding.</p>"
"documentation":"<p>Provides details about an action that affects or that was taken on a resource.</p>"
},
"FindingProviderFields":{
"shape":"FindingProviderFields",
"documentation":"<p>In a <code>BatchImportFindings</code> request, finding providers use <code>FindingProviderFields</code> to provide and update their own values for confidence, criticality, related findings, severity, and types.</p>"
}
},
"documentation":"<p>Provides consistent format for the contents of the Security Hub-aggregated findings. <code>AwsSecurityFinding</code> format enables you to share findings between AWS security services and third-party solutions, and security standards checks.</p> <note> <p>A finding is a potential security issue generated either by AWS services (Amazon GuardDuty, Amazon Inspector, and Amazon Macie) or by the integrated third-party solutions and standards checks.</p> </note>"
@ -5773,11 +5801,15 @@
},
"SeverityProduct":{
"shape":"NumberFilterList",
"documentation":"<p>The native severity as defined by the security-findings provider's solution that generated the finding.</p>"
"documentation":"<p>The native severity as defined by the security-findings provider's solution that generated the finding.</p>",
"deprecated":true,
"deprecatedMessage":"This filter is deprecated, use FindingProviiltersSeverityOriginal instead."
},
"SeverityNormalized":{
"shape":"NumberFilterList",
"documentation":"<p>The normalized severity of a finding.</p>"
"documentation":"<p>The normalized severity of a finding.</p>",
"deprecated":true,
"deprecatedMessage":"This filter is deprecated, use SeverityLabel or FindingProviderFieldsSeverityLabel instead."
},
"SeverityLabel":{
"shape":"StringFilterList",
@ -6070,6 +6102,34 @@
"Keyword":{
"shape":"KeywordFilterList",
"documentation":"<p>A keyword for a finding.</p>"
},
"FindingProviderFieldsConfidence":{
"shape":"NumberFilterList",
"documentation":"<p>The finding provider value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.</p> <p>Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.</p>"
},
"FindingProviderFieldsCriticality":{
"shape":"NumberFilterList",
"documentation":"<p>The finding provider value for the level of importance assigned to the resources associated with the findings.</p> <p>A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources. </p>"
},
"FindingProviderFieldsRelatedFindingsId":{
"shape":"StringFilterList",
"documentation":"<p>The finding identifier of a related finding that is identified by the finding provider.</p>"
},
"FindingProviderFieldsRelatedFindingsProductArn":{
"shape":"StringFilterList",
"documentation":"<p>The ARN of the solution that generated a related finding that is identified by the finding provider.</p>"
},
"FindingProviderFieldsSeverityLabel":{
"shape":"StringFilterList",
"documentation":"<p>The finding provider value for the severity label.</p>"
},
"FindingProviderFieldsSeverityOriginal":{
"shape":"StringFilterList",
"documentation":"<p>The finding provider's original value for the severity.</p>"
},
"FindingProviderFieldsTypes":{
"shape":"StringFilterList",
"documentation":"<p>One or more finding types that the finding provider assigned to the finding. Uses the format of <code>namespace/category/classifier</code> that classify a finding.</p> <p>Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications</p>"
}
},
"documentation":"<p>A collection of attributes that are applied to all active Security Hub-aggregated findings and that result in a subset of findings that are included in this insight.</p> <p>You can filter by up to 10 finding attributes. For each attribute, you can provide up to 20 filter values.</p>"
@ -6359,11 +6419,17 @@
"required":["Findings"],
"members":{
"Findings":{
"shape":"AwsSecurityFindingList",
"shape":"BatchImportFindingsRequestFindingList",
"documentation":"<p>A list of findings to import. To successfully import a finding, it must follow the <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html\">AWS Security Finding Format</a>. Maximum of 100 findings per request.</p>"
}
}
},
"BatchImportFindingsRequestFindingList":{
"type":"list",
"member":{"shape":"AwsSecurityFinding"},
"max":100,
"min":1
},
"BatchImportFindingsResponse":{
"type":"structure",
"required":[
@ -6477,6 +6543,32 @@
"type":"list",
"member":{"shape":"NonEmptyString"}
},
"Cell":{
"type":"structure",
"members":{
"Column":{
"shape":"Long",
"documentation":"<p>The column number of the column that contains the data. For a Microsoft Excel workbook, the column number corresponds to the alphabetical column identifiers. For example, a value of 1 for Column corresponds to the A column in the workbook.</p>"
},
"Row":{
"shape":"Long",
"documentation":"<p>The row number of the row that contains the data.</p>"
},
"ColumnName":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the column that contains the data.</p>"
},
"CellReference":{
"shape":"NonEmptyString",
"documentation":"<p>For a Microsoft Excel workbook, provides the location of the cell, as an absolute cell reference, that contains the data. For example, Sheet2!C5 for cell C5 on Sheet2.</p>"
}
},
"documentation":"<p>An occurrence of sensitive data detected in a Microsoft Excel workbook, comma-separated value (CSV) file, or tab-separated value (TSV) file.</p>"
},
"Cells":{
"type":"list",
"member":{"shape":"Cell"}
},
"CidrBlockAssociation":{
"type":"structure",
"members":{
@ -6509,6 +6601,50 @@
},
"documentation":"<p>Information about a city.</p>"
},
"ClassificationResult":{
"type":"structure",
"members":{
"MimeType":{
"shape":"NonEmptyString",
"documentation":"<p>The type of content that the finding applies to.</p>"
},
"SizeClassified":{
"shape":"Long",
"documentation":"<p>The total size in bytes of the affected data.</p>"
},
"AdditionalOccurrences":{
"shape":"Boolean",
"documentation":"<p>Indicates whether there are additional occurrences of sensitive data that are not included in the finding. This occurs when the number of occurrences exceeds the maximum that can be included.</p>"
},
"Status":{
"shape":"ClassificationStatus",
"documentation":"<p>The current status of the sensitive data detection.</p>"
},
"SensitiveData":{
"shape":"SensitiveDataResultList",
"documentation":"<p>Provides details about sensitive data that was identified based on built-in configuration.</p>"
},
"CustomDataIdentifiers":{
"shape":"CustomDataIdentifiersResult",
"documentation":"<p>Provides details about sensitive data that was identified based on customer-defined configuration.</p>"
}
},
"documentation":"<p>Details about the sensitive data that was detected on the resource.</p>"
},
"ClassificationStatus":{
"type":"structure",
"members":{
"Code":{
"shape":"NonEmptyString",
"documentation":"<p>The code that represents the status of the sensitive data detection.</p>"
},
"Reason":{
"shape":"NonEmptyString",
"documentation":"<p>A longer description of the current status of the sensitive data detection.</p>"
}
},
"documentation":"<p>Provides details about the current status of the sensitive data detection.</p>"
},
"Compliance":{
"type":"structure",
"members":{
@ -6667,6 +6803,46 @@
"max":50,
"min":1
},
"CustomDataIdentifiersDetections":{
"type":"structure",
"members":{
"Count":{
"shape":"Long",
"documentation":"<p>The total number of occurrences of sensitive data that were detected.</p>"
},
"Arn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the custom identifier that was used to detect the sensitive data.</p>"
},
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>he name of the custom identifier that detected the sensitive data.</p>"
},
"Occurrences":{
"shape":"Occurrences",
"documentation":"<p>Details about the sensitive data that was detected.</p>"
}
},
"documentation":"<p>The list of detected instances of sensitive data.</p>"
},
"CustomDataIdentifiersDetectionsList":{
"type":"list",
"member":{"shape":"CustomDataIdentifiersDetections"}
},
"CustomDataIdentifiersResult":{
"type":"structure",
"members":{
"Detections":{
"shape":"CustomDataIdentifiersDetectionsList",
"documentation":"<p>The list of detected instances of sensitive data.</p>"
},
"TotalCount":{
"shape":"Long",
"documentation":"<p>The total number of occurrences of sensitive data.</p>"
}
},
"documentation":"<p>Contains an instance of sensitive data that was detected by a customer-defined identifier.</p>"
},
"Cvss":{
"type":"structure",
"members":{
@ -6689,6 +6865,20 @@
"type":"list",
"member":{"shape":"Cvss"}
},
"DataClassificationDetails":{
"type":"structure",
"members":{
"DetailedResultsLocation":{
"shape":"NonEmptyString",
"documentation":"<p>The path to the folder or file that contains the sensitive data.</p>"
},
"Result":{
"shape":"ClassificationResult",
"documentation":"<p>The details about the sensitive data that was detected on the resource.</p>"
}
},
"documentation":"<p>Provides details about sensitive data that was detected on a resource.</p>"
},
"DateFilter":{
"type":"structure",
"members":{
@ -6921,6 +7111,12 @@
"documentation":"<p>The maximum number of results to return.</p>",
"location":"querystring",
"locationName":"MaxResults"
},
"ProductArn":{
"shape":"NonEmptyString",
"documentation":"<p>The ARN of the integration to return.</p>",
"location":"querystring",
"locationName":"ProductArn"
}
}
},
@ -7148,6 +7344,46 @@
"key":{"shape":"NonEmptyString"},
"value":{"shape":"NonEmptyString"}
},
"FindingProviderFields":{
"type":"structure",
"members":{
"Confidence":{
"shape":"RatioScale",
"documentation":"<p>A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.</p> <p>Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.</p>"
},
"Criticality":{
"shape":"RatioScale",
"documentation":"<p>The level of importance assigned to the resources associated with the finding.</p> <p>A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.</p>"
},
"RelatedFindings":{
"shape":"RelatedFindingList",
"documentation":"<p>A list of findings that are related to the current finding.</p>"
},
"Severity":{
"shape":"FindingProviderSeverity",
"documentation":"<p>The severity of a finding.</p>"
},
"Types":{
"shape":"TypeList",
"documentation":"<p>One or more finding types in the format of <code>namespace/category/classifier</code> that classify a finding.</p> <p>Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications</p>"
}
},
"documentation":"<p>In a <code>BatchImportFindings</code> request, finding providers use <code>FindingProviderFields</code> to provide and update values for confidence, criticality, related findings, severity, and types.</p>"
},
"FindingProviderSeverity":{
"type":"structure",
"members":{
"Label":{
"shape":"SeverityLabel",
"documentation":"<p>The severity label assigned to the finding by the finding provider.</p>"
},
"Original":{
"shape":"NonEmptyString",
"documentation":"<p>The finding provider's original value for the severity.</p>"
}
},
"documentation":"<p>The severity assigned to the finding by the finding provider.</p>"
},
"GeoLocation":{
"type":"structure",
"members":{
@ -8110,6 +8346,54 @@
"type":"list",
"member":{"shape":"NumberFilter"}
},
"Occurrences":{
"type":"structure",
"members":{
"LineRanges":{
"shape":"Ranges",
"documentation":"<p>Occurrences of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.</p>"
},
"OffsetRanges":{
"shape":"Ranges",
"documentation":"<p>Occurrences of sensitive data detected in a binary text file.</p>"
},
"Pages":{
"shape":"Pages",
"documentation":"<p>Occurrences of sensitive data in an Adobe Portable Document Format (PDF) file.</p>"
},
"Records":{
"shape":"Records",
"documentation":"<p>Occurrences of sensitive data in an Apache Avro object container or an Apache Parquet file.</p>"
},
"Cells":{
"shape":"Cells",
"documentation":"<p>Occurrences of sensitive data detected in Microsoft Excel workbooks, comma-separated value (CSV) files, or tab-separated value (TSV) files.</p>"
}
},
"documentation":"<p>The detected occurrences of sensitive data.</p>"
},
"Page":{
"type":"structure",
"members":{
"PageNumber":{
"shape":"Long",
"documentation":"<p>The page number of the page that contains the sensitive data.</p>"
},
"LineRange":{
"shape":"Range",
"documentation":"<p>An occurrence of sensitive data detected in a non-binary text file or a Microsoft Word file. Non-binary text files include files such as HTML, XML, JSON, and TXT files.</p>"
},
"OffsetRange":{
"shape":"Range",
"documentation":"<p>An occurrence of sensitive data detected in a binary text file.</p>"
}
},
"documentation":"<p>An occurrence of sensitive data in an Adobe Portable Document Format (PDF) file.</p>"
},
"Pages":{
"type":"list",
"member":{"shape":"Page"}
},
"Partition":{
"type":"string",
"enum":[
@ -8304,6 +8588,28 @@
"type":"list",
"member":{"shape":"Product"}
},
"Range":{
"type":"structure",
"members":{
"Start":{
"shape":"Long",
"documentation":"<p>The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.</p>"
},
"End":{
"shape":"Long",
"documentation":"<p>The number of lines (for a line range) or characters (for an offset range) from the beginning of the file to the end of the sensitive data.</p>"
},
"StartColumn":{
"shape":"Long",
"documentation":"<p>In the line where the sensitive data starts, the column within the line where the sensitive data starts.</p>"
}
},
"documentation":"<p>Identifies where the sensitive data begins and ends.</p>"
},
"Ranges":{
"type":"list",
"member":{"shape":"Range"}
},
"RatioScale":{
"type":"integer",
"max":100,
@ -8323,6 +8629,20 @@
},
"documentation":"<p>A recommendation on how to remediate the issue identified in a finding.</p>"
},
"Record":{
"type":"structure",
"members":{
"JsonPath":{
"shape":"NonEmptyString",
"documentation":"<p>The path, as a JSONPath expression, to the field in the record that contains the data. If the field name is longer than 20 characters, it is truncated. If the path is longer than 250 characters, it is truncated.</p>"
},
"RecordIndex":{
"shape":"Long",
"documentation":"<p>The record index, starting from 0, for the record that contains the data.</p>"
}
},
"documentation":"<p>An occurrence of sensitive data in an Apache Avro object container or an Apache Parquet file.</p>"
},
"RecordState":{
"type":"string",
"enum":[
@ -8330,6 +8650,10 @@
"ARCHIVED"
]
},
"Records":{
"type":"list",
"member":{"shape":"Record"}
},
"RelatedFinding":{
"type":"structure",
"required":[
@ -8397,6 +8721,10 @@
"shape":"FieldMap",
"documentation":"<p>A list of AWS tags associated with a resource at the time the finding was processed.</p>"
},
"DataClassification":{
"shape":"DataClassificationDetails",
"documentation":"<p>Contains information about sensitive data that was detected on the resource.</p>"
},
"Details":{
"shape":"ResourceDetails",
"documentation":"<p>Additional details about the resource related to a finding.</p>"
@ -8469,6 +8797,10 @@
"shape":"AwsS3BucketDetails",
"documentation":"<p>Details about an Amazon S3 bucket related to a finding.</p>"
},
"AwsS3AccountPublicAccessBlock":{
"shape":"AwsS3AccountPublicAccessBlockDetails",
"documentation":"<p>Details about the Amazon S3 Public Access Block configuration for an account.</p>"
},
"AwsS3Object":{
"shape":"AwsS3ObjectDetails",
"documentation":"<p>Details about an Amazon S3 object related to a finding.</p>"
@ -8624,6 +8956,50 @@
"type":"list",
"member":{"shape":"NonEmptyString"}
},
"SensitiveDataDetections":{
"type":"structure",
"members":{
"Count":{
"shape":"Long",
"documentation":"<p>The total number of occurrences of sensitive data that were detected.</p>"
},
"Type":{
"shape":"NonEmptyString",
"documentation":"<p>The type of sensitive data that was detected. For example, the type might indicate that the data is an email address.</p>"
},
"Occurrences":{
"shape":"Occurrences",
"documentation":"<p>Details about the sensitive data that was detected.</p>"
}
},
"documentation":"<p>The list of detected instances of sensitive data.</p>"
},
"SensitiveDataDetectionsList":{
"type":"list",
"member":{"shape":"SensitiveDataDetections"}
},
"SensitiveDataResult":{
"type":"structure",
"members":{
"Category":{
"shape":"NonEmptyString",
"documentation":"<p>The category of sensitive data that was detected. For example, the category can indicate that the sensitive data involved credentials, financial information, or personal information.</p>"
},
"Detections":{
"shape":"SensitiveDataDetectionsList",
"documentation":"<p>The list of detected instances of sensitive data.</p>"
},
"TotalCount":{
"shape":"Long",
"documentation":"<p>The total number of occurrences of sensitive data.</p>"
}
},
"documentation":"<p>Contains a detected instance of sensitive data that are based on built-in identifiers.</p>"
},
"SensitiveDataResultList":{
"type":"list",
"member":{"shape":"SensitiveDataResult"}
},
"Severity":{
"type":"structure",
"members":{

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

@ -393,7 +393,7 @@
"required":["Name"],
"members":{
"Name":{
"shape":"NamespaceName",
"shape":"NamespaceNameHttp",
"documentation":"<p>The name that you want to assign to this namespace.</p>"
},
"CreatorRequestId":{
@ -428,7 +428,7 @@
],
"members":{
"Name":{
"shape":"NamespaceName",
"shape":"NamespaceNamePrivate",
"documentation":"<p>The name that you want to assign to this namespace. When you create a private DNS namespace, AWS Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.</p>"
},
"CreatorRequestId":{
@ -464,7 +464,7 @@
"required":["Name"],
"members":{
"Name":{
"shape":"NamespaceName",
"shape":"NamespaceNamePublic",
"documentation":"<p>The name that you want to assign to this namespace.</p>"
},
"CreatorRequestId":{
@ -497,7 +497,7 @@
"members":{
"Name":{
"shape":"ServiceName",
"documentation":"<p>The name that you want to assign to the service.</p> <p>If you want AWS Cloud Map to create an <code>SRV</code> record when you register an instance, and if you're using a system that requires a specific <code>SRV</code> format, such as <a href=\"http://www.haproxy.org/\">HAProxy</a>, specify the following for <code>Name</code>:</p> <ul> <li> <p>Start the name with an underscore (_), such as <code>_exampleservice</code> </p> </li> <li> <p>End the name with <i>._protocol</i>, such as <code>._tcp</code> </p> </li> </ul> <p>When you register an instance, AWS Cloud Map creates an <code>SRV</code> record and assigns a name to the record by concatenating the service name and the namespace name, for example:</p> <p> <code>_exampleservice._tcp.example.com</code> </p>"
"documentation":"<p>The name that you want to assign to the service.</p> <p>If you want AWS Cloud Map to create an <code>SRV</code> record when you register an instance, and if you're using a system that requires a specific <code>SRV</code> format, such as <a href=\"http://www.haproxy.org/\">HAProxy</a>, specify the following for <code>Name</code>:</p> <ul> <li> <p>Start the name with an underscore (_), such as <code>_exampleservice</code> </p> </li> <li> <p>End the name with <i>._protocol</i>, such as <code>._tcp</code> </p> </li> </ul> <p>When you register an instance, AWS Cloud Map creates an <code>SRV</code> record and assigns a name to the record by concatenating the service name and the namespace name, for example:</p> <p> <code>_exampleservice._tcp.example.com</code> </p> <note> <p>For a single DNS namespace, you cannot create two services with names that differ only by case (such as EXAMPLE and example). Otherwise, these services will have the same DNS name. However, you can create multiple HTTP services with names that differ only by case because HTTP services are case sensitive.</p> </note>"
},
"NamespaceId":{
"shape":"ResourceId",
@ -527,6 +527,10 @@
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags to add to the service. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.</p>"
},
"Type":{
"shape":"ServiceTypeOption",
"documentation":"<p>If present, specifies that the service instances are only discoverable using the <code>DiscoverInstances</code> API operation. No DNS records will be registered for the service instances. The only valid value is <code>HTTP</code>.</p>"
}
}
},
@ -902,7 +906,9 @@
"members":{
"FailureThreshold":{
"shape":"FailureThreshold",
"documentation":"<important> <p>This parameter has been deprecated and is always set to 1. AWS Cloud Map waits for approximately 30 seconds after receiving an <code>UpdateInstanceCustomHealthStatus</code> request before changing the status of the service instance.</p> </important> <p>The number of 30-second intervals that you want AWS Cloud Map to wait after receiving an <code>UpdateInstanceCustomHealthStatus</code> request before it changes the health status of a service instance.</p> <p>Sending a second or subsequent <code>UpdateInstanceCustomHealthStatus</code> request with the same value before 30 seconds has passed doesn't accelerate the change. AWS Cloud Map still waits <code>30</code> seconds after the first request to make the change.</p>"
"documentation":"<important> <p>This parameter has been deprecated and is always set to 1. AWS Cloud Map waits for approximately 30 seconds after receiving an <code>UpdateInstanceCustomHealthStatus</code> request before changing the status of the service instance.</p> </important> <p>The number of 30-second intervals that you want AWS Cloud Map to wait after receiving an <code>UpdateInstanceCustomHealthStatus</code> request before it changes the health status of a service instance.</p> <p>Sending a second or subsequent <code>UpdateInstanceCustomHealthStatus</code> request with the same value before 30 seconds has passed doesn't accelerate the change. AWS Cloud Map still waits <code>30</code> seconds after the first request to make the change.</p>",
"deprecated":true,
"deprecatedMessage":"Configurable FailureThreshold of HealthCheckCustomConfig is deprecated. It will always have value 1."
}
},
"documentation":"<p>A complex type that contains information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:</p> <ul> <li> <p>You can't use a health check that is defined by <code>HealthCheckConfig</code> because the resource isn't available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)</p> </li> <li> <p>You want to use a third-party health checker regardless of where your resources are.</p> </li> </ul> <important> <p>If you specify a health check configuration, you can specify either <code>HealthCheckCustomConfig</code> or <code>HealthCheckConfig</code> but not both.</p> </important> <p>To change the status of a custom health check, submit an <code>UpdateInstanceCustomHealthStatus</code> request. AWS Cloud Map doesn't monitor the status of the resource, it just keeps a record of the status specified in the most recent <code>UpdateInstanceCustomHealthStatus</code> request.</p> <p>Here's how custom health checks work:</p> <ol> <li> <p>You create a service and specify a value for <code>FailureThreshold</code>. </p> <p>The failure threshold indicates the number of 30-second intervals you want AWS Cloud Map to wait between the time that your application sends an <a href=\"https://docs.aws.amazon.com/cloud-map/latest/api/API_UpdateInstanceCustomHealthStatus.html\">UpdateInstanceCustomHealthStatus</a> request and the time that AWS Cloud Map stops routing internet traffic to the corresponding resource.</p> </li> <li> <p>You register an instance.</p> </li> <li> <p>You configure a third-party health checker to monitor the resource that is associated with the new instance. </p> <note> <p>AWS Cloud Map doesn't check the health of the resource directly. </p> </note> </li> <li> <p>The third-party health-checker determines that the resource is unhealthy and notifies your application.</p> </li> <li> <p>Your application submits an <code>UpdateInstanceCustomHealthStatus</code> request.</p> </li> <li> <p>AWS Cloud Map waits for (<code>FailureThreshold</code> x 30) seconds.</p> </li> <li> <p>If another <code>UpdateInstanceCustomHealthStatus</code> request doesn't arrive during that time to change the status back to healthy, AWS Cloud Map stops routing traffic to the resource.</p> </li> </ol>"
@ -939,7 +945,7 @@
"documentation":"<p>The ID of an instance that matches the values that you specified in the request.</p>"
},
"NamespaceName":{
"shape":"NamespaceName",
"shape":"NamespaceNameHttp",
"documentation":"<p>The name of the namespace that you specified when you registered the instance.</p>"
},
"ServiceName":{
@ -1272,6 +1278,21 @@
"type":"string",
"max":1024
},
"NamespaceNameHttp":{
"type":"string",
"max":1024,
"pattern":"^[!-~]{1,1024}$"
},
"NamespaceNamePrivate":{
"type":"string",
"max":1024,
"pattern":"^[!-~]{1,1024}$"
},
"NamespaceNamePublic":{
"type":"string",
"max":1024,
"pattern":"^([a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?\\.)+[a-zA-Z0-9]([a-zA-Z0-9\\-]{0,61}[a-zA-Z0-9])?$"
},
"NamespaceNotFound":{
"type":"structure",
"members":{
@ -1614,6 +1635,10 @@
"shape":"DnsConfig",
"documentation":"<p>A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.</p>"
},
"Type":{
"shape":"ServiceType",
"documentation":"<p>Describes the systems that can be used to discover the service instances.</p> <dl> <dt>DNS_HTTP</dt> <dd> <p>The service instances can be discovered using either DNS queries or the <code>DiscoverInstances</code> API operation.</p> </dd> <dt>HTTP</dt> <dd> <p>The service instances can only be discovered using the <code>DiscoverInstances</code> API operation.</p> </dd> <dt>DNS</dt> <dd> <p>Reserved.</p> </dd> </dl>"
},
"HealthCheckConfig":{
"shape":"HealthCheckConfig",
"documentation":"<p> <i>Public DNS and HTTP namespaces only.</i> A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with 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/\">Amazon Route 53 Pricing</a>.</p>"
@ -1725,6 +1750,10 @@
"shape":"ServiceName",
"documentation":"<p>The name of the service.</p>"
},
"Type":{
"shape":"ServiceType",
"documentation":"<p>Describes the systems that can be used to discover the service instances.</p> <dl> <dt>DNS_HTTP</dt> <dd> <p>The service instances can be discovered using either DNS queries or the <code>DiscoverInstances</code> API operation.</p> </dd> <dt>HTTP</dt> <dd> <p>The service instances can only be discovered using the <code>DiscoverInstances</code> API operation.</p> </dd> <dt>DNS</dt> <dd> <p>Reserved.</p> </dd> </dl>"
},
"Description":{
"shape":"ResourceDescription",
"documentation":"<p>The description that you specify when you create the service.</p>"
@ -1743,6 +1772,18 @@
},
"documentation":"<p>A complex type that contains information about a specified service.</p>"
},
"ServiceType":{
"type":"string",
"enum":[
"HTTP",
"DNS_HTTP",
"DNS"
]
},
"ServiceTypeOption":{
"type":"string",
"enum":["HTTP"]
},
"Tag":{
"type":"structure",
"required":[

166
botocore/data/shield/2016-06-02/service-2.json
View file

@ -437,6 +437,53 @@
],
"documentation":"<p>Retrieves the resources that are included in the protection group. </p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidResourceException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS Shield.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidResourceException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Adds or updates tags for a resource in AWS Shield.</p>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"POST",
"requestUri":"/"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"InternalErrorException"},
{"shape":"InvalidResourceException"},
{"shape":"InvalidParameterException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Removes tags from a resource in AWS Shield.</p>"
},
"UpdateEmergencyContactSettings":{
"name":"UpdateEmergencyContactSettings",
"http":{
@ -813,6 +860,10 @@
"Members":{
"shape":"ProtectionGroupMembers",
"documentation":"<p>The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set <code>Pattern</code> to <code>ARBITRARY</code> and you must not set it for any other <code>Pattern</code> setting. </p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>One or more tag key-value pairs for the protection group.</p>"
}
}
},
@ -835,6 +886,10 @@
"ResourceArn":{
"shape":"ResourceArn",
"documentation":"<p>The ARN (Amazon Resource Name) of the resource to be protected.</p> <p>The ARN should be in one of the following formats:</p> <ul> <li> <p>For an Application Load Balancer: <code>arn:aws:elasticloadbalancing:<i>region</i>:<i>account-id</i>:loadbalancer/app/<i>load-balancer-name</i>/<i>load-balancer-id</i> </code> </p> </li> <li> <p>For an Elastic Load Balancer (Classic Load Balancer): <code>arn:aws:elasticloadbalancing:<i>region</i>:<i>account-id</i>:loadbalancer/<i>load-balancer-name</i> </code> </p> </li> <li> <p>For an AWS CloudFront distribution: <code>arn:aws:cloudfront::<i>account-id</i>:distribution/<i>distribution-id</i> </code> </p> </li> <li> <p>For an AWS Global Accelerator accelerator: <code>arn:aws:globalaccelerator::<i>account-id</i>:accelerator/<i>accelerator-id</i> </code> </p> </li> <li> <p>For Amazon Route 53: <code>arn:aws:route53:::hostedzone/<i>hosted-zone-id</i> </code> </p> </li> <li> <p>For an Elastic IP address: <code>arn:aws:ec2:<i>region</i>:<i>account-id</i>:eip-allocation/<i>allocation-id</i> </code> </p> </li> </ul>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>One or more tag key-value pairs for the <a>Protection</a> object that is created.</p>"
}
}
},
@ -1357,6 +1412,25 @@
}
}
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["ResourceARN"],
"members":{
"ResourceARN":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource to get tags for.</p>"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"Tags":{
"shape":"TagList",
"documentation":"<p>A list of tag key and value pairs associated with the specified resource.</p>"
}
}
},
"LockedSubscriptionException":{
"type":"structure",
"members":{
@ -1457,6 +1531,10 @@
"HealthCheckIds":{
"shape":"HealthCheckIds",
"documentation":"<p>The unique identifier (ID) for the Route 53 health check that's associated with the protection. </p>"
},
"ProtectionArn":{
"shape":"ResourceArn",
"documentation":"<p>The ARN (Amazon Resource Name) of the protection.</p>"
}
},
"documentation":"<p>An object that represents a resource that is under DDoS protection.</p>"
@ -1489,6 +1567,10 @@
"Members":{
"shape":"ProtectionGroupMembers",
"documentation":"<p>The Amazon Resource Names (ARNs) of the resources to include in the protection group. You must set this when you set <code>Pattern</code> to <code>ARBITRARY</code> and you must not set it for any other <code>Pattern</code> setting. </p>"
},
"ProtectionGroupArn":{
"shape":"ResourceArn",
"documentation":"<p>The ARN (Amazon Resource Name) of the protection group.</p>"
}
},
"documentation":"<p>A grouping of protected resources that you and AWS Shield Advanced can monitor as a collective. This resource grouping improves the accuracy of detection and reduces false positives. </p>"
@ -1701,6 +1783,10 @@
"SubscriptionLimits":{
"shape":"SubscriptionLimits",
"documentation":"<p>Limits settings for your subscription. </p>"
},
"SubscriptionArn":{
"shape":"ResourceArn",
"documentation":"<p>The ARN (Amazon Resource Name) of the subscription.</p>"
}
},
"documentation":"<p>Information about the AWS Shield Advanced subscription for an account.</p>"
@ -1783,6 +1869,64 @@
"type":"list",
"member":{"shape":"SummarizedCounter"}
},
"Tag":{
"type":"structure",
"members":{
"Key":{
"shape":"TagKey",
"documentation":"<p>Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as \"customer.\" Tag keys are case-sensitive.</p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p>Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive.</p>"
}
},
"documentation":"<p>A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.</p>"
},
"TagKey":{
"type":"string",
"max":128,
"min":1
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":200,
"min":0
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"},
"max":200,
"min":0
},
"TagResourceRequest":{
"type":"structure",
"required":[
"ResourceARN",
"Tags"
],
"members":{
"ResourceARN":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource that you want to add or update tags for.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags that you want to modify or add to the resource.</p>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
}
},
"TagValue":{
"type":"string",
"max":256,
"min":0
},
"TimeRange":{
"type":"structure",
"members":{
@ -1817,6 +1961,28 @@
"REQUESTS"
]
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"ResourceARN",
"TagKeys"
],
"members":{
"ResourceARN":{
"shape":"ResourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource that you want to remove tags from.</p>"
},
"TagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The tag key for each tag that you want to remove from the resource.</p>"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
}
},
"UpdateEmergencyContactSettingsRequest":{
"type":"structure",
"members":{

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

@ -2182,7 +2182,7 @@
},
"ResourceId":{
"shape":"ResourceId",
"documentation":"<p>The resource ID you want to tag.</p> <p>Use the ID of the resource. Here are some examples:</p> <p>ManagedInstance: mi-012345abcde</p> <p>MaintenanceWindow: mw-012345abcde</p> <p>PatchBaseline: pb-012345abcde</p> <p>For the Document and Parameter values, use the name of the resource.</p> <note> <p>The ManagedInstance type for this API action is only for on-premises managed instances. You must specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.</p> </note>"
"documentation":"<p>The resource ID you want to tag.</p> <p>Use the ID of the resource. Here are some examples:</p> <p>ManagedInstance: mi-012345abcde</p> <p>MaintenanceWindow: mw-012345abcde</p> <p>PatchBaseline: pb-012345abcde</p> <p>OpsMetadata object: <code>ResourceID</code> for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, <code>ResourceID</code> is created from the strings that come after the word <code>opsmetadata</code> in the ARN. For example, an OpsMetadata object with an ARN of <code>arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager</code> has a <code>ResourceID</code> of either <code>aws/ssm/MyGroup/appmanager</code> or <code>/aws/ssm/MyGroup/appmanager</code>.</p> <p>For the Document and Parameter values, use the name of the resource.</p> <note> <p>The ManagedInstance type for this API action is only for on-premises managed instances. You must specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.</p> </note>"
},
"Tags":{
"shape":"TagList",
@ -3364,6 +3364,42 @@
"min":3,
"pattern":"^[a-zA-Z0-9_\\-.]{3,128}$"
},
"BaselineOverride":{
"type":"structure",
"members":{
"OperatingSystem":{
"shape":"OperatingSystem",
"documentation":"<p>The operating system rule used by the patch baseline override.</p>"
},
"GlobalFilters":{"shape":"PatchFilterGroup"},
"ApprovalRules":{"shape":"PatchRuleGroup"},
"ApprovedPatches":{
"shape":"PatchIdList",
"documentation":"<p>A list of explicitly approved patches for the baseline.</p> <p>For information about accepted formats for lists of approved patches and rejected patches, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html\">About package name formats for approved and rejected patch lists</a> in the <i>AWS Systems Manager User Guide</i>.</p>"
},
"ApprovedPatchesComplianceLevel":{
"shape":"PatchComplianceLevel",
"documentation":"<p>Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation.</p>"
},
"RejectedPatches":{
"shape":"PatchIdList",
"documentation":"<p>A list of explicitly rejected patches for the baseline.</p> <p>For information about accepted formats for lists of approved patches and rejected patches, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/patch-manager-approved-rejected-package-name-formats.html\">About package name formats for approved and rejected patch lists</a> in the <i>AWS Systems Manager User Guide</i>.</p>"
},
"RejectedPatchesAction":{
"shape":"PatchAction",
"documentation":"<p>The action for Patch Manager to take on patches included in the RejectedPackages list. A patch can be allowed only if it is a dependency of another package, or blocked entirely along with packages that include it as a dependency.</p>"
},
"ApprovedPatchesEnableNonSecurity":{
"shape":"Boolean",
"documentation":"<p>Indicates whether the list of approved patches includes non-security updates that should be applied to the instances. The default value is 'false'. Applies to Linux instances only.</p>"
},
"Sources":{
"shape":"PatchSourceList",
"documentation":"<p>Information about the patches to use to update the instances, including target operating systems and source repositories. Applies to Linux instances only.</p>"
}
},
"documentation":"<p>Defines the basic information about a patch baseline override.</p>"
},
"BatchErrorMessage":{"type":"string"},
"Boolean":{"type":"boolean"},
"CalendarNameOrARN":{"type":"string"},
@ -4486,6 +4522,10 @@
"Metadata":{
"shape":"MetadataMap",
"documentation":"<p>Metadata for a new Application Manager application. </p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>Optional metadata that you assign to a resource. You can specify a maximum of five tags for an OpsMetadata object. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an OpsMetadata object to identify an environment or target AWS Region. In this case, you could specify the following key-value pairs:</p> <ul> <li> <p> <code>Key=Environment,Value=Production</code> </p> </li> <li> <p> <code>Key=Region,Value=us-east-2</code> </p> </li> </ul>"
}
}
},
@ -4524,7 +4564,7 @@
},
"ApprovedPatchesComplianceLevel":{
"shape":"PatchComplianceLevel",
"documentation":"<p>Defines the compliance level for approved patches. This means that if an approved patch is reported as missing, this is the severity of the compliance violation. The default value is UNSPECIFIED.</p>"
"documentation":"<p>Defines the compliance level for approved patches. When an approved patch is reported as missing, this value describes the severity of the compliance violation. The default value is UNSPECIFIED.</p>"
},
"ApprovedPatchesEnableNonSecurity":{
"shape":"Boolean",
@ -6878,7 +6918,7 @@
},
"PluginName":{
"shape":"CommandPluginName",
"documentation":"<p>(Optional) The name of the plugin for which you want detailed results. If the document contains only one plugin, the name can be omitted and the details will be returned.</p> <p>Plugin names are also referred to as step names in Systems Manager documents.</p>"
"documentation":"<p>The name of the plugin for which you want detailed results. If the document contains only one plugin, you can omit the name and details for that plugin are returned. If the document contains more than one plugin, you must specify the name of the plugin for which you want to view details.</p> <p>Plugin names are also referred to as <i>step names</i> in Systems Manager documents. For example, <code>aws:RunShellScript</code> is a plugin.</p>"
}
}
},
@ -6907,7 +6947,7 @@
},
"PluginName":{
"shape":"CommandPluginName",
"documentation":"<p>The name of the plugin for which you want detailed results. For example, aws:RunShellScript is a plugin.</p>"
"documentation":"<p>The name of the plugin, or <i>step name</i>, for which details are reported. For example, <code>aws:RunShellScript</code> is a plugin.</p>"
},
"ResponseCode":{
"shape":"ResponseCode",
@ -7014,6 +7054,10 @@
"SnapshotId":{
"shape":"SnapshotId",
"documentation":"<p>The user-defined snapshot ID.</p>"
},
"BaselineOverride":{
"shape":"BaselineOverride",
"documentation":"<p>Defines the basic information about a patch baseline override.</p>"
}
}
},
@ -7891,7 +7935,7 @@
"members":{
"SettingId":{
"shape":"ServiceSettingId",
"documentation":"<p>The ID of the service setting to get. The setting ID can be <code>/ssm/parameter-store/default-parameter-tier</code>, <code>/ssm/parameter-store/high-throughput-enabled</code>, or <code>/ssm/managed-instance/activation-tier</code>.</p>"
"documentation":"<p>The ID of the service setting to get. The setting ID can be <code>/ssm/automation/customer-script-log-destination</code>, <code>/ssm/automation/customer-script-log-group-name</code>, <code>/ssm/parameter-store/default-parameter-tier</code>, <code>/ssm/parameter-store/high-throughput-enabled</code>, or <code>/ssm/managed-instance/activation-tier</code>.</p>"
}
},
"documentation":"<p>The request body of the GetServiceSetting API action.</p>"
@ -8019,7 +8063,7 @@
"documentation":"<p>An S3 bucket where you want to store the results of this request.</p>"
}
},
"documentation":"<p>An S3 bucket where you want to store the results of this request.</p>"
"documentation":"<p>An S3 bucket where you want to store the results of this request.</p> <p>For the minimal permissions required to enable Amazon S3 output for an association, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-state-assoc.html\">Creating associations</a> in the <i>Systems Manager User Guide</i>. </p>"
},
"InstanceAssociationOutputUrl":{
"type":"structure",
@ -8249,7 +8293,7 @@
"members":{
"Key":{
"shape":"InstanceInformationStringFilterKey",
"documentation":"<p>The filter key name to describe your instances. For example:</p> <p>\"InstanceIds\"|\"AgentVersion\"|\"PingStatus\"|\"PlatformTypes\"|\"ActivationIds\"|\"IamRole\"|\"ResourceType\"|\"AssociationStatus\"|\"Tag Key\"</p>"
"documentation":"<p>The filter key name to describe your instances. For example:</p> <p>\"InstanceIds\"|\"AgentVersion\"|\"PingStatus\"|\"PlatformTypes\"|\"ActivationIds\"|\"IamRole\"|\"ResourceType\"|\"AssociationStatus\"|\"Tag Key\"</p> <important> <p> <code>Tag key</code> is not a valid filter. You must specify either <code>tag-key</code> or <code>tag:keyname</code> and a string. Here are some valid examples: tag-key, tag:123, tag:al!, tag:Windows. Here are some <i>invalid</i> examples: tag-keys, Tag Key, tag:, tagKey, abc:keyname.</p> </important>"
},
"Values":{
"shape":"InstanceInformationFilterValueSet",
@ -12426,12 +12470,12 @@
},
"ApproveAfterDays":{
"shape":"ApproveAfterDays",
"documentation":"<p>The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of <code>7</code> means that patches are approved seven days after they are released. Not supported on Ubuntu Server.</p>",
"documentation":"<p>The number of days after the release date of each patch matched by the rule that the patch is marked as approved in the patch baseline. For example, a value of <code>7</code> means that patches are approved seven days after they are released. Not supported on Debian Server or Ubuntu Server.</p>",
"box":true
},
"ApproveUntilDate":{
"shape":"PatchStringDateTime",
"documentation":"<p>The cutoff date for auto approval of released patches. Any patches released on or before this date are installed automatically. Not supported on Ubuntu Server.</p> <p>Enter dates in the format <code>YYYY-MM-DD</code>. For example, <code>2020-12-31</code>.</p>",
"documentation":"<p>The cutoff date for auto approval of released patches. Any patches released on or before this date are installed automatically. Not supported on Debian Server or Ubuntu Server.</p> <p>Enter dates in the format <code>YYYY-MM-DD</code>. For example, <code>2020-12-31</code>.</p>",
"box":true
},
"EnableNonSecurity":{
@ -12680,7 +12724,7 @@
"members":{
"Name":{
"shape":"PSParameterName",
"documentation":"<p>The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: <code>/Dev/DBServer/MySQL/db-string13</code> </p> <p>Naming Constraints:</p> <ul> <li> <p>Parameter names are case sensitive.</p> </li> <li> <p>A parameter name must be unique within an AWS Region</p> </li> <li> <p>A parameter name can't be prefixed with \"aws\" or \"ssm\" (case-insensitive).</p> </li> <li> <p>Parameter names can include only the following symbols and letters: <code>a-zA-Z0-9_.-/</code> </p> </li> <li> <p>A parameter name can't include spaces.</p> </li> <li> <p>Parameter hierarchies are limited to a maximum depth of fifteen levels.</p> </li> </ul> <p>For additional information about valid values for parameter names, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-parameter-name-constraints.html\">About requirements and constraints for parameter names</a> in the <i>AWS Systems Manager User Guide</i>.</p> <note> <p>The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters:</p> <p> <code>arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName</code> </p> </note>"
"documentation":"<p>The fully qualified name of the parameter that you want to add to the system. The fully qualified name includes the complete hierarchy of the parameter path and name. For parameters in a hierarchy, you must include a leading forward slash character (/) when you create or reference a parameter. For example: <code>/Dev/DBServer/MySQL/db-string13</code> </p> <p>Naming Constraints:</p> <ul> <li> <p>Parameter names are case sensitive.</p> </li> <li> <p>A parameter name must be unique within an AWS Region</p> </li> <li> <p>A parameter name can't be prefixed with \"aws\" or \"ssm\" (case-insensitive).</p> </li> <li> <p>Parameter names can include only the following symbols and letters: <code>a-zA-Z0-9_.-</code> </p> <p>In addition, the slash character ( / ) is used to delineate hierarchies in parameter names. For example: <code>/Dev/Production/East/Project-ABC/MyParameter</code> </p> </li> <li> <p>A parameter name can't include spaces.</p> </li> <li> <p>Parameter hierarchies are limited to a maximum depth of fifteen levels.</p> </li> </ul> <p>For additional information about valid values for parameter names, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-paramstore-su-create.html\">Creating Systems Manager parameters</a> in the <i>AWS Systems Manager User Guide</i>.</p> <note> <p>The maximum length constraint listed below includes capacity for additional system attributes that are not part of the name. The maximum length for a parameter name, including the full length of the parameter ARN, is 1011 characters. For example, the length of the following parameter name is 65 characters, not 20 characters:</p> <p> <code>arn:aws:ssm:us-east-2:111122223333:parameter/ExampleParameterName</code> </p> </note>"
},
"Description":{
"shape":"ParameterDescription",
@ -12819,7 +12863,7 @@
},
"Targets":{
"shape":"Targets",
"documentation":"<p>The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.</p> <p>You can specify targets using instance IDs, resource group names, or tags that have been applied to instances.</p> <p> <b>Example 1</b>: Specify instance IDs</p> <p> <code>Key=InstanceIds,Values=<i>instance-id-1</i>,<i>instance-id-2</i>,<i>instance-id-3</i> </code> </p> <p> <b>Example 2</b>: Use tag key-pairs applied to instances</p> <p> <code>Key=tag:<i>my-tag-key</i>,Values=<i>my-tag-value-1</i>,<i>my-tag-value-2</i> </code> </p> <p> <b>Example 3</b>: Use tag-keys applied to instances</p> <p> <code>Key=tag-key,Values=<i>my-tag-key-1</i>,<i>my-tag-key-2</i> </code> </p> <p> <b>Example 4</b>: Use resource group names</p> <p> <code>Key=resource-groups:Name,Values=<i>resource-group-name</i> </code> </p> <p> <b>Example 5</b>: Use filters for resource group types</p> <p> <code>Key=resource-groups:ResourceTypeFilters,Values=<i>resource-type-1</i>,<i>resource-type-2</i> </code> </p> <note> <p>For <code>Key=resource-groups:ResourceTypeFilters</code>, specify resource types in the following format</p> <p> <code>Key=resource-groups:ResourceTypeFilters,Values=<i>AWS::EC2::INSTANCE</i>,<i>AWS::EC2::VPC</i> </code> </p> </note> <p>For more information about these examples formats, including the best use case for each one, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html\">Examples: Register targets with a maintenance window</a> in the <i>AWS Systems Manager User Guide</i>.</p>"
"documentation":"<p>The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs.</p> <note> <p>If a single maintenance window task is registered with multiple targets, its task invocations occur sequentially and not in parallel. If your task must run on multiple targets at the same time, register a task for each target individually and assign each task the same priority level.</p> </note> <p>You can specify targets using instance IDs, resource group names, or tags that have been applied to instances.</p> <p> <b>Example 1</b>: Specify instance IDs</p> <p> <code>Key=InstanceIds,Values=<i>instance-id-1</i>,<i>instance-id-2</i>,<i>instance-id-3</i> </code> </p> <p> <b>Example 2</b>: Use tag key-pairs applied to instances</p> <p> <code>Key=tag:<i>my-tag-key</i>,Values=<i>my-tag-value-1</i>,<i>my-tag-value-2</i> </code> </p> <p> <b>Example 3</b>: Use tag-keys applied to instances</p> <p> <code>Key=tag-key,Values=<i>my-tag-key-1</i>,<i>my-tag-key-2</i> </code> </p> <p> <b>Example 4</b>: Use resource group names</p> <p> <code>Key=resource-groups:Name,Values=<i>resource-group-name</i> </code> </p> <p> <b>Example 5</b>: Use filters for resource group types</p> <p> <code>Key=resource-groups:ResourceTypeFilters,Values=<i>resource-type-1</i>,<i>resource-type-2</i> </code> </p> <note> <p>For <code>Key=resource-groups:ResourceTypeFilters</code>, specify resource types in the following format</p> <p> <code>Key=resource-groups:ResourceTypeFilters,Values=<i>AWS::EC2::INSTANCE</i>,<i>AWS::EC2::VPC</i> </code> </p> </note> <p>For more information about these examples formats, including the best use case for each one, see <a href=\"https://docs.aws.amazon.com/systems-manager/latest/userguide/mw-cli-tutorial-targets-examples.html\">Examples: Register targets with a maintenance window</a> in the <i>AWS Systems Manager User Guide</i>.</p>"
},
"OwnerInformation":{
"shape":"OwnerInformation",
@ -12969,7 +13013,7 @@
},
"ResourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the resource from which you want to remove tags. For example:</p> <p>ManagedInstance: mi-012345abcde</p> <p>MaintenanceWindow: mw-012345abcde</p> <p>PatchBaseline: pb-012345abcde</p> <p>For the Document and Parameter values, use the name of the resource.</p> <note> <p>The ManagedInstance type for this API action is only for on-premises managed instances. Specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.</p> </note>"
"documentation":"<p>The ID of the resource from which you want to remove tags. For example:</p> <p>ManagedInstance: mi-012345abcde</p> <p>MaintenanceWindow: mw-012345abcde</p> <p>PatchBaseline: pb-012345abcde</p> <p>OpsMetadata object: <code>ResourceID</code> for tagging is created from the Amazon Resource Name (ARN) for the object. Specifically, <code>ResourceID</code> is created from the strings that come after the word <code>opsmetadata</code> in the ARN. For example, an OpsMetadata object with an ARN of <code>arn:aws:ssm:us-east-2:1234567890:opsmetadata/aws/ssm/MyGroup/appmanager</code> has a <code>ResourceID</code> of either <code>aws/ssm/MyGroup/appmanager</code> or <code>/aws/ssm/MyGroup/appmanager</code>.</p> <p>For the Document and Parameter values, use the name of the resource.</p> <note> <p>The ManagedInstance type for this API action is only for on-premises managed instances. Specify the name of the managed instance in the following format: mi-ID_number. For example, mi-1a2b3c4d5e6f.</p> </note>"
},
"TagKeys":{
"shape":"KeyList",
@ -12988,7 +13032,7 @@
"members":{
"SettingId":{
"shape":"ServiceSettingId",
"documentation":"<p>The Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be <code>/ssm/parameter-store/default-parameter-tier</code>, <code>/ssm/parameter-store/high-throughput-enabled</code>, or <code>/ssm/managed-instance/activation-tier</code>. For example, <code>arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled</code>.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the service setting to reset. The setting ID can be <code>/ssm/automation/customer-script-log-destination</code>, <code>/ssm/automation/customer-script-log-group-name</code>, <code>/ssm/parameter-store/default-parameter-tier</code>, <code>/ssm/parameter-store/high-throughput-enabled</code>, or <code>/ssm/managed-instance/activation-tier</code>. For example, <code>arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled</code>.</p>"
}
},
"documentation":"<p>The request body of the ResetServiceSetting API action.</p>"
@ -13387,7 +13431,8 @@
"MaintenanceWindow",
"Parameter",
"PatchBaseline",
"OpsItem"
"OpsItem",
"OpsMetadata"
]
},
"ResponseCode":{"type":"integer"},
@ -15426,11 +15471,11 @@
"members":{
"SettingId":{
"shape":"ServiceSettingId",
"documentation":"<p>The Amazon Resource Name (ARN) of the service setting to reset. For example, <code>arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled</code>. The setting ID can be one of the following.</p> <ul> <li> <p> <code>/ssm/parameter-store/default-parameter-tier</code> </p> </li> <li> <p> <code>/ssm/parameter-store/high-throughput-enabled</code> </p> </li> <li> <p> <code>/ssm/managed-instance/activation-tier</code> </p> </li> </ul>"
"documentation":"<p>The Amazon Resource Name (ARN) of the service setting to reset. For example, <code>arn:aws:ssm:us-east-1:111122223333:servicesetting/ssm/parameter-store/high-throughput-enabled</code>. The setting ID can be one of the following.</p> <ul> <li> <p> <code>/ssm/automation/customer-script-log-destination</code> </p> </li> <li> <p> <code>/ssm/automation/customer-script-log-group-name</code> </p> </li> <li> <p> <code>/ssm/parameter-store/default-parameter-tier</code> </p> </li> <li> <p> <code>/ssm/parameter-store/high-throughput-enabled</code> </p> </li> <li> <p> <code>/ssm/managed-instance/activation-tier</code> </p> </li> </ul>"
},
"SettingValue":{
"shape":"ServiceSettingValue",
"documentation":"<p>The new value to specify for the service setting. For the <code>/ssm/parameter-store/default-parameter-tier</code> setting ID, the setting value can be one of the following.</p> <ul> <li> <p>Standard</p> </li> <li> <p>Advanced</p> </li> <li> <p>Intelligent-Tiering</p> </li> </ul> <p>For the <code>/ssm/parameter-store/high-throughput-enabled</code>, and <code>/ssm/managed-instance/activation-tier</code> setting IDs, the setting value can be true or false.</p>"
"documentation":"<p>The new value to specify for the service setting. For the <code>/ssm/parameter-store/default-parameter-tier</code> setting ID, the setting value can be one of the following.</p> <ul> <li> <p>Standard</p> </li> <li> <p>Advanced</p> </li> <li> <p>Intelligent-Tiering</p> </li> </ul> <p>For the <code>/ssm/parameter-store/high-throughput-enabled</code>, and <code>/ssm/managed-instance/activation-tier</code> setting IDs, the setting value can be true or false.</p> <p>For the <code>/ssm/automation/customer-script-log-destination</code> setting ID, the setting value can be CloudWatch.</p> <p>For the <code>/ssm/automation/customer-script-log-group-name</code> setting ID, the setting value can be the name of a CloudWatch Logs log group.</p>"
}
},
"documentation":"<p>The request body of the UpdateServiceSetting API action.</p>"

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