The maximum number of requests that can be made in a given time period.
" + "smithy.api#documentation": "The target maximum number of requests that can be made in a given time period.
" } }, "offset": { @@ -9755,13 +9755,13 @@ "burstLimit": { "target": "com.amazonaws.apigateway#Integer", "traits": { - "smithy.api#documentation": "The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
" + "smithy.api#documentation": "The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.
" } }, "rateLimit": { "target": "com.amazonaws.apigateway#Double", "traits": { - "smithy.api#documentation": "The API request steady-state rate limit.
" + "smithy.api#documentation": "The API target request rate limit.
" } } }, @@ -11415,13 +11415,13 @@ "throttle": { "target": "com.amazonaws.apigateway#ThrottleSettings", "traits": { - "smithy.api#documentation": "The request throttle limits of a usage plan.
" + "smithy.api#documentation": "Map containing method level throttling information for API stage in a usage plan.
" } }, "quota": { "target": "com.amazonaws.apigateway#QuotaSettings", "traits": { - "smithy.api#documentation": "The maximum number of permitted requests per a given unit time interval.
" + "smithy.api#documentation": "The target maximum number of permitted requests per a given unit time interval.
" } }, "productCode": { @@ -11438,7 +11438,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.
\nIn a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.
\nRepresents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. \n In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. \n Consider using AWS Budgets to monitor costs \n and AWS WAF to manage API requests.
\nIn a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.
\nAssociates an application to entitle.
" + } + }, + "com.amazonaws.appstream#AssociateApplicationToEntitlementRequest": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the stack.
", + "smithy.api#required": {} + } + }, + "EntitlementName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "ApplicationIdentifier": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The identifier of the application.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appstream#AssociateApplicationToEntitlementResult": { + "type": "structure", + "members": {} + }, "com.amazonaws.appstream#AssociateFleet": { "type": "operation", "input": { @@ -1064,6 +1135,82 @@ } } }, + "com.amazonaws.appstream#CreateEntitlement": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#CreateEntitlementRequest" + }, + "output": { + "target": "com.amazonaws.appstream#CreateEntitlementResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#EntitlementAlreadyExistsException" + }, + { + "target": "com.amazonaws.appstream#LimitExceededException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new entitlement. Entitlements control access to specific applications within\n a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user\n identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all\n applications in a stack. Entitlements don't apply to the desktop stream view\n application, or to applications managed by a dynamic app provider using the Dynamic\n Application Framework.
" + } + }, + "com.amazonaws.appstream#CreateEntitlementRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the stack with which the entitlement is associated.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description of the entitlement.
" + } + }, + "AppVisibility": { + "target": "com.amazonaws.appstream#AppVisibility", + "traits": { + "smithy.api#documentation": "Specifies whether all or selected apps are entitled.
", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.appstream#EntitlementAttributeList", + "traits": { + "smithy.api#documentation": "The attributes of the entitlement.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appstream#CreateEntitlementResult": { + "type": "structure", + "members": { + "Entitlement": { + "target": "com.amazonaws.appstream#Entitlement", + "traits": { + "smithy.api#documentation": "The entitlement.
" + } + } + } + }, "com.amazonaws.appstream#CreateFleet": { "type": "operation", "input": { @@ -1975,6 +2122,55 @@ "type": "structure", "members": {} }, + "com.amazonaws.appstream#DeleteEntitlement": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DeleteEntitlementRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DeleteEntitlementResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#EntitlementNotFoundException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified entitlement.
" + } + }, + "com.amazonaws.appstream#DeleteEntitlementRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the stack with which the entitlement is associated.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appstream#DeleteEntitlementResult": { + "type": "structure", + "members": {} + }, "com.amazonaws.appstream#DeleteFleet": { "type": "operation", "input": { @@ -2164,6 +2360,9 @@ { "target": "com.amazonaws.appstream#ConcurrentModificationException" }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, { "target": "com.amazonaws.appstream#ResourceInUseException" }, @@ -2502,6 +2701,76 @@ } } }, + "com.amazonaws.appstream#DescribeEntitlements": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DescribeEntitlementsRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DescribeEntitlementsResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#EntitlementNotFoundException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list that describes one of more entitlements.
" + } + }, + "com.amazonaws.appstream#DescribeEntitlementsRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the entitlement.
" + } + }, + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the stack with which the entitlement is associated.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum size of each page of results.
" + } + } + } + }, + "com.amazonaws.appstream#DescribeEntitlementsResult": { + "type": "structure", + "members": { + "Entitlements": { + "target": "com.amazonaws.appstream#EntitlementList", + "traits": { + "smithy.api#documentation": "The entitlements.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this\n operation.
" + } + } + } + }, "com.amazonaws.appstream#DescribeFleets": { "type": "operation", "input": { @@ -3305,6 +3574,59 @@ "type": "structure", "members": {} }, + "com.amazonaws.appstream#DisassociateApplicationFromEntitlement": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#DisassociateApplicationFromEntitlementRequest" + }, + "output": { + "target": "com.amazonaws.appstream#DisassociateApplicationFromEntitlementResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#EntitlementNotFoundException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified application from the specified entitlement.
" + } + }, + "com.amazonaws.appstream#DisassociateApplicationFromEntitlementRequest": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the stack with which the entitlement is associated.
", + "smithy.api#required": {} + } + }, + "EntitlementName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "ApplicationIdentifier": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The identifier of the application to remove from the entitlement.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.appstream#DisassociateApplicationFromEntitlementResult": { + "type": "structure", + "members": {} + }, "com.amazonaws.appstream#DisassociateFleet": { "type": "operation", "input": { @@ -3471,6 +3793,146 @@ "type": "structure", "members": {} }, + "com.amazonaws.appstream#EntitledApplication": { + "type": "structure", + "members": { + "ApplicationIdentifier": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The identifier of the application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The application associated to an entitlement. Access is controlled based on user attributes.
" + } + }, + "com.amazonaws.appstream#EntitledApplicationList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#EntitledApplication" + } + }, + "com.amazonaws.appstream#Entitlement": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the stack with which the entitlement is associated.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description of the entitlement.
" + } + }, + "AppVisibility": { + "target": "com.amazonaws.appstream#AppVisibility", + "traits": { + "smithy.api#documentation": "Specifies whether all or selected apps are entitled.
", + "smithy.api#required": {} + } + }, + "Attributes": { + "target": "com.amazonaws.appstream#EntitlementAttributeList", + "traits": { + "smithy.api#documentation": "The attributes of the entitlement.
", + "smithy.api#required": {} + } + }, + "CreatedTime": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the entitlement was created.
" + } + }, + "LastModifiedTime": { + "target": "com.amazonaws.appstream#Timestamp", + "traits": { + "smithy.api#documentation": "The time when the entitlement was last modified.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies an entitlement. Entitlements control access to specific applications within\n a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user\n identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all\n applications in a stack. Entitlements don't apply to the desktop stream view\n application, or to applications managed by a dynamic app provider using the Dynamic\n Application Framework.
" + } + }, + "com.amazonaws.appstream#EntitlementAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appstream#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The entitlement already exists.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.appstream#EntitlementAttribute": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "A supported AWS IAM SAML PrincipalTag attribute that is matched to the\n associated value when a user identity federates into an Amazon AppStream 2.0 SAML\n application.
The following are valid values:
\nroles
\ndepartment
\norganization
\ngroups
\ntitle
\ncostCenter
\nuserType
\n", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "
A value that is matched to a supported SAML attribute name when a user identity\n federates into an Amazon AppStream 2.0 SAML application.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "An attribute associated with an entitlement. Application entitlements work by matching\n a supported SAML 2.0 attribute name to a value when a user identity federates to an\n Amazon AppStream 2.0 SAML application.
" + } + }, + "com.amazonaws.appstream#EntitlementAttributeList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#EntitlementAttribute" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.appstream#EntitlementList": { + "type": "list", + "member": { + "target": "com.amazonaws.appstream#Entitlement" + } + }, + "com.amazonaws.appstream#EntitlementNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.appstream#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The entitlement can't be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.appstream#ErrorMessage": { "type": "string", "traits": { @@ -4514,6 +4976,77 @@ } } }, + "com.amazonaws.appstream#ListEntitledApplications": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#ListEntitledApplicationsRequest" + }, + "output": { + "target": "com.amazonaws.appstream#ListEntitledApplicationsResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#EntitlementNotFoundException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves a list of entitled applications.
" + } + }, + "com.amazonaws.appstream#ListEntitledApplicationsRequest": { + "type": "structure", + "members": { + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the stack with which the entitlement is associated.
", + "smithy.api#required": {} + } + }, + "EntitlementName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.appstream#Integer", + "traits": { + "smithy.api#documentation": "The maximum size of each page of results.
" + } + } + } + }, + "com.amazonaws.appstream#ListEntitledApplicationsResult": { + "type": "structure", + "members": { + "EntitledApplications": { + "target": "com.amazonaws.appstream#EntitledApplicationList", + "traits": { + "smithy.api#documentation": "The entitled applications.
" + } + }, + "NextToken": { + "target": "com.amazonaws.appstream#String", + "traits": { + "smithy.api#documentation": "The pagination token used to retrieve the next page of results for this operation.
" + } + } + } + }, "com.amazonaws.appstream#ListTagsForResource": { "type": "operation", "input": { @@ -4685,6 +5218,9 @@ { "target": "com.amazonaws.appstream#AssociateApplicationFleet" }, + { + "target": "com.amazonaws.appstream#AssociateApplicationToEntitlement" + }, { "target": "com.amazonaws.appstream#AssociateFleet" }, @@ -4706,6 +5242,9 @@ { "target": "com.amazonaws.appstream#CreateDirectoryConfig" }, + { + "target": "com.amazonaws.appstream#CreateEntitlement" + }, { "target": "com.amazonaws.appstream#CreateFleet" }, @@ -4739,6 +5278,9 @@ { "target": "com.amazonaws.appstream#DeleteDirectoryConfig" }, + { + "target": "com.amazonaws.appstream#DeleteEntitlement" + }, { "target": "com.amazonaws.appstream#DeleteFleet" }, @@ -4772,6 +5314,9 @@ { "target": "com.amazonaws.appstream#DescribeDirectoryConfigs" }, + { + "target": "com.amazonaws.appstream#DescribeEntitlements" + }, { "target": "com.amazonaws.appstream#DescribeFleets" }, @@ -4805,6 +5350,9 @@ { "target": "com.amazonaws.appstream#DisassociateApplicationFleet" }, + { + "target": "com.amazonaws.appstream#DisassociateApplicationFromEntitlement" + }, { "target": "com.amazonaws.appstream#DisassociateFleet" }, @@ -4820,6 +5368,9 @@ { "target": "com.amazonaws.appstream#ListAssociatedStacks" }, + { + "target": "com.amazonaws.appstream#ListEntitledApplications" + }, { "target": "com.amazonaws.appstream#ListTagsForResource" }, @@ -4847,6 +5398,9 @@ { "target": "com.amazonaws.appstream#UpdateDirectoryConfig" }, + { + "target": "com.amazonaws.appstream#UpdateEntitlement" + }, { "target": "com.amazonaws.appstream#UpdateFleet" }, @@ -6069,6 +6623,80 @@ } } }, + "com.amazonaws.appstream#UpdateEntitlement": { + "type": "operation", + "input": { + "target": "com.amazonaws.appstream#UpdateEntitlementRequest" + }, + "output": { + "target": "com.amazonaws.appstream#UpdateEntitlementResult" + }, + "errors": [ + { + "target": "com.amazonaws.appstream#ConcurrentModificationException" + }, + { + "target": "com.amazonaws.appstream#EntitlementNotFoundException" + }, + { + "target": "com.amazonaws.appstream#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.appstream#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the specified entitlement.
" + } + }, + "com.amazonaws.appstream#UpdateEntitlementRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the entitlement.
", + "smithy.api#required": {} + } + }, + "StackName": { + "target": "com.amazonaws.appstream#Name", + "traits": { + "smithy.api#documentation": "The name of the stack with which the entitlement is associated.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.appstream#Description", + "traits": { + "smithy.api#documentation": "The description of the entitlement.
" + } + }, + "AppVisibility": { + "target": "com.amazonaws.appstream#AppVisibility", + "traits": { + "smithy.api#documentation": "Specifies whether all or only selected apps are entitled.
" + } + }, + "Attributes": { + "target": "com.amazonaws.appstream#EntitlementAttributeList", + "traits": { + "smithy.api#documentation": "The attributes of the entitlement.
" + } + } + } + }, + "com.amazonaws.appstream#UpdateEntitlementResult": { + "type": "structure", + "members": { + "Entitlement": { + "target": "com.amazonaws.appstream#Entitlement", + "traits": { + "smithy.api#documentation": "The entitlement.
" + } + } + } + }, "com.amazonaws.appstream#UpdateFleet": { "type": "operation", "input": { diff --git a/codegen/sdk/aws-models/appsync.2017-07-25.json b/codegen/sdk/aws-models/appsync.2017-07-25.json index 8be4c799ec6..365e42529c3 100644 --- a/codegen/sdk/aws-models/appsync.2017-07-25.json +++ b/codegen/sdk/aws-models/appsync.2017-07-25.json @@ -1253,6 +1253,12 @@ }, "syncConfig": { "target": "com.amazonaws.appsync#SyncConfig" + }, + "maxBatchSize": { + "target": "com.amazonaws.appsync#MaxBatchSize", + "traits": { + "smithy.api#documentation": "The maximum batching size for a resolver.
" + } } } }, @@ -1474,6 +1480,12 @@ "traits": { "smithy.api#documentation": "The caching configuration for the resolver.
" } + }, + "maxBatchSize": { + "target": "com.amazonaws.appsync#MaxBatchSize", + "traits": { + "smithy.api#documentation": "The maximum batching size for a resolver.
" + } } } }, @@ -2481,6 +2493,12 @@ }, "syncConfig": { "target": "com.amazonaws.appsync#SyncConfig" + }, + "maxBatchSize": { + "target": "com.amazonaws.appsync#MaxBatchSize", + "traits": { + "smithy.api#documentation": "The maximum batching size for a resolver.
" + } } }, "traits": { @@ -4050,6 +4068,16 @@ "smithy.api#length": { "min": 1, "max": 65536 + }, + "smithy.api#pattern": "^.*$" + } + }, + "com.amazonaws.appsync#MaxBatchSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 2000 } } }, @@ -4300,6 +4328,12 @@ "traits": { "smithy.api#documentation": "The caching configuration for the resolver.
" } + }, + "maxBatchSize": { + "target": "com.amazonaws.appsync#MaxBatchSize", + "traits": { + "smithy.api#documentation": "The maximum batching size for a resolver.
" + } } }, "traits": { @@ -4588,7 +4622,8 @@ "smithy.api#length": { "min": 0, "max": 256 - } + }, + "smithy.api#pattern": "^[\\s\\w+-=\\.:/@]*$" } }, "com.amazonaws.appsync#Type": { @@ -5167,6 +5202,12 @@ }, "syncConfig": { "target": "com.amazonaws.appsync#SyncConfig" + }, + "maxBatchSize": { + "target": "com.amazonaws.appsync#MaxBatchSize", + "traits": { + "smithy.api#documentation": "The maximum batching size for a resolver.
" + } } } }, @@ -5390,6 +5431,12 @@ "traits": { "smithy.api#documentation": "The caching configuration for the resolver.
" } + }, + "maxBatchSize": { + "target": "com.amazonaws.appsync#MaxBatchSize", + "traits": { + "smithy.api#documentation": "The maximum batching size for a resolver.
" + } } } }, diff --git a/codegen/sdk/aws-models/chimesdkmessaging.2021-05-15.json b/codegen/sdk/aws-models/chimesdkmessaging.2021-05-15.json index 3a7cd1cb339..812376a0e7a 100644 --- a/codegen/sdk/aws-models/chimesdkmessaging.2021-05-15.json +++ b/codegen/sdk/aws-models/chimesdkmessaging.2021-05-15.json @@ -874,6 +874,18 @@ "traits": { "smithy.api#documentation": "The message metadata.
" } + }, + "PushNotification": { + "target": "com.amazonaws.chimesdkmessaging#PushNotificationConfiguration", + "traits": { + "smithy.api#documentation": "The push notification configuration of the message.
" + } + }, + "MessageAttributes": { + "target": "com.amazonaws.chimesdkmessaging#MessageAttributeMap", + "traits": { + "smithy.api#documentation": "The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences.
The Amazon Chime SDK Messaging APIs in this section allow software developers to send\n and receive messages in custom messaging applications. These APIs depend on the frameworks\n provided by the Amazon Chime SDK Identity APIs. For more information about the messaging\n APIs, see Amazon Chime SDK messaging\n
", + "smithy.api#title": "Amazon Chime SDK Messaging" + }, "version": "2021-05-15", "operations": [ { @@ -1334,22 +1361,7 @@ { "target": "com.amazonaws.chimesdkmessaging#UpdateChannelReadMarker" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Chime SDK Messaging", - "arnNamespace": "chime", - "cloudFormationName": "ChimeSDKMessaging", - "cloudTrailEventSource": "chimesdkmessaging.amazonaws.com", - "endpointPrefix": "messaging-chime" - }, - "aws.auth#sigv4": { - "name": "chime" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "The Amazon Chime SDK Messaging APIs in this section allow software developers to send\n and receive messages in custom messaging applications. These APIs depend on the frameworks\n provided by the Amazon Chime SDK Identity APIs. For more information about the messaging\n APIs, see Amazon Chime SDK messaging\n
", - "smithy.api#title": "Amazon Chime SDK Messaging" - } + ] }, "com.amazonaws.chimesdkmessaging#ClientRequestToken": { "type": "string", @@ -3617,7 +3629,7 @@ "Type": { "target": "com.amazonaws.chimesdkmessaging#ChannelMembershipType", "traits": { - "smithy.api#documentation": "The membership type of a user, DEFAULT or HIDDEN. Default\n members are always returned as part of ListChannelMemberships. Hidden members\n are only returned if the type filter in ListChannelMemberships equals\n HIDDEN. Otherwise hidden members are not returned.
The membership type of a user, DEFAULT or HIDDEN. Default\n members are returned as part of ListChannelMemberships if no type is specified. Hidden members\n are only returned if the type filter in ListChannelMemberships equals\n HIDDEN.
The title of the push notification.
", - "smithy.api#required": {} + "smithy.api#documentation": "The title of the push notification.
" } }, "Body": { "target": "com.amazonaws.chimesdkmessaging#PushNotificationBody", "traits": { - "smithy.api#documentation": "The body of the push notification.
", - "smithy.api#required": {} + "smithy.api#documentation": "The body of the push notification.
" } }, "Type": { "target": "com.amazonaws.chimesdkmessaging#PushNotificationType", "traits": { - "smithy.api#documentation": "Enum value that indicates the type of the push notification for a message.\n DEFAULT: Normal mobile push notification.\n VOIP: VOIP mobile push notification.
Enum value that indicates the type of the push notification for a message.\n DEFAULT: Normal mobile push notification.\n VOIP: VOIP mobile push notification.
Contains a list of tags, up to a limit of 50
" + "smithy.api#documentation": "Contains a list of tags, up to a limit of 50
", + "smithy.api#required": {} } } }, @@ -197,6 +207,86 @@ "com.amazonaws.cloudtrail#ByteBuffer": { "type": "blob" }, + "com.amazonaws.cloudtrail#CancelQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#CancelQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#CancelQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#ConflictException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveQueryException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#QueryIdNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "Cancels a query if the query is not in a terminated state, such as CANCELLED, FAILED or FINISHED. You must specify an ARN value for EventDataStore. \n The ID of the query that you want to cancel is also required. When you run CancelQuery, the query status might \n show as CANCELLED even if the operation is not yet finished.
The ARN (or the ID suffix of the ARN) of an event data store on which the specified query is running.
", + "smithy.api#required": {} + } + }, + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "The ID of the query that you want to cancel. The QueryId comes from the response of a StartQuery \n operation.
The ID of the canceled query.
", + "smithy.api#required": {} + } + }, + "QueryStatus": { + "target": "com.amazonaws.cloudtrail#QueryStatus", + "traits": { + "smithy.api#documentation": "Shows the status of a query after a CancelQuery request. Typically, the values shown are either \n RUNNING or CANCELLED.
Creates a new event data store.
" + } + }, + "com.amazonaws.cloudtrail#CreateEventDataStoreRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "The name of the event data store.
", + "smithy.api#required": {} + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "The advanced event selectors to use to select the events for the data store. For more information about how to use advanced event \n selectors, see Log events by using advanced event selectors in the CloudTrail \n User Guide.
" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the event data store includes events from all regions, or only from the region in which the event data store \n is created.
" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether an event data store collects events logged for an organization in Organizations.
" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "The retention period of the event data store, in days. You can set a retention period of up to 2555 days, \n the equivalent of seven years.
" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "Specifies whether termination protection is enabled for the event data store. If termination protection is enabled, you \n cannot delete the event data store until termination protection is disabled.
" + } + }, + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList" + } + } + }, + "com.amazonaws.cloudtrail#CreateEventDataStoreResponse": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "The ARN of the event data store.
" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "The name of the event data store.
" + } + }, + "Status": { + "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", + "traits": { + "smithy.api#documentation": "The status of event data store creation.
" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "The advanced event selectors that were used to select the events for the data store.
" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the event data store collects events from all regions, or only from the region in which it was created.
" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether an event data store is collecting logged events for an organization in Organizations.
" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "The retention period of an event data store, in days.
" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "Indicates whether termination protection is enabled for the event data store.
" + } + }, + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList" + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "The timestamp that shows when the event data store was created.
" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "The timestamp that shows when an event data store was updated, if applicable. \n UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
Disables the event data store specified by EventDataStore, which accepts an event data store ARN. \n After you run DeleteEventDataStore, the event data store is automatically deleted after a wait period of \n seven days. TerminationProtectionEnabled must be set to False on the event data store; this \n operation cannot work if TerminationProtectionEnabled is True.
After you run DeleteEventDataStore on an event data store, you cannot run ListQueries, \n DescribeQuery, or GetQueryResults on queries that are using an event data store in a \n PENDING_DELETION state.
The ARN (or the ID suffix of the ARN) of the event data store to delete.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudtrail#DeleteEventDataStoreResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.cloudtrail#DeleteTrail": { "type": "operation", "input": { @@ -736,26 +1079,116 @@ "smithy.api#documentation": "Returns the objects or data listed below if successful. Otherwise, returns an error.
" } }, - "com.amazonaws.cloudtrail#DescribeTrails": { + "com.amazonaws.cloudtrail#DescribeQuery": { "type": "operation", "input": { - "target": "com.amazonaws.cloudtrail#DescribeTrailsRequest" + "target": "com.amazonaws.cloudtrail#DescribeQueryRequest" }, "output": { - "target": "com.amazonaws.cloudtrail#DescribeTrailsResponse" + "target": "com.amazonaws.cloudtrail#DescribeQueryResponse" }, "errors": [ { - "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" }, { - "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" }, { - "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" - } - ], - "traits": { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#QueryIdNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns metadata about a query, including query run time in milliseconds, number of events scanned and matched, and query \n status. You must specify an ARN for EventDataStore, and a value for QueryID.
The ARN (or the ID suffix of the ARN) of an event data store on which the specified query was run.
", + "smithy.api#required": {} + } + }, + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "The query ID.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudtrail#DescribeQueryResponse": { + "type": "structure", + "members": { + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "The ID of the query.
" + } + }, + "QueryString": { + "target": "com.amazonaws.cloudtrail#QueryStatement", + "traits": { + "smithy.api#documentation": "The SQL code of a query.
" + } + }, + "QueryStatus": { + "target": "com.amazonaws.cloudtrail#QueryStatus", + "traits": { + "smithy.api#documentation": "The status of a query. Values for QueryStatus include QUEUED, RUNNING, \n FINISHED, FAILED, or CANCELLED\n
Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time \n in milliseconds, and the query's creation time.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "The error message returned if a query failed.
" + } + } + } + }, + "com.amazonaws.cloudtrail#DescribeTrails": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#DescribeTrailsRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#DescribeTrailsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidTrailNameException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { "smithy.api#documentation": "Retrieves settings for one or more trails associated with the current region for your account.
", "smithy.api#idempotent": {} } @@ -795,7 +1228,14 @@ } }, "com.amazonaws.cloudtrail#ErrorMessage": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 1000 + }, + "smithy.api#pattern": ".*" + } }, "com.amazonaws.cloudtrail#Event": { "type": "structure", @@ -870,6 +1310,219 @@ ] } }, + "com.amazonaws.cloudtrail#EventDataStore": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "The ARN of the event data store.
" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "The name of the event data store.
" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "Indicates whether the event data store is protected from termination.
" + } + }, + "Status": { + "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", + "traits": { + "smithy.api#documentation": "The status of an event data store. Values are ENABLED and PENDING_DELETION.
The advanced event selectors that were used to select events for the data store.
" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the event data store includes events from all regions, or only from the region in which it was created.
" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "Indicates that an event data store is collecting logged events for an organization.
" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "The retention period, in days.
" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "The timestamp of the event data store's creation.
" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "The timestamp showing when an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
A storage lake of event data against which you can run complex SQL-based queries. An event data store can include events \n that you have logged on your account from the last 90 to 2555 days \n (about three months to up to seven years). To select events for an event data store, \n use advanced event selectors.
" + } + }, + "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreARNInvalid", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The specified event data store ARN is not valid or does not map to an event data store in your account.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#EventDataStoreAlreadyExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreAlreadyExists", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "An event data store with that name already exists.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#EventDataStoreArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 256 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._/\\-:]+$" + } + }, + "com.amazonaws.cloudtrail#EventDataStoreMaxLimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreMaxLimitExceeded", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "Your account has used the maximum number of event data stores.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#EventDataStoreName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._\\-]+$" + } + }, + "com.amazonaws.cloudtrail#EventDataStoreNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "The specified event data store was not found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudtrail#EventDataStoreStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CREATED", + "name": "CREATED" + }, + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "PENDING_DELETION", + "name": "PENDING_DELETION" + } + ] + } + }, + "com.amazonaws.cloudtrail#EventDataStoreTerminationProtectedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "EventDataStoreTerminationProtectedException", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The event data store cannot be deleted because termination protection is enabled for it.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#EventDataStores": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#EventDataStore" + } + }, "com.amazonaws.cloudtrail#EventSelector": { "type": "structure", "members": { @@ -920,6 +1573,113 @@ "target": "com.amazonaws.cloudtrail#String" } }, + "com.amazonaws.cloudtrail#GetEventDataStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#GetEventDataStoreRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#GetEventDataStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about an event data store specified as either an ARN or the ID portion of the ARN.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.cloudtrail#GetEventDataStoreRequest": { + "type": "structure", + "members": { + "EventDataStore": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "The ARN (or ID suffix of the ARN) of the event data store about which you want information.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudtrail#GetEventDataStoreResponse": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "The event data store Amazon Resource Number (ARN).
" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "The name of the event data store.
" + } + }, + "Status": { + "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", + "traits": { + "smithy.api#documentation": "The status of an event data store. Values can be ENABLED and PENDING_DELETION.
The advanced event selectors used to select events for the data store.
" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the event data store includes events from all regions, or only from the region in which it was created.
" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether an event data store is collecting logged events for an organization in Organizations.
" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "The retention period of the event data store, in days.
" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "Indicates that termination protection is enabled.
" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "The timestamp of the event data store's creation.
" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "Shows the time that an event data store was updated, if applicable. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
A JSON string that contains the insight types you want to log on a trail. In this release, only ApiCallRateInsight is supported as an insight type.
A JSON string that contains the insight types you want to log on a trail. In this release, ApiErrorRateInsight and \n ApiCallRateInsight are supported as insight types.
Gets event data results of a query. You must specify the QueryID value returned by the StartQuery \n operation, and an ARN for EventDataStore.
The ARN (or ID suffix of the ARN) of the event data store against which the query was run.
", + "smithy.api#required": {} + } + }, + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "The ID of the query for which you want to get results.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "A token you can use to get the next page of query results.
" + } + }, + "MaxQueryResults": { + "target": "com.amazonaws.cloudtrail#MaxQueryResults", + "traits": { + "smithy.api#documentation": "The maximum number of query results to display on a single page.
" + } + } + } + }, + "com.amazonaws.cloudtrail#GetQueryResultsResponse": { + "type": "structure", + "members": { + "QueryStatus": { + "target": "com.amazonaws.cloudtrail#QueryStatus", + "traits": { + "smithy.api#documentation": "The status of the query. Values include QUEUED, RUNNING, FINISHED, FAILED, \n or CANCELLED.
Shows the count of query results.
" + } + }, + "QueryResultRows": { + "target": "com.amazonaws.cloudtrail#QueryResultRows", + "traits": { + "smithy.api#documentation": "Contains the individual event results of the query.
" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "A token you can use to get the next page of query results.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "The error message returned if a query failed.
" } } } @@ -1240,6 +2111,46 @@ "smithy.api#documentation": "Returns the objects or data listed below if successful. Otherwise, returns an error.
" } }, + "com.amazonaws.cloudtrail#InactiveEventDataStoreException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InactiveEventDataStore", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The event data store against which you ran your query is inactive.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InactiveQueryException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InactiveQuery", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The specified query cannot be canceled because it is in the FINISHED, FAILED, or \n CANCELLED state.
The type of Insights events to log on a trail. The valid Insights type in this release is ApiCallRateInsight.
The type of insights to log on a trail. ApiCallRateInsight and ApiErrorRateInsight are valid insight types.
Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidDateRange", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "A date range for the query was specified that is not valid. For more information \n about writing a query, see Create \n or edit a query in the CloudTrail User Guide.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.cloudtrail#InvalidEventCategoryException": { "type": "structure", "members": { @@ -1435,6 +2372,26 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidEventDataStoreStatus", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The event data store is not in a status that supports the operation.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.cloudtrail#InvalidEventSelectorsException": { "type": "structure", "members": { @@ -1595,6 +2552,66 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudtrail#InvalidParameterException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameter", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The request includes a parameter that is not valid.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidQueryStatementException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidQueryStatement", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The query that was submitted has validation errors, or uses incorrect syntax or unsupported keywords. For more information \n about writing a query, see Create \n or edit a query in the CloudTrail User Guide.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#InvalidQueryStatusException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidQueryStatus", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "The query status is not valid for the operation.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, "com.amazonaws.cloudtrail#InvalidS3BucketNameException": { "type": "structure", "members": { @@ -1796,6 +2813,82 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudtrail#ListEventDataStores": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListEventDataStoresRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListEventDataStoresResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about all event data stores in the account, in the current region.
", + "smithy.api#idempotent": {}, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.cloudtrail#ListEventDataStoresMaxResultsCount": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.cloudtrail#ListEventDataStoresRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "A token you can use to get the next page of event data store results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudtrail#ListEventDataStoresMaxResultsCount", + "traits": { + "smithy.api#documentation": "The maximum number of event data stores to display on a single page.
" + } + } + } + }, + "com.amazonaws.cloudtrail#ListEventDataStoresResponse": { + "type": "structure", + "members": { + "EventDataStores": { + "target": "com.amazonaws.cloudtrail#EventDataStores", + "traits": { + "smithy.api#documentation": "Contains information about event data stores in the account, in the current region.
" + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "A token you can use to get the next page of results.
" + } + } + } + }, "com.amazonaws.cloudtrail#ListPublicKeys": { "type": "operation", "input": { @@ -1849,29 +2942,148 @@ "smithy.api#documentation": "Reserved for future use.
" } } - }, - "traits": { - "smithy.api#documentation": "Requests the public keys for a specified time range.
" + }, + "traits": { + "smithy.api#documentation": "Requests the public keys for a specified time range.
" + } + }, + "com.amazonaws.cloudtrail#ListPublicKeysResponse": { + "type": "structure", + "members": { + "PublicKeyList": { + "target": "com.amazonaws.cloudtrail#PublicKeyList", + "traits": { + "smithy.api#documentation": "Contains an array of PublicKey objects.
\nThe returned public keys may have validity time ranges that overlap.
\nReserved for future use.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Returns the objects or data listed below if successful. Otherwise, returns an error.
" + } + }, + "com.amazonaws.cloudtrail#ListQueries": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#ListQueriesRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#ListQueriesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidDateRangeException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidMaxResultsException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidQueryStatusException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of queries and query statuses for the past seven days. You must specify an ARN value for \n EventDataStore. Optionally, to shorten the list of results, you can specify a time range, \n formatted as timestamps, by adding StartTime and EndTime parameters, and a \n QueryStatus value. Valid values for QueryStatus include QUEUED, RUNNING, \n FINISHED, FAILED, or CANCELLED.
The ARN (or the ID suffix of the ARN) of an event data store on which queries were run.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.cloudtrail#PaginationToken", + "traits": { + "smithy.api#documentation": "A token you can use to get the next page of results.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.cloudtrail#ListQueriesMaxResultsCount", + "traits": { + "smithy.api#documentation": "The maximum number of queries to show on a page.
" + } + }, + "StartTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "Use with EndTime to bound a ListQueries request, and limit its results to only those queries run \n within a specified time period.
Use with StartTime to bound a ListQueries request, and limit its results to only those queries run \n within a specified time period.
The status of queries that you want to return in results. Valid values for QueryStatus include QUEUED, RUNNING, \n FINISHED, FAILED, or CANCELLED.
Contains an array of PublicKey objects.
\nThe returned public keys may have validity time ranges that overlap.
\nLists matching query results, and shows query ID, status, and creation time of each query.
" } }, "NextToken": { - "target": "com.amazonaws.cloudtrail#String", + "target": "com.amazonaws.cloudtrail#PaginationToken", "traits": { - "smithy.api#documentation": "Reserved for future use.
" + "smithy.api#documentation": "A token you can use to get the next page of results.
" } } - }, - "traits": { - "smithy.api#documentation": "Returns the objects or data listed below if successful. Otherwise, returns an error.
" } }, "com.amazonaws.cloudtrail#ListTags": { @@ -1886,6 +3098,12 @@ { "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, { "target": "com.amazonaws.cloudtrail#InvalidTokenException" }, @@ -2010,6 +3228,12 @@ } } }, + "com.amazonaws.cloudtrail#Long": { + "type": "long", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.cloudtrail#LookupAttribute": { "type": "structure", "members": { @@ -2183,6 +3407,36 @@ "smithy.api#documentation": "Contains a response to a LookupEvents action.
" } }, + "com.amazonaws.cloudtrail#MaxConcurrentQueriesException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "MaxConcurrentQueries", + "httpResponseCode": 429 + }, + "smithy.api#documentation": "You are already running the maximum number of concurrent queries. Wait a minute for some queries to finish, and then \n run the query again.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.cloudtrail#MaxQueryResults": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, "com.amazonaws.cloudtrail#MaxResults": { "type": "integer", "traits": { @@ -2317,6 +3571,16 @@ "smithy.api#httpError": 404 } }, + "com.amazonaws.cloudtrail#PaginationToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 1000 + }, + "smithy.api#pattern": ".*" + } + }, "com.amazonaws.cloudtrail#PublicKey": { "type": "structure", "members": { @@ -2485,7 +3749,7 @@ } ], "traits": { - "smithy.api#documentation": "Lets you enable Insights event logging by specifying the Insights\n selectors that you want to enable on an existing trail. You also use\n PutInsightSelectors to turn off Insights event logging, by passing an empty list of insight types. \n The valid Insights event type in this release is ApiCallRateInsight.
Lets you enable Insights event logging by specifying the Insights\n selectors that you want to enable on an existing trail. You also use\n PutInsightSelectors to turn off Insights event logging, by passing an empty list of insight types. \n The valid Insights event types in this release are ApiErrorRateInsight and ApiCallRateInsight.
A JSON string that contains the Insights types that you want to log on a trail. The valid Insights type in this release is ApiCallRateInsight.
A JSON string that contains the insight types you want to log on a trail. ApiCallRateInsight and ApiErrorRateInsight are valid insight types.
A JSON string that contains the Insights event types that you want to log on a trail. The valid Insights type in this release is ApiCallRateInsight.
A JSON string that contains the Insights event types that you want to log on a trail. The valid Insights types in this release are \n ApiErrorRateInsight and ApiCallRateInsight.
The ID of a query.
" + } + }, + "QueryStatus": { + "target": "com.amazonaws.cloudtrail#QueryStatus", + "traits": { + "smithy.api#documentation": "The status of the query. This can be QUEUED, RUNNING, FINISHED, FAILED, \n or CANCELLED.
The creation time of a query.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A SQL string of criteria about events that you want to collect in an event data store.
" + } + }, + "com.amazonaws.cloudtrail#QueryIdNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "QueryIdNotFound", + "httpResponseCode": 404 + }, + "smithy.api#documentation": "The query ID does not exist or does not map to a query.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.cloudtrail#QueryResultColumn": { + "type": "map", + "key": { + "target": "com.amazonaws.cloudtrail#QueryResultKey" + }, + "value": { + "target": "com.amazonaws.cloudtrail#QueryResultValue" + } + }, + "com.amazonaws.cloudtrail#QueryResultKey": { + "type": "string" + }, + "com.amazonaws.cloudtrail#QueryResultRow": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#QueryResultColumn" + } + }, + "com.amazonaws.cloudtrail#QueryResultRows": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#QueryResultRow" + } + }, + "com.amazonaws.cloudtrail#QueryResultValue": { + "type": "string" + }, + "com.amazonaws.cloudtrail#QueryStatement": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10000 + }, + "smithy.api#pattern": "^(?s)" + } + }, + "com.amazonaws.cloudtrail#QueryStatistics": { + "type": "structure", + "members": { + "ResultsCount": { + "target": "com.amazonaws.cloudtrail#Integer", + "traits": { + "smithy.api#documentation": "The number of results returned.
" + } + }, + "TotalResultsCount": { + "target": "com.amazonaws.cloudtrail#Integer", + "traits": { + "smithy.api#documentation": "The total number of results returned by a query.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Metadata about a query, such as the number of results.
" + } + }, + "com.amazonaws.cloudtrail#QueryStatisticsForDescribeQuery": { + "type": "structure", + "members": { + "EventsMatched": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "The number of events that matched a query.
" + } + }, + "EventsScanned": { + "target": "com.amazonaws.cloudtrail#Long", + "traits": { + "smithy.api#documentation": "The number of events that the query scanned in the event data store.
" + } + }, + "ExecutionTimeInMillis": { + "target": "com.amazonaws.cloudtrail#Integer", + "traits": { + "smithy.api#documentation": "The query's run time, in milliseconds.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "The creation time of the query.
" } } + }, + "traits": { + "smithy.api#documentation": "Gets metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time \n in milliseconds, and the query's creation time.
" + } + }, + "com.amazonaws.cloudtrail#QueryStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "QUEUED", + "name": "QUEUED" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "FINISHED", + "name": "FINISHED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "CANCELLED", + "name": "CANCELLED" + } + ] } }, "com.amazonaws.cloudtrail#ReadWriteType": { @@ -2556,6 +3988,12 @@ { "target": "com.amazonaws.cloudtrail#CloudTrailARNInvalidException" }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, { "target": "com.amazonaws.cloudtrail#InvalidTagParameterException" }, @@ -2596,7 +4034,8 @@ "TagsList": { "target": "com.amazonaws.cloudtrail#TagsList", "traits": { - "smithy.api#documentation": "Specifies a list of tags to be removed.
" + "smithy.api#documentation": "Specifies a list of tags to be removed.
", + "smithy.api#required": {} } } }, @@ -2666,50 +4105,187 @@ "smithy.api#httpError": 400 } }, - "com.amazonaws.cloudtrail#ResourceTag": { + "com.amazonaws.cloudtrail#ResourceTag": { + "type": "structure", + "members": { + "ResourceId": { + "target": "com.amazonaws.cloudtrail#String", + "traits": { + "smithy.api#documentation": "Specifies the ARN of the resource.
" + } + }, + "TagsList": { + "target": "com.amazonaws.cloudtrail#TagsList", + "traits": { + "smithy.api#documentation": "A list of tags.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A resource tag.
" + } + }, + "com.amazonaws.cloudtrail#ResourceTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.cloudtrail#ResourceTag" + } + }, + "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.cloudtrail#ErrorMessage", + "traits": { + "smithy.api#documentation": "Brief description of the exception returned by the request.
" + } + } + }, + "traits": { + "aws.protocols#awsQueryError": { + "code": "ResourceTypeNotSupported", + "httpResponseCode": 400 + }, + "smithy.api#documentation": "This exception is thrown when the specified resource type is not supported by CloudTrail.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.cloudtrail#RestoreEventDataStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#RestoreEventDataStoreRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#RestoreEventDataStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreMaxLimitExceededException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidEventDataStoreStatusException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "Restores a deleted event data store specified by EventDataStore, which accepts an event data store ARN. \n You can only restore a deleted event data store within the seven-day wait period after deletion. Restoring an event data store \n can take several minutes, depending on the size of the event data store.
The ARN (or the ID suffix of the ARN) of the event data store that you want to restore.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudtrail#RestoreEventDataStoreResponse": { "type": "structure", "members": { - "ResourceId": { - "target": "com.amazonaws.cloudtrail#String", + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", "traits": { - "smithy.api#documentation": "Specifies the ARN of the resource.
" + "smithy.api#documentation": "The event data store ARN.
" } }, - "TagsList": { - "target": "com.amazonaws.cloudtrail#TagsList", + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", "traits": { - "smithy.api#documentation": "A list of tags.
" + "smithy.api#documentation": "The name of the event data store.
" } - } - }, - "traits": { - "smithy.api#documentation": "A resource tag.
" - } - }, - "com.amazonaws.cloudtrail#ResourceTagList": { - "type": "list", - "member": { - "target": "com.amazonaws.cloudtrail#ResourceTag" - } - }, - "com.amazonaws.cloudtrail#ResourceTypeNotSupportedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.cloudtrail#ErrorMessage", + }, + "Status": { + "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", "traits": { - "smithy.api#documentation": "Brief description of the exception returned by the request.
" + "smithy.api#documentation": "The status of the event data store.
" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "The advanced event selectors that were used to select events.
" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the event data store is collecting events from all regions, or only from the region in which the event data \n store was created.
" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether an event data store is collecting logged events for an organization in Organizations.
" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "The retention period, in days.
" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "Indicates that termination protection is enabled and the event data store cannot be automatically deleted.
" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "The timestamp of an event data store's creation.
" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "The timestamp that shows when an event data store was updated, if applicable. \n UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
This exception is thrown when the specified resource type is not supported by CloudTrail.
", - "smithy.api#error": "client", - "smithy.api#httpError": 400 + "smithy.api#box": {}, + "smithy.api#range": { + "min": 7, + "max": 2555 + } } }, "com.amazonaws.cloudtrail#S3BucketDoesNotExistException": { @@ -2810,6 +4386,68 @@ "smithy.api#documentation": "Returns the objects or data listed below if successful. Otherwise, returns an error.
" } }, + "com.amazonaws.cloudtrail#StartQuery": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#StartQueryRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#StartQueryResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidQueryStatementException" + }, + { + "target": "com.amazonaws.cloudtrail#MaxConcurrentQueriesException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "Starts a CloudTrail Lake query. The required QueryStatement \n parameter provides your SQL query, enclosed in single quotation marks.
The SQL code of your query.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.cloudtrail#StartQueryResponse": { + "type": "structure", + "members": { + "QueryId": { + "target": "com.amazonaws.cloudtrail#UUID", + "traits": { + "smithy.api#documentation": "The ID of the started query.
" + } + } + } + }, "com.amazonaws.cloudtrail#StopLogging": { "type": "operation", "input": { @@ -2875,14 +4513,14 @@ "type": "structure", "members": { "Key": { - "target": "com.amazonaws.cloudtrail#String", + "target": "com.amazonaws.cloudtrail#TagKey", "traits": { "smithy.api#documentation": "The key in a key-value pair. The key must be must be no longer than 128 Unicode characters. \n The key must be unique for the resource to which it applies.
", "smithy.api#required": {} } }, "Value": { - "target": "com.amazonaws.cloudtrail#String", + "target": "com.amazonaws.cloudtrail#TagValue", "traits": { "smithy.api#documentation": "The value in a key-value pair of a tag. The value must be no longer than 256 Unicode characters.
" } @@ -2892,6 +4530,24 @@ "smithy.api#documentation": "A custom key-value pair associated with a resource such as a CloudTrail trail.
" } }, + "com.amazonaws.cloudtrail#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.cloudtrail#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, "com.amazonaws.cloudtrail#TagsLimitExceededException": { "type": "structure", "members": { @@ -2918,7 +4574,17 @@ "target": "com.amazonaws.cloudtrail#Tag" }, "traits": { - "smithy.api#documentation": "A list of tags.
" + "smithy.api#documentation": "A list of tags.
", + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.cloudtrail#TerminationProtectionEnabled": { + "type": "boolean", + "traits": { + "smithy.api#box": {} } }, "com.amazonaws.cloudtrail#Trail": { @@ -3130,6 +4796,16 @@ "target": "com.amazonaws.cloudtrail#TrailInfo" } }, + "com.amazonaws.cloudtrail#UUID": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 36, + "max": 36 + }, + "smithy.api#pattern": "^[a-f0-9\\-]+$" + } + }, "com.amazonaws.cloudtrail#UnsupportedOperationException": { "type": "structure", "members": { @@ -3150,6 +4826,167 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.cloudtrail#UpdateEventDataStore": { + "type": "operation", + "input": { + "target": "com.amazonaws.cloudtrail#UpdateEventDataStoreRequest" + }, + "output": { + "target": "com.amazonaws.cloudtrail#UpdateEventDataStoreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.cloudtrail#CloudTrailAccessNotEnabledException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreARNInvalidException" + }, + { + "target": "com.amazonaws.cloudtrail#EventDataStoreNotFoundException" + }, + { + "target": "com.amazonaws.cloudtrail#InactiveEventDataStoreException" + }, + { + "target": "com.amazonaws.cloudtrail#InsufficientDependencyServiceAccessPermissionException" + }, + { + "target": "com.amazonaws.cloudtrail#InvalidParameterException" + }, + { + "target": "com.amazonaws.cloudtrail#NotOrganizationMasterAccountException" + }, + { + "target": "com.amazonaws.cloudtrail#OperationNotPermittedException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationNotInAllFeaturesModeException" + }, + { + "target": "com.amazonaws.cloudtrail#OrganizationsNotInUseException" + }, + { + "target": "com.amazonaws.cloudtrail#UnsupportedOperationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates an event data store. The required EventDataStore value is an ARN or the ID portion of the ARN. \n Other parameters are optional, but at least one optional parameter must be specified, or CloudTrail throws an error. \n RetentionPeriod is in days, and valid values are integers between 90 and 2555. \n By default, TerminationProtection is enabled. AdvancedEventSelectors includes or excludes management \n and data events in your event data store; for more information about AdvancedEventSelectors, see \n PutEventSelectorsRequest$AdvancedEventSelectors.
The ARN (or the ID suffix of the ARN) of the event data store that you want to update.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "The event data store name.
" + } + }, + "AdvancedEventSelectors": { + "target": "com.amazonaws.cloudtrail#AdvancedEventSelectors", + "traits": { + "smithy.api#documentation": "The advanced event selectors used to select events for the event data store.
" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether an event data store collects events from all regions, or only from the region in which it was created.
" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether an event data store collects events logged for an organization in Organizations.
" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "The retention period, in days.
" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "Indicates that termination protection is enabled and the event data store cannot be automatically deleted.
" + } + } + } + }, + "com.amazonaws.cloudtrail#UpdateEventDataStoreResponse": { + "type": "structure", + "members": { + "EventDataStoreArn": { + "target": "com.amazonaws.cloudtrail#EventDataStoreArn", + "traits": { + "smithy.api#documentation": "The ARN of the event data store.
" + } + }, + "Name": { + "target": "com.amazonaws.cloudtrail#EventDataStoreName", + "traits": { + "smithy.api#documentation": "The name of the event data store.
" + } + }, + "Status": { + "target": "com.amazonaws.cloudtrail#EventDataStoreStatus", + "traits": { + "smithy.api#documentation": "The status of an event data store. Values can be ENABLED and PENDING_DELETION.
The advanced event selectors that are applied to the event data store.
" + } + }, + "MultiRegionEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether the event data store includes events from all regions, or only from the region in which it was created.
" + } + }, + "OrganizationEnabled": { + "target": "com.amazonaws.cloudtrail#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether an event data store is collecting logged events for an organization in Organizations.
" + } + }, + "RetentionPeriod": { + "target": "com.amazonaws.cloudtrail#RetentionPeriod", + "traits": { + "smithy.api#documentation": "The retention period, in days.
" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.cloudtrail#TerminationProtectionEnabled", + "traits": { + "smithy.api#documentation": "Indicates whether termination protection is enabled for the event data store.
" + } + }, + "CreatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "The timestamp that shows when an event data store was first created.
" + } + }, + "UpdatedTimestamp": { + "target": "com.amazonaws.cloudtrail#Date", + "traits": { + "smithy.api#documentation": "The timestamp that shows when the event data store was last updated. UpdatedTimestamp is always either the same or newer than the time shown in CreatedTimestamp.
Configuration information about the S3 bucket where Identity Resolution Jobs writes result files.
\nYou need to give Customer Profiles service principal write permission to your S3 bucket.\n Otherwise, you'll get an exception in the API response. For an example policy, see\n Amazon Connect Customer Profiles cross-service confused deputy prevention.\n
\nConfiguration information about the S3 bucket where Identity Resolution Jobs writes result files.
\nYou need to give Customer Profiles service principal write permission to your S3 bucket.\n Otherwise, you'll get an exception in the API response. For an example policy, see\n Amazon Connect Customer Profiles cross-service confused deputy prevention.
\nThe name of the profile object type.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the profile object type.
" } }, "CreatedAt": { @@ -2024,6 +2023,12 @@ "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } + }, + "ObjectTypeNames": { + "target": "com.amazonaws.customerprofiles#ObjectTypeNames", + "traits": { + "smithy.api#documentation": "A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event.\nIt supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, \nShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.
This API is in preview release for Amazon Connect and subject to change.
\nBefore calling this API, use CreateDomain or\n UpdateDomain to\n enable identity resolution: set Matching to true.
GetMatches returns potentially matching profiles, based on the results of the latest run\n of a machine learning process.
\nThe process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly\nbatch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every \nSaturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the \nGetMatches\nAPI to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from\nS3.
Amazon Connect uses the following profile attributes to identify matches:
\nPhoneNumber
\nHomePhoneNumber
\nBusinessPhoneNumber
\nMobilePhoneNumber
\nEmailAddress
\nPersonalEmailAddress
\nBusinessEmailAddress
\nFullName
\nBusinessName
\nFor example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing\n email addresses such as JOHN_DOE@ANYCOMPANY.COM and\n johndoe@anycompany.com, or different phone number\n formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.
", + "smithy.api#documentation": "Before calling this API, use CreateDomain or\n UpdateDomain to\n enable identity resolution: set Matching to true.
GetMatches returns potentially matching profiles, based on the results of the latest run\n of a machine learning process.
\nThe process of matching duplicate profiles. If Matching = true, Amazon Connect Customer Profiles starts a weekly\nbatch process called Identity Resolution Job. If you do not specify a date and time for Identity Resolution Job to run, by default it runs every \nSaturday at 12AM UTC to detect duplicate profiles in your domains.
After the Identity Resolution Job completes, use the \nGetMatches\nAPI to return and review the results. Or, if you have configured ExportingConfig in the MatchingRequest, you can download the results from\nS3.
Amazon Connect uses the following profile attributes to identify matches:
\nPhoneNumber
\nHomePhoneNumber
\nBusinessPhoneNumber
\nMobilePhoneNumber
\nEmailAddress
\nPersonalEmailAddress
\nBusinessEmailAddress
\nFullName
\nBusinessName
\nFor example, two or more profiles—with spelling mistakes such as John Doe and Jhn Doe, or different casing\n email addresses such as JOHN_DOE@ANYCOMPANY.COM and\n johndoe@anycompany.com, or different phone number\n formats such as 555-010-0000 and +1-555-010-0000—can be detected as belonging to the same customer John Doe and merged into a unified profile.
", "smithy.api#http": { "method": "GET", "uri": "/domains/{DomainName}/matches", @@ -2867,8 +2872,7 @@ "ObjectTypeName": { "target": "com.amazonaws.customerprofiles#typeName", "traits": { - "smithy.api#documentation": "The name of the profile object type.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the profile object type.
" } }, "CreatedAt": { @@ -2890,6 +2894,12 @@ "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } + }, + "ObjectTypeNames": { + "target": "com.amazonaws.customerprofiles#ObjectTypeNames", + "traits": { + "smithy.api#documentation": "A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event.\nIt supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, \nShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.
Applies a filter to the response to include profile objects with the specified index\n values. This filter is only supported for ObjectTypeName _asset and _case.
" + "smithy.api#documentation": "Applies a filter to the response to include profile objects with the specified index\n values. This filter is only supported for ObjectTypeName _asset, _case and _order.
" } } } @@ -3594,7 +3604,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and subject to change.
\nRuns an AWS Lambda job that does the following:
\nAll the profileKeys in the ProfileToBeMerged will be moved to the\n main profile.
All the objects in the ProfileToBeMerged will be moved to the main\n profile.
All the ProfileToBeMerged will be deleted at the end.
All the profileKeys in the ProfileIdsToBeMerged will be moved to the\n main profile.
Standard fields are merged as follows:
\nFields are always \"union\"-ed if there are no conflicts in standard fields or\n attributeKeys.
\nWhen there are conflicting fields:
\n\nIf no SourceProfileIds entry is specified, the main\n Profile value is always taken.
If a SourceProfileIds entry is specified, the specified\n profileId is always taken, even if it is a NULL value.
You can use MergeProfiles together with GetMatches, which\n returns potentially matching profiles, or use it with the results of another matching\n system. After profiles have been merged, they cannot be separated (unmerged).
", + "smithy.api#documentation": "Runs an AWS Lambda job that does the following:
\nAll the profileKeys in the ProfileToBeMerged will be moved to the\n main profile.
All the objects in the ProfileToBeMerged will be moved to the main\n profile.
All the ProfileToBeMerged will be deleted at the end.
All the profileKeys in the ProfileIdsToBeMerged will be moved to the\n main profile.
Standard fields are merged as follows:
\nFields are always \"union\"-ed if there are no conflicts in standard fields or\n attributeKeys.
\nWhen there are conflicting fields:
\n\nIf no SourceProfileIds entry is specified, the main\n Profile value is always taken.
If a SourceProfileIds entry is specified, the specified\n profileId is always taken, even if it is a NULL value.
You can use MergeProfiles together with GetMatches, which\n returns potentially matching profiles, or use it with the results of another matching\n system. After profiles have been merged, they cannot be separated (unmerged).
", "smithy.api#http": { "method": "POST", "uri": "/domains/{DomainName}/profiles/objects/merge", @@ -3662,7 +3672,7 @@ "KeyName": { "target": "com.amazonaws.customerprofiles#name", "traits": { - "smithy.api#documentation": "A searchable identifier of a standard profile object. The predefined keys you can use to\n search for _asset include: _assetId, _assetName, _serialNumber. The predefined keys you can\n use to search for _case include: _caseId.
", + "smithy.api#documentation": "A searchable identifier of a standard profile object. The predefined keys you can use to\n search for _asset include: _assetId, _assetName, _serialNumber. The predefined keys you can\n use to search for _case include: _caseId. The predefined keys you can use to search for\n _order include: _orderId.
", "smithy.api#required": {} } }, @@ -3675,7 +3685,7 @@ } }, "traits": { - "smithy.api#documentation": "The filter applied to ListProfileObjects response to include profile objects with the\n specified index values. This filter is only supported for ObjectTypeName _asset and\n _case.
" + "smithy.api#documentation": "The filter applied to ListProfileObjects response to include profile objects with the\n specified index values. This filter is only supported for ObjectTypeName _asset, _case and\n _order.
" } }, "com.amazonaws.customerprofiles#ObjectTypeField": { @@ -3710,7 +3720,7 @@ "StandardIdentifiers": { "target": "com.amazonaws.customerprofiles#StandardIdentifierList", "traits": { - "smithy.api#documentation": "The types of keys that a ProfileObject can have. Each ProfileObject can have only 1\n UNIQUE key but multiple PROFILE keys. PROFILE, ASSET or CASE means that this key can be\n used to tie an object to a PROFILE, ASSET or CASE respectively. UNIQUE means that it can be\n used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to\n search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is\n only used to match a profile but is not persisted to be used for searching of the profile.\n A NEW_ONLY key is only used if the profile does not already exist before the object is\n ingested, otherwise it is only used for matching objects to profiles.
" + "smithy.api#documentation": "The types of keys that a ProfileObject can have. Each ProfileObject can have only 1\n UNIQUE key but multiple PROFILE keys. PROFILE, ASSET, CASE, or ORDER means that this key can be\n used to tie an object to a PROFILE, ASSET, CASE, or ORDER respectively. UNIQUE means that it can be\n used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to\n search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is\n only used to match a profile but is not persisted to be used for searching of the profile.\n A NEW_ONLY key is only used if the profile does not already exist before the object is\n ingested, otherwise it is only used for matching objects to profiles.
" } }, "FieldNames": { @@ -3730,6 +3740,15 @@ "target": "com.amazonaws.customerprofiles#ObjectTypeKey" } }, + "com.amazonaws.customerprofiles#ObjectTypeNames": { + "type": "map", + "key": { + "target": "com.amazonaws.customerprofiles#string1To255" + }, + "value": { + "target": "com.amazonaws.customerprofiles#typeName" + } + }, "com.amazonaws.customerprofiles#OperatorPropertiesKeys": { "type": "string", "traits": { @@ -4058,8 +4077,7 @@ "ObjectTypeName": { "target": "com.amazonaws.customerprofiles#typeName", "traits": { - "smithy.api#documentation": "The name of the profile object type.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the profile object type.
" } }, "Tags": { @@ -4073,6 +4091,12 @@ "traits": { "smithy.api#documentation": "The configuration that controls how Customer Profiles retrieves data from the\n source.
" } + }, + "ObjectTypeNames": { + "target": "com.amazonaws.customerprofiles#ObjectTypeNames", + "traits": { + "smithy.api#documentation": "A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event.\nIt supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, \nShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.
The name of the profile object type.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the profile object type.
" } }, "CreatedAt": { @@ -4119,6 +4142,12 @@ "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource.
" } + }, + "ObjectTypeNames": { + "target": "com.amazonaws.customerprofiles#ObjectTypeNames", + "traits": { + "smithy.api#documentation": "A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an ObjectTypeName (template) used to ingest the event.\nIt supports the following event types: SegmentIdentify, ShopifyCreateCustomers, ShopifyUpdateCustomers, ShopifyCreateDraftOrders, \nShopifyUpdateDraftOrders, ShopifyCreateOrders, and ShopifyUpdatedOrders.
The format of your sourceLastUpdatedTimestamp that was previously set up.\n
The format of your sourceLastUpdatedTimestamp that was previously set up.\n
A searchable identifier of a customer profile. The predefined keys you can use to search include: _account, _profileId,\n _fullName, _phone, _email, _ctrContactId, _marketoLeadId, _salesforceAccountId,\n _salesforceContactId, _zendeskUserId, _zendeskExternalId, _serviceNowSystemId.
", + "smithy.api#documentation": "A searchable identifier of a customer profile. The predefined keys you can use\n to search include: _account, _profileId, _assetId, _caseId, _orderId, _fullName, _phone,\n _email, _ctrContactId, _marketoLeadId, _salesforceAccountId, _salesforceContactId,\n _salesforceAssetId, _zendeskUserId, _zendeskExternalId, _zendeskTicketId,\n _serviceNowSystemId, _serviceNowIncidentId, _segmentUserId, _shopifyCustomerId,\n _shopifyOrderId.
", "smithy.api#required": {} } }, @@ -5068,6 +5097,10 @@ { "value": "NEW_ONLY", "name": "NEW_ONLY" + }, + { + "value": "ORDER", + "name": "ORDER" } ] } diff --git a/codegen/sdk/aws-models/datasync.2018-11-09.json b/codegen/sdk/aws-models/datasync.2018-11-09.json index 793683e68ba..f8c9a4309b6 100644 --- a/codegen/sdk/aws-models/datasync.2018-11-09.json +++ b/codegen/sdk/aws-models/datasync.2018-11-09.json @@ -318,6 +318,68 @@ "smithy.api#documentation": "CreateLocationEfs
" } }, + "com.amazonaws.datasync#CreateLocationFsxLustre": { + "type": "operation", + "input": { + "target": "com.amazonaws.datasync#CreateLocationFsxLustreRequest" + }, + "output": { + "target": "com.amazonaws.datasync#CreateLocationFsxLustreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.datasync#InternalException" + }, + { + "target": "com.amazonaws.datasync#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an endpoint for an Amazon FSx for Lustre file system.
" + } + }, + "com.amazonaws.datasync#CreateLocationFsxLustreRequest": { + "type": "structure", + "members": { + "FsxFilesystemArn": { + "target": "com.amazonaws.datasync#FsxFilesystemArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the FSx for Lustre file system.
", + "smithy.api#required": {} + } + }, + "SecurityGroupArns": { + "target": "com.amazonaws.datasync#Ec2SecurityGroupArnList", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the security groups that are used to configure the FSx for Lustre file system.
", + "smithy.api#required": {} + } + }, + "Subdirectory": { + "target": "com.amazonaws.datasync#FsxLustreSubdirectory", + "traits": { + "smithy.api#documentation": "A subdirectory in the location's path. This subdirectory in the FSx for Lustre file system is used to read data from the FSx for Lustre source location or write data to the FSx for Lustre destination.
" + } + }, + "Tags": { + "target": "com.amazonaws.datasync#InputTagList", + "traits": { + "smithy.api#documentation": "The key-value pair that represents a tag that you want to add to the resource. The value can be an empty string. This value helps you manage, filter, and search for your resources. We recommend that you create a name tag for your location.
" + } + } + } + }, + "com.amazonaws.datasync#CreateLocationFsxLustreResponse": { + "type": "structure", + "members": { + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the FSx for Lustre file system location that's\n created.
" + } + } + } + }, "com.amazonaws.datasync#CreateLocationFsxWindows": { "type": "operation", "input": { @@ -344,7 +406,7 @@ "Subdirectory": { "target": "com.amazonaws.datasync#FsxWindowsSubdirectory", "traits": { - "smithy.api#documentation": "A subdirectory in the location’s path. This subdirectory in the Amazon FSx for Windows\n File Server file system is used to read data from the Amazon FSx for Windows File Server\n source location or write data to the FSx for Windows File Server destination.
" + "smithy.api#documentation": "A subdirectory in the location's path. This subdirectory in the Amazon FSx for Windows\n File Server file system is used to read data from the Amazon FSx for Windows File Server\n source location or write data to the FSx for Windows File Server destination.
" } }, "FsxFilesystemArn": { @@ -357,7 +419,7 @@ "SecurityGroupArns": { "target": "com.amazonaws.datasync#Ec2SecurityGroupArnList", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the security groups that are to use to configure the\n FSx for Windows File Server file system.
", + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the security groups that are used to configure the\n FSx for Windows File Server file system.
", "smithy.api#required": {} } }, @@ -1229,6 +1291,67 @@ "smithy.api#documentation": "DescribeLocationEfsResponse
" } }, + "com.amazonaws.datasync#DescribeLocationFsxLustre": { + "type": "operation", + "input": { + "target": "com.amazonaws.datasync#DescribeLocationFsxLustreRequest" + }, + "output": { + "target": "com.amazonaws.datasync#DescribeLocationFsxLustreResponse" + }, + "errors": [ + { + "target": "com.amazonaws.datasync#InternalException" + }, + { + "target": "com.amazonaws.datasync#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "Returns metadata, such as the path information about an Amazon FSx for Lustre\n location.
" + } + }, + "com.amazonaws.datasync#DescribeLocationFsxLustreRequest": { + "type": "structure", + "members": { + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the FSx for Lustre location to describe.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.datasync#DescribeLocationFsxLustreResponse": { + "type": "structure", + "members": { + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the FSx for Lustre location that was described.
" + } + }, + "LocationUri": { + "target": "com.amazonaws.datasync#LocationUri", + "traits": { + "smithy.api#documentation": "The URI of the FSx for Lustre location that was described.
" + } + }, + "SecurityGroupArns": { + "target": "com.amazonaws.datasync#Ec2SecurityGroupArnList", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx for Lustre file system.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.datasync#Time", + "traits": { + "smithy.api#documentation": "The time that the FSx for Lustre location was created.
" + } + } + } + }, "com.amazonaws.datasync#DescribeLocationFsxWindows": { "type": "operation", "input": { @@ -2198,6 +2321,9 @@ { "target": "com.amazonaws.datasync#CreateLocationEfs" }, + { + "target": "com.amazonaws.datasync#CreateLocationFsxLustre" + }, { "target": "com.amazonaws.datasync#CreateLocationFsxWindows" }, @@ -2234,6 +2360,9 @@ { "target": "com.amazonaws.datasync#DescribeLocationEfs" }, + { + "target": "com.amazonaws.datasync#DescribeLocationFsxLustre" + }, { "target": "com.amazonaws.datasync#DescribeLocationFsxWindows" }, @@ -2315,6 +2444,16 @@ "smithy.api#pattern": "^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):fsx:[a-z\\-0-9]*:[0-9]{12}:file-system/fs-.*$" } }, + "com.amazonaws.datasync#FsxLustreSubdirectory": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 4096 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_\\-\\+\\./\\(\\)\\$\\p{Zs}]+$" + } + }, "com.amazonaws.datasync#FsxWindowsSubdirectory": { "type": "string", "traits": { @@ -3024,7 +3163,7 @@ "LocationUri": { "target": "com.amazonaws.datasync#LocationUri", "traits": { - "smithy.api#documentation": "Represents a list of URLs of a location. LocationUri returns an array that\n contains a list of locations when the ListLocations operation is\n called.
Format: TYPE://GLOBAL_ID/SUBDIR.
TYPE designates the type of location. Valid values: NFS | EFS | S3.
\nGLOBAL_ID is the globally unique identifier of the resource that backs the location. An\n example for EFS is us-east-2.fs-abcd1234. An example for Amazon S3 is the bucket\n name, such as myBucket. An example for NFS is a valid IPv4 address or a host name\n compliant with Domain Name Service (DNS).
SUBDIR is a valid file system path, delimited by forward slashes as is the *nix\n convention. For NFS and Amazon EFS, it's the export path to mount the location. For\n Amazon S3, it's the prefix path that you mount to and treat as the root of the\n location.
\n " + "smithy.api#documentation": "Represents a list of URIs of a location. LocationUri returns an array that\n contains a list of locations when the ListLocations operation is\n called.
Format: TYPE://GLOBAL_ID/SUBDIR.
TYPE designates the type of location. Valid values: NFS | EFS | S3.
\nGLOBAL_ID is the globally unique identifier of the resource that backs the location. An\n example for EFS is us-east-2.fs-abcd1234. An example for Amazon S3 is the bucket\n name, such as myBucket. An example for NFS is a valid IPv4 address or a host name\n compliant with Domain Name Service (DNS).
SUBDIR is a valid file system path, delimited by forward slashes as is the *nix\n convention. For NFS and Amazon EFS, it's the export path to mount the location. For\n Amazon S3, it's the prefix path that you mount to and treat as the root of the\n location.
\n " } } }, @@ -3039,7 +3178,7 @@ "min": 0, "max": 4356 }, - "smithy.api#pattern": "^(efs|nfs|s3|smb|fsxw)://[a-zA-Z0-9.\\-]+$" + "smithy.api#pattern": "^(efs|nfs|s3|smb|fsxw|fsxl)://[a-zA-Z0-9.\\-]+$" } }, "com.amazonaws.datasync#LogGroupArn": { diff --git a/codegen/sdk/aws-models/detective.2018-10-26.json b/codegen/sdk/aws-models/detective.2018-10-26.json index 1a9e2eaa1a9..a974a116bf7 100644 --- a/codegen/sdk/aws-models/detective.2018-10-26.json +++ b/codegen/sdk/aws-models/detective.2018-10-26.json @@ -75,20 +75,20 @@ "AccountId": { "target": "com.amazonaws.detective#AccountId", "traits": { - "smithy.api#documentation": "The account identifier of the AWS account.
", + "smithy.api#documentation": "The account identifier of the Amazon Web Services account.
", "smithy.api#required": {} } }, "EmailAddress": { "target": "com.amazonaws.detective#EmailAddress", "traits": { - "smithy.api#documentation": "The AWS account root user email address for the AWS account.
", + "smithy.api#documentation": "The Amazon Web Services account root user email address for the Amazon Web Services\n account.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "An AWS account that is the administrator account of or a member of a behavior\n graph.
" + "smithy.api#documentation": "An Amazon Web Services account that is the administrator account of or a member of a\n behavior graph.
" } }, "com.amazonaws.detective#AccountId": { @@ -125,8 +125,55 @@ } } }, + "com.amazonaws.detective#Administrator": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.detective#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account identifier of the Detective administrator\n account for the organization.
" + } + }, + "GraphArn": { + "target": "com.amazonaws.detective#GraphArn", + "traits": { + "smithy.api#documentation": "The ARN of the organization behavior graph.
" + } + }, + "DelegationTime": { + "target": "com.amazonaws.detective#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time when the Detective administrator account was enabled. The\n value is an ISO8601 formatted string. For example,\n 2021-08-18T16:35:56.284Z.
Information about the Detective administrator account for an\n organization.
" + } + }, + "com.amazonaws.detective#AdministratorList": { + "type": "list", + "member": { + "target": "com.amazonaws.detective#Administrator" + } + }, "com.amazonaws.detective#AmazonDetective": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Detective", + "arnNamespace": "detective", + "cloudFormationName": "Detective", + "cloudTrailEventSource": "detective.amazonaws.com", + "endpointPrefix": "api.detective" + }, + "aws.auth#sigv4": { + "name": "detective" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Detective uses machine learning and purpose-built visualizations to help you to\n analyze and investigate security issues across your Amazon Web Services (Amazon Web Services) workloads. Detective automatically extracts time-based events such\n as login attempts, API calls, and network traffic from CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by\n Amazon GuardDuty.
\nThe Detective API primarily supports the creation and management of behavior\n graphs. A behavior graph contains the extracted data from a set of member accounts, and is\n created and managed by an administrator account.
\nTo add a member account to the behavior graph, the administrator account sends an\n invitation to the account. When the account accepts the invitation, it becomes a member\n account in the behavior graph.
\nDetective is also integrated with Organizations. The organization\n management account designates the Detective administrator account for the\n organization. That account becomes the administrator account for the organization behavior\n graph. The Detective administrator account can enable any organization account as\n a member account in the organization behavior graph. The organization accounts do not\n receive invitations. The Detective administrator account can also invite other\n accounts to the organization behavior graph.
\nEvery behavior graph is specific to a Region. You can only use the API to manage\n behavior graphs that belong to the Region that is associated with the currently selected\n endpoint.
\nThe administrator account for a behavior graph can use the Detective API to do\n the following:
\nEnable and disable Detective. Enabling Detective creates a new\n behavior graph.
\nView the list of member accounts in a behavior graph.
\nAdd member accounts to a behavior graph.
\nRemove member accounts from a behavior graph.
\nApply tags to a behavior graph.
\nThe organization management account can use the Detective API to select the\n delegated administrator for Detective.
\nThe Detective administrator account for an organization can use the Detective API to do the following:
\nPerform all of the functions of an administrator account.
\nDetermine whether to automatically enable new organization accounts as member\n accounts in the organization behavior graph.
\nAn invited member account can use the Detective API to do the following:
\nView the list of behavior graphs that they are invited to.
\nAccept an invitation to contribute to a behavior graph.
\nDecline an invitation to contribute to a behavior graph.
\nRemove their account from a behavior graph.
\nAll API actions are logged as CloudTrail events. See Logging Detective API Calls with CloudTrail.
\nWe replaced the term \"master account\" with the term \"administrator account.\" An\n administrator account is used to centrally manage multiple accounts. In the case of\n Detective, the administrator account manages the accounts in their behavior\n graph.
\nDetective uses machine learning and purpose-built visualizations to help you analyze and\n investigate security issues across your Amazon Web Services (AWS) workloads. Detective automatically\n extracts time-based events such as login attempts, API calls, and network traffic from\n AWS CloudTrail and Amazon Virtual Private Cloud (Amazon VPC) flow logs. It also extracts findings detected by\n Amazon GuardDuty.
\nThe Detective API primarily supports the creation and management of behavior graphs. A\n behavior graph contains the extracted data from a set of member accounts, and is created\n and managed by an administrator account.
\nEvery behavior graph is specific to a Region. You can only use the API to manage graphs\n that belong to the Region that is associated with the currently selected endpoint.
\nA Detective administrator account can use the Detective API to do the following:
\nEnable and disable Detective. Enabling Detective creates a new behavior graph.
\nView the list of member accounts in a behavior graph.
\nAdd member accounts to a behavior graph.
\nRemove member accounts from a behavior graph.
\nA member account can use the Detective API to do the following:
\nView the list of behavior graphs that they are invited to.
\nAccept an invitation to contribute to a behavior graph.
\nDecline an invitation to contribute to a behavior graph.
\nRemove their account from a behavior graph.
\nAll API actions are logged as CloudTrail events. See Logging Detective API Calls with CloudTrail.
\nWe replaced the term \"master account\" with the term \"administrator account.\" An\n administrator account is used to centrally manage multiple accounts. In the case of\n Detective, the administrator account manages the accounts in their behavior graph.
\nCreates a new behavior graph for the calling account, and sets that account as the\n administrator account. This operation is called by the account that is enabling\n Detective.
\nBefore you try to enable Detective, make sure that your account has been enrolled in\n Amazon GuardDuty for at least 48 hours. If you do not meet this requirement, you cannot enable\n Detective. If you do meet the GuardDuty prerequisite, then when you make the request to enable\n Detective, it checks whether your data volume is within the Detective quota. If it exceeds the\n quota, then you cannot enable Detective.
\nThe operation also enables Detective for the calling account in the currently selected\n Region. It returns the ARN of the new behavior graph.
\n\n CreateGraph triggers a process to create the corresponding data tables for\n the new behavior graph.
An account can only be the administrator account for one behavior graph within a Region.\n If the same account calls CreateGraph with the same administrator account, it\n always returns the same behavior graph ARN. It does not create a new behavior graph.
Creates a new behavior graph for the calling account, and sets that account as the\n administrator account. This operation is called by the account that is enabling Detective.
\nBefore you try to enable Detective, make sure that your account has been\n enrolled in Amazon GuardDuty for at least 48 hours. If you do not meet this\n requirement, you cannot enable Detective. If you do meet the GuardDuty\n prerequisite, then when you make the request to enable Detective, it checks\n whether your data volume is within the Detective quota. If it exceeds the quota,\n then you cannot enable Detective.
\nThe operation also enables Detective for the calling account in the currently\n selected Region. It returns the ARN of the new behavior graph.
\n\n CreateGraph triggers a process to create the corresponding data tables for\n the new behavior graph.
An account can only be the administrator account for one behavior graph within a Region.\n If the same account calls CreateGraph with the same administrator account, it\n always returns the same behavior graph ARN. It does not create a new behavior graph.
Sends a request to invite the specified AWS accounts to be member accounts in the\n behavior graph. This operation can only be called by the administrator account for a\n behavior graph.
\n\n CreateMembers verifies the accounts and then invites the verified accounts.\n The administrator can optionally specify to not send invitation emails to the member\n accounts. This would be used when the administrator manages their member accounts\n centrally.
The request provides the behavior graph ARN and the list of accounts to invite.
\nThe response separates the requested accounts into two lists:
\nThe accounts that CreateMembers was able to start the verification\n for. This list includes member accounts that are being verified, that have passed\n verification and are to be invited, and that have failed verification.
The accounts that CreateMembers was unable to process. This list\n includes accounts that were already invited to be member accounts in the behavior\n graph.
\n CreateMembers is used to send invitations to accounts. For the organization\n behavior graph, the Detective administrator account uses\n CreateMembers to enable organization accounts as member accounts.
For invited accounts, CreateMembers sends a request to invite the specified\n Amazon Web Services accounts to be member accounts in the behavior graph. This operation\n can only be called by the administrator account for a behavior graph.
\n CreateMembers verifies the accounts and then invites the verified accounts.\n The administrator can optionally specify to not send invitation emails to the member\n accounts. This would be used when the administrator manages their member accounts\n centrally.
For organization accounts in the organization behavior graph, CreateMembers\n attempts to enable the accounts. The organization accounts do not receive\n invitations.
The request provides the behavior graph ARN and the list of accounts to invite or to\n enable.
\nThe response separates the requested accounts into two lists:
\nThe accounts that CreateMembers was able to process. For invited\n accounts, includes member accounts that are being verified, that have passed\n verification and are to be invited, and that have failed verification. For\n organization accounts in the organization behavior graph, includes accounts that can\n be enabled and that cannot be enabled.
The accounts that CreateMembers was unable to process. This list\n includes accounts that were already invited to be member accounts in the behavior\n graph.
The ARN of the behavior graph to invite the member accounts to contribute their data\n to.
", + "smithy.api#documentation": "The ARN of the behavior graph.
", "smithy.api#required": {} } }, @@ -313,13 +360,13 @@ "DisableEmailNotification": { "target": "com.amazonaws.detective#Boolean", "traits": { - "smithy.api#documentation": "if set to true, then the member accounts do not receive email\n notifications. By default, this is set to false, and the member accounts\n receive email notifications.
if set to true, then the invited accounts do not receive email\n notifications. By default, this is set to false, and the invited accounts\n receive email notifications.
Organization accounts in the organization behavior graph do not receive email\n notifications.
" } }, "Accounts": { "target": "com.amazonaws.detective#AccountList", "traits": { - "smithy.api#documentation": "The list of AWS accounts to invite to become member accounts in the behavior graph.\n You can invite up to 50 accounts at a time. For each invited account, the account list\n contains the account identifier and the AWS account root user email address.
", + "smithy.api#documentation": "The list of Amazon Web Services accounts to invite or to enable. You can invite or enable\n up to 50 accounts at a time. For each invited account, the account list contains the\n account identifier and the Amazon Web Services account root user email address. For\n organization accounts in the organization behavior graph, the email address is not\n required.
", "smithy.api#required": {} } } @@ -331,13 +378,13 @@ "Members": { "target": "com.amazonaws.detective#MemberDetailList", "traits": { - "smithy.api#documentation": "The set of member account invitation requests that Detective was able to process. This\n includes accounts that are being verified, that failed verification, and that passed\n verification and are being sent an invitation.
" + "smithy.api#documentation": "The set of member account invitation or enablement requests that Detective was\n able to process. This includes accounts that are being verified, that failed verification,\n and that passed verification and are being sent an invitation or are being enabled.
" } }, "UnprocessedAccounts": { "target": "com.amazonaws.detective#UnprocessedAccountList", "traits": { - "smithy.api#documentation": "The list of accounts for which Detective was unable to process the invitation request. For\n each account, the list provides the reason why the request could not be processed. The list\n includes accounts that are already member accounts in the behavior graph.
" + "smithy.api#documentation": "The list of accounts for which Detective was unable to process the invitation\n or enablement request. For each account, the list provides the reason why the request could\n not be processed. The list includes accounts that are already member accounts in the\n behavior graph.
" } } } @@ -359,7 +406,7 @@ } ], "traits": { - "smithy.api#documentation": "Disables the specified behavior graph and queues it to be deleted. This operation\n removes the graph from each member account's list of behavior graphs.
\n\n DeleteGraph can only be called by the administrator account for a behavior\n graph.
Disables the specified behavior graph and queues it to be deleted. This operation\n removes the behavior graph from each member account's list of behavior graphs.
\n\n DeleteGraph can only be called by the administrator account for a behavior\n graph.
Deletes one or more member accounts from the administrator account's behavior graph.\n This operation can only be called by a Detective administrator account. That account cannot use\n DeleteMembers to delete their own account from the behavior graph. To\n disable a behavior graph, the administrator account uses the DeleteGraph API\n method.
Removes the specified member accounts from the behavior graph. The removed accounts no\n longer contribute data to the behavior graph. This operation can only be called by the\n administrator account for the behavior graph.
\nFor invited accounts, the removed accounts are deleted from the list of accounts in the\n behavior graph. To restore the account, the administrator account must send another\n invitation.
\nFor organization accounts in the organization behavior graph, the Detective\n administrator account can always enable the organization account again. Organization\n accounts that are not enabled as member accounts are not included in the\n ListMembers results for the organization behavior graph.
An administrator account cannot use DeleteMembers to remove their own\n account from the behavior graph. To disable a behavior graph, the administrator account\n uses the DeleteGraph API method.
The ARN of the behavior graph to delete members from.
", + "smithy.api#documentation": "The ARN of the behavior graph to remove members from.
", "smithy.api#required": {} } }, "AccountIds": { "target": "com.amazonaws.detective#AccountIdList", "traits": { - "smithy.api#documentation": "The list of AWS account identifiers for the member accounts to delete from the\n behavior graph. You can delete up to 50 member accounts at a time.
", + "smithy.api#documentation": "The list of Amazon Web Services account identifiers for the member accounts to remove\n from the behavior graph. You can remove up to 50 member accounts at a time.
", "smithy.api#required": {} } } @@ -435,17 +482,90 @@ "AccountIds": { "target": "com.amazonaws.detective#AccountIdList", "traits": { - "smithy.api#documentation": "The list of AWS account identifiers for the member accounts that Detective successfully\n deleted from the behavior graph.
" + "smithy.api#documentation": "The list of Amazon Web Services account identifiers for the member accounts that Detective successfully removed from the behavior graph.
" } }, "UnprocessedAccounts": { "target": "com.amazonaws.detective#UnprocessedAccountList", "traits": { - "smithy.api#documentation": "The list of member accounts that Detective was not able to delete from the behavior graph.\n For each member account, provides the reason that the deletion could not be\n processed.
" + "smithy.api#documentation": "The list of member accounts that Detective was not able to remove from the\n behavior graph. For each member account, provides the reason that the deletion could not be\n processed.
" + } + } + } + }, + "com.amazonaws.detective#DescribeOrganizationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.detective#DescribeOrganizationConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.detective#DescribeOrganizationConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.detective#InternalServerException" + }, + { + "target": "com.amazonaws.detective#TooManyRequestsException" + }, + { + "target": "com.amazonaws.detective#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about the configuration for the organization behavior graph.\n Currently indicates whether to automatically enable new organization accounts as member\n accounts.
\nCan only be called by the Detective administrator account for the organization.
", + "smithy.api#http": { + "method": "POST", + "uri": "/orgs/describeOrganizationConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.detective#DescribeOrganizationConfigurationRequest": { + "type": "structure", + "members": { + "GraphArn": { + "target": "com.amazonaws.detective#GraphArn", + "traits": { + "smithy.api#documentation": "The ARN of the organization behavior graph.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.detective#DescribeOrganizationConfigurationResponse": { + "type": "structure", + "members": { + "AutoEnable": { + "target": "com.amazonaws.detective#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether to automatically enable new organization accounts as member accounts\n in the organization behavior graph.
" } } } }, + "com.amazonaws.detective#DisableOrganizationAdminAccount": { + "type": "operation", + "errors": [ + { + "target": "com.amazonaws.detective#InternalServerException" + }, + { + "target": "com.amazonaws.detective#TooManyRequestsException" + }, + { + "target": "com.amazonaws.detective#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes the Detective administrator account for the organization in the current\n Region. Deletes the behavior graph for that account.
\nCan only be called by the organization management account. Before you can select a\n different Detective administrator account, you must remove the Detective\n administrator account in all Regions.
", + "smithy.api#http": { + "method": "POST", + "uri": "/orgs/disableAdminAccount", + "code": 200 + } + } + }, "com.amazonaws.detective#DisassociateMembership": { "type": "operation", "input": { @@ -466,7 +586,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the member account from the specified behavior graph. This operation can only be\n called by a member account that has the ENABLED status.
Removes the member account from the specified behavior graph. This operation can only be\n called by an invited member account that has the ENABLED status.
\n DisassociateMembership cannot be called by an organization account in the\n organization behavior graph. For the organization behavior graph, the Detective\n administrator account determines which organization accounts to enable or disable as member\n accounts.
Designates the Detective administrator account for the organization in the\n current Region.
\nIf the account does not have Detective enabled, then enables Detective\n for that account and creates a new behavior graph.
\nCan only be called by the organization management account.
\nThe Detective administrator account for an organization must be the same in all\n Regions. If you already designated a Detective administrator account in another\n Region, then you must designate the same account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/orgs/enableAdminAccount", + "code": 200 + } + } + }, + "com.amazonaws.detective#EnableOrganizationAdminAccountRequest": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.detective#AccountId", + "traits": { + "smithy.api#documentation": "The Amazon Web Services account identifier of the account to designate as the Detective administrator account for the organization.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.detective#ErrorMessage": { "type": "string" }, @@ -549,7 +706,7 @@ "AccountIds": { "target": "com.amazonaws.detective#AccountIdList", "traits": { - "smithy.api#documentation": "The list of AWS account identifiers for the member account for which to return member\n details. You can request details for up to 50 member accounts at a time.
\nYou cannot use GetMembers to retrieve information about member accounts\n that were removed from the behavior graph.
The list of Amazon Web Services account identifiers for the member account for which to\n return member details. You can request details for up to 50 member accounts at a\n time.
\nYou cannot use GetMembers to retrieve information about member accounts\n that were removed from the behavior graph.
The member account details that Detective is returning in response to the request.
" + "smithy.api#documentation": "The member account details that Detective is returning in response to the\n request.
" } }, "UnprocessedAccounts": { @@ -584,7 +741,7 @@ "CreatedTime": { "target": "com.amazonaws.detective#Timestamp", "traits": { - "smithy.api#documentation": "The date and time that the behavior graph was created. The value is in milliseconds\n since the epoch.
" + "smithy.api#documentation": "The date and time that the behavior graph was created. The value is an ISO8601 formatted\n string. For example, 2021-08-18T16:35:56.284Z.
Retrieves the list of open and accepted behavior graph invitations for the member\n account. This operation can only be called by a member account.
\nOpen invitations are invitations that the member account has not responded to.
\nThe results do not include behavior graphs for which the member account declined the\n invitation. The results also do not include behavior graphs that the member account\n resigned from or was removed from.
", + "smithy.api#documentation": "Retrieves the list of open and accepted behavior graph invitations for the member\n account. This operation can only be called by an invited member account.
\nOpen invitations are invitations that the member account has not responded to.
\nThe results do not include behavior graphs for which the member account declined the\n invitation. The results also do not include behavior graphs that the member account\n resigned from or was removed from.
", "smithy.api#http": { "method": "POST", "uri": "/invitations/list", @@ -765,7 +937,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the list of member accounts for a behavior graph. Does not return member\n accounts that were removed from the behavior graph.
", + "smithy.api#documentation": "Retrieves the list of member accounts for a behavior graph.
\nFor invited accounts, the results do not include member accounts that were removed from\n the behavior graph.
\nFor the organization behavior graph, the results do not include organization accounts\n that the Detective administrator account has not enabled as member\n accounts.
", "smithy.api#http": { "method": "POST", "uri": "/graph/members/list", @@ -808,13 +980,80 @@ "MemberDetails": { "target": "com.amazonaws.detective#MemberDetailList", "traits": { - "smithy.api#documentation": "The list of member accounts in the behavior graph.
\nThe results include member accounts that did not pass verification and member accounts\n that have not yet accepted the invitation to the behavior graph. The results do not include\n member accounts that were removed from the behavior graph.
" + "smithy.api#documentation": "The list of member accounts in the behavior graph.
\nFor invited accounts, the results include member accounts that did not pass verification\n and member accounts that have not yet accepted the invitation to the behavior graph. The\n results do not include member accounts that were removed from the behavior graph.
\nFor the organization behavior graph, the results do not include organization accounts\n that the Detective administrator account has not enabled as member\n accounts.
" + } + }, + "NextToken": { + "target": "com.amazonaws.detective#PaginationToken", + "traits": { + "smithy.api#documentation": "If there are more member accounts remaining in the results, then use this pagination\n token to request the next page of member accounts.
" + } + } + } + }, + "com.amazonaws.detective#ListOrganizationAdminAccounts": { + "type": "operation", + "input": { + "target": "com.amazonaws.detective#ListOrganizationAdminAccountsRequest" + }, + "output": { + "target": "com.amazonaws.detective#ListOrganizationAdminAccountsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.detective#InternalServerException" + }, + { + "target": "com.amazonaws.detective#TooManyRequestsException" + }, + { + "target": "com.amazonaws.detective#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns information about the Detective administrator account for an\n organization. Can only be called by the organization management account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/orgs/adminAccountslist", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.detective#ListOrganizationAdminAccountsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.detective#PaginationToken", + "traits": { + "smithy.api#documentation": "For requests to get the next page of results, the pagination token that was returned\n with the previous set of results. The initial request does not include a pagination\n token.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.detective#MemberResultsLimit", + "traits": { + "smithy.api#documentation": "The maximum number of results to return.
" + } + } + } + }, + "com.amazonaws.detective#ListOrganizationAdminAccountsResponse": { + "type": "structure", + "members": { + "Administrators": { + "target": "com.amazonaws.detective#AdministratorList", + "traits": { + "smithy.api#documentation": "The list of delegated administrator accounts.
" } }, "NextToken": { "target": "com.amazonaws.detective#PaginationToken", "traits": { - "smithy.api#documentation": "If there are more member accounts remaining in the results, then this is the pagination\n token to use to request the next page of member accounts.
" + "smithy.api#documentation": "If there are more accounts remaining in the results, then this is the pagination token\n to use to request the next page of accounts.
" } } } @@ -877,19 +1116,19 @@ "AccountId": { "target": "com.amazonaws.detective#AccountId", "traits": { - "smithy.api#documentation": "The AWS account identifier for the member account.
" + "smithy.api#documentation": "The Amazon Web Services account identifier for the member account.
" } }, "EmailAddress": { "target": "com.amazonaws.detective#EmailAddress", "traits": { - "smithy.api#documentation": "The AWS account root user email address for the member account.
" + "smithy.api#documentation": "The Amazon Web Services account root user email address for the member account.
" } }, "GraphArn": { "target": "com.amazonaws.detective#GraphArn", "traits": { - "smithy.api#documentation": "The ARN of the behavior graph that the member account was invited to.
" + "smithy.api#documentation": "The ARN of the behavior graph.
" } }, "MasterId": { @@ -898,37 +1137,37 @@ "smithy.api#deprecated": { "message": "This property is deprecated. Use AdministratorId instead." }, - "smithy.api#documentation": "The AWS account identifier of the administrator account for the behavior graph.
" + "smithy.api#documentation": "The Amazon Web Services account identifier of the administrator account for the behavior\n graph.
" } }, "AdministratorId": { "target": "com.amazonaws.detective#AccountId", "traits": { - "smithy.api#documentation": "The AWS account identifier of the administrator account for the behavior graph.
" + "smithy.api#documentation": "The Amazon Web Services account identifier of the administrator account for the behavior\n graph.
" } }, "Status": { "target": "com.amazonaws.detective#MemberStatus", "traits": { - "smithy.api#documentation": "The current membership status of the member account. The status can have one of the\n following values:
\n\n INVITED - Indicates that the member was sent an invitation but has\n not yet responded.
\n VERIFICATION_IN_PROGRESS - Indicates that Detective is verifying that the\n account identifier and email address provided for the member account match. If they\n do match, then Detective sends the invitation. If the email address and account\n identifier don't match, then the member cannot be added to the behavior graph.
\n VERIFICATION_FAILED - Indicates that the account and email address\n provided for the member account do not match, and Detective did not send an invitation to\n the account.
\n ENABLED - Indicates that the member account accepted the invitation\n to contribute to the behavior graph.
\n ACCEPTED_BUT_DISABLED - Indicates that the member account accepted\n the invitation but is prevented from contributing data to the behavior graph.\n DisabledReason provides the reason why the member account is not\n enabled.
Member accounts that declined an invitation or that were removed from the behavior graph\n are not included.
" + "smithy.api#documentation": "The current membership status of the member account. The status can have one of the\n following values:
\n\n INVITED - For invited accounts only. Indicates that the member was\n sent an invitation but has not yet responded.
\n VERIFICATION_IN_PROGRESS - For invited accounts only, indicates that\n Detective is verifying that the account identifier and email address\n provided for the member account match. If they do match, then Detective\n sends the invitation. If the email address and account identifier don't match, then\n the member cannot be added to the behavior graph.
For organization accounts in the organization behavior graph, indicates that\n Detective is verifying that the account belongs to the\n organization.
\n\n VERIFICATION_FAILED - For invited accounts only. Indicates that the\n account and email address provided for the member account do not match, and Detective did not send an invitation to the account.
\n ENABLED - Indicates that the member account currently contributes\n data to the behavior graph. For invited accounts, the member account accepted the\n invitation. For organization accounts in the organization behavior graph, the Detective administrator account enabled the organization account as a member\n account.
\n ACCEPTED_BUT_DISABLED - The account accepted the invitation, or was\n enabled by the Detective administrator account, but is prevented from\n contributing data to the behavior graph. DisabledReason provides the\n reason why the member account is not enabled.
Invited accounts that declined an invitation or that were removed from the behavior\n graph are not included. In the organization behavior graph, organization accounts that the\n Detective administrator account did not enable are not included.
" } }, "DisabledReason": { "target": "com.amazonaws.detective#MemberDisabledReason", "traits": { - "smithy.api#documentation": "For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that\n the member account is not enabled.
The reason can have one of the following values:
\n\n VOLUME_TOO_HIGH - Indicates that adding the member account would\n cause the data volume for the behavior graph to be too high.
\n VOLUME_UNKNOWN - Indicates that Detective is unable to verify the data\n volume for the member account. This is usually because the member account is not\n enrolled in Amazon GuardDuty.
For member accounts with a status of ACCEPTED_BUT_DISABLED, the reason that\n the member account is not enabled.
The reason can have one of the following values:
\n\n VOLUME_TOO_HIGH - Indicates that adding the member account would\n cause the data volume for the behavior graph to be too high.
\n VOLUME_UNKNOWN - Indicates that Detective is unable to\n verify the data volume for the member account. This is usually because the member\n account is not enrolled in Amazon GuardDuty.
The date and time that Detective sent the invitation to the member account. The value is in\n milliseconds since the epoch.
" + "smithy.api#documentation": "For invited accounts, the date and time that Detective sent the invitation to\n the account. The value is an ISO8601 formatted string. For example,\n 2021-08-18T16:35:56.284Z.
The date and time that the member account was last updated. The value is in milliseconds\n since the epoch.
" + "smithy.api#documentation": "The date and time that the member account was last updated. The value is an ISO8601\n formatted string. For example, 2021-08-18T16:35:56.284Z.
The data and time when the member account data volume was last updated.
" + "smithy.api#documentation": "The data and time when the member account data volume was last updated. The value is an\n ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
The date and time when the graph utilization percentage was last updated.
" + "smithy.api#documentation": "The date and time when the graph utilization percentage was last updated. The value is\n an ISO8601 formatted string. For example, 2021-08-18T16:35:56.284Z.
The type of behavior graph membership.
\nFor an organization account in the organization behavior graph, the type is\n ORGANIZATION.
For an account that was invited to a behavior graph, the type is\n INVITATION.
Details about a member account that was invited to contribute to a behavior\n graph.
" + "smithy.api#documentation": "Details about a member account in a behavior graph.
" } }, "com.amazonaws.detective#MemberDetailList": { @@ -1059,7 +1304,7 @@ } ], "traits": { - "smithy.api#documentation": "Rejects an invitation to contribute the account data to a behavior graph. This operation\n must be called by a member account that has the INVITED status.
Rejects an invitation to contribute the account data to a behavior graph. This operation\n must be called by an invited member account that has the INVITED\n status.
\n RejectInvitation cannot be called by an organization account in the\n organization behavior graph. In the organization behavior graph, organization accounts do\n not receive an invitation.
This request cannot be completed for one of the following reasons.
\nThe request would cause the number of member accounts in the behavior graph to\n exceed the maximum allowed. A behavior graph cannot have more than 1000 member\n accounts.
\nThe request would cause the data rate for the behavior graph to exceed the maximum\n allowed.
\nDetective is unable to verify the data rate for the member account. This is usually\n because the member account is not enrolled in Amazon GuardDuty.
\nThis request cannot be completed for one of the following reasons.
\nThe request would cause the number of member accounts in the behavior graph to\n exceed the maximum allowed. A behavior graph cannot have more than 1200 member\n accounts.
\nThe request would cause the data rate for the behavior graph to exceed the maximum\n allowed.
\nDetective is unable to verify the data rate for the member account. This\n is usually because the member account is not enrolled in Amazon GuardDuty.
\nSends a request to enable data ingest for a member account that has a status of\n ACCEPTED_BUT_DISABLED.
For valid member accounts, the status is updated as follows.
\nIf Detective enabled the member account, then the new status is\n ENABLED.
If Detective cannot enable the member account, the status remains\n ACCEPTED_BUT_DISABLED.
Sends a request to enable data ingest for a member account that has a status of\n ACCEPTED_BUT_DISABLED.
For valid member accounts, the status is updated as follows.
\nIf Detective enabled the member account, then the new status is\n ENABLED.
If Detective cannot enable the member account, the status remains\n ACCEPTED_BUT_DISABLED.
The request cannot be completed because too many other requests are occurring at the\n same time.
", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, "com.amazonaws.detective#UnprocessedAccount": { "type": "structure", "members": { "AccountId": { "target": "com.amazonaws.detective#AccountId", "traits": { - "smithy.api#documentation": "The AWS account identifier of the member account that was not processed.
" + "smithy.api#documentation": "The Amazon Web Services account identifier of the member account that was not\n processed.
" } }, "Reason": { @@ -1341,6 +1599,49 @@ "type": "structure", "members": {} }, + "com.amazonaws.detective#UpdateOrganizationConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.detective#UpdateOrganizationConfigurationRequest" + }, + "errors": [ + { + "target": "com.amazonaws.detective#InternalServerException" + }, + { + "target": "com.amazonaws.detective#TooManyRequestsException" + }, + { + "target": "com.amazonaws.detective#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates the configuration for the Organizations integration in the current Region.\n Can only be called by the Detective administrator account for the\n organization.
", + "smithy.api#http": { + "method": "POST", + "uri": "/orgs/updateOrganizationConfiguration", + "code": 200 + } + } + }, + "com.amazonaws.detective#UpdateOrganizationConfigurationRequest": { + "type": "structure", + "members": { + "GraphArn": { + "target": "com.amazonaws.detective#GraphArn", + "traits": { + "smithy.api#documentation": "The ARN of the organization behavior graph.
", + "smithy.api#required": {} + } + }, + "AutoEnable": { + "target": "com.amazonaws.detective#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether to automatically enable new organization accounts as member accounts\n in the organization behavior graph.
" + } + } + } + }, "com.amazonaws.detective#ValidationException": { "type": "structure", "members": { diff --git a/codegen/sdk/aws-models/devopsguru.2020-12-01.json b/codegen/sdk/aws-models/devopsguru.2020-12-01.json index cb3eb4d29ee..74db84bada5 100644 --- a/codegen/sdk/aws-models/devopsguru.2020-12-01.json +++ b/codegen/sdk/aws-models/devopsguru.2020-12-01.json @@ -1439,6 +1439,12 @@ "traits": { "smithy.api#documentation": "The pagination token to use to retrieve \n the next page of results for this operation. If there are no more pages, this value is null.
" } + }, + "Tags": { + "target": "com.amazonaws.devopsguru#TagHealths", + "traits": { + "smithy.api#documentation": "Tags help you identify and organize your Amazon Web Services resources. Many Amazon Web Services services support\n \t\ttagging, so you can assign the same tag to resources from different services to indicate\n \t\tthat the resources are related. For example, you can assign the same tag to an Amazon DynamoDB\n \t\ttable resource that you assign to an Lambda function. For more information about\n \t\tusing tags, see the Tagging\n \t\t\tbest practices whitepaper.
\n \tEach Amazon Web Services tag has two parts.
\n \tA tag key (for example, CostCenter,\n \t\t\t\tEnvironment, Project, or Secret). Tag\n \t\t\t\tkeys are case-sensitive.
An optional field known as a tag value (for example,\n \t\t\t\t111122223333, Production, or a team\n \t\t\t\tname). Omitting the tag value is the same as using an empty\n \t\t\t\tstring. Like tag keys, tag values are\n \t\t\t\tcase-sensitive.
Together these are known as key-value pairs.
\n \tThe string used for a key in a tag that you use to define your resource coverage must begin with the\n\t\t\tprefix Devops-guru-. The tag key might be\n\t\t\tDevops-guru-deployment-application or\n\t\t\tDevops-guru-rds-application. While keys are case-sensitive, the\n\t\t\tcase of key characters don't matter to DevOps Guru. For example, DevOps Guru works with a\n\t\t\tkey named devops-guru-rds and a key named\n\t\t\tDevOps-Guru-RDS. Possible key/value pairs in your\n\t\t\tapplication might be Devops-Guru-production-application/RDS or\n\t\t\tDevops-Guru-production-application/containers.
Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the AWS Cloud. \n Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications \n faster. Amazon Virtual Private Cloud (Amazon VPC) enables you to provision a logically isolated section of the \n AWS Cloud where you can launch AWS resources in a virtual network that you've defined. Amazon Elastic Block Store \n (Amazon EBS) provides block level storage volumes for use with EC2 instances. EBS volumes are highly available \n and reliable storage volumes that can be attached to any running instance and used like a hard drive.
\nTo learn more, see the following resources:
\nAmazon EC2: AmazonEC2 product page, Amazon EC2 documentation\n
\nAmazon EBS: Amazon EBS product page, Amazon EBS documentation\n
\nAmazon VPC: Amazon VPC product page, Amazon VPC documentation\n
\nAWS VPN: AWS VPN product page, AWS VPN documentation\n
\nAmazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the Amazon Web Services Cloud. \n Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications \n faster. Amazon Virtual Private Cloud (Amazon VPC) enables you to provision a logically isolated section of the \n Amazon Web Services Cloud where you can launch Amazon Web Services resources in a virtual network that you've defined. Amazon Elastic Block Store \n (Amazon EBS) provides block level storage volumes for use with EC2 instances. EBS volumes are highly available \n and reliable storage volumes that can be attached to any running instance and used like a hard drive.
\nTo learn more, see the following resources:
\nAmazon EC2: AmazonEC2 product page, Amazon EC2 documentation\n
\nAmazon EBS: Amazon EBS product page, Amazon EBS documentation\n
\nAmazon VPC: Amazon VPC product page, Amazon VPC documentation\n
\nAmazon Web Services VPN: Amazon Web Services VPN product page, Amazon Web Services VPN documentation\n
\nThe ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. \n\t\t\tOnly valid for Capacity Reservations that were created by a Capacity Reservation Fleet.
", "smithy.api#xmlName": "capacityReservationFleetId" } + }, + "PlacementGroupArn": { + "target": "com.amazonaws.ec2#PlacementGroupArn", + "traits": { + "aws.protocols#ec2QueryName": "PlacementGroupArn", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster placement group in which \n\t\t\tthe Capacity Reservation was created. For more information, see \n\t\t\t\n\t\t\t\tCapacity Reservations for cluster placement groups in the \n\t\t\tAmazon EC2 User Guide.
", + "smithy.api#xmlName": "placementGroupArn" + } } }, "traits": { @@ -10019,6 +10030,12 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
" } + }, + "PlacementGroupArn": { + "target": "com.amazonaws.ec2#PlacementGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster placement group in which \n\t\t\tto create the Capacity Reservation. For more information, see \n\t\t\t\n\t\t\t\tCapacity Reservations for cluster placement groups in the \n\t\t\tAmazon EC2 User Guide.
" + } } } }, @@ -10773,7 +10790,7 @@ "Type": { "target": "com.amazonaws.ec2#FleetType", "traits": { - "smithy.api#documentation": "The fleet type. The default value is maintain.
\n maintain - The EC2 Fleet places an asynchronous request for your desired\n capacity, and continues to maintain your desired Spot capacity by replenishing\n interrupted Spot Instances.
\n request - The EC2 Fleet places an asynchronous one-time request for your\n desired capacity, but does submit Spot requests in alternative capacity pools if Spot\n capacity is unavailable, and does not maintain Spot capacity if Spot Instances are\n interrupted.
\n instant - The EC2 Fleet places a synchronous one-time request for your\n desired capacity, and returns errors for any instances that could not be\n launched.
For more information, see EC2 Fleet\n request types in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "The fleet type. The default value is maintain.
\n maintain - The EC2 Fleet places an asynchronous request for your desired\n capacity, and continues to maintain your desired Spot capacity by replenishing\n interrupted Spot Instances.
\n request - The EC2 Fleet places an asynchronous one-time request for your\n desired capacity, but does submit Spot requests in alternative capacity pools if Spot\n capacity is unavailable, and does not maintain Spot capacity if Spot Instances are\n interrupted.
\n instant - The EC2 Fleet places a synchronous one-time request for your\n desired capacity, and returns errors for any instances that could not be\n launched.
For more information, see EC2 Fleet\n request types in the Amazon EC2 User Guide.
" } }, "ValidFrom": { @@ -12527,7 +12544,7 @@ "InterfaceType": { "target": "com.amazonaws.ec2#NetworkInterfaceCreationType", "traits": { - "smithy.api#documentation": "Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify \n\t\t\tefa. For more information, see \n\t\t\t Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide. To create a trunk network interface, specify \n\t\t efa. For more information, see \n\t\t Network interface trunking in the Amazon Elastic Compute Cloud User Guide.
Indicates the type of network interface. To create an Elastic Fabric Adapter (EFA), specify \n\t\t\tefa. For more information, see \n\t\t\t Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide. To create a trunk network interface, specify \n\t\t trunk.
Describes attributes of your AWS account. The following are the supported account attributes:
\n\n supported-platforms: Indicates whether your account can launch instances\n into EC2-Classic and EC2-VPC, or only into EC2-VPC.
\n default-vpc: The ID of the default VPC for your account, or\n none.
\n max-instances: This attribute is no longer supported. The returned\n value does not reflect your actual vCPU limit for running On-Demand Instances.\n For more information, see On-Demand Instance Limits in the\n Amazon Elastic Compute Cloud User Guide.
\n vpc-max-security-groups-per-interface: The maximum number of security groups\n that you can assign to a network interface.
\n max-elastic-ips: The maximum number of Elastic IP addresses that you can\n allocate for use with EC2-Classic.
\n vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can\n allocate for use with EC2-VPC.
Describes attributes of your Amazon Web Services account. The following are the supported account attributes:
\n\n supported-platforms: Indicates whether your account can launch instances\n into EC2-Classic and EC2-VPC, or only into EC2-VPC.
\n default-vpc: The ID of the default VPC for your account, or\n none.
\n max-instances: This attribute is no longer supported. The returned\n value does not reflect your actual vCPU limit for running On-Demand Instances.\n For more information, see On-Demand Instance Limits in the\n Amazon Elastic Compute Cloud User Guide.
\n vpc-max-security-groups-per-interface: The maximum number of security groups\n that you can assign to a network interface.
\n max-elastic-ips: The maximum number of Elastic IP addresses that you can\n allocate for use with EC2-Classic.
\n vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can\n allocate for use with EC2-VPC.
One or more filters.
\n\t \t\n instance-type - The type of instance for which the Capacity Reservation reserves capacity.
\n owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
\n availability-zone-id - The Availability Zone ID of the Capacity Reservation.
\n instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.
\n availability-zone - The Availability Zone ID of the Capacity Reservation.
\n tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the \n\t \t\t\tfollowing tenancy settings:
\n default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
\n dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
\n outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
\n state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
\n active- The Capacity Reservation is active and the capacity is available for your use.
\n expired - The Capacity Reservation expired automatically at the date and time specified in your request. \n\t \t\t\t\tThe reserved capacity is no longer available for your use.
\n cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
\n pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
\n failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, \n\t \t\t\t\tcapacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
\n start-date - The date and time at which the Capacity Reservation was started.
\n end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is \n\t \t\t\treleased and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
\n end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
\n unlimited - The Capacity Reservation remains active until you explicitly cancel it.
\n limited - The Capacity Reservation expires automatically at a specified date and time.
\n instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
\n open - The Capacity Reservation accepts all instances that have matching\n\t\t\t\t\t\t\tattributes (instance type, platform, and Availability Zone). Instances\n\t\t\t\t\t\t\tthat have matching attributes launch into the Capacity Reservation\n\t\t\t\t\t\t\tautomatically without specifying any additional parameters.
\n targeted - The Capacity Reservation only accepts instances that have matching\n\t\t\t\t\t\t\tattributes (instance type, platform, and Availability Zone), and\n\t\t\t\t\t\t\texplicitly target the Capacity Reservation. This ensures that only\n\t\t\t\t\t\t\tpermitted instances can use the reserved capacity.
One or more filters.
\n\t \t\n instance-type - The type of instance for which the Capacity Reservation reserves capacity.
\n owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
\n instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.
\n availability-zone - The Availability Zone of the Capacity Reservation.
\n tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the \n\t \t\t\tfollowing tenancy settings:
\n default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
\n dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
\n outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
\n state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
\n active- The Capacity Reservation is active and the capacity is available for your use.
\n expired - The Capacity Reservation expired automatically at the date and time specified in your request. \n\t \t\t\t\tThe reserved capacity is no longer available for your use.
\n cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
\n pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
\n failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, \n\t \t\t\t\tcapacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
\n start-date - The date and time at which the Capacity Reservation was started.
\n end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is \n\t \t\t\treleased and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time.
\n end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
\n unlimited - The Capacity Reservation remains active until you explicitly cancel it.
\n limited - The Capacity Reservation expires automatically at a specified date and time.
\n instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
\n open - The Capacity Reservation accepts all instances that have matching\n\t\t\t\t\t\t\tattributes (instance type, platform, and Availability Zone). Instances\n\t\t\t\t\t\t\tthat have matching attributes launch into the Capacity Reservation\n\t\t\t\t\t\t\tautomatically without specifying any additional parameters.
\n targeted - The Capacity Reservation only accepts instances that have matching\n\t\t\t\t\t\t\tattributes (instance type, platform, and Availability Zone), and\n\t\t\t\t\t\t\texplicitly target the Capacity Reservation. This ensures that only\n\t\t\t\t\t\t\tpermitted instances can use the reserved capacity.
One or more filters.
\n\n create-time - The time the launch template version was created.
\n ebs-optimized - A boolean that indicates whether the instance\n is optimized for Amazon EBS I/O.
\n iam-instance-profile - The ARN of the IAM instance\n profile.
\n image-id - The ID of the AMI.
\n instance-type - The instance type.
\n is-default-version - A boolean that indicates whether the\n launch template version is the default version.
\n kernel-id - The kernel ID.
\n ram-disk-id - The RAM disk ID.
One or more filters.
\n\n create-time - The time the launch template version was created.
\n ebs-optimized - A boolean that indicates whether the instance\n is optimized for Amazon EBS I/O.
\n http-endpoint - Indicates whether the HTTP metadata endpoint on\n your instances is enabled (enabled | disabled).
\n http-protocol-ipv4 - Indicates whether the IPv4 endpoint for the\n instance metadata service is enabled (enabled |\n disabled).
\n host-resource-group-arn - The ARN of the host resource group in\n which to launch the instances.
\n http-tokens - The state of token usage for your instance metadata\n requests (optional | required).
\n iam-instance-profile - The ARN of the IAM instance\n profile.
\n image-id - The ID of the AMI.
\n instance-type - The instance type.
\n is-default-version - A boolean that indicates whether the\n launch template version is the default version.
\n kernel-id - The kernel ID.
\n license-configuration-arn - The ARN of the license\n configuration.
\n network-card-index - The index of the network card.
\n ram-disk-id - The RAM disk ID.
The filters.
\n\n group-name - The name of the placement group.
\n state - The state of the placement group (pending |\n available | deleting |\n deleted).
\n strategy - The strategy of the placement group\n (cluster | spread |\n partition).
\n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
The filters.
\n\n group-name - The name of the placement group.
\n group-arn - The Amazon Resource Name (ARN) of the placement group.
\n state - The state of the placement group (pending |\n available | deleting |\n deleted).
\n strategy - The strategy of the placement group\n (cluster | spread |\n partition).
\n tag: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value.\n For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
\n tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
The filters.
\n\n snapshot-id - The snapshot ID.
\n volume-id - The ID of the volume the snapshot is for.
\n last-tiering-operation - The state of the last archive or restore action. (archiving | archival_error |\n archival_complete | restoring | restore_error | restore_complete)
The filters.
\n\n snapshot-id - The snapshot ID.
\n volume-id - The ID of the volume the snapshot is for.
\n last-tiering-operation - The state of the last archive or restore action. (archival-in-progress | archival-completed |\n archival-failed | permanent-restore-in-progress | permanent-restore-completed | permanent-restore-failed | \n\t\ttemporary-restore-in-progress | temporary-restore-completed | temporary-restore-failed)
[VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.
", + "smithy.api#documentation": "[VPC only] Describes the stale security group rules for security groups in a specified VPC. \n Rules are stale when they reference a deleted security group in the same VPC or in a peer VPC, \n or if they reference a security group in a peer VPC for which the VPC peering connection has \n been deleted.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -32363,7 +32406,7 @@ "type": "structure", "members": { "ElasticGpuId": { - "target": "com.amazonaws.ec2#String", + "target": "com.amazonaws.ec2#ElasticGpuId", "traits": { "aws.protocols#ec2QueryName": "ElasticGpuId", "smithy.api#documentation": "The ID of the Elastic Graphics accelerator.
", @@ -34723,13 +34766,13 @@ "Values": { "target": "com.amazonaws.ec2#ValueStringList", "traits": { - "smithy.api#documentation": "The filter values. Filter values are case-sensitive.
", + "smithy.api#documentation": "The filter values. Filter values are case-sensitive. If you specify multiple values for a \n filter, the values are joined with an OR, and the request returns all results \n that match any of the specified values.
A filter name and value pair that is used to return a more specific list of results from a describe operation. \n Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
" + "smithy.api#documentation": "A filter name and value pair that is used to return a more specific list of results from a describe operation. \n Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
\nIf you specify multiple filters, the filters are joined with an AND, and the request returns only \n results that match all of the specified filters.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.
\nValid only when replacementStrategy is set to launch-before-terminate.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.
\nRequired when ReplacementStrategy is set to launch-before-terminate.
Not valid when ReplacementStrategy is set to launch.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.
\nValid only when ReplacementStrategy is set to launch-before-terminate.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.
\nRequired when ReplacementStrategy is set to launch-before-terminate.
Not valid when ReplacementStrategy is set to launch.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
The Spot Instance replacement strategy to use when Amazon EC2 emits a rebalance\n notification signal that your Spot Instance is at an elevated risk of being interrupted.\n For more information, see Capacity rebalancing in the Amazon EC2 User Guide.
" + "smithy.api#documentation": "The Spot Instance replacement strategy to use when Amazon EC2 emits a rebalance\n notification signal that your Spot Instance is at an elevated risk of being interrupted.\n For more information, see Capacity rebalancing in the Amazon EC2 User Guide.
" } }, "com.amazonaws.ec2#FleetSpotMaintenanceStrategies": { @@ -39138,7 +39181,7 @@ } }, "OfferingId": { - "target": "com.amazonaws.ec2#String", + "target": "com.amazonaws.ec2#OfferingId", "traits": { "aws.protocols#ec2QueryName": "OfferingId", "smithy.api#documentation": "The ID of the offering.
", @@ -39282,7 +39325,7 @@ } }, "HostReservationId": { - "target": "com.amazonaws.ec2#String", + "target": "com.amazonaws.ec2#HostReservationId", "traits": { "aws.protocols#ec2QueryName": "HostReservationId", "smithy.api#documentation": "The ID of the reservation that specifies the associated Dedicated Hosts.
", @@ -39306,7 +39349,7 @@ } }, "OfferingId": { - "target": "com.amazonaws.ec2#String", + "target": "com.amazonaws.ec2#OfferingId", "traits": { "aws.protocols#ec2QueryName": "OfferingId", "smithy.api#documentation": "The ID of the reservation. This remains the same regardless of which Dedicated\n Hosts are associated with it.
", @@ -40310,7 +40353,7 @@ "Architecture": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The architecture of the virtual machine.
\nValid values: i386 | x86_64 | arm64\n
The architecture of the virtual machine.
\nValid values: i386 | x86_64\n
The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.
If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credentials\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.
The state of token usage for your instance metadata requests.
\nIf the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.
If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credentials\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.
Default: optional\n
Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not \n specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your\n instance metadata.
Enables or disables the HTTP metadata endpoint on your instances.
\nIf you specify a value of disabled, you cannot access your\n instance metadata.
Default: enabled\n
Enables or disables the IPv6 endpoint for the instance metadata service.
" } + }, + "InstanceMetadataTags": { + "target": "com.amazonaws.ec2#InstanceMetadataTagsState", + "traits": { + "smithy.api#documentation": "Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off \n access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled\n
The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional.
If the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.
If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credential\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.
The state of token usage for your instance metadata requests.
\nIf the state is optional, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.
If the state is required, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credential\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.
Default: optional\n
Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
", + "smithy.api#documentation": "Indicates whether the HTTP metadata endpoint on your instances is enabled or\n disabled.
\nIf the value is disabled, you cannot access your\n instance metadata.
Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.
", "smithy.api#xmlName": "httpProtocolIpv6" } + }, + "InstanceMetadataTags": { + "target": "com.amazonaws.ec2#InstanceMetadataTagsState", + "traits": { + "aws.protocols#ec2QueryName": "InstanceMetadataTags", + "smithy.api#documentation": "Indicates whether access to instance tags from the instance metadata is enabled or\n disabled. For more information, see Work with\n instance tags using the instance metadata.
", + "smithy.api#xmlName": "instanceMetadataTags" + } } }, "traits": { @@ -43048,6 +43105,21 @@ ] } }, + "com.amazonaws.ec2#InstanceMetadataTagsState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "disabled", + "name": "disabled" + }, + { + "value": "enabled", + "name": "enabled" + } + ] + } + }, "com.amazonaws.ec2#InstanceMonitoring": { "type": "structure", "members": { @@ -44316,1476 +44388,1464 @@ "traits": { "smithy.api#enum": [ { - "value": "t1.micro", - "name": "t1_micro" + "value": "a1.medium", + "name": "a1_medium" }, { - "value": "t2.nano", - "name": "t2_nano" + "value": "a1.large", + "name": "a1_large" }, { - "value": "t2.micro", - "name": "t2_micro" + "value": "a1.xlarge", + "name": "a1_xlarge" }, { - "value": "t2.small", - "name": "t2_small" + "value": "a1.2xlarge", + "name": "a1_2xlarge" }, { - "value": "t2.medium", - "name": "t2_medium" + "value": "a1.4xlarge", + "name": "a1_4xlarge" }, { - "value": "t2.large", - "name": "t2_large" + "value": "a1.metal", + "name": "a1_metal" }, { - "value": "t2.xlarge", - "name": "t2_xlarge" + "value": "c1.medium", + "name": "c1_medium" }, { - "value": "t2.2xlarge", - "name": "t2_2xlarge" + "value": "c1.xlarge", + "name": "c1_xlarge" }, { - "value": "t3.nano", - "name": "t3_nano" + "value": "c3.large", + "name": "c3_large" }, { - "value": "t3.micro", - "name": "t3_micro" + "value": "c3.xlarge", + "name": "c3_xlarge" }, { - "value": "t3.small", - "name": "t3_small" + "value": "c3.2xlarge", + "name": "c3_2xlarge" }, { - "value": "t3.medium", - "name": "t3_medium" + "value": "c3.4xlarge", + "name": "c3_4xlarge" }, { - "value": "t3.large", - "name": "t3_large" + "value": "c3.8xlarge", + "name": "c3_8xlarge" }, { - "value": "t3.xlarge", - "name": "t3_xlarge" + "value": "c4.large", + "name": "c4_large" }, { - "value": "t3.2xlarge", - "name": "t3_2xlarge" + "value": "c4.xlarge", + "name": "c4_xlarge" }, { - "value": "t3a.nano", - "name": "t3a_nano" + "value": "c4.2xlarge", + "name": "c4_2xlarge" }, { - "value": "t3a.micro", - "name": "t3a_micro" + "value": "c4.4xlarge", + "name": "c4_4xlarge" }, { - "value": "t3a.small", - "name": "t3a_small" + "value": "c4.8xlarge", + "name": "c4_8xlarge" }, { - "value": "t3a.medium", - "name": "t3a_medium" + "value": "c5.large", + "name": "c5_large" }, { - "value": "t3a.large", - "name": "t3a_large" + "value": "c5.xlarge", + "name": "c5_xlarge" }, { - "value": "t3a.xlarge", - "name": "t3a_xlarge" + "value": "c5.2xlarge", + "name": "c5_2xlarge" }, { - "value": "t3a.2xlarge", - "name": "t3a_2xlarge" + "value": "c5.4xlarge", + "name": "c5_4xlarge" }, { - "value": "t4g.nano", - "name": "t4g_nano" + "value": "c5.9xlarge", + "name": "c5_9xlarge" }, { - "value": "t4g.micro", - "name": "t4g_micro" + "value": "c5.12xlarge", + "name": "c5_12xlarge" }, { - "value": "t4g.small", - "name": "t4g_small" + "value": "c5.18xlarge", + "name": "c5_18xlarge" }, { - "value": "t4g.medium", - "name": "t4g_medium" + "value": "c5.24xlarge", + "name": "c5_24xlarge" }, { - "value": "t4g.large", - "name": "t4g_large" + "value": "c5.metal", + "name": "c5_metal" }, { - "value": "t4g.xlarge", - "name": "t4g_xlarge" + "value": "c5a.large", + "name": "c5a_large" }, { - "value": "t4g.2xlarge", - "name": "t4g_2xlarge" + "value": "c5a.xlarge", + "name": "c5a_xlarge" }, { - "value": "m1.small", - "name": "m1_small" + "value": "c5a.2xlarge", + "name": "c5a_2xlarge" }, { - "value": "m1.medium", - "name": "m1_medium" + "value": "c5a.4xlarge", + "name": "c5a_4xlarge" }, { - "value": "m1.large", - "name": "m1_large" + "value": "c5a.8xlarge", + "name": "c5a_8xlarge" }, { - "value": "m1.xlarge", - "name": "m1_xlarge" + "value": "c5a.12xlarge", + "name": "c5a_12xlarge" }, { - "value": "m3.medium", - "name": "m3_medium" + "value": "c5a.16xlarge", + "name": "c5a_16xlarge" }, { - "value": "m3.large", - "name": "m3_large" + "value": "c5a.24xlarge", + "name": "c5a_24xlarge" }, { - "value": "m3.xlarge", - "name": "m3_xlarge" + "value": "c5ad.large", + "name": "c5ad_large" }, { - "value": "m3.2xlarge", - "name": "m3_2xlarge" + "value": "c5ad.xlarge", + "name": "c5ad_xlarge" }, { - "value": "m4.large", - "name": "m4_large" + "value": "c5ad.2xlarge", + "name": "c5ad_2xlarge" }, { - "value": "m4.xlarge", - "name": "m4_xlarge" + "value": "c5ad.4xlarge", + "name": "c5ad_4xlarge" }, { - "value": "m4.2xlarge", - "name": "m4_2xlarge" + "value": "c5ad.8xlarge", + "name": "c5ad_8xlarge" }, { - "value": "m4.4xlarge", - "name": "m4_4xlarge" + "value": "c5ad.12xlarge", + "name": "c5ad_12xlarge" }, { - "value": "m4.10xlarge", - "name": "m4_10xlarge" + "value": "c5ad.16xlarge", + "name": "c5ad_16xlarge" }, { - "value": "m4.16xlarge", - "name": "m4_16xlarge" + "value": "c5ad.24xlarge", + "name": "c5ad_24xlarge" }, { - "value": "m2.xlarge", - "name": "m2_xlarge" + "value": "c5d.large", + "name": "c5d_large" }, { - "value": "m2.2xlarge", - "name": "m2_2xlarge" + "value": "c5d.xlarge", + "name": "c5d_xlarge" }, { - "value": "m2.4xlarge", - "name": "m2_4xlarge" + "value": "c5d.2xlarge", + "name": "c5d_2xlarge" }, { - "value": "cr1.8xlarge", - "name": "cr1_8xlarge" + "value": "c5d.4xlarge", + "name": "c5d_4xlarge" }, { - "value": "r3.large", - "name": "r3_large" + "value": "c5d.9xlarge", + "name": "c5d_9xlarge" }, { - "value": "r3.xlarge", - "name": "r3_xlarge" + "value": "c5d.12xlarge", + "name": "c5d_12xlarge" }, { - "value": "r3.2xlarge", - "name": "r3_2xlarge" + "value": "c5d.18xlarge", + "name": "c5d_18xlarge" }, { - "value": "r3.4xlarge", - "name": "r3_4xlarge" + "value": "c5d.24xlarge", + "name": "c5d_24xlarge" }, { - "value": "r3.8xlarge", - "name": "r3_8xlarge" + "value": "c5d.metal", + "name": "c5d_metal" }, { - "value": "r4.large", - "name": "r4_large" + "value": "c5n.large", + "name": "c5n_large" }, { - "value": "r4.xlarge", - "name": "r4_xlarge" + "value": "c5n.xlarge", + "name": "c5n_xlarge" }, { - "value": "r4.2xlarge", - "name": "r4_2xlarge" + "value": "c5n.2xlarge", + "name": "c5n_2xlarge" }, { - "value": "r4.4xlarge", - "name": "r4_4xlarge" + "value": "c5n.4xlarge", + "name": "c5n_4xlarge" }, { - "value": "r4.8xlarge", - "name": "r4_8xlarge" + "value": "c5n.9xlarge", + "name": "c5n_9xlarge" }, { - "value": "r4.16xlarge", - "name": "r4_16xlarge" + "value": "c5n.18xlarge", + "name": "c5n_18xlarge" }, { - "value": "r5.large", - "name": "r5_large" + "value": "c5n.metal", + "name": "c5n_metal" }, { - "value": "r5.xlarge", - "name": "r5_xlarge" + "value": "c6g.medium", + "name": "c6g_medium" }, { - "value": "r5.2xlarge", - "name": "r5_2xlarge" + "value": "c6g.large", + "name": "c6g_large" }, { - "value": "r5.4xlarge", - "name": "r5_4xlarge" + "value": "c6g.xlarge", + "name": "c6g_xlarge" }, { - "value": "r5.8xlarge", - "name": "r5_8xlarge" + "value": "c6g.2xlarge", + "name": "c6g_2xlarge" }, { - "value": "r5.12xlarge", - "name": "r5_12xlarge" + "value": "c6g.4xlarge", + "name": "c6g_4xlarge" }, { - "value": "r5.16xlarge", - "name": "r5_16xlarge" + "value": "c6g.8xlarge", + "name": "c6g_8xlarge" }, { - "value": "r5.24xlarge", - "name": "r5_24xlarge" + "value": "c6g.12xlarge", + "name": "c6g_12xlarge" }, { - "value": "r5.metal", - "name": "r5_metal" + "value": "c6g.16xlarge", + "name": "c6g_16xlarge" }, { - "value": "r5a.large", - "name": "r5a_large" + "value": "c6g.metal", + "name": "c6g_metal" }, { - "value": "r5a.xlarge", - "name": "r5a_xlarge" + "value": "c6gd.medium", + "name": "c6gd_medium" }, { - "value": "r5a.2xlarge", - "name": "r5a_2xlarge" + "value": "c6gd.large", + "name": "c6gd_large" }, { - "value": "r5a.4xlarge", - "name": "r5a_4xlarge" + "value": "c6gd.xlarge", + "name": "c6gd_xlarge" }, { - "value": "r5a.8xlarge", - "name": "r5a_8xlarge" + "value": "c6gd.2xlarge", + "name": "c6gd_2xlarge" }, { - "value": "r5a.12xlarge", - "name": "r5a_12xlarge" + "value": "c6gd.4xlarge", + "name": "c6gd_4xlarge" }, { - "value": "r5a.16xlarge", - "name": "r5a_16xlarge" + "value": "c6gd.8xlarge", + "name": "c6gd_8xlarge" }, { - "value": "r5a.24xlarge", - "name": "r5a_24xlarge" + "value": "c6gd.12xlarge", + "name": "c6gd_12xlarge" }, { - "value": "r5b.large", - "name": "r5b_large" + "value": "c6gd.16xlarge", + "name": "c6gd_16xlarge" }, { - "value": "r5b.xlarge", - "name": "r5b_xlarge" + "value": "c6gd.metal", + "name": "c6gd_metal" }, { - "value": "r5b.2xlarge", - "name": "r5b_2xlarge" + "value": "c6gn.medium", + "name": "c6gn_medium" }, { - "value": "r5b.4xlarge", - "name": "r5b_4xlarge" + "value": "c6gn.large", + "name": "c6gn_large" }, { - "value": "r5b.8xlarge", - "name": "r5b_8xlarge" + "value": "c6gn.xlarge", + "name": "c6gn_xlarge" }, { - "value": "r5b.12xlarge", - "name": "r5b_12xlarge" + "value": "c6gn.2xlarge", + "name": "c6gn_2xlarge" }, { - "value": "r5b.16xlarge", - "name": "r5b_16xlarge" + "value": "c6gn.4xlarge", + "name": "c6gn_4xlarge" }, { - "value": "r5b.24xlarge", - "name": "r5b_24xlarge" + "value": "c6gn.8xlarge", + "name": "c6gn_8xlarge" }, { - "value": "r5b.metal", - "name": "r5b_metal" + "value": "c6gn.12xlarge", + "name": "c6gn_12xlarge" }, { - "value": "r5d.large", - "name": "r5d_large" + "value": "c6gn.16xlarge", + "name": "c6gn_16xlarge" }, { - "value": "r5d.xlarge", - "name": "r5d_xlarge" + "value": "c6i.large", + "name": "c6i_large" }, { - "value": "r5d.2xlarge", - "name": "r5d_2xlarge" + "value": "c6i.xlarge", + "name": "c6i_xlarge" }, { - "value": "r5d.4xlarge", - "name": "r5d_4xlarge" + "value": "c6i.2xlarge", + "name": "c6i_2xlarge" }, { - "value": "r5d.8xlarge", - "name": "r5d_8xlarge" + "value": "c6i.4xlarge", + "name": "c6i_4xlarge" }, { - "value": "r5d.12xlarge", - "name": "r5d_12xlarge" + "value": "c6i.8xlarge", + "name": "c6i_8xlarge" }, { - "value": "r5d.16xlarge", - "name": "r5d_16xlarge" + "value": "c6i.12xlarge", + "name": "c6i_12xlarge" }, { - "value": "r5d.24xlarge", - "name": "r5d_24xlarge" + "value": "c6i.16xlarge", + "name": "c6i_16xlarge" }, { - "value": "r5d.metal", - "name": "r5d_metal" + "value": "c6i.24xlarge", + "name": "c6i_24xlarge" }, { - "value": "r5ad.large", - "name": "r5ad_large" + "value": "c6i.32xlarge", + "name": "c6i_32xlarge" }, { - "value": "r5ad.xlarge", - "name": "r5ad_xlarge" + "value": "cc1.4xlarge", + "name": "cc1_4xlarge" }, { - "value": "r5ad.2xlarge", - "name": "r5ad_2xlarge" + "value": "cc2.8xlarge", + "name": "cc2_8xlarge" }, { - "value": "r5ad.4xlarge", - "name": "r5ad_4xlarge" + "value": "cg1.4xlarge", + "name": "cg1_4xlarge" }, { - "value": "r5ad.8xlarge", - "name": "r5ad_8xlarge" + "value": "cr1.8xlarge", + "name": "cr1_8xlarge" }, { - "value": "r5ad.12xlarge", - "name": "r5ad_12xlarge" + "value": "d2.xlarge", + "name": "d2_xlarge" }, { - "value": "r5ad.16xlarge", - "name": "r5ad_16xlarge" + "value": "d2.2xlarge", + "name": "d2_2xlarge" }, { - "value": "r5ad.24xlarge", - "name": "r5ad_24xlarge" + "value": "d2.4xlarge", + "name": "d2_4xlarge" }, { - "value": "r6g.metal", - "name": "r6g_metal" + "value": "d2.8xlarge", + "name": "d2_8xlarge" }, { - "value": "r6g.medium", - "name": "r6g_medium" + "value": "d3.xlarge", + "name": "d3_xlarge" }, { - "value": "r6g.large", - "name": "r6g_large" + "value": "d3.2xlarge", + "name": "d3_2xlarge" }, { - "value": "r6g.xlarge", - "name": "r6g_xlarge" + "value": "d3.4xlarge", + "name": "d3_4xlarge" }, { - "value": "r6g.2xlarge", - "name": "r6g_2xlarge" + "value": "d3.8xlarge", + "name": "d3_8xlarge" }, { - "value": "r6g.4xlarge", - "name": "r6g_4xlarge" + "value": "d3en.xlarge", + "name": "d3en_xlarge" }, { - "value": "r6g.8xlarge", - "name": "r6g_8xlarge" + "value": "d3en.2xlarge", + "name": "d3en_2xlarge" }, { - "value": "r6g.12xlarge", - "name": "r6g_12xlarge" + "value": "d3en.4xlarge", + "name": "d3en_4xlarge" }, { - "value": "r6g.16xlarge", - "name": "r6g_16xlarge" + "value": "d3en.6xlarge", + "name": "d3en_6xlarge" }, { - "value": "r6gd.metal", - "name": "r6gd_metal" + "value": "d3en.8xlarge", + "name": "d3en_8xlarge" }, { - "value": "r6gd.medium", - "name": "r6gd_medium" + "value": "d3en.12xlarge", + "name": "d3en_12xlarge" }, { - "value": "r6gd.large", - "name": "r6gd_large" + "value": "dl1.24xlarge", + "name": "dl1_24xlarge" }, { - "value": "r6gd.xlarge", - "name": "r6gd_xlarge" - }, - { - "value": "r6gd.2xlarge", - "name": "r6gd_2xlarge" - }, - { - "value": "r6gd.4xlarge", - "name": "r6gd_4xlarge" - }, - { - "value": "r6gd.8xlarge", - "name": "r6gd_8xlarge" + "value": "f1.2xlarge", + "name": "f1_2xlarge" }, { - "value": "r6gd.12xlarge", - "name": "r6gd_12xlarge" + "value": "f1.4xlarge", + "name": "f1_4xlarge" }, { - "value": "r6gd.16xlarge", - "name": "r6gd_16xlarge" + "value": "f1.16xlarge", + "name": "f1_16xlarge" }, { - "value": "x1.16xlarge", - "name": "x1_16xlarge" + "value": "g2.2xlarge", + "name": "g2_2xlarge" }, { - "value": "x1.32xlarge", - "name": "x1_32xlarge" + "value": "g2.8xlarge", + "name": "g2_8xlarge" }, { - "value": "x1e.xlarge", - "name": "x1e_xlarge" + "value": "g3.4xlarge", + "name": "g3_4xlarge" }, { - "value": "x1e.2xlarge", - "name": "x1e_2xlarge" + "value": "g3.8xlarge", + "name": "g3_8xlarge" }, { - "value": "x1e.4xlarge", - "name": "x1e_4xlarge" + "value": "g3.16xlarge", + "name": "g3_16xlarge" }, { - "value": "x1e.8xlarge", - "name": "x1e_8xlarge" + "value": "g3s.xlarge", + "name": "g3s_xlarge" }, { - "value": "x1e.16xlarge", - "name": "x1e_16xlarge" + "value": "g4ad.xlarge", + "name": "g4ad_xlarge" }, { - "value": "x1e.32xlarge", - "name": "x1e_32xlarge" + "value": "g4ad.2xlarge", + "name": "g4ad_2xlarge" }, { - "value": "i2.xlarge", - "name": "i2_xlarge" + "value": "g4ad.4xlarge", + "name": "g4ad_4xlarge" }, { - "value": "i2.2xlarge", - "name": "i2_2xlarge" + "value": "g4ad.8xlarge", + "name": "g4ad_8xlarge" }, { - "value": "i2.4xlarge", - "name": "i2_4xlarge" + "value": "g4ad.16xlarge", + "name": "g4ad_16xlarge" }, { - "value": "i2.8xlarge", - "name": "i2_8xlarge" + "value": "g4dn.xlarge", + "name": "g4dn_xlarge" }, { - "value": "i3.large", - "name": "i3_large" + "value": "g4dn.2xlarge", + "name": "g4dn_2xlarge" }, { - "value": "i3.xlarge", - "name": "i3_xlarge" + "value": "g4dn.4xlarge", + "name": "g4dn_4xlarge" }, { - "value": "i3.2xlarge", - "name": "i3_2xlarge" + "value": "g4dn.8xlarge", + "name": "g4dn_8xlarge" }, { - "value": "i3.4xlarge", - "name": "i3_4xlarge" + "value": "g4dn.12xlarge", + "name": "g4dn_12xlarge" }, { - "value": "i3.8xlarge", - "name": "i3_8xlarge" + "value": "g4dn.16xlarge", + "name": "g4dn_16xlarge" }, { - "value": "i3.16xlarge", - "name": "i3_16xlarge" + "value": "g4dn.metal", + "name": "g4dn_metal" }, { - "value": "i3.metal", - "name": "i3_metal" + "value": "g5.xlarge", + "name": "g5_xlarge" }, { - "value": "i3en.large", - "name": "i3en_large" + "value": "g5.2xlarge", + "name": "g5_2xlarge" }, { - "value": "i3en.xlarge", - "name": "i3en_xlarge" + "value": "g5.4xlarge", + "name": "g5_4xlarge" }, { - "value": "i3en.2xlarge", - "name": "i3en_2xlarge" + "value": "g5.8xlarge", + "name": "g5_8xlarge" }, { - "value": "i3en.3xlarge", - "name": "i3en_3xlarge" + "value": "g5.12xlarge", + "name": "g5_12xlarge" }, { - "value": "i3en.6xlarge", - "name": "i3en_6xlarge" + "value": "g5.16xlarge", + "name": "g5_16xlarge" }, { - "value": "i3en.12xlarge", - "name": "i3en_12xlarge" + "value": "g5.24xlarge", + "name": "g5_24xlarge" }, { - "value": "i3en.24xlarge", - "name": "i3en_24xlarge" + "value": "g5.48xlarge", + "name": "g5_48xlarge" }, { - "value": "i3en.metal", - "name": "i3en_metal" + "value": "g5g.xlarge", + "name": "g5g_xlarge" }, { - "value": "hi1.4xlarge", - "name": "hi1_4xlarge" + "value": "g5g.2xlarge", + "name": "g5g_2xlarge" }, { - "value": "hs1.8xlarge", - "name": "hs1_8xlarge" + "value": "g5g.4xlarge", + "name": "g5g_4xlarge" }, { - "value": "c1.medium", - "name": "c1_medium" + "value": "g5g.8xlarge", + "name": "g5g_8xlarge" }, { - "value": "c1.xlarge", - "name": "c1_xlarge" + "value": "g5g.16xlarge", + "name": "g5g_16xlarge" }, { - "value": "c3.large", - "name": "c3_large" + "value": "g5g.metal", + "name": "g5g_metal" }, { - "value": "c3.xlarge", - "name": "c3_xlarge" + "value": "hi1.4xlarge", + "name": "hi1_4xlarge" }, { - "value": "c3.2xlarge", - "name": "c3_2xlarge" + "value": "hs1.8xlarge", + "name": "hs1_8xlarge" }, { - "value": "c3.4xlarge", - "name": "c3_4xlarge" + "value": "h1.2xlarge", + "name": "h1_2xlarge" }, { - "value": "c3.8xlarge", - "name": "c3_8xlarge" + "value": "h1.4xlarge", + "name": "h1_4xlarge" }, { - "value": "c4.large", - "name": "c4_large" + "value": "h1.8xlarge", + "name": "h1_8xlarge" }, { - "value": "c4.xlarge", - "name": "c4_xlarge" + "value": "h1.16xlarge", + "name": "h1_16xlarge" }, { - "value": "c4.2xlarge", - "name": "c4_2xlarge" + "value": "i2.xlarge", + "name": "i2_xlarge" }, { - "value": "c4.4xlarge", - "name": "c4_4xlarge" + "value": "i2.2xlarge", + "name": "i2_2xlarge" }, { - "value": "c4.8xlarge", - "name": "c4_8xlarge" + "value": "i2.4xlarge", + "name": "i2_4xlarge" }, { - "value": "c5.large", - "name": "c5_large" + "value": "i2.8xlarge", + "name": "i2_8xlarge" }, { - "value": "c5.xlarge", - "name": "c5_xlarge" + "value": "i3.large", + "name": "i3_large" }, { - "value": "c5.2xlarge", - "name": "c5_2xlarge" + "value": "i3.xlarge", + "name": "i3_xlarge" }, { - "value": "c5.4xlarge", - "name": "c5_4xlarge" + "value": "i3.2xlarge", + "name": "i3_2xlarge" }, { - "value": "c5.9xlarge", - "name": "c5_9xlarge" + "value": "i3.4xlarge", + "name": "i3_4xlarge" }, { - "value": "c5.12xlarge", - "name": "c5_12xlarge" + "value": "i3.8xlarge", + "name": "i3_8xlarge" }, { - "value": "c5.18xlarge", - "name": "c5_18xlarge" + "value": "i3.16xlarge", + "name": "i3_16xlarge" }, { - "value": "c5.24xlarge", - "name": "c5_24xlarge" + "value": "i3.metal", + "name": "i3_metal" }, { - "value": "c5.metal", - "name": "c5_metal" + "value": "i3en.large", + "name": "i3en_large" }, { - "value": "c5a.large", - "name": "c5a_large" + "value": "i3en.xlarge", + "name": "i3en_xlarge" }, { - "value": "c5a.xlarge", - "name": "c5a_xlarge" + "value": "i3en.2xlarge", + "name": "i3en_2xlarge" }, { - "value": "c5a.2xlarge", - "name": "c5a_2xlarge" + "value": "i3en.3xlarge", + "name": "i3en_3xlarge" }, { - "value": "c5a.4xlarge", - "name": "c5a_4xlarge" + "value": "i3en.6xlarge", + "name": "i3en_6xlarge" }, { - "value": "c5a.8xlarge", - "name": "c5a_8xlarge" + "value": "i3en.12xlarge", + "name": "i3en_12xlarge" }, { - "value": "c5a.12xlarge", - "name": "c5a_12xlarge" + "value": "i3en.24xlarge", + "name": "i3en_24xlarge" }, { - "value": "c5a.16xlarge", - "name": "c5a_16xlarge" + "value": "i3en.metal", + "name": "i3en_metal" }, { - "value": "c5a.24xlarge", - "name": "c5a_24xlarge" + "value": "im4gn.large", + "name": "im4gn_large" }, { - "value": "c5ad.large", - "name": "c5ad_large" + "value": "im4gn.xlarge", + "name": "im4gn_xlarge" }, { - "value": "c5ad.xlarge", - "name": "c5ad_xlarge" + "value": "im4gn.2xlarge", + "name": "im4gn_2xlarge" }, { - "value": "c5ad.2xlarge", - "name": "c5ad_2xlarge" + "value": "im4gn.4xlarge", + "name": "im4gn_4xlarge" }, { - "value": "c5ad.4xlarge", - "name": "c5ad_4xlarge" + "value": "im4gn.8xlarge", + "name": "im4gn_8xlarge" }, { - "value": "c5ad.8xlarge", - "name": "c5ad_8xlarge" + "value": "im4gn.16xlarge", + "name": "im4gn_16xlarge" }, { - "value": "c5ad.12xlarge", - "name": "c5ad_12xlarge" + "value": "inf1.xlarge", + "name": "inf1_xlarge" }, { - "value": "c5ad.16xlarge", - "name": "c5ad_16xlarge" + "value": "inf1.2xlarge", + "name": "inf1_2xlarge" }, { - "value": "c5ad.24xlarge", - "name": "c5ad_24xlarge" + "value": "inf1.6xlarge", + "name": "inf1_6xlarge" }, { - "value": "c5d.large", - "name": "c5d_large" + "value": "inf1.24xlarge", + "name": "inf1_24xlarge" }, { - "value": "c5d.xlarge", - "name": "c5d_xlarge" + "value": "is4gen.medium", + "name": "is4gen_medium" }, { - "value": "c5d.2xlarge", - "name": "c5d_2xlarge" + "value": "is4gen.large", + "name": "is4gen_large" }, { - "value": "c5d.4xlarge", - "name": "c5d_4xlarge" + "value": "is4gen.xlarge", + "name": "is4gen_xlarge" }, { - "value": "c5d.9xlarge", - "name": "c5d_9xlarge" + "value": "is4gen.2xlarge", + "name": "is4gen_2xlarge" }, { - "value": "c5d.12xlarge", - "name": "c5d_12xlarge" + "value": "is4gen.4xlarge", + "name": "is4gen_4xlarge" }, { - "value": "c5d.18xlarge", - "name": "c5d_18xlarge" + "value": "is4gen.8xlarge", + "name": "is4gen_8xlarge" }, { - "value": "c5d.24xlarge", - "name": "c5d_24xlarge" + "value": "m1.small", + "name": "m1_small" }, { - "value": "c5d.metal", - "name": "c5d_metal" + "value": "m1.medium", + "name": "m1_medium" }, { - "value": "c5n.large", - "name": "c5n_large" + "value": "m1.large", + "name": "m1_large" }, { - "value": "c5n.xlarge", - "name": "c5n_xlarge" + "value": "m1.xlarge", + "name": "m1_xlarge" }, { - "value": "c5n.2xlarge", - "name": "c5n_2xlarge" + "value": "m2.xlarge", + "name": "m2_xlarge" }, { - "value": "c5n.4xlarge", - "name": "c5n_4xlarge" + "value": "m2.2xlarge", + "name": "m2_2xlarge" }, { - "value": "c5n.9xlarge", - "name": "c5n_9xlarge" + "value": "m2.4xlarge", + "name": "m2_4xlarge" }, { - "value": "c5n.18xlarge", - "name": "c5n_18xlarge" + "value": "m3.medium", + "name": "m3_medium" }, { - "value": "c5n.metal", - "name": "c5n_metal" + "value": "m3.large", + "name": "m3_large" }, { - "value": "c6g.metal", - "name": "c6g_metal" + "value": "m3.xlarge", + "name": "m3_xlarge" }, { - "value": "c6g.medium", - "name": "c6g_medium" + "value": "m3.2xlarge", + "name": "m3_2xlarge" }, { - "value": "c6g.large", - "name": "c6g_large" + "value": "m4.large", + "name": "m4_large" }, { - "value": "c6g.xlarge", - "name": "c6g_xlarge" + "value": "m4.xlarge", + "name": "m4_xlarge" }, { - "value": "c6g.2xlarge", - "name": "c6g_2xlarge" + "value": "m4.2xlarge", + "name": "m4_2xlarge" }, { - "value": "c6g.4xlarge", - "name": "c6g_4xlarge" + "value": "m4.4xlarge", + "name": "m4_4xlarge" }, { - "value": "c6g.8xlarge", - "name": "c6g_8xlarge" + "value": "m4.10xlarge", + "name": "m4_10xlarge" }, { - "value": "c6g.12xlarge", - "name": "c6g_12xlarge" + "value": "m4.16xlarge", + "name": "m4_16xlarge" }, { - "value": "c6g.16xlarge", - "name": "c6g_16xlarge" + "value": "m5.large", + "name": "m5_large" }, { - "value": "c6gd.metal", - "name": "c6gd_metal" + "value": "m5.xlarge", + "name": "m5_xlarge" }, { - "value": "c6gd.medium", - "name": "c6gd_medium" + "value": "m5.2xlarge", + "name": "m5_2xlarge" }, { - "value": "c6gd.large", - "name": "c6gd_large" + "value": "m5.4xlarge", + "name": "m5_4xlarge" }, { - "value": "c6gd.xlarge", - "name": "c6gd_xlarge" + "value": "m5.8xlarge", + "name": "m5_8xlarge" }, { - "value": "c6gd.2xlarge", - "name": "c6gd_2xlarge" + "value": "m5.12xlarge", + "name": "m5_12xlarge" }, { - "value": "c6gd.4xlarge", - "name": "c6gd_4xlarge" + "value": "m5.16xlarge", + "name": "m5_16xlarge" }, { - "value": "c6gd.8xlarge", - "name": "c6gd_8xlarge" + "value": "m5.24xlarge", + "name": "m5_24xlarge" }, { - "value": "c6gd.12xlarge", - "name": "c6gd_12xlarge" + "value": "m5.metal", + "name": "m5_metal" }, { - "value": "c6gd.16xlarge", - "name": "c6gd_16xlarge" + "value": "m5a.large", + "name": "m5a_large" }, { - "value": "c6gn.medium", - "name": "c6gn_medium" + "value": "m5a.xlarge", + "name": "m5a_xlarge" }, { - "value": "c6gn.large", - "name": "c6gn_large" + "value": "m5a.2xlarge", + "name": "m5a_2xlarge" }, { - "value": "c6gn.xlarge", - "name": "c6gn_xlarge" + "value": "m5a.4xlarge", + "name": "m5a_4xlarge" }, { - "value": "c6gn.2xlarge", - "name": "c6gn_2xlarge" + "value": "m5a.8xlarge", + "name": "m5a_8xlarge" }, { - "value": "c6gn.4xlarge", - "name": "c6gn_4xlarge" + "value": "m5a.12xlarge", + "name": "m5a_12xlarge" }, { - "value": "c6gn.8xlarge", - "name": "c6gn_8xlarge" + "value": "m5a.16xlarge", + "name": "m5a_16xlarge" }, { - "value": "c6gn.12xlarge", - "name": "c6gn_12xlarge" + "value": "m5a.24xlarge", + "name": "m5a_24xlarge" }, { - "value": "c6gn.16xlarge", - "name": "c6gn_16xlarge" + "value": "m5ad.large", + "name": "m5ad_large" }, { - "value": "c6i.large", - "name": "c6i_large" + "value": "m5ad.xlarge", + "name": "m5ad_xlarge" }, { - "value": "c6i.xlarge", - "name": "c6i_xlarge" + "value": "m5ad.2xlarge", + "name": "m5ad_2xlarge" }, { - "value": "c6i.2xlarge", - "name": "c6i_2xlarge" + "value": "m5ad.4xlarge", + "name": "m5ad_4xlarge" }, { - "value": "c6i.4xlarge", - "name": "c6i_4xlarge" + "value": "m5ad.8xlarge", + "name": "m5ad_8xlarge" }, { - "value": "c6i.8xlarge", - "name": "c6i_8xlarge" + "value": "m5ad.12xlarge", + "name": "m5ad_12xlarge" }, { - "value": "c6i.12xlarge", - "name": "c6i_12xlarge" + "value": "m5ad.16xlarge", + "name": "m5ad_16xlarge" }, { - "value": "c6i.16xlarge", - "name": "c6i_16xlarge" + "value": "m5ad.24xlarge", + "name": "m5ad_24xlarge" }, { - "value": "c6i.24xlarge", - "name": "c6i_24xlarge" + "value": "m5d.large", + "name": "m5d_large" }, { - "value": "c6i.32xlarge", - "name": "c6i_32xlarge" + "value": "m5d.xlarge", + "name": "m5d_xlarge" }, { - "value": "cc1.4xlarge", - "name": "cc1_4xlarge" + "value": "m5d.2xlarge", + "name": "m5d_2xlarge" }, { - "value": "cc2.8xlarge", - "name": "cc2_8xlarge" + "value": "m5d.4xlarge", + "name": "m5d_4xlarge" }, { - "value": "g2.2xlarge", - "name": "g2_2xlarge" + "value": "m5d.8xlarge", + "name": "m5d_8xlarge" }, { - "value": "g2.8xlarge", - "name": "g2_8xlarge" + "value": "m5d.12xlarge", + "name": "m5d_12xlarge" }, { - "value": "g3.4xlarge", - "name": "g3_4xlarge" + "value": "m5d.16xlarge", + "name": "m5d_16xlarge" }, { - "value": "g3.8xlarge", - "name": "g3_8xlarge" + "value": "m5d.24xlarge", + "name": "m5d_24xlarge" }, { - "value": "g3.16xlarge", - "name": "g3_16xlarge" + "value": "m5d.metal", + "name": "m5d_metal" }, { - "value": "g3s.xlarge", - "name": "g3s_xlarge" + "value": "m5dn.large", + "name": "m5dn_large" }, { - "value": "g4ad.xlarge", - "name": "g4ad_xlarge" + "value": "m5dn.xlarge", + "name": "m5dn_xlarge" }, { - "value": "g4ad.2xlarge", - "name": "g4ad_2xlarge" + "value": "m5dn.2xlarge", + "name": "m5dn_2xlarge" }, { - "value": "g4ad.4xlarge", - "name": "g4ad_4xlarge" + "value": "m5dn.4xlarge", + "name": "m5dn_4xlarge" }, { - "value": "g4ad.8xlarge", - "name": "g4ad_8xlarge" + "value": "m5dn.8xlarge", + "name": "m5dn_8xlarge" }, { - "value": "g4ad.16xlarge", - "name": "g4ad_16xlarge" + "value": "m5dn.12xlarge", + "name": "m5dn_12xlarge" }, { - "value": "g4dn.xlarge", - "name": "g4dn_xlarge" + "value": "m5dn.16xlarge", + "name": "m5dn_16xlarge" }, { - "value": "g4dn.2xlarge", - "name": "g4dn_2xlarge" + "value": "m5dn.24xlarge", + "name": "m5dn_24xlarge" }, { - "value": "g4dn.4xlarge", - "name": "g4dn_4xlarge" + "value": "m5dn.metal", + "name": "m5dn_metal" }, { - "value": "g4dn.8xlarge", - "name": "g4dn_8xlarge" + "value": "m5n.large", + "name": "m5n_large" }, { - "value": "g4dn.12xlarge", - "name": "g4dn_12xlarge" + "value": "m5n.xlarge", + "name": "m5n_xlarge" }, { - "value": "g4dn.16xlarge", - "name": "g4dn_16xlarge" + "value": "m5n.2xlarge", + "name": "m5n_2xlarge" }, { - "value": "g4dn.metal", - "name": "g4dn_metal" + "value": "m5n.4xlarge", + "name": "m5n_4xlarge" }, { - "value": "cg1.4xlarge", - "name": "cg1_4xlarge" + "value": "m5n.8xlarge", + "name": "m5n_8xlarge" }, { - "value": "p2.xlarge", - "name": "p2_xlarge" + "value": "m5n.12xlarge", + "name": "m5n_12xlarge" }, { - "value": "p2.8xlarge", - "name": "p2_8xlarge" + "value": "m5n.16xlarge", + "name": "m5n_16xlarge" }, { - "value": "p2.16xlarge", - "name": "p2_16xlarge" + "value": "m5n.24xlarge", + "name": "m5n_24xlarge" }, { - "value": "p3.2xlarge", - "name": "p3_2xlarge" + "value": "m5n.metal", + "name": "m5n_metal" }, { - "value": "p3.8xlarge", - "name": "p3_8xlarge" + "value": "m5zn.large", + "name": "m5zn_large" }, { - "value": "p3.16xlarge", - "name": "p3_16xlarge" + "value": "m5zn.xlarge", + "name": "m5zn_xlarge" }, { - "value": "p3dn.24xlarge", - "name": "p3dn_24xlarge" + "value": "m5zn.2xlarge", + "name": "m5zn_2xlarge" }, { - "value": "p4d.24xlarge", - "name": "p4d_24xlarge" + "value": "m5zn.3xlarge", + "name": "m5zn_3xlarge" }, { - "value": "d2.xlarge", - "name": "d2_xlarge" + "value": "m5zn.6xlarge", + "name": "m5zn_6xlarge" }, { - "value": "d2.2xlarge", - "name": "d2_2xlarge" + "value": "m5zn.12xlarge", + "name": "m5zn_12xlarge" }, { - "value": "d2.4xlarge", - "name": "d2_4xlarge" + "value": "m5zn.metal", + "name": "m5zn_metal" }, { - "value": "d2.8xlarge", - "name": "d2_8xlarge" + "value": "m6a.large", + "name": "m6a_large" }, { - "value": "d3.xlarge", - "name": "d3_xlarge" + "value": "m6a.xlarge", + "name": "m6a_xlarge" }, { - "value": "d3.2xlarge", - "name": "d3_2xlarge" + "value": "m6a.2xlarge", + "name": "m6a_2xlarge" }, { - "value": "d3.4xlarge", - "name": "d3_4xlarge" + "value": "m6a.4xlarge", + "name": "m6a_4xlarge" }, { - "value": "d3.8xlarge", - "name": "d3_8xlarge" + "value": "m6a.8xlarge", + "name": "m6a_8xlarge" }, { - "value": "d3en.xlarge", - "name": "d3en_xlarge" + "value": "m6a.12xlarge", + "name": "m6a_12xlarge" }, { - "value": "d3en.2xlarge", - "name": "d3en_2xlarge" + "value": "m6a.16xlarge", + "name": "m6a_16xlarge" }, { - "value": "d3en.4xlarge", - "name": "d3en_4xlarge" + "value": "m6a.24xlarge", + "name": "m6a_24xlarge" }, { - "value": "d3en.6xlarge", - "name": "d3en_6xlarge" + "value": "m6a.32xlarge", + "name": "m6a_32xlarge" }, { - "value": "d3en.8xlarge", - "name": "d3en_8xlarge" + "value": "m6a.48xlarge", + "name": "m6a_48xlarge" }, { - "value": "d3en.12xlarge", - "name": "d3en_12xlarge" + "value": "m6g.metal", + "name": "m6g_metal" }, { - "value": "dl1.24xlarge", - "name": "dl1_24xlarge" + "value": "m6g.medium", + "name": "m6g_medium" }, { - "value": "f1.2xlarge", - "name": "f1_2xlarge" + "value": "m6g.large", + "name": "m6g_large" }, { - "value": "f1.4xlarge", - "name": "f1_4xlarge" + "value": "m6g.xlarge", + "name": "m6g_xlarge" }, { - "value": "f1.16xlarge", - "name": "f1_16xlarge" + "value": "m6g.2xlarge", + "name": "m6g_2xlarge" }, { - "value": "m5.large", - "name": "m5_large" + "value": "m6g.4xlarge", + "name": "m6g_4xlarge" }, { - "value": "m5.xlarge", - "name": "m5_xlarge" + "value": "m6g.8xlarge", + "name": "m6g_8xlarge" }, { - "value": "m5.2xlarge", - "name": "m5_2xlarge" + "value": "m6g.12xlarge", + "name": "m6g_12xlarge" }, { - "value": "m5.4xlarge", - "name": "m5_4xlarge" + "value": "m6g.16xlarge", + "name": "m6g_16xlarge" }, { - "value": "m5.8xlarge", - "name": "m5_8xlarge" + "value": "m6gd.metal", + "name": "m6gd_metal" }, { - "value": "m5.12xlarge", - "name": "m5_12xlarge" + "value": "m6gd.medium", + "name": "m6gd_medium" }, { - "value": "m5.16xlarge", - "name": "m5_16xlarge" + "value": "m6gd.large", + "name": "m6gd_large" }, { - "value": "m5.24xlarge", - "name": "m5_24xlarge" + "value": "m6gd.xlarge", + "name": "m6gd_xlarge" }, { - "value": "m5.metal", - "name": "m5_metal" + "value": "m6gd.2xlarge", + "name": "m6gd_2xlarge" }, { - "value": "m5a.large", - "name": "m5a_large" + "value": "m6gd.4xlarge", + "name": "m6gd_4xlarge" }, { - "value": "m5a.xlarge", - "name": "m5a_xlarge" + "value": "m6gd.8xlarge", + "name": "m6gd_8xlarge" }, { - "value": "m5a.2xlarge", - "name": "m5a_2xlarge" + "value": "m6gd.12xlarge", + "name": "m6gd_12xlarge" }, { - "value": "m5a.4xlarge", - "name": "m5a_4xlarge" + "value": "m6gd.16xlarge", + "name": "m6gd_16xlarge" }, { - "value": "m5a.8xlarge", - "name": "m5a_8xlarge" + "value": "m6i.large", + "name": "m6i_large" }, { - "value": "m5a.12xlarge", - "name": "m5a_12xlarge" + "value": "m6i.xlarge", + "name": "m6i_xlarge" }, { - "value": "m5a.16xlarge", - "name": "m5a_16xlarge" + "value": "m6i.2xlarge", + "name": "m6i_2xlarge" }, { - "value": "m5a.24xlarge", - "name": "m5a_24xlarge" + "value": "m6i.4xlarge", + "name": "m6i_4xlarge" }, { - "value": "m5d.large", - "name": "m5d_large" + "value": "m6i.8xlarge", + "name": "m6i_8xlarge" }, { - "value": "m5d.xlarge", - "name": "m5d_xlarge" + "value": "m6i.12xlarge", + "name": "m6i_12xlarge" }, { - "value": "m5d.2xlarge", - "name": "m5d_2xlarge" + "value": "m6i.16xlarge", + "name": "m6i_16xlarge" }, { - "value": "m5d.4xlarge", - "name": "m5d_4xlarge" + "value": "m6i.24xlarge", + "name": "m6i_24xlarge" }, { - "value": "m5d.8xlarge", - "name": "m5d_8xlarge" + "value": "m6i.32xlarge", + "name": "m6i_32xlarge" }, { - "value": "m5d.12xlarge", - "name": "m5d_12xlarge" + "value": "mac1.metal", + "name": "mac1_metal" }, { - "value": "m5d.16xlarge", - "name": "m5d_16xlarge" + "value": "p2.xlarge", + "name": "p2_xlarge" }, { - "value": "m5d.24xlarge", - "name": "m5d_24xlarge" + "value": "p2.8xlarge", + "name": "p2_8xlarge" }, { - "value": "m5d.metal", - "name": "m5d_metal" + "value": "p2.16xlarge", + "name": "p2_16xlarge" }, { - "value": "m5ad.large", - "name": "m5ad_large" + "value": "p3.2xlarge", + "name": "p3_2xlarge" }, { - "value": "m5ad.xlarge", - "name": "m5ad_xlarge" + "value": "p3.8xlarge", + "name": "p3_8xlarge" }, { - "value": "m5ad.2xlarge", - "name": "m5ad_2xlarge" + "value": "p3.16xlarge", + "name": "p3_16xlarge" }, { - "value": "m5ad.4xlarge", - "name": "m5ad_4xlarge" + "value": "p3dn.24xlarge", + "name": "p3dn_24xlarge" }, { - "value": "m5ad.8xlarge", - "name": "m5ad_8xlarge" + "value": "p4d.24xlarge", + "name": "p4d_24xlarge" }, { - "value": "m5ad.12xlarge", - "name": "m5ad_12xlarge" + "value": "r3.large", + "name": "r3_large" }, { - "value": "m5ad.16xlarge", - "name": "m5ad_16xlarge" + "value": "r3.xlarge", + "name": "r3_xlarge" }, { - "value": "m5ad.24xlarge", - "name": "m5ad_24xlarge" + "value": "r3.2xlarge", + "name": "r3_2xlarge" }, { - "value": "m5zn.large", - "name": "m5zn_large" + "value": "r3.4xlarge", + "name": "r3_4xlarge" }, { - "value": "m5zn.xlarge", - "name": "m5zn_xlarge" + "value": "r3.8xlarge", + "name": "r3_8xlarge" }, { - "value": "m5zn.2xlarge", - "name": "m5zn_2xlarge" + "value": "r4.large", + "name": "r4_large" }, { - "value": "m5zn.3xlarge", - "name": "m5zn_3xlarge" + "value": "r4.xlarge", + "name": "r4_xlarge" }, { - "value": "m5zn.6xlarge", - "name": "m5zn_6xlarge" + "value": "r4.2xlarge", + "name": "r4_2xlarge" }, { - "value": "m5zn.12xlarge", - "name": "m5zn_12xlarge" + "value": "r4.4xlarge", + "name": "r4_4xlarge" }, { - "value": "m5zn.metal", - "name": "m5zn_metal" + "value": "r4.8xlarge", + "name": "r4_8xlarge" }, { - "value": "h1.2xlarge", - "name": "h1_2xlarge" + "value": "r4.16xlarge", + "name": "r4_16xlarge" }, { - "value": "h1.4xlarge", - "name": "h1_4xlarge" + "value": "r5.large", + "name": "r5_large" }, { - "value": "h1.8xlarge", - "name": "h1_8xlarge" + "value": "r5.xlarge", + "name": "r5_xlarge" }, { - "value": "h1.16xlarge", - "name": "h1_16xlarge" + "value": "r5.2xlarge", + "name": "r5_2xlarge" }, { - "value": "z1d.large", - "name": "z1d_large" + "value": "r5.4xlarge", + "name": "r5_4xlarge" }, { - "value": "z1d.xlarge", - "name": "z1d_xlarge" + "value": "r5.8xlarge", + "name": "r5_8xlarge" }, { - "value": "z1d.2xlarge", - "name": "z1d_2xlarge" + "value": "r5.12xlarge", + "name": "r5_12xlarge" }, { - "value": "z1d.3xlarge", - "name": "z1d_3xlarge" + "value": "r5.16xlarge", + "name": "r5_16xlarge" }, { - "value": "z1d.6xlarge", - "name": "z1d_6xlarge" + "value": "r5.24xlarge", + "name": "r5_24xlarge" }, { - "value": "z1d.12xlarge", - "name": "z1d_12xlarge" + "value": "r5.metal", + "name": "r5_metal" }, { - "value": "z1d.metal", - "name": "z1d_metal" + "value": "r5a.large", + "name": "r5a_large" }, { - "value": "u-6tb1.56xlarge", - "name": "u_6tb1_56xlarge" + "value": "r5a.xlarge", + "name": "r5a_xlarge" }, { - "value": "u-6tb1.112xlarge", - "name": "u_6tb1_112xlarge" + "value": "r5a.2xlarge", + "name": "r5a_2xlarge" }, { - "value": "u-9tb1.112xlarge", - "name": "u_9tb1_112xlarge" + "value": "r5a.4xlarge", + "name": "r5a_4xlarge" }, { - "value": "u-12tb1.112xlarge", - "name": "u_12tb1_112xlarge" + "value": "r5a.8xlarge", + "name": "r5a_8xlarge" }, { - "value": "u-6tb1.metal", - "name": "u_6tb1_metal" + "value": "r5a.12xlarge", + "name": "r5a_12xlarge" }, { - "value": "u-9tb1.metal", - "name": "u_9tb1_metal" + "value": "r5a.16xlarge", + "name": "r5a_16xlarge" }, { - "value": "u-12tb1.metal", - "name": "u_12tb1_metal" + "value": "r5a.24xlarge", + "name": "r5a_24xlarge" }, { - "value": "u-18tb1.metal", - "name": "u_18tb1_metal" + "value": "r5ad.large", + "name": "r5ad_large" }, { - "value": "u-24tb1.metal", - "name": "u_24tb1_metal" + "value": "r5ad.xlarge", + "name": "r5ad_xlarge" }, { - "value": "a1.medium", - "name": "a1_medium" + "value": "r5ad.2xlarge", + "name": "r5ad_2xlarge" }, { - "value": "a1.large", - "name": "a1_large" + "value": "r5ad.4xlarge", + "name": "r5ad_4xlarge" }, { - "value": "a1.xlarge", - "name": "a1_xlarge" + "value": "r5ad.8xlarge", + "name": "r5ad_8xlarge" }, { - "value": "a1.2xlarge", - "name": "a1_2xlarge" + "value": "r5ad.12xlarge", + "name": "r5ad_12xlarge" }, { - "value": "a1.4xlarge", - "name": "a1_4xlarge" + "value": "r5ad.16xlarge", + "name": "r5ad_16xlarge" }, { - "value": "a1.metal", - "name": "a1_metal" + "value": "r5ad.24xlarge", + "name": "r5ad_24xlarge" }, { - "value": "m5dn.large", - "name": "m5dn_large" + "value": "r5b.large", + "name": "r5b_large" }, { - "value": "m5dn.xlarge", - "name": "m5dn_xlarge" + "value": "r5b.xlarge", + "name": "r5b_xlarge" }, { - "value": "m5dn.2xlarge", - "name": "m5dn_2xlarge" + "value": "r5b.2xlarge", + "name": "r5b_2xlarge" }, { - "value": "m5dn.4xlarge", - "name": "m5dn_4xlarge" + "value": "r5b.4xlarge", + "name": "r5b_4xlarge" }, { - "value": "m5dn.8xlarge", - "name": "m5dn_8xlarge" + "value": "r5b.8xlarge", + "name": "r5b_8xlarge" }, { - "value": "m5dn.12xlarge", - "name": "m5dn_12xlarge" + "value": "r5b.12xlarge", + "name": "r5b_12xlarge" }, { - "value": "m5dn.16xlarge", - "name": "m5dn_16xlarge" + "value": "r5b.16xlarge", + "name": "r5b_16xlarge" }, { - "value": "m5dn.24xlarge", - "name": "m5dn_24xlarge" + "value": "r5b.24xlarge", + "name": "r5b_24xlarge" }, { - "value": "m5dn.metal", - "name": "m5dn_metal" + "value": "r5b.metal", + "name": "r5b_metal" }, { - "value": "m5n.large", - "name": "m5n_large" + "value": "r5d.large", + "name": "r5d_large" }, { - "value": "m5n.xlarge", - "name": "m5n_xlarge" + "value": "r5d.xlarge", + "name": "r5d_xlarge" }, { - "value": "m5n.2xlarge", - "name": "m5n_2xlarge" + "value": "r5d.2xlarge", + "name": "r5d_2xlarge" }, { - "value": "m5n.4xlarge", - "name": "m5n_4xlarge" + "value": "r5d.4xlarge", + "name": "r5d_4xlarge" }, { - "value": "m5n.8xlarge", - "name": "m5n_8xlarge" + "value": "r5d.8xlarge", + "name": "r5d_8xlarge" }, { - "value": "m5n.12xlarge", - "name": "m5n_12xlarge" + "value": "r5d.12xlarge", + "name": "r5d_12xlarge" }, { - "value": "m5n.16xlarge", - "name": "m5n_16xlarge" + "value": "r5d.16xlarge", + "name": "r5d_16xlarge" }, { - "value": "m5n.24xlarge", - "name": "m5n_24xlarge" + "value": "r5d.24xlarge", + "name": "r5d_24xlarge" }, { - "value": "m5n.metal", - "name": "m5n_metal" + "value": "r5d.metal", + "name": "r5d_metal" }, { "value": "r5dn.large", @@ -45860,208 +45920,228 @@ "name": "r5n_metal" }, { - "value": "inf1.xlarge", - "name": "inf1_xlarge" + "value": "r6g.medium", + "name": "r6g_medium" }, { - "value": "inf1.2xlarge", - "name": "inf1_2xlarge" + "value": "r6g.large", + "name": "r6g_large" }, { - "value": "inf1.6xlarge", - "name": "inf1_6xlarge" + "value": "r6g.xlarge", + "name": "r6g_xlarge" }, { - "value": "inf1.24xlarge", - "name": "inf1_24xlarge" + "value": "r6g.2xlarge", + "name": "r6g_2xlarge" }, { - "value": "m6g.metal", - "name": "m6g_metal" + "value": "r6g.4xlarge", + "name": "r6g_4xlarge" }, { - "value": "m6g.medium", - "name": "m6g_medium" + "value": "r6g.8xlarge", + "name": "r6g_8xlarge" }, { - "value": "m6g.large", - "name": "m6g_large" + "value": "r6g.12xlarge", + "name": "r6g_12xlarge" }, { - "value": "m6g.xlarge", - "name": "m6g_xlarge" + "value": "r6g.16xlarge", + "name": "r6g_16xlarge" }, { - "value": "m6g.2xlarge", - "name": "m6g_2xlarge" + "value": "r6g.metal", + "name": "r6g_metal" }, { - "value": "m6g.4xlarge", - "name": "m6g_4xlarge" + "value": "r6gd.medium", + "name": "r6gd_medium" }, { - "value": "m6g.8xlarge", - "name": "m6g_8xlarge" + "value": "r6gd.large", + "name": "r6gd_large" }, { - "value": "m6g.12xlarge", - "name": "m6g_12xlarge" + "value": "r6gd.xlarge", + "name": "r6gd_xlarge" }, { - "value": "m6g.16xlarge", - "name": "m6g_16xlarge" + "value": "r6gd.2xlarge", + "name": "r6gd_2xlarge" }, { - "value": "m6gd.metal", - "name": "m6gd_metal" + "value": "r6gd.4xlarge", + "name": "r6gd_4xlarge" }, { - "value": "m6gd.medium", - "name": "m6gd_medium" + "value": "r6gd.8xlarge", + "name": "r6gd_8xlarge" }, { - "value": "m6gd.large", - "name": "m6gd_large" + "value": "r6gd.12xlarge", + "name": "r6gd_12xlarge" }, { - "value": "m6gd.xlarge", - "name": "m6gd_xlarge" + "value": "r6gd.16xlarge", + "name": "r6gd_16xlarge" }, { - "value": "m6gd.2xlarge", - "name": "m6gd_2xlarge" + "value": "r6gd.metal", + "name": "r6gd_metal" }, { - "value": "m6gd.4xlarge", - "name": "m6gd_4xlarge" + "value": "t1.micro", + "name": "t1_micro" }, { - "value": "m6gd.8xlarge", - "name": "m6gd_8xlarge" + "value": "t2.nano", + "name": "t2_nano" }, { - "value": "m6gd.12xlarge", - "name": "m6gd_12xlarge" + "value": "t2.micro", + "name": "t2_micro" }, { - "value": "m6gd.16xlarge", - "name": "m6gd_16xlarge" + "value": "t2.small", + "name": "t2_small" }, { - "value": "m6a.large", - "name": "m6a_large" + "value": "t2.medium", + "name": "t2_medium" }, { - "value": "m6a.xlarge", - "name": "m6a_xlarge" + "value": "t2.large", + "name": "t2_large" }, { - "value": "m6a.2xlarge", - "name": "m6a_2xlarge" + "value": "t2.xlarge", + "name": "t2_xlarge" }, { - "value": "m6a.4xlarge", - "name": "m6a_4xlarge" + "value": "t2.2xlarge", + "name": "t2_2xlarge" }, { - "value": "m6a.8xlarge", - "name": "m6a_8xlarge" + "value": "t3.nano", + "name": "t3_nano" }, { - "value": "m6a.12xlarge", - "name": "m6a_12xlarge" + "value": "t3.micro", + "name": "t3_micro" }, { - "value": "m6a.16xlarge", - "name": "m6a_16xlarge" + "value": "t3.small", + "name": "t3_small" }, { - "value": "m6a.24xlarge", - "name": "m6a_24xlarge" + "value": "t3.medium", + "name": "t3_medium" }, { - "value": "m6a.32xlarge", - "name": "m6a_32xlarge" + "value": "t3.large", + "name": "t3_large" }, { - "value": "m6a.48xlarge", - "name": "m6a_48xlarge" + "value": "t3.xlarge", + "name": "t3_xlarge" }, { - "value": "m6i.large", - "name": "m6i_large" + "value": "t3.2xlarge", + "name": "t3_2xlarge" }, { - "value": "m6i.xlarge", - "name": "m6i_xlarge" + "value": "t3a.nano", + "name": "t3a_nano" }, { - "value": "m6i.2xlarge", - "name": "m6i_2xlarge" + "value": "t3a.micro", + "name": "t3a_micro" }, { - "value": "m6i.4xlarge", - "name": "m6i_4xlarge" + "value": "t3a.small", + "name": "t3a_small" }, { - "value": "m6i.8xlarge", - "name": "m6i_8xlarge" + "value": "t3a.medium", + "name": "t3a_medium" }, { - "value": "m6i.12xlarge", - "name": "m6i_12xlarge" + "value": "t3a.large", + "name": "t3a_large" }, { - "value": "m6i.16xlarge", - "name": "m6i_16xlarge" + "value": "t3a.xlarge", + "name": "t3a_xlarge" }, { - "value": "m6i.24xlarge", - "name": "m6i_24xlarge" + "value": "t3a.2xlarge", + "name": "t3a_2xlarge" }, { - "value": "m6i.32xlarge", - "name": "m6i_32xlarge" + "value": "t4g.nano", + "name": "t4g_nano" }, { - "value": "mac1.metal", - "name": "mac1_metal" + "value": "t4g.micro", + "name": "t4g_micro" }, { - "value": "x2gd.medium", - "name": "x2gd_medium" + "value": "t4g.small", + "name": "t4g_small" }, { - "value": "x2gd.large", - "name": "x2gd_large" + "value": "t4g.medium", + "name": "t4g_medium" }, { - "value": "x2gd.xlarge", - "name": "x2gd_xlarge" + "value": "t4g.large", + "name": "t4g_large" }, { - "value": "x2gd.2xlarge", - "name": "x2gd_2xlarge" + "value": "t4g.xlarge", + "name": "t4g_xlarge" }, { - "value": "x2gd.4xlarge", - "name": "x2gd_4xlarge" + "value": "t4g.2xlarge", + "name": "t4g_2xlarge" }, { - "value": "x2gd.8xlarge", - "name": "x2gd_8xlarge" + "value": "u-6tb1.56xlarge", + "name": "u_6tb1_56xlarge" }, { - "value": "x2gd.12xlarge", - "name": "x2gd_12xlarge" + "value": "u-6tb1.112xlarge", + "name": "u_6tb1_112xlarge" }, { - "value": "x2gd.16xlarge", - "name": "x2gd_16xlarge" + "value": "u-9tb1.112xlarge", + "name": "u_9tb1_112xlarge" }, { - "value": "x2gd.metal", - "name": "x2gd_metal" + "value": "u-12tb1.112xlarge", + "name": "u_12tb1_112xlarge" + }, + { + "value": "u-6tb1.metal", + "name": "u_6tb1_metal" + }, + { + "value": "u-9tb1.metal", + "name": "u_9tb1_metal" + }, + { + "value": "u-12tb1.metal", + "name": "u_12tb1_metal" + }, + { + "value": "u-18tb1.metal", + "name": "u_18tb1_metal" + }, + { + "value": "u-24tb1.metal", + "name": "u_24tb1_metal" }, { "value": "vt1.3xlarge", @@ -46076,108 +46156,100 @@ "name": "vt1_24xlarge" }, { - "value": "im4gn.16xlarge", - "name": "im4gn_16xlarge" - }, - { - "value": "im4gn.2xlarge", - "name": "im4gn_2xlarge" - }, - { - "value": "im4gn.4xlarge", - "name": "im4gn_4xlarge" + "value": "x1.16xlarge", + "name": "x1_16xlarge" }, { - "value": "im4gn.8xlarge", - "name": "im4gn_8xlarge" + "value": "x1.32xlarge", + "name": "x1_32xlarge" }, { - "value": "im4gn.large", - "name": "im4gn_large" + "value": "x1e.xlarge", + "name": "x1e_xlarge" }, { - "value": "im4gn.xlarge", - "name": "im4gn_xlarge" + "value": "x1e.2xlarge", + "name": "x1e_2xlarge" }, { - "value": "is4gen.2xlarge", - "name": "is4gen_2xlarge" + "value": "x1e.4xlarge", + "name": "x1e_4xlarge" }, { - "value": "is4gen.4xlarge", - "name": "is4gen_4xlarge" + "value": "x1e.8xlarge", + "name": "x1e_8xlarge" }, { - "value": "is4gen.8xlarge", - "name": "is4gen_8xlarge" + "value": "x1e.16xlarge", + "name": "x1e_16xlarge" }, { - "value": "is4gen.large", - "name": "is4gen_large" + "value": "x1e.32xlarge", + "name": "x1e_32xlarge" }, { - "value": "is4gen.medium", - "name": "is4gen_medium" + "value": "x2gd.medium", + "name": "x2gd_medium" }, { - "value": "is4gen.xlarge", - "name": "is4gen_xlarge" + "value": "x2gd.large", + "name": "x2gd_large" }, { - "value": "g5g.xlarge", - "name": "g5g_xlarge" + "value": "x2gd.xlarge", + "name": "x2gd_xlarge" }, { - "value": "g5g.2xlarge", - "name": "g5g_2xlarge" + "value": "x2gd.2xlarge", + "name": "x2gd_2xlarge" }, { - "value": "g5g.4xlarge", - "name": "g5g_4xlarge" + "value": "x2gd.4xlarge", + "name": "x2gd_4xlarge" }, { - "value": "g5g.8xlarge", - "name": "g5g_8xlarge" + "value": "x2gd.8xlarge", + "name": "x2gd_8xlarge" }, { - "value": "g5g.16xlarge", - "name": "g5g_16xlarge" + "value": "x2gd.12xlarge", + "name": "x2gd_12xlarge" }, { - "value": "g5g.metal", - "name": "g5g_metal" + "value": "x2gd.16xlarge", + "name": "x2gd_16xlarge" }, { - "value": "g5.xlarge", - "name": "g5_xlarge" + "value": "x2gd.metal", + "name": "x2gd_metal" }, { - "value": "g5.2xlarge", - "name": "g5_2xlarge" + "value": "z1d.large", + "name": "z1d_large" }, { - "value": "g5.4xlarge", - "name": "g5_4xlarge" + "value": "z1d.xlarge", + "name": "z1d_xlarge" }, { - "value": "g5.8xlarge", - "name": "g5_8xlarge" + "value": "z1d.2xlarge", + "name": "z1d_2xlarge" }, { - "value": "g5.12xlarge", - "name": "g5_12xlarge" + "value": "z1d.3xlarge", + "name": "z1d_3xlarge" }, { - "value": "g5.16xlarge", - "name": "g5_16xlarge" + "value": "z1d.6xlarge", + "name": "z1d_6xlarge" }, { - "value": "g5.24xlarge", - "name": "g5_24xlarge" + "value": "z1d.12xlarge", + "name": "z1d_12xlarge" }, { - "value": "g5.48xlarge", - "name": "g5_48xlarge" + "value": "z1d.metal", + "name": "z1d_metal" } ] } @@ -48641,13 +48713,13 @@ "Add": { "target": "com.amazonaws.ec2#LaunchPermissionList", "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID to add to the list of launch permissions for the AMI.
" + "smithy.api#documentation": "The Amazon Web Services account ID, organization ARN, or OU ARN to add to the list of launch permissions for the AMI.
" } }, "Remove": { "target": "com.amazonaws.ec2#LaunchPermissionList", "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID to remove from the list of launch permissions for the AMI.
" + "smithy.api#documentation": "The Amazon Web Services account ID, organization ARN, or OU ARN to remove from the list of launch permissions for the AMI.
" } } }, @@ -49541,7 +49613,7 @@ "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataEndpointState", "traits": { "aws.protocols#ec2QueryName": "HttpEndpoint", - "smithy.api#documentation": "This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your instance metadata.\n
Enables or disables the HTTP metadata endpoint on your instances. If the parameter is\n not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your instance metadata.\n
Enables or disables the IPv6 endpoint for the instance metadata service.
\nDefault: disabled\n
\n \n
", + "smithy.api#xmlName": "instanceMetadataTags" + } } }, "traits": { @@ -49576,7 +49656,7 @@ "HttpEndpoint": { "target": "com.amazonaws.ec2#LaunchTemplateInstanceMetadataEndpointState", "traits": { - "smithy.api#documentation": "This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your instance metadata.\n
Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not\n specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your instance metadata.\n
Enables or disables the IPv6 endpoint for the instance metadata service.
\nDefault: disabled\n
Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the instance\n metadata. For more information, see Work with\n instance tags using the instance metadata.
Default: disabled\n
Enables or disables the HTTP metadata endpoint on your instances. If\n the parameter is not specified, the existing state is maintained.
\nIf you specify a value of disabled, you cannot access your\n instance metadata.
Enables or disables the HTTP metadata endpoint on your instances. If\n this parameter is not specified, the existing state is maintained.
\nIf you specify a value of disabled, you cannot access your\n instance metadata.
Enables or disables the IPv6 endpoint for the instance metadata service. This setting \n applies only if you have enabled the HTTP metadata endpoint.
" } + }, + "InstanceMetadataTags": { + "target": "com.amazonaws.ec2#InstanceMetadataTagsState", + "traits": { + "smithy.api#documentation": "Set to enabled to allow access to instance tags from the instance\n metadata. Set to disabled to turn off access to instance tags from the\n instance metadata. For more information, see Work with\n instance tags using the instance metadata.
Default: disabled\n
Modifies the payer responsibility for your VPC endpoint service.
" + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityRequest": { + "type": "structure", + "members": { + "DryRun": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "smithy.api#documentation": "Checks whether you have the required permissions for the action, without actually making the request, \n and provides an error response. If you have the required permissions, the error response is DryRunOperation. \n Otherwise, it is UnauthorizedOperation.
The ID of the service.
", + "smithy.api#required": {} + } + }, + "PayerResponsibility": { + "target": "com.amazonaws.ec2#PayerResponsibility", + "traits": { + "smithy.api#documentation": "The entity that is responsible for the endpoint costs. The default is the endpoint owner.\n If you set the payer responsibility to the service owner, you cannot set it back to the\n endpoint owner.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.ec2#ModifyVpcEndpointServicePayerResponsibilityResult": { + "type": "structure", + "members": { + "ReturnValue": { + "target": "com.amazonaws.ec2#Boolean", + "traits": { + "aws.protocols#ec2QueryName": "Return", + "smithy.api#documentation": "Returns true if the request succeeds; otherwise, it returns an error.
The number of seconds after which a DPD timeout occurs.
\nConstraints: A value between 0 and 30.
\nDefault: 30\n
The number of seconds after which a DPD timeout occurs.
\nConstraints: A value greater than or equal to 30.
\nDefault: 30\n
The BYOIP CIDR.
" + "smithy.api#documentation": "The BYOIP CIDR.
", + "smithy.api#required": {} } }, "IpamPoolId": { "target": "com.amazonaws.ec2#IpamPoolId", "traits": { - "smithy.api#documentation": "The IPAM pool ID.
" + "smithy.api#documentation": "The IPAM pool ID.
", + "smithy.api#required": {} } }, "IpamPoolOwner": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services account ID of the owner of the IPAM pool.
" + "smithy.api#documentation": "The Amazon Web Services account ID of the owner of the IPAM pool.
", + "smithy.api#required": {} } } } @@ -58161,6 +58321,17 @@ "smithy.api#documentation": "Describes a path statement.
" } }, + "com.amazonaws.ec2#PayerResponsibility": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ServiceOwner", + "name": "ServiceOwner" + } + ] + } + }, "com.amazonaws.ec2#PaymentOption": { "type": "string", "traits": { @@ -58747,12 +58918,26 @@ "smithy.api#documentation": "Any tags applied to the placement group.
", "smithy.api#xmlName": "tagSet" } + }, + "GroupArn": { + "target": "com.amazonaws.ec2#String", + "traits": { + "aws.protocols#ec2QueryName": "GroupArn", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the placement group.
", + "smithy.api#xmlName": "groupArn" + } } }, "traits": { "smithy.api#documentation": "Describes a placement group.
" } }, + "com.amazonaws.ec2#PlacementGroupArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:aws([a-z-]+)?:ec2:[a-z\\d-]+:\\d{12}:placement-group/([^\\s].+[^\\s]){1,255}$" + } + }, "com.amazonaws.ec2#PlacementGroupId": { "type": "string" }, @@ -60187,7 +60372,7 @@ } }, "HostReservationId": { - "target": "com.amazonaws.ec2#String", + "target": "com.amazonaws.ec2#HostReservationId", "traits": { "aws.protocols#ec2QueryName": "HostReservationId", "smithy.api#documentation": "The ID of the reservation.
", @@ -67610,6 +67795,14 @@ "smithy.api#xmlName": "privateDnsNameConfiguration" } }, + "PayerResponsibility": { + "target": "com.amazonaws.ec2#PayerResponsibility", + "traits": { + "aws.protocols#ec2QueryName": "PayerResponsibility", + "smithy.api#documentation": "The payer responsibility.
", + "smithy.api#xmlName": "payerResponsibility" + } + }, "Tags": { "target": "com.amazonaws.ec2#TagList", "traits": { @@ -67723,6 +67916,14 @@ "smithy.api#xmlName": "managesVpcEndpoints" } }, + "PayerResponsibility": { + "target": "com.amazonaws.ec2#PayerResponsibility", + "traits": { + "aws.protocols#ec2QueryName": "PayerResponsibility", + "smithy.api#documentation": "The payer responsibility.
", + "smithy.api#xmlName": "payerResponsibility" + } + }, "Tags": { "target": "com.amazonaws.ec2#TagList", "traits": { @@ -68617,13 +68818,13 @@ "target": "com.amazonaws.ec2#Integer", "traits": { "aws.protocols#ec2QueryName": "TerminationDelay", - "smithy.api#documentation": "The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.
\nValid only when ReplacementStrategy is set to launch-before-terminate.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot\n Instance after launching a new replacement Spot Instance.
\nRequired when ReplacementStrategy is set to launch-before-terminate.
Not valid when ReplacementStrategy is set to launch.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your\n Spot Instance is at an elevated risk of being interrupted. For more information, see\n Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your\n Spot Instance is at an elevated risk of being interrupted. For more information, see\n Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.
" } }, "com.amazonaws.ec2#SpotDatafeedSubscription": { @@ -69482,7 +69683,7 @@ "target": "com.amazonaws.ec2#SpotCapacityRebalance", "traits": { "aws.protocols#ec2QueryName": "CapacityRebalance", - "smithy.api#documentation": "The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an\n elevated risk of being interrupted.
", + "smithy.api#documentation": "The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your\n Spot Instance is at an elevated risk of being interrupted. For more information, see\n Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.
", "smithy.api#xmlName": "capacityRebalance" } } @@ -78059,7 +78260,7 @@ "DPDTimeoutSeconds": { "target": "com.amazonaws.ec2#Integer", "traits": { - "smithy.api#documentation": "The number of seconds after which a DPD timeout occurs.
\nConstraints: A value between 0 and 30.
\nDefault: 30\n
The number of seconds after which a DPD timeout occurs.
\nConstraints: A value greater than or equal to 30.
\nDefault: 30\n
The status of the attachment. Valid values are PRECREATED,\n\t\t\t\tCREATED, ATTACHING, ATTACHED,\n\t\t\t\tDETACHING, DETACHED, and DELETED.
The status of the attachment. Valid values are PRECREATED,\n\t\t\t\tCREATED, ATTACHING, ATTACHED,\n\t\t\t\tDETACHING, DETACHED, DELETED, and\n\t\t\t\tFAILED.
The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection.
\n\t\tWhen using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.
\n\t\tWhen managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n\t\t\tan Auto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.
\n\t\tWhen managed termination protection is disabled, your Amazon EC2 instances aren't protected\n\t\t\tfrom termination when the Auto Scaling group scales in.
" + "smithy.api#documentation": "The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection. The default is disabled.
\n\t\tWhen using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection doesn't work.
\n\t\tWhen managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n\t\t\tan Auto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions enabled as well. For more information, see Instance Protection in the Auto Scaling User Guide.
\n\t\tWhen managed termination protection is disabled, your Amazon EC2 instances aren't protected\n\t\t\tfrom termination when the Auto Scaling group scales in.
" } } }, @@ -6561,7 +6561,7 @@ } ], "traits": { - "smithy.api#documentation": "Starts a new task using the specified task definition.
\n\t\tYou can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
\n\t\tAlternatively, you can use StartTask to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.
\n\t\tThe Amazon ECS API follows an eventual consistency model. This is because the distributed\n\t\t\tnature of the system supporting the API. This means that the result of an API command\n\t\t\tyou run that affects your Amazon ECS resources might not be immediately visible to all\n\t\t\tsubsequent commands you run. Keep this in mind when you carry out an API command that\n\t\t\timmediately follows a previous API command.
\n\t\tTo manage eventual consistency, you can do the following:
\n\t\tConfirm the state of the resource before you run a command to modify it. Run\n\t\t\t\t\tthe DescribeTasks command using an exponential backoff algorithm to ensure that\n\t\t\t\t\tyou allow enough time for the previous command to propagate through the system.\n\t\t\t\t\tTo do this, run the DescribeTasks command repeatedly, starting with a couple of\n\t\t\t\t\tseconds of wait time and increasing gradually up to five minutes of wait\n\t\t\t\t\ttime.
\n\t\t\tAdd wait time between subsequent commands, even if the DescribeTasks command\n\t\t\t\t\treturns an accurate response. Apply an exponential backoff algorithm starting\n\t\t\t\t\twith a couple of seconds of wait time, and increase gradually up to about five\n\t\t\t\t\tminutes of wait time.
\n\t\t\tStarts a new task using the specified task definition.
\n\t\tYou can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
\n\t\tAlternatively, you can use StartTask to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.
\n\t\tThe Amazon ECS API follows an eventual consistency model. This is because of the distributed\n\t\t\tnature of the system supporting the API. This means that the result of an API command\n\t\t\tyou run that affects your Amazon ECS resources might not be immediately visible to all\n\t\t\tsubsequent commands you run. Keep this in mind when you carry out an API command that\n\t\t\timmediately follows a previous API command.
\n\t\tTo manage eventual consistency, you can do the following:
\n\t\tConfirm the state of the resource before you run a command to modify it. Run\n\t\t\t\t\tthe DescribeTasks command using an exponential backoff algorithm to ensure that\n\t\t\t\t\tyou allow enough time for the previous command to propagate through the system.\n\t\t\t\t\tTo do this, run the DescribeTasks command repeatedly, starting with a couple of\n\t\t\t\t\tseconds of wait time and increasing gradually up to five minutes of wait\n\t\t\t\t\ttime.
\n\t\t\tAdd wait time between subsequent commands, even if the DescribeTasks command\n\t\t\t\t\treturns an accurate response. Apply an exponential backoff algorithm starting\n\t\t\t\t\twith a couple of seconds of wait time, and increase gradually up to about five\n\t\t\t\t\tminutes of wait time.
\n\t\t\tA list of container instance IDs or full ARN entries.
", + "smithy.api#documentation": "A list of up to 10 container instance IDs or full ARN entries.
", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/eks.2017-11-01.json b/codegen/sdk/aws-models/eks.2017-11-01.json index 22aeb6d0c84..36f95d2ae16 100644 --- a/codegen/sdk/aws-models/eks.2017-11-01.json +++ b/codegen/sdk/aws-models/eks.2017-11-01.json @@ -74,7 +74,7 @@ "name": "eks" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on\n Amazon Web Services without needing to stand up or maintain your own Kubernetes control plane.\n Kubernetes is an open-source system for automating the deployment, scaling, and\n management of containerized applications.
\nAmazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use\n all the existing plugins and tooling from the Kubernetes community. Applications running\n on Amazon EKS are fully compatible with applications running on any standard Kubernetes\n environment, whether running in on-premises data centers or public clouds. This means\n that you can easily migrate any standard Kubernetes application to Amazon EKS without any\n code modification required.
", + "smithy.api#documentation": "Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy\n for you to run Kubernetes on Amazon Web Services without needing to stand up or maintain\n your own Kubernetes control plane. Kubernetes is an open-source system for automating\n the deployment, scaling, and management of containerized applications.
\nAmazon EKS runs up-to-date versions of the open-source Kubernetes software, so\n you can use all the existing plugins and tooling from the Kubernetes community.\n Applications running on Amazon EKS are fully compatible with applications\n running on any standard Kubernetes environment, whether running in on-premises data\n centers or public clouds. This means that you can easily migrate any standard Kubernetes\n application to Amazon EKS without any code modification required.
", "smithy.api#title": "Amazon Elastic Kubernetes Service" }, "version": "2017-11-01", @@ -191,7 +191,7 @@ } }, "traits": { - "smithy.api#documentation": "You don't have permissions to perform the requested operation. The user or role that\n is making the request must have at least one IAM permissions policy attached that\n grants the required permissions. For more information, see Access\n Management in the IAM User Guide.
", + "smithy.api#documentation": "You don't have permissions to perform the requested operation. The user or role that\n is making the request must have at least one IAM permissions policy\n attached that grants the required permissions. For more information, see Access\n Management in the IAM User Guide.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -250,7 +250,7 @@ "serviceAccountRoleArn": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that is bound to the Kubernetes service account used\n by the add-on.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that is bound to the Kubernetes service\n account used by the add-on.
" } }, "tags": { @@ -610,12 +610,12 @@ "name": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group associated with an Amazon EKS managed node group.
" + "smithy.api#documentation": "The name of the Auto Scaling group associated with an Amazon EKS managed node\n group.
" } } }, "traits": { - "smithy.api#documentation": "An Auto Scaling group that is associated with an Amazon EKS managed node group.
" + "smithy.api#documentation": "An Auto Scaling group that is associated with an Amazon EKS managed node\n group.
" } }, "com.amazonaws.eks#AutoScalingGroupList": { @@ -754,13 +754,13 @@ "roleArn": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control\n plane to make calls to Amazon Web Services API operations on your behalf.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that provides permissions for the\n Kubernetes control plane to make calls to Amazon Web Services API operations on your\n behalf.
" } }, "resourcesVpcConfig": { "target": "com.amazonaws.eks#VpcConfigResponse", "traits": { - "smithy.api#documentation": "The VPC configuration used by the cluster control plane. Amazon EKS VPC resources have\n specific requirements to work properly with Kubernetes. For more information, see Cluster VPC\n Considerations and Cluster Security Group Considerations in the\n Amazon EKS User Guide.
" + "smithy.api#documentation": "The VPC configuration used by the cluster control plane. Amazon EKS VPC\n resources have specific requirements to work properly with Kubernetes. For more\n information, see Cluster VPC Considerations and Cluster Security\n Group Considerations in the Amazon EKS User Guide.
" } }, "kubernetesNetworkConfig": { @@ -802,7 +802,7 @@ "platformVersion": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "The platform version of your Amazon EKS cluster. For more information, see Platform\n Versions in the \n Amazon EKS User Guide\n .
" + "smithy.api#documentation": "The platform version of your Amazon EKS cluster. For more information, see\n Platform Versions in the \n Amazon EKS User Guide\n .
" } }, "tags": { @@ -950,7 +950,7 @@ "roleArn": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that is authorized to request the connector configuration.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that is authorized to request the connector\n configuration.
", "smithy.api#required": {} } }, @@ -984,7 +984,7 @@ "activationExpiry": { "target": "com.amazonaws.eks#Timestamp", "traits": { - "smithy.api#documentation": "The expiration time of the connected cluster. The cluster's YAML file must be applied through the native \n provider.
" + "smithy.api#documentation": "The expiration time of the connected cluster. The cluster's YAML file must be applied\n through the native provider.
" } }, "provider": { @@ -996,7 +996,7 @@ "roleArn": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes cluster.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role to communicate with services from the connected Kubernetes\n cluster.
" } } }, @@ -1074,7 +1074,7 @@ "resolveConflicts": { "target": "com.amazonaws.eks#ResolveConflicts", "traits": { - "smithy.api#documentation": "How to resolve parameter value conflicts when migrating an existing add-on to an Amazon EKS\n add-on.
" + "smithy.api#documentation": "How to resolve parameter value conflicts when migrating an existing add-on to an\n Amazon EKS add-on.
" } }, "clientRequestToken": { @@ -1132,7 +1132,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Amazon EKS control plane.
\nThe Amazon EKS control plane consists of control plane instances that run the Kubernetes\n software, such as etcd and the API server. The control plane runs in an\n account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server\n endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It runs on its\n own set of Amazon EC2 instances.
The cluster control plane is provisioned across multiple Availability Zones and\n fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC\n subnets to provide connectivity from the control plane instances to the nodes (for\n example, to support kubectl exec, logs, and proxy\n data flows).
Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over\n the Kubernetes API server endpoint and a certificate file that is created for your\n cluster.
\n \nIn most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster,\n you must configure your Kubernetes tooling to communicate with the API server and launch\n nodes into your cluster. For more information, see Managing Cluster\n Authentication and Launching Amazon EKS nodes in the Amazon EKS User Guide.
", + "smithy.api#documentation": "Creates an Amazon EKS control plane.
\nThe Amazon EKS control plane consists of control plane instances that run the Kubernetes\n software, such as etcd and the API server. The control plane runs in an\n account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server\n endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It runs on its\n own set of Amazon EC2 instances.
The cluster control plane is provisioned across multiple Availability Zones and\n fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC\n subnets to provide connectivity from the control plane instances to the nodes (for\n example, to support kubectl exec, logs, and proxy\n data flows).
Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over\n the Kubernetes API server endpoint and a certificate file that is created for your\n cluster.
\n \nIn most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster,\n you must configure your Kubernetes tooling to communicate with the API server and launch\n nodes into your cluster. For more information, see Managing Cluster\n Authentication and Launching Amazon EKS nodes in the\n Amazon EKS User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/clusters", @@ -1159,7 +1159,7 @@ "roleArn": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control\n plane to make calls to Amazon Web Services API operations on your behalf. For more information, see\n Amazon EKS\n Service IAM Role in the \n Amazon EKS User Guide\n .
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that provides permissions for the\n Kubernetes control plane to make calls to Amazon Web Services API operations on your\n behalf. For more information, see Amazon EKS Service IAM Role in the \n Amazon EKS User Guide\n .
", "smithy.api#required": {} } }, @@ -1179,7 +1179,7 @@ "logging": { "target": "com.amazonaws.eks#Logging", "traits": { - "smithy.api#documentation": "Enable or disable exporting the Kubernetes control plane logs for your cluster to\n CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more\n information, see Amazon EKS Cluster control plane logs in the\n \n Amazon EKS User Guide\n .
\nCloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported\n control plane logs. For more information, see CloudWatch Pricing.
\nEnable or disable exporting the Kubernetes control plane logs for your cluster to\n CloudWatch Logs. By default, cluster control plane logs aren't exported to\n CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs in the\n \n Amazon EKS User Guide\n .
\nCloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.
\nCreates an Fargate profile for your Amazon EKS cluster. You must have at least one Fargate\n profile in a cluster to be able to run pods on Fargate.
\nThe Fargate profile allows an administrator to declare which pods run on Fargate and specify\n which pods run on which Fargate profile. This declaration is done through the profile’s\n selectors. Each profile can have up to five selectors that contain a namespace and\n labels. A namespace is required for every selector. The label field consists of multiple\n optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a\n to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is\n run on Fargate.
\nWhen you create a Fargate profile, you must specify a pod execution role to use with the\n pods that are scheduled with the profile. This role is added to the cluster's Kubernetes\n Role Based Access\n Control (RBAC) for authorization so that the kubelet that is\n running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can\n appear in your cluster as a node. The pod execution role also provides IAM permissions\n to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more\n information, see Pod Execution Role in the Amazon EKS User Guide.
Fargate profiles are immutable. However, you can create a new updated profile to replace\n an existing profile and then delete the original after the updated profile has finished\n creating.
\nIf any Fargate profiles in a cluster are in the DELETING status, you must\n wait for that Fargate profile to finish deleting before you can create any other profiles\n in that cluster.
For more information, see Fargate Profile in the Amazon EKS User Guide.
", + "smithy.api#documentation": "Creates an Fargate profile for your Amazon EKS cluster. You\n must have at least one Fargate profile in a cluster to be able to run\n pods on Fargate.
\nThe Fargate profile allows an administrator to declare which pods run\n on Fargate and specify which pods run on which Fargate\n profile. This declaration is done through the profile’s selectors. Each profile can have\n up to five selectors that contain a namespace and labels. A namespace is required for\n every selector. The label field consists of multiple optional key-value pairs. Pods that\n match the selectors are scheduled on Fargate. If a to-be-scheduled pod\n matches any of the selectors in the Fargate profile, then that pod is run\n on Fargate.
\nWhen you create a Fargate profile, you must specify a pod execution\n role to use with the pods that are scheduled with the profile. This role is added to the\n cluster's Kubernetes Role Based Access Control (RBAC) for authorization so that the\n kubelet that is running on the Fargate infrastructure\n can register with your Amazon EKS cluster so that it can appear in your cluster\n as a node. The pod execution role also provides IAM permissions to the\n Fargate infrastructure to allow read access to Amazon ECR\n image repositories. For more information, see Pod\n Execution Role in the Amazon EKS User Guide.
Fargate profiles are immutable. However, you can create a new updated\n profile to replace an existing profile and then delete the original after the updated\n profile has finished creating.
\nIf any Fargate profiles in a cluster are in the DELETING\n status, you must wait for that Fargate profile to finish deleting before\n you can create any other profiles in that cluster.
For more information, see Fargate Profile in the\n Amazon EKS User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/fargate-profiles", @@ -1264,7 +1264,7 @@ "clusterName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "The name of the Amazon EKS cluster to apply the Fargate profile to.
", + "smithy.api#documentation": "The name of the Amazon EKS cluster to apply the Fargate profile\n to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1272,20 +1272,20 @@ "podExecutionRoleArn": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in\n the Fargate profile. The pod execution role allows Fargate infrastructure to register with\n your cluster as a node, and it provides read access to Amazon ECR image repositories. For\n more information, see Pod Execution Role in the\n Amazon EKS User Guide.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in\n the Fargate profile. The pod execution role allows Fargate\n infrastructure to register with your cluster as a node, and it provides read access to\n Amazon ECR image repositories. For more information, see Pod\n Execution Role in the Amazon EKS User Guide.
", "smithy.api#required": {} } }, "subnets": { "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "The IDs of subnets to launch your pods into. At this time, pods running on Fargate are\n not assigned public IP addresses, so only private subnets (with no direct route to an\n Internet Gateway) are accepted for this parameter.
" + "smithy.api#documentation": "The IDs of subnets to launch your pods into. At this time, pods running on Fargate are not assigned public IP addresses, so only private subnets (with\n no direct route to an Internet Gateway) are accepted for this parameter.
" } }, "selectors": { "target": "com.amazonaws.eks#FargateProfileSelectors", "traits": { - "smithy.api#documentation": "The selectors to match for pods to use this Fargate profile. Each selector must have an\n associated namespace. Optionally, you can also specify labels for a namespace. You may\n specify up to five selectors in a Fargate profile.
" + "smithy.api#documentation": "The selectors to match for pods to use this Fargate profile. Each\n selector must have an associated namespace. Optionally, you can also specify labels for\n a namespace. You may specify up to five selectors in a Fargate\n profile.
" } }, "clientRequestToken": { @@ -1346,7 +1346,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a managed node group for an Amazon EKS cluster. You can only create a node group\n for your cluster that is equal to the current Kubernetes version for the cluster. All\n node groups are created with the latest AMI release version for the respective minor\n Kubernetes version of the cluster, unless you deploy a custom AMI using a launch\n template. For more information about using launch templates, see Launch\n template support.
\nAn Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that\n are managed by Amazon Web Services for an Amazon EKS cluster. Each node group uses a version of the Amazon EKS\n optimized Amazon Linux 2 AMI. For more information, see Managed\n Node Groups in the Amazon EKS User Guide.
", + "smithy.api#documentation": "Creates a managed node group for an Amazon EKS cluster. You can only create a\n node group for your cluster that is equal to the current Kubernetes version for the\n cluster. All node groups are created with the latest AMI release version for the\n respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using\n a launch template. For more information about using launch templates, see Launch\n template support.
\nAn Amazon EKS managed node group is an Amazon EC2\n Auto Scaling group and associated Amazon EC2 instances that are managed by\n Amazon Web Services for an Amazon EKS cluster. Each node group uses a version\n of the Amazon EKS optimized Amazon Linux 2 AMI. For more information, see Managed\n Node Groups in the Amazon EKS User Guide.
", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/node-groups", @@ -1400,7 +1400,7 @@ "amiType": { "target": "com.amazonaws.eks#AMITypes", "traits": { - "smithy.api#documentation": "The AMI type for your node group. GPU instance types should use the\n AL2_x86_64_GPU AMI type. Non-GPU instances should use the\n AL2_x86_64 AMI type. Arm instances should use the\n AL2_ARM_64 AMI type. All types use the Amazon EKS optimized Amazon Linux 2 AMI.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify amiType,\n or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
The AMI type for your node group. GPU instance types should use the\n AL2_x86_64_GPU AMI type. Non-GPU instances should use the\n AL2_x86_64 AMI type. Arm instances should use the\n AL2_ARM_64 AMI type. All types use the Amazon EKS optimized\n Amazon Linux 2 AMI. If you specify launchTemplate, and your launch template uses a custom AMI,\n then don't specify amiType, or the node group deployment\n will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker\n node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive\n permissions for these API calls through an IAM instance profile and associated\n policies. Before you can launch nodes and register them into a cluster, you must create\n an IAM role for those nodes to use when they are launched. For more information, see\n Amazon EKS node IAM role in the \n Amazon EKS User Guide\n .\n If you specify launchTemplate, then don't specify \n IamInstanceProfile\n in your launch template,\n or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The\n Amazon EKS worker node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls\n through an IAM instance profile and associated policies. Before you can\n launch nodes and register them into a cluster, you must create an IAM\n role for those nodes to use when they are launched. For more information, see Amazon EKS node IAM role in the\n \n Amazon EKS User Guide\n . If you specify launchTemplate, then don't specify \n \n IamInstanceProfile\n in your launch template,\n or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
The AMI version of the Amazon EKS optimized AMI to use with your node group. By default,\n the latest available AMI version for the node group's current Kubernetes version is\n used. For more information, see Amazon EKS\n optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide. If you specify launchTemplate,\n and your launch template uses a custom AMI, then don't specify releaseVersion, or the node group \n deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
The AMI version of the Amazon EKS optimized AMI to use with your node group.\n By default, the latest available AMI version for the node group's current Kubernetes\n version is used. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion,\n or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. If an IAM account is associated with the add-on, it is not removed.
", + "smithy.api#documentation": "Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. If an IAM\n account is associated with the add-on, it is not removed.
", "smithy.api#httpQuery": "preserve" } } @@ -1580,7 +1580,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the Amazon EKS cluster control plane.
\nIf you have active services in your cluster that are associated with a load balancer,\n you must delete those services before deleting the cluster so that the load balancers\n are deleted properly. Otherwise, you can have orphaned resources in your VPC that\n prevent you from being able to delete the VPC. For more information, see Deleting a\n Cluster in the Amazon EKS User Guide.
\nIf you have managed node groups or Fargate profiles attached to the cluster, you must\n delete them first. For more information, see DeleteNodegroup and DeleteFargateProfile.
", + "smithy.api#documentation": "Deletes the Amazon EKS cluster control plane.
\nIf you have active services in your cluster that are associated with a load balancer,\n you must delete those services before deleting the cluster so that the load balancers\n are deleted properly. Otherwise, you can have orphaned resources in your VPC that\n prevent you from being able to delete the VPC. For more information, see Deleting a\n Cluster in the Amazon EKS User Guide.
\nIf you have managed node groups or Fargate profiles attached to the\n cluster, you must delete them first. For more information, see DeleteNodegroup and DeleteFargateProfile.
", "smithy.api#http": { "method": "DELETE", "uri": "/clusters/{name}", @@ -1635,7 +1635,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an Fargate profile.
\nWhen you delete a Fargate profile, any pods running on Fargate that were created with the\n profile are deleted. If those pods match another Fargate profile, then they are scheduled\n on Fargate with that profile. If they no longer match any Fargate profiles, then they are not\n scheduled on Fargate and they may remain in a pending state.
\nOnly one Fargate profile in a cluster can be in the DELETING status at a\n time. You must wait for a Fargate profile to finish deleting before you can delete any\n other profiles in that cluster.
Deletes an Fargate profile.
\nWhen you delete a Fargate profile, any pods running on Fargate that were created with the profile are deleted. If those pods match\n another Fargate profile, then they are scheduled on Fargate with that profile. If they no longer match any Fargate profiles, then\n they are not scheduled on Fargate and they may remain in a pending\n state.
\nOnly one Fargate profile in a cluster can be in the\n DELETING status at a time. You must wait for a Fargate\n profile to finish deleting before you can delete any other profiles in that\n cluster.
The name of the Amazon EKS cluster associated with the Fargate profile to delete.
", + "smithy.api#documentation": "The name of the Amazon EKS cluster associated with the Fargate\n profile to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1718,7 +1718,7 @@ "clusterName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "The name of the Amazon EKS cluster that is associated with your node group.
", + "smithy.api#documentation": "The name of the Amazon EKS cluster that is associated with your node\n group.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1773,7 +1773,7 @@ } ], "traits": { - "smithy.api#documentation": "Deregisters a connected cluster to remove it from the Amazon EKS control plane.
", + "smithy.api#documentation": "Deregisters a connected cluster to remove it from the Amazon EKS control\n plane.
", "smithy.api#http": { "method": "DELETE", "uri": "/cluster-registrations/{name}", @@ -2235,7 +2235,7 @@ "clusterName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "The name of the Amazon EKS cluster associated with the Fargate profile.
", + "smithy.api#documentation": "The name of the Amazon EKS cluster associated with the Fargate\n profile.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2463,7 +2463,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns descriptive information about an update against your Amazon EKS cluster or\n associated managed node group.
\nWhen the status of the update is Succeeded, the update is complete. If an\n update fails, the status is Failed, and an error detail explains the reason\n for the failure.
Returns descriptive information about an update against your Amazon EKS\n cluster or associated managed node group.
\nWhen the status of the update is Succeeded, the update is complete. If an\n update fails, the status is Failed, and an error detail explains the reason\n for the failure.
Disassociates an identity provider configuration from a cluster. If you disassociate\n an identity provider from your cluster, users included in the provider can no longer\n access the cluster. However, you can still access the cluster with Amazon Web Services IAM\n users.
", + "smithy.api#documentation": "Disassociates an identity provider configuration from a cluster. If you disassociate\n an identity provider from your cluster, users included in the provider can no longer\n access the cluster. However, you can still access the cluster with Amazon Web Services\n IAM users.
", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/identity-provider-configs/disassociate", @@ -2601,7 +2601,7 @@ "provider": { "target": "com.amazonaws.eks#Provider", "traits": { - "smithy.api#documentation": "Key Management Service (KMS) key. Either the ARN or the alias can be used.
" + "smithy.api#documentation": "Key Management Service (KMS) key. Either the ARN or the alias can be\n used.
" } } }, @@ -2702,7 +2702,7 @@ "errorCode": { "target": "com.amazonaws.eks#ErrorCode", "traits": { - "smithy.api#documentation": "A brief description of the error.
\n\n SubnetNotFound: We couldn't find one of the\n subnets associated with the cluster.
\n\n SecurityGroupNotFound: We couldn't find one\n of the security groups associated with the cluster.
\n\n EniLimitReached: You have reached the elastic\n network interface limit for your account.
\n\n IpNotAvailable: A subnet associated with the\n cluster doesn't have any free IP addresses.
\n\n AccessDenied: You don't have permissions to\n perform the specified operation.
\n\n OperationNotPermitted: The service role\n associated with the cluster doesn't have the required access permissions for\n Amazon EKS.
\n\n VpcIdNotFound: We couldn't find the VPC\n associated with the cluster.
\nA brief description of the error.
\n\n SubnetNotFound: We couldn't find one of the\n subnets associated with the cluster.
\n\n SecurityGroupNotFound: We couldn't find one\n of the security groups associated with the cluster.
\n\n EniLimitReached: You have reached the elastic\n network interface limit for your account.
\n\n IpNotAvailable: A subnet associated with the\n cluster doesn't have any free IP addresses.
\n\n AccessDenied: You don't have permissions to\n perform the specified operation.
\n\n OperationNotPermitted: The service role\n associated with the cluster doesn't have the required access permissions for\n Amazon EKS.
\n\n VpcIdNotFound: We couldn't find the VPC\n associated with the cluster.
\nThe name of the Amazon EKS cluster that the Fargate profile belongs to.
" + "smithy.api#documentation": "The name of the Amazon EKS cluster that the Fargate profile\n belongs to.
" } }, "createdAt": { "target": "com.amazonaws.eks#Timestamp", "traits": { - "smithy.api#documentation": "The Unix epoch timestamp in seconds for when the Fargate profile was created.
" + "smithy.api#documentation": "The Unix epoch timestamp in seconds for when the Fargate profile was\n created.
" } }, "podExecutionRoleArn": { @@ -2986,13 +2986,28 @@ "smithy.api#httpError": 400 } }, + "com.amazonaws.eks#IpFamily": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ipv4", + "name": "IPV4" + }, + { + "value": "ipv6", + "name": "IPV6" + } + ] + } + }, "com.amazonaws.eks#Issue": { "type": "structure", "members": { "code": { "target": "com.amazonaws.eks#NodegroupIssueCode", "traits": { - "smithy.api#documentation": "A brief description of the error.
\n\n AccessDenied: Amazon EKS or one or more of your\n managed nodes is failing to authenticate or authorize with your Kubernetes\n cluster API server.
\n\n AsgInstanceLaunchFailures: Your Auto Scaling group is\n experiencing failures while attempting to launch instances.
\n\n AutoScalingGroupNotFound: We couldn't find\n the Auto Scaling group associated with the managed node group. You may be able to\n recreate an Auto Scaling group with the same settings to recover.
\n\n ClusterUnreachable: Amazon EKS or one or more of\n your managed nodes is unable to to communicate with your Kubernetes cluster API\n server. This can happen if there are network disruptions or if API servers are\n timing out processing requests.
\n\n Ec2LaunchTemplateNotFound: We couldn't find\n the Amazon EC2 launch template for your managed node group. You may be able to\n recreate a launch template with the same settings to recover.
\n\n Ec2LaunchTemplateVersionMismatch: The Amazon EC2\n launch template version for your managed node group does not match the version\n that Amazon EKS created. You may be able to revert to the version that Amazon EKS created\n to recover.
\n\n Ec2SecurityGroupDeletionFailure: We could not\n delete the remote access security group for your managed node group. Remove any\n dependencies from the security group.
\n\n Ec2SecurityGroupNotFound: We couldn't find\n the cluster security group for the cluster. You must recreate your\n cluster.
\n\n Ec2SubnetInvalidConfiguration: One or more\n Amazon EC2 subnets specified for a node group do not automatically assign public IP\n addresses to instances launched into it. If you want your instances to be\n assigned a public IP address, then you need to enable the auto-assign\n public IP address setting for the subnet. See Modifying\n the public IPv4 addressing attribute for your subnet in the Amazon\n VPC User Guide.
\n IamInstanceProfileNotFound: We couldn't find\n the IAM instance profile for your managed node group. You may be able to\n recreate an instance profile with the same settings to recover.
\n\n IamNodeRoleNotFound: We couldn't find the\n IAM role for your managed node group. You may be able to recreate an IAM role\n with the same settings to recover.
\n\n InstanceLimitExceeded: Your Amazon Web Services account is\n unable to launch any more instances of the specified instance type. You may be\n able to request an Amazon EC2 instance limit increase to recover.
\n\n InsufficientFreeAddresses: One or more of the\n subnets associated with your managed node group does not have enough available\n IP addresses for new nodes.
\n\n InternalFailure: These errors are usually\n caused by an Amazon EKS server-side issue.
\n\n NodeCreationFailure: Your launched instances\n are unable to register with your Amazon EKS cluster. Common causes of this failure\n are insufficient node IAM role\n permissions or lack of outbound internet access for the nodes.
\nA brief description of the error.
\n\n AccessDenied: Amazon EKS or one or\n more of your managed nodes is failing to authenticate or authorize with your\n Kubernetes cluster API server.
\n\n AsgInstanceLaunchFailures: Your Auto Scaling group is experiencing failures while attempting to launch\n instances.
\n\n AutoScalingGroupNotFound: We couldn't find\n the Auto Scaling group associated with the managed node group. You may be\n able to recreate an Auto Scaling group with the same settings to\n recover.
\n\n ClusterUnreachable: Amazon EKS or one\n or more of your managed nodes is unable to to communicate with your Kubernetes\n cluster API server. This can happen if there are network disruptions or if API\n servers are timing out processing requests.
\n\n Ec2LaunchTemplateNotFound: We couldn't find\n the Amazon EC2 launch template for your managed node group. You may be\n able to recreate a launch template with the same settings to recover.
\n\n Ec2LaunchTemplateVersionMismatch: The Amazon EC2 launch template version for your managed node group does not\n match the version that Amazon EKS created. You may be able to revert to\n the version that Amazon EKS created to recover.
\n\n Ec2SecurityGroupDeletionFailure: We could not\n delete the remote access security group for your managed node group. Remove any\n dependencies from the security group.
\n\n Ec2SecurityGroupNotFound: We couldn't find\n the cluster security group for the cluster. You must recreate your\n cluster.
\n\n Ec2SubnetInvalidConfiguration: One or more\n Amazon EC2 subnets specified for a node group do not automatically\n assign public IP addresses to instances launched into it. If you want your\n instances to be assigned a public IP address, then you need to enable the\n auto-assign public IP address setting for the subnet. See\n Modifying\n the public IPv4 addressing attribute for your subnet in the Amazon\n VPC User Guide.
\n IamInstanceProfileNotFound: We couldn't find\n the IAM instance profile for your managed node group. You may be\n able to recreate an instance profile with the same settings to recover.
\n\n IamNodeRoleNotFound: We couldn't find the\n IAM role for your managed node group. You may be able to\n recreate an IAM role with the same settings to recover.
\n\n InstanceLimitExceeded: Your Amazon Web Services account is unable to launch any more instances of the specified instance\n type. You may be able to request an Amazon EC2 instance limit increase\n to recover.
\n\n InsufficientFreeAddresses: One or more of the\n subnets associated with your managed node group does not have enough available\n IP addresses for new nodes.
\n\n InternalFailure: These errors are usually\n caused by an Amazon EKS server-side issue.
\n\n NodeCreationFailure: Your launched instances\n are unable to register with your Amazon EKS cluster. Common causes of this failure\n are insufficient node IAM role\n permissions or lack of outbound internet access for the nodes.
\nThe CIDR block to assign Kubernetes service IP addresses from. If you don't specify a\n block, Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR\n blocks. We recommend that you specify a block that does not overlap with resources in\n other networks that are peered or connected to your VPC. The block must meet the\n following requirements:
\nWithin one of the following private IP address blocks: 10.0.0.0/8,\n 172.16.0.0/12, or 192.168.0.0/16.
\nDoesn't overlap with any CIDR block assigned to the VPC that you selected for\n VPC.
\nBetween /24 and /12.
\nYou can only specify a custom CIDR block when you create a cluster and can't\n change this value once the cluster is created.
\nDon't specify a value if you select ipv6 for ipFamily. The CIDR block to assign Kubernetes service IP addresses from.\n If you don't specify a block, Kubernetes assigns addresses from either the 10.100.0.0/16\n or 172.20.0.0/16 CIDR blocks. We recommend that you specify a block that does not\n overlap with resources in other networks that are peered or connected to your VPC. The\n block must meet the following requirements:
Within one of the following private IP address blocks: 10.0.0.0/8,\n 172.16.0.0/12, or 192.168.0.0/16.
\nDoesn't overlap with any CIDR block assigned to the VPC that you selected for\n VPC.
\nBetween /24 and /12.
\nYou can only specify a custom CIDR block when you create a cluster and can't\n change this value once the cluster is created.
\nSpecify which IP version is used to assign Kubernetes Pod and Service IP addresses. If\n you don't specify a value, ipv4 is used by default. You can only specify an\n IP family when you create a cluster and can't change this value once the cluster is\n created. If you specify ipv6, the VPC and subnets that you specify for\n cluster creation must have both IPv4 and IPv6 CIDR blocks assigned to them.
You can only specify ipv6 for 1.21 and later clusters that use version\n 1.10.0 or later of the Amazon VPC CNI add-on. If you specify ipv6, then ensure\n that your VPC meets the requirements and that you're familiar with the considerations\n listed in Assigning\n IPv6 addresses to Pods and Services in the Amazon EKS User Guide. If\n you specify ipv6, Kubernetes assigns Service and Pod addresses from the\n unique local address range (fc00::/7). You can't specify a custom IPv6 CIDR\n block.
The CIDR block that Kubernetes service IP addresses are assigned from. If you didn't\n specify a CIDR block when you created the cluster, then Kubernetes assigns addresses\n from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this was specified, then\n it was specified when the cluster was created and it cannot be changed.
" + "smithy.api#documentation": "The CIDR block that Kubernetes Pod and Service IP addresses are assigned from.\n Kubernetes assigns addresses from an IPv4 CIDR block assigned to a subnet that the node\n is in. If you didn't specify a CIDR block when you created the cluster, then Kubernetes\n assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks. If this\n was specified, then it was specified when the cluster was created and it can't be\n changed.
" + } + }, + "serviceIpv6Cidr": { + "target": "com.amazonaws.eks#String", + "traits": { + "smithy.api#documentation": "The CIDR block that Kubernetes Pod and Service IP addresses are assigned from if you\n created a 1.21 or later cluster with version 1.10.0 or later of the Amazon VPC CNI add-on and\n specified ipv6 for ipFamily when you\n created the cluster. Kubernetes assigns addresses from the unique local address range\n (fc00::/7).
The IP family used to assign Kubernetes Pod and Service IP addresses. The IP family is\n always ipv4, unless you have a 1.21 or later cluster running\n version 1.10.0 or later of the Amazon VPC CNI add-on and specified ipv6 when you\n created the cluster.
The Kubernetes network configuration for the cluster.
" + "smithy.api#documentation": "The Kubernetes network configuration for the cluster. The response contains a value\n for serviceIpv6Cidr or serviceIpv4Cidr, but not both.
" } }, "com.amazonaws.eks#LaunchTemplateSpecification": { @@ -3069,7 +3102,7 @@ } }, "traits": { - "smithy.api#documentation": "An object representing a node group launch template specification. The launch template\n cannot include \n SubnetId\n , \n IamInstanceProfile\n , \n RequestSpotInstances\n , \n HibernationOptions\n , or \n TerminateInstances\n , or the node group deployment or\n update will fail. For more information about launch templates, see \n CreateLaunchTemplate\n in the Amazon EC2 API Reference.\n For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
Specify either name or id, but not both.
An object representing a node group launch template specification. The launch template\n cannot include \n SubnetId\n , \n IamInstanceProfile\n , \n RequestSpotInstances\n , \n HibernationOptions\n , or \n TerminateInstances\n , or the node group deployment or\n update will fail. For more information about launch templates, see \n CreateLaunchTemplate\n in the Amazon EC2 API\n Reference. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
Specify either name or id, but not both.
Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region.
", + "smithy.api#documentation": "Lists the Amazon EKS clusters in your Amazon Web Services account in the\n specified Region.
", "smithy.api#http": { "method": "GET", "uri": "/clusters", @@ -3279,7 +3312,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services\n account in the specified Region.
", + "smithy.api#documentation": "Lists the Fargate profiles associated with the specified cluster in\n your Amazon Web Services account in the specified Region.
", "smithy.api#http": { "method": "GET", "uri": "/clusters/{clusterName}/fargate-profiles", @@ -3326,7 +3359,7 @@ "fargateProfileNames": { "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "A list of all of the Fargate profiles associated with the specified cluster.
" + "smithy.api#documentation": "A list of all of the Fargate profiles associated with the specified\n cluster.
" } }, "nextToken": { @@ -3457,7 +3490,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the Amazon EKS managed node groups associated with the specified cluster in your\n Amazon Web Services account in the specified Region. Self-managed node groups are not listed.
", + "smithy.api#documentation": "Lists the Amazon EKS managed node groups associated with the specified cluster\n in your Amazon Web Services account in the specified Region. Self-managed node groups are\n not listed.
", "smithy.api#http": { "method": "GET", "uri": "/clusters/{clusterName}/node-groups", @@ -3477,7 +3510,7 @@ "clusterName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "The name of the Amazon EKS cluster that you would like to list node groups in.
", + "smithy.api#documentation": "The name of the Amazon EKS cluster that you would like to list node groups\n in.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3597,7 +3630,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services\n account, in the specified Region.
", + "smithy.api#documentation": "Lists the updates associated with an Amazon EKS cluster or managed node group\n in your Amazon Web Services account, in the specified Region.
", "smithy.api#http": { "method": "GET", "uri": "/clusters/{name}/updates", @@ -3691,7 +3724,7 @@ "enabled": { "target": "com.amazonaws.eks#BoxedBoolean", "traits": { - "smithy.api#documentation": "If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a\n log type isn't enabled, that log type doesn't export its control plane logs. Each\n individual log type can be enabled or disabled independently.
" + "smithy.api#documentation": "If a log type is enabled, that log type exports its control plane logs to CloudWatch Logs. If a log type isn't enabled, that log type doesn't export its control\n plane logs. Each individual log type can be enabled or disabled independently.
" } } }, @@ -3782,7 +3815,7 @@ "releaseVersion": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "If the node group was deployed using a launch template with a custom AMI, then this is\n the AMI ID that was specified in the launch template. For node groups that weren't\n deployed using a launch template, this is the version of the Amazon EKS optimized AMI that\n the node group was deployed with.
" + "smithy.api#documentation": "If the node group was deployed using a launch template with a custom AMI, then this is\n the AMI ID that was specified in the launch template. For node groups that weren't\n deployed using a launch template, this is the version of the Amazon EKS\n optimized AMI that the node group was deployed with.
" } }, "createdAt": { @@ -3842,19 +3875,19 @@ "nodeRole": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "The IAM role associated with your node group. The Amazon EKS node kubelet\n daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API\n calls through an IAM instance profile and associated policies.
The IAM role associated with your node group. The Amazon EKS\n node kubelet daemon makes calls to Amazon Web Services APIs on your behalf.\n Nodes receive permissions for these API calls through an IAM instance\n profile and associated policies.
The Kubernetes labels applied to the nodes in the node group.
\nOnly labels that are applied with the Amazon EKS API are shown here. There may be other\n Kubernetes labels applied to the nodes in this group.
\nThe Kubernetes labels applied to the nodes in the node group.
\nOnly labels that are applied with the Amazon EKS API are shown here. There\n may be other Kubernetes labels applied to the nodes in this group.
\nThe Kubernetes taints to be applied to the nodes in the node group when they are\n created. Effect is one of No_Schedule, Prefer_No_Schedule, or No_Execute. Kubernetes taints\n can be used together with tolerations to control how workloads are scheduled to your\n nodes.
The Kubernetes taints to be applied to the nodes in the node group when they are\n created. Effect is one of No_Schedule, Prefer_No_Schedule, or\n No_Execute. Kubernetes taints can be used together with tolerations to\n control how workloads are scheduled to your nodes.
The maximum number of nodes that the managed node group can scale out to. For\n information about the maximum number that you can specify, see Amazon EKS service\n quotas in the Amazon EKS User Guide.
" + "smithy.api#documentation": "The maximum number of nodes that the managed node group can scale out to. For\n information about the maximum number that you can specify, see Amazon EKS service quotas in the Amazon EKS User Guide.
" } }, "desiredSize": { "target": "com.amazonaws.eks#ZeroCapacity", "traits": { - "smithy.api#documentation": "The current number of nodes that the managed node group should maintain.
\nIf you use Cluster Autoscaler, you shouldn't change the desiredSize value\n directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale\n down.
\nWhenever this parameter changes, the number of worker nodes in the node group is\n updated to the specified size. If this parameter is given a value that is smaller than\n the current number of running worker nodes, the necessary number of worker nodes are\n terminated to match the given value.\n \n When using CloudFormation, no action occurs if you remove this parameter from your CFN\n template.
\nThis parameter can be different from minSize in some cases, such as when starting with\n extra hosts for testing. This parameter can also be different when you want to start\n with an estimated number of needed hosts, but let Cluster Autoscaler reduce the number\n if there are too many. When Cluster Autoscaler is used, the desiredSize parameter is\n altered by Cluster Autoscaler (but can be out-of-date for short periods of time).\n Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than\n maxSize.
" + "smithy.api#documentation": "The current number of nodes that the managed node group should maintain.
\nIf you use Cluster Autoscaler, you shouldn't change the desiredSize value\n directly, as this can cause the Cluster Autoscaler to suddenly scale up or scale\n down.
\nWhenever this parameter changes, the number of worker nodes in the node group is\n updated to the specified size. If this parameter is given a value that is smaller than\n the current number of running worker nodes, the necessary number of worker nodes are\n terminated to match the given value.\n \n When using CloudFormation, no action occurs if you remove this parameter from your CFN\n template.
\nThis parameter can be different from minSize in some cases, such as when starting with\n extra hosts for testing. This parameter can also be different when you want to start\n with an estimated number of needed hosts, but let Cluster Autoscaler reduce the number\n if there are too many. When Cluster Autoscaler is used, the desiredSize parameter is\n altered by Cluster Autoscaler (but can be out-of-date for short periods of time).\n Cluster Autoscaler doesn't scale a managed node group lower than minSize or higher than\n maxSize.
" } } }, @@ -4078,13 +4111,13 @@ "maxUnavailable": { "target": "com.amazonaws.eks#NonZeroInteger", "traits": { - "smithy.api#documentation": "The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. \n This value or maxUnavailablePercentage is required to have a value.The maximum number\n is 100.
The maximum number of nodes unavailable at once during a version update. Nodes will be\n updated in parallel. This value or maxUnavailablePercentage is required to\n have a value.The maximum number is 100.
The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be\n updated in parallel, up to 100 nodes at once. This value or maxUnavailable is required to have a value.
The maximum percentage of nodes unavailable during a version update. This percentage\n of nodes will be updated in parallel, up to 100 nodes at once. This value or\n maxUnavailable is required to have a value.
The key value pairs that describe required claims in the identity token. If set, each\n claim is verified to be present in the token with a matching value. For the maximum\n number of claims that you can require, see Amazon EKS service quotas in the\n Amazon EKS User Guide.
" + "smithy.api#documentation": "The key value pairs that describe required claims in the identity token. If set, each\n claim is verified to be present in the token with a matching value. For the maximum\n number of claims that you can require, see Amazon EKS service\n quotas in the Amazon EKS User Guide.
" } } }, @@ -4283,12 +4316,12 @@ "keyArn": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same\n region as the cluster, and if the KMS key was created in a different account, the user\n must have access to the KMS key. For more information, see Allowing\n Users in Other Accounts to Use a KMS key in the Key Management Service\n Developer Guide.
" + "smithy.api#documentation": "Amazon Resource Name (ARN) or alias of the KMS key. The KMS key must be symmetric, created in the same\n region as the cluster, and if the KMS key was created in a different account, the user\n must have access to the KMS key. For more information, see Allowing\n Users in Other Accounts to Use a KMS key in the Key Management Service Developer Guide.
" } } }, "traits": { - "smithy.api#documentation": "Identifies the Key Management Service (KMS) key used to encrypt the secrets.
" + "smithy.api#documentation": "Identifies the Key Management Service (KMS) key used to encrypt the\n secrets.
" } }, "com.amazonaws.eks#RegisterCluster": { @@ -4326,7 +4359,7 @@ } ], "traits": { - "smithy.api#documentation": "Connects a Kubernetes cluster to the Amazon EKS control plane.
\nAny Kubernetes cluster can be connected to the Amazon EKS control plane to view current information about the cluster and its nodes.\n
\nCluster connection requires two steps. First, send a \n RegisterClusterRequest\n to add it to the Amazon EKS control plane.
Second, a Manifest containing the activationID and activationCode must be applied to the Kubernetes cluster through it's native provider to provide visibility.
After the Manifest is updated and applied, then the connected cluster is visible to the Amazon EKS control plane. If the Manifest is not applied within three days, \n then the connected cluster will no longer be visible and must be deregistered. See DeregisterCluster.
", + "smithy.api#documentation": "Connects a Kubernetes cluster to the Amazon EKS control plane.
\nAny Kubernetes cluster can be connected to the Amazon EKS control plane to\n view current information about the cluster and its nodes.
\nCluster connection requires two steps. First, send a \n RegisterClusterRequest\n to add it to the Amazon EKS\n control plane.
Second, a Manifest containing the activationID and\n activationCode must be applied to the Kubernetes cluster through it's\n native provider to provide visibility.
After the Manifest is updated and applied, then the connected cluster is visible to\n the Amazon EKS control plane. If the Manifest is not applied within three days,\n then the connected cluster will no longer be visible and must be deregistered. See DeregisterCluster.
", "smithy.api#http": { "method": "POST", "uri": "/cluster-registrations", @@ -4354,7 +4387,7 @@ "clientRequestToken": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request.
", "smithy.api#idempotencyToken": {} } }, @@ -4380,13 +4413,13 @@ "ec2SshKey": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "The Amazon EC2 SSH key that provides access for SSH communication with the nodes in the\n managed node group. For more information, see Amazon EC2 key\n pairs and Linux instances in the Amazon Elastic Compute Cloud User Guide for Linux Instances.
" + "smithy.api#documentation": "The Amazon EC2 SSH key that provides access for SSH communication with the\n nodes in the managed node group. For more information, see Amazon EC2 key pairs and Linux instances in the Amazon Elastic Compute Cloud User Guide for Linux Instances.
" } }, "sourceSecurityGroups": { "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "The security groups that are allowed SSH access (port 22) to the nodes. If you specify\n an Amazon EC2 SSH key but do not specify a source security group when you create a managed\n node group, then port 22 on the nodes is opened to the internet (0.0.0.0/0). For more\n information, see Security Groups for Your VPC in the\n Amazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "The security groups that are allowed SSH access (port 22) to the nodes. If you specify\n an Amazon EC2 SSH key but do not specify a source security group when you create\n a managed node group, then port 22 on the nodes is opened to the internet (0.0.0.0/0).\n For more information, see Security Groups for Your VPC in the\n Amazon Virtual Private Cloud User Guide.
" } } }, @@ -4621,7 +4654,7 @@ } ], "traits": { - "smithy.api#documentation": "Associates the specified tags to a resource with the specified\n resourceArn. If existing tags on a resource are not specified in the\n request parameters, they are not changed. When a resource is deleted, the tags\n associated with that resource are deleted as well. Tags that you create for Amazon EKS\n resources do not propagate to any other resources associated with the cluster. For\n example, if you tag a cluster with this operation, that tag does not automatically\n propagate to the subnets and nodes associated with the cluster.
Associates the specified tags to a resource with the specified\n resourceArn. If existing tags on a resource are not specified in the\n request parameters, they are not changed. When a resource is deleted, the tags\n 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\n cluster. For example, if you tag a cluster with this operation, that tag does not\n automatically propagate to the subnets and nodes associated with the cluster.
At least one of your specified cluster subnets is in an Availability Zone that does\n not support Amazon EKS. The exception output specifies the supported Availability Zones for\n your account, from which you can choose subnets for your cluster.
", + "smithy.api#documentation": "At least one of your specified cluster subnets is in an Availability Zone that does\n not support Amazon EKS. The exception output specifies the supported\n Availability Zones for your account, from which you can choose subnets for your\n cluster.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -4955,7 +4988,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an Amazon EKS cluster configuration. Your cluster continues to function during the\n update. The response output includes an update ID that you can use to track the status\n of your cluster update with the DescribeUpdate API operation.
\nYou can use this API operation to enable or disable exporting the Kubernetes control\n plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't\n exported to CloudWatch Logs. For more information, see Amazon EKS\n Cluster Control Plane Logs in the\n \n Amazon EKS User Guide\n .
\nCloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported\n control plane logs. For more information, see CloudWatch Pricing.
\nYou can also use this API operation to enable or disable public and private access to\n your cluster's Kubernetes API server endpoint. By default, public access is enabled, and\n private access is disabled. For more information, see Amazon EKS cluster\n endpoint access control in the \n Amazon EKS User Guide\n .
\nYou can't update the subnets or security group IDs for an existing cluster.
\nCluster updates are asynchronous, and they should finish within a few minutes. During\n an update, the cluster status moves to UPDATING (this status transition is\n eventually consistent). When the update is complete (either Failed or\n Successful), the cluster status moves to Active.
Updates an Amazon EKS cluster configuration. Your cluster continues to\n function during the update. The response output includes an update ID that you can use\n to track the status of your cluster update with the DescribeUpdate API\n operation.
\nYou can use this API operation to enable or disable exporting the Kubernetes control\n plane logs for your cluster to CloudWatch Logs. By default, cluster control plane\n logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the\n \n Amazon EKS User Guide\n .
\nCloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.
\nYou can also use this API operation to enable or disable public and private access to\n your cluster's Kubernetes API server endpoint. By default, public access is enabled, and\n private access is disabled. For more information, see Amazon EKS cluster endpoint access control in the\n \n Amazon EKS User Guide\n .
\nYou can't update the subnets or security group IDs for an existing cluster.
\nCluster updates are asynchronous, and they should finish within a few minutes. During\n an update, the cluster status moves to UPDATING (this status transition is\n eventually consistent). When the update is complete (either Failed or\n Successful), the cluster status moves to Active.
Enable or disable exporting the Kubernetes control plane logs for your cluster to\n CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more\n information, see Amazon EKS cluster control plane logs in the\n \n Amazon EKS User Guide\n .
\nCloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported\n control plane logs. For more information, see CloudWatch Pricing.
\nEnable or disable exporting the Kubernetes control plane logs for your cluster to\n CloudWatch Logs. By default, cluster control plane logs aren't exported to\n CloudWatch Logs. For more information, see Amazon EKS cluster control plane logs in the\n \n Amazon EKS User Guide\n .
\nCloudWatch Logs ingestion, archive storage, and data scanning rates apply to\n exported control plane logs. For more information, see CloudWatch\n Pricing.
\nUpdates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues\n to function during the update. The response output includes an update ID that you can\n use to track the status of your cluster update with the DescribeUpdate\n API operation.
\nCluster updates are asynchronous, and they should finish within a few minutes. During\n an update, the cluster status moves to UPDATING (this status transition is\n eventually consistent). When the update is complete (either Failed or\n Successful), the cluster status moves to Active.
If your cluster has managed node groups attached to it, all of your node groups’\n Kubernetes versions must match the cluster’s Kubernetes version in order to update the\n cluster to a new Kubernetes version.
", + "smithy.api#documentation": "Updates an Amazon EKS cluster to the specified Kubernetes version. Your\n cluster continues to function during the update. The response output includes an update\n ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.
\nCluster updates are asynchronous, and they should finish within a few minutes. During\n an update, the cluster status moves to UPDATING (this status transition is\n eventually consistent). When the update is complete (either Failed or\n Successful), the cluster status moves to Active.
If your cluster has managed node groups attached to it, all of your node groups’\n Kubernetes versions must match the cluster’s Kubernetes version in order to update the\n cluster to a new Kubernetes version.
", "smithy.api#http": { "method": "POST", "uri": "/clusters/{name}/updates", @@ -5124,7 +5157,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an Amazon EKS managed node group configuration. Your node group continues to\n function during the update. The response output includes an update ID that you can use\n to track the status of your node group update with the DescribeUpdate\n API operation. Currently you can update the Kubernetes labels for a node group or the\n scaling configuration.
", + "smithy.api#documentation": "Updates an Amazon EKS managed node group configuration. Your node group\n continues to function during the update. The response output includes an update ID that\n you can use to track the status of your node group update with the DescribeUpdate API operation. Currently you can update the Kubernetes\n labels for a node group or the scaling configuration.
", "smithy.api#http": { "method": "POST", "uri": "/clusters/{clusterName}/node-groups/{nodegroupName}/update-config", @@ -5138,7 +5171,7 @@ "clusterName": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "The name of the Amazon EKS cluster that the managed node group resides in.
", + "smithy.api#documentation": "The name of the Amazon EKS cluster that the managed node group resides\n in.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5221,7 +5254,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the Kubernetes version or AMI version of an Amazon EKS managed node group.
\nYou can update a node group using a launch template only if the node group was\n originally deployed with a launch template. If you need to update a custom AMI in a node\n group that was deployed with a launch template, then update your custom AMI, specify the\n new ID in a new version of the launch template, and then update the node group to the\n new version of the launch template.
\nIf you update without a launch template, then you can update to the latest available\n AMI version of a node group's current Kubernetes version by not specifying a Kubernetes\n version in the request. You can update to the latest AMI version of your cluster's\n current Kubernetes version by specifying your cluster's Kubernetes version in the\n request. For more information, see Amazon EKS\n optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.
\nYou cannot roll back a node group to an earlier Kubernetes version or AMI\n version.
\nWhen a node in a managed node group is terminated due to a scaling action or update,\n the pods in that node are drained first. Amazon EKS attempts to drain the nodes gracefully\n and will fail if it is unable to do so. You can force the update if Amazon EKS\n is unable to drain the nodes as a result of a pod disruption budget issue.
Updates the Kubernetes version or AMI version of an Amazon EKS managed node\n group.
\nYou can update a node group using a launch template only if the node group was\n originally deployed with a launch template. If you need to update a custom AMI in a node\n group that was deployed with a launch template, then update your custom AMI, specify the\n new ID in a new version of the launch template, and then update the node group to the\n new version of the launch template.
\nIf you update without a launch template, then you can update to the latest available\n AMI version of a node group's current Kubernetes version by not specifying a Kubernetes\n version in the request. You can update to the latest AMI version of your cluster's\n current Kubernetes version by specifying your cluster's Kubernetes version in the\n request. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.
\nYou cannot roll back a node group to an earlier Kubernetes version or AMI\n version.
\nWhen a node in a managed node group is terminated due to a scaling action or update,\n the pods in that node are drained first. Amazon EKS attempts to drain the nodes\n gracefully and will fail if it is unable to do so. You can force the update\n if Amazon EKS is unable to drain the nodes as a result of a pod disruption\n budget issue.
The name of the Amazon EKS cluster that is associated with the managed node group to\n update.
", + "smithy.api#documentation": "The name of the Amazon EKS cluster that is associated with the managed node\n group to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5257,7 +5290,7 @@ "releaseVersion": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "The AMI version of the Amazon EKS optimized AMI to use for the update. By default, the\n latest available AMI version for the node group's Kubernetes version is used. For more\n information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the\n Amazon EKS User Guide. If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify \n releaseVersion, or the node group update will fail.\n For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
The AMI version of the Amazon EKS optimized AMI to use for the update. By\n default, the latest available AMI version for the node group's Kubernetes version is\n used. For more information, see Amazon EKS optimized Amazon Linux 2 AMI versions in the Amazon EKS User Guide.\n If you specify launchTemplate, and your launch template uses a custom AMI, then don't specify releaseVersion,\n or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.
Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network\n interfaces in these subnets to allow communication between your nodes and the Kubernetes\n control plane.
" + "smithy.api#documentation": "Specify subnets for your Amazon EKS nodes. Amazon EKS creates\n cross-account elastic network interfaces in these subnets to allow communication between\n your nodes and the Kubernetes control plane.
" } }, "securityGroupIds": { "target": "com.amazonaws.eks#StringList", "traits": { - "smithy.api#documentation": "Specify one or more security groups for the cross-account elastic network interfaces\n that Amazon EKS creates to use that allow communication between your nodes and the Kubernetes\n control plane. If you don't specify any security groups, then familiarize yourself with\n the difference between Amazon EKS defaults for clusters deployed with Kubernetes:
\n1.14 Amazon EKS platform version eks.2 and earlier
1.14 Amazon EKS platform version eks.3 and later
For more information, see Amazon EKS security group\n considerations in the \n Amazon EKS User Guide\n .
" + "smithy.api#documentation": "Specify one or more security groups for the cross-account elastic network interfaces\n that Amazon EKS creates to use that allow communication between your nodes and\n the Kubernetes control plane. If you don't specify any security groups, then familiarize\n yourself with the difference between Amazon EKS defaults for clusters deployed\n with Kubernetes:
\n1.14 Amazon EKS platform version eks.2 and earlier
1.14 Amazon EKS platform version eks.3 and later
For more information, see Amazon EKS security group\n considerations in the \n Amazon EKS User Guide\n .
" } }, "endpointPublicAccess": { "target": "com.amazonaws.eks#BoxedBoolean", "traits": { - "smithy.api#documentation": "Set this value to false to disable public access to your cluster's\n Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes\n API server can only receive requests from within the cluster VPC. The default value for\n this parameter is true, which enables public access for your Kubernetes API\n server. For more information, see Amazon EKS cluster\n endpoint access control in the \n Amazon EKS User Guide\n .
Set this value to false to disable public access to your cluster's\n Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes\n API server can only receive requests from within the cluster VPC. The default value for\n this parameter is true, which enables public access for your Kubernetes API\n server. For more information, see Amazon EKS cluster endpoint access control in the\n \n Amazon EKS User Guide\n .
Set this value to true to enable private access for your cluster's\n Kubernetes API server endpoint. If you enable private access, Kubernetes API requests\n from within your cluster's VPC use the private VPC endpoint. The default value for this\n parameter is false, which disables private access for your Kubernetes API\n server. If you disable private access and you have nodes or Fargate pods in the\n cluster, then ensure that publicAccessCidrs includes the necessary CIDR\n blocks for communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster\n endpoint access control in the \n Amazon EKS User Guide\n .
Set this value to true to enable private access for your cluster's\n Kubernetes API server endpoint. If you enable private access, Kubernetes API requests\n from within your cluster's VPC use the private VPC endpoint. The default value for this\n parameter is false, which disables private access for your Kubernetes API\n server. If you disable private access and you have nodes or Fargate\n pods in the cluster, then ensure that publicAccessCidrs includes the\n necessary CIDR blocks for communication with the nodes or Fargate pods.\n For more information, see Amazon EKS cluster endpoint access control in\n the \n Amazon EKS User Guide\n .
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server\n endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that\n you specify is denied. The default value is 0.0.0.0/0. If you've disabled\n private endpoint access and you have nodes or Fargate pods in the cluster, then ensure\n that you specify the necessary CIDR blocks. For more information, see Amazon EKS cluster\n endpoint access control in the \n Amazon EKS User Guide\n .
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server\n endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that\n you specify is denied. The default value is 0.0.0.0/0. If you've disabled\n private endpoint access and you have nodes or Fargate pods in the\n cluster, then ensure that you specify the necessary CIDR blocks. For more information,\n see Amazon EKS cluster endpoint access control in the\n \n Amazon EKS User Guide\n .
An object representing the VPC configuration to use for an Amazon EKS cluster.
" + "smithy.api#documentation": "An object representing the VPC configuration to use for an Amazon EKS\n cluster.
" } }, "com.amazonaws.eks#VpcConfigResponse": { @@ -5552,7 +5585,7 @@ "clusterSecurityGroupId": { "target": "com.amazonaws.eks#String", "traits": { - "smithy.api#documentation": "The cluster security group that was created by Amazon EKS for the cluster. Managed node\n groups use this security group for control-plane-to-data-plane communication.
" + "smithy.api#documentation": "The cluster security group that was created by Amazon EKS for the cluster.\n Managed node groups use this security group for control-plane-to-data-plane\n communication.
" } }, "vpcId": { @@ -5564,24 +5597,24 @@ "endpointPublicAccess": { "target": "com.amazonaws.eks#Boolean", "traits": { - "smithy.api#documentation": "This parameter indicates whether the Amazon EKS public API server endpoint is enabled. If\n the Amazon EKS public API server endpoint is disabled, your cluster's Kubernetes API server\n can only receive requests that originate from within the cluster VPC.
" + "smithy.api#documentation": "This parameter indicates whether the Amazon EKS public API server endpoint is\n enabled. If the Amazon EKS public API server endpoint is disabled, your\n cluster's Kubernetes API server can only receive requests that originate from within the\n cluster VPC.
" } }, "endpointPrivateAccess": { "target": "com.amazonaws.eks#Boolean", "traits": { - "smithy.api#documentation": "This parameter indicates whether the Amazon EKS private API server endpoint is enabled. If\n the Amazon EKS private API server endpoint is enabled, Kubernetes API requests that originate\n from within your cluster's VPC use the private VPC endpoint instead of traversing the\n internet. If this value is disabled and you have nodes or Fargate pods in the cluster,\n then ensure that publicAccessCidrs includes the necessary CIDR blocks for\n communication with the nodes or Fargate pods. For more information, see Amazon EKS cluster\n endpoint access control in the \n Amazon EKS User Guide\n .
This parameter indicates whether the Amazon EKS private API server endpoint is\n enabled. If the Amazon EKS private API server endpoint is enabled, Kubernetes\n API requests that originate from within your cluster's VPC use the private VPC endpoint\n instead of traversing the internet. If this value is disabled and you have nodes or\n Fargate pods in the cluster, then ensure that\n publicAccessCidrs includes the necessary CIDR blocks for communication\n with the nodes or Fargate pods. For more information, see Amazon EKS cluster endpoint access control in the\n \n Amazon EKS User Guide\n .
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server\n endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks\n is denied. The default value is 0.0.0.0/0. If you've disabled private\n endpoint access and you have nodes or Fargate pods in the cluster, then ensure that the\n necessary CIDR blocks are listed. For more information, see Amazon EKS cluster\n endpoint access control in the \n Amazon EKS User Guide\n .
The CIDR blocks that are allowed access to your cluster's public Kubernetes API server\n endpoint. Communication to the endpoint from addresses outside of the listed CIDR blocks\n is denied. The default value is 0.0.0.0/0. If you've disabled private\n endpoint access and you have nodes or Fargate pods in the cluster,\n then ensure that the necessary CIDR blocks are listed. For more information, see Amazon EKS cluster endpoint access control in the\n \n Amazon EKS User Guide\n .
An object representing an Amazon EKS cluster VPC configuration response.
" + "smithy.api#documentation": "An object representing an Amazon EKS cluster VPC configuration\n response.
" } }, "com.amazonaws.eks#ZeroCapacity": { diff --git a/codegen/sdk/aws-models/elasticsearchservice.2015-01-01.json b/codegen/sdk/aws-models/elasticsearchservice.2015-01-01.json index d5485e057e2..b282df3683a 100644 --- a/codegen/sdk/aws-models/elasticsearchservice.2015-01-01.json +++ b/codegen/sdk/aws-models/elasticsearchservice.2015-01-01.json @@ -261,6 +261,18 @@ "traits": { "smithy.api#documentation": "Describes the SAML application configured for a domain.
" } + }, + "AnonymousAuthDisableDate": { + "target": "com.amazonaws.elasticsearchservice#DisableTimestamp", + "traits": { + "smithy.api#documentation": "Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
" + } + }, + "AnonymousAuthEnabled": { + "target": "com.amazonaws.elasticsearchservice#Boolean", + "traits": { + "smithy.api#documentation": "True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
" + } } }, "traits": { @@ -293,6 +305,12 @@ "traits": { "smithy.api#documentation": "Specifies the SAML application configuration for the domain.
" } + }, + "AnonymousAuthEnabled": { + "target": "com.amazonaws.elasticsearchservice#Boolean", + "traits": { + "smithy.api#documentation": "True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
" + } } }, "traits": { @@ -323,6 +341,24 @@ }, "com.amazonaws.elasticsearchservice#AmazonElasticsearchService2015": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Elasticsearch Service", + "arnNamespace": "es", + "cloudFormationName": "Elasticsearch", + "cloudTrailEventSource": "elasticsearchservice.amazonaws.com", + "endpointPrefix": "es" + }, + "aws.auth#sigv4": { + "name": "es" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.
\nFor sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide.\n The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs.
\nThe endpoint for configuration service requests is region-specific: es.region.amazonaws.com.\n For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints,\n see Regions and Endpoints.
", + "smithy.api#title": "Amazon Elasticsearch Service", + "smithy.api#xmlNamespace": { + "uri": "http://es.amazonaws.com/doc/2015-01-01/" + } + }, "version": "2015-01-01", "operations": [ { @@ -445,25 +481,7 @@ { "target": "com.amazonaws.elasticsearchservice#UpgradeElasticsearchDomain" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Elasticsearch Service", - "arnNamespace": "es", - "cloudFormationName": "Elasticsearch", - "cloudTrailEventSource": "elasticsearchservice.amazonaws.com", - "endpointPrefix": "es" - }, - "aws.auth#sigv4": { - "name": "es" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.
\nFor sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide.\n The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs.
\nThe endpoint for configuration service requests is region-specific: es.region.amazonaws.com.\n For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints,\n see Regions and Endpoints.
", - "smithy.api#title": "Amazon Elasticsearch Service", - "smithy.api#xmlNamespace": { - "uri": "http://es.amazonaws.com/doc/2015-01-01/" - } - } + ] }, "com.amazonaws.elasticsearchservice#AssociatePackage": { "type": "operation", @@ -2508,6 +2526,9 @@ "smithy.api#documentation": "Container for results from DescribeReservedElasticsearchInstances
Time until which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" } }, + "activeFromTimestamp": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#box": {} + } + }, "updatesChangesetId": { "target": "com.amazonaws.finspacedata#ChangesetId", "traits": { @@ -696,8 +702,7 @@ "datasetDescription": { "target": "com.amazonaws.finspacedata#DatasetDescription", "traits": { - "smithy.api#documentation": "Description of a Dataset.
", - "smithy.api#required": {} + "smithy.api#documentation": "Description of a Dataset.
" } }, "ownerInfo": { @@ -716,8 +721,7 @@ "alias": { "target": "com.amazonaws.finspacedata#AliasString", "traits": { - "smithy.api#documentation": "The unique resource identifier for a Dataset.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique resource identifier for a Dataset.
" } }, "schemaDefinition": { @@ -792,6 +796,12 @@ "smithy.api#documentation": "Destination type for a Dataview.
\n\n GLUE_TABLE - Glue table destination type.
Time until which the Changeset is active. The value is determined as Epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
" } }, + "activeFromTimestamp": { + "target": "com.amazonaws.finspacedata#TimestampEpoch", + "traits": { + "smithy.api#box": {} + } + }, "updatesChangesetId": { "target": "com.amazonaws.finspacedata#ChangesetId", "traits": { @@ -2272,6 +2304,15 @@ } } }, + "com.amazonaws.finspacedata#S3DestinationFormatOptions": { + "type": "map", + "key": { + "target": "com.amazonaws.finspacedata#StringMapKey" + }, + "value": { + "target": "com.amazonaws.finspacedata#StringMapValue" + } + }, "com.amazonaws.finspacedata#SchemaDefinition": { "type": "structure", "members": { @@ -2582,8 +2623,7 @@ "alias": { "target": "com.amazonaws.finspacedata#AliasString", "traits": { - "smithy.api#documentation": "The unique resource identifier for a Dataset.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique resource identifier for a Dataset.
" } }, "schemaDefinition": { diff --git a/codegen/sdk/aws-models/forecast.2018-06-26.json b/codegen/sdk/aws-models/forecast.2018-06-26.json index 05c0c39cf14..50182d1a4b6 100644 --- a/codegen/sdk/aws-models/forecast.2018-06-26.json +++ b/codegen/sdk/aws-models/forecast.2018-06-26.json @@ -42,7 +42,7 @@ "Configuration": { "target": "com.amazonaws.forecast#Configuration", "traits": { - "smithy.api#documentation": "\n Weather Index\n
\nTo enable the Weather Index, do not specify a value for\n Configuration.
\n Holidays\n
\nTo enable Holidays, specify a country with one of the following two-letter country\n codes:
\n\"AL\" - ALBANIA
\n\"AR\" - ARGENTINA
\n\"AT\" - AUSTRIA
\n\"AU\" - AUSTRALIA
\n\"BA\" - BOSNIA HERZEGOVINA
\n\"BE\" - BELGIUM
\n\"BG\" - BULGARIA
\n\"BO\" - BOLIVIA
\n\"BR\" - BRAZIL
\n\"BY\" - BELARUS
\n\"CA\" - CANADA
\n\"CL\" - CHILE
\n\"CO\" - COLOMBIA
\n\"CR\" - COSTA RICA
\n\"HR\" - CROATIA
\n\"CZ\" - CZECH REPUBLIC
\n\"DK\" - DENMARK
\n\"EC\" - ECUADOR
\n\"EE\" - ESTONIA
\n\"ET\" - ETHIOPIA
\n\"FI\" - FINLAND
\n\"FR\" - FRANCE
\n\"DE\" - GERMANY
\n\"GR\" - GREECE
\n\"HU\" - HUNGARY
\n\"IS\" - ICELAND
\n\"IN\" - INDIA
\n\"IE\" - IRELAND
\n\"IT\" - ITALY
\n\"JP\" - JAPAN
\n\"KZ\" - KAZAKHSTAN
\n\"KR\" - KOREA
\n\"LV\" - LATVIA
\n\"LI\" - LIECHTENSTEIN
\n\"LT\" - LITHUANIA
\n\"LU\" - LUXEMBOURG
\n\"MK\" - MACEDONIA
\n\"MT\" - MALTA
\n\"MX\" - MEXICO
\n\"MD\" - MOLDOVA
\n\"ME\" - MONTENEGRO
\n\"NL\" - NETHERLANDS
\n\"NZ\" - NEW ZEALAND
\n\"NI\" - NICARAGUA
\n\"NG\" - NIGERIA
\n\"NO\" - NORWAY
\n\"PA\" - PANAMA
\n\"PY\" - PARAGUAY
\n\"PE\" - PERU
\n\"PL\" - POLAND
\n\"PT\" - PORTUGAL
\n\"RO\" - ROMANIA
\n\"RU\" - RUSSIA
\n\"RS\" - SERBIA
\n\"SK\" - SLOVAKIA
\n\"SI\" - SLOVENIA
\n\"ZA\" - SOUTH AFRICA
\n\"ES\" - SPAIN
\n\"SE\" - SWEDEN
\n\"CH\" - SWITZERLAND
\n\"UA\" - UKRAINE
\n\"AE\" - UNITED ARAB EMIRATES
\n\"US\" - UNITED STATES
\n\"UK\" - UNITED KINGDOM
\n\"UY\" - URUGUAY
\n\"VE\" - VENEZUELA
\n\n Weather Index\n
\nTo enable the Weather Index, do not specify a value for\n Configuration.
\n Holidays\n
\nTo enable Holidays, set CountryCode to one of the following two-letter country\n codes:
\"AL\" - ALBANIA
\n\"AR\" - ARGENTINA
\n\"AT\" - AUSTRIA
\n\"AU\" - AUSTRALIA
\n\"BA\" - BOSNIA HERZEGOVINA
\n\"BE\" - BELGIUM
\n\"BG\" - BULGARIA
\n\"BO\" - BOLIVIA
\n\"BR\" - BRAZIL
\n\"BY\" - BELARUS
\n\"CA\" - CANADA
\n\"CL\" - CHILE
\n\"CO\" - COLOMBIA
\n\"CR\" - COSTA RICA
\n\"HR\" - CROATIA
\n\"CZ\" - CZECH REPUBLIC
\n\"DK\" - DENMARK
\n\"EC\" - ECUADOR
\n\"EE\" - ESTONIA
\n\"ET\" - ETHIOPIA
\n\"FI\" - FINLAND
\n\"FR\" - FRANCE
\n\"DE\" - GERMANY
\n\"GR\" - GREECE
\n\"HU\" - HUNGARY
\n\"IS\" - ICELAND
\n\"IN\" - INDIA
\n\"IE\" - IRELAND
\n\"IT\" - ITALY
\n\"JP\" - JAPAN
\n\"KZ\" - KAZAKHSTAN
\n\"KR\" - KOREA
\n\"LV\" - LATVIA
\n\"LI\" - LIECHTENSTEIN
\n\"LT\" - LITHUANIA
\n\"LU\" - LUXEMBOURG
\n\"MK\" - MACEDONIA
\n\"MT\" - MALTA
\n\"MX\" - MEXICO
\n\"MD\" - MOLDOVA
\n\"ME\" - MONTENEGRO
\n\"NL\" - NETHERLANDS
\n\"NZ\" - NEW ZEALAND
\n\"NI\" - NICARAGUA
\n\"NG\" - NIGERIA
\n\"NO\" - NORWAY
\n\"PA\" - PANAMA
\n\"PY\" - PARAGUAY
\n\"PE\" - PERU
\n\"PL\" - POLAND
\n\"PT\" - PORTUGAL
\n\"RO\" - ROMANIA
\n\"RU\" - RUSSIA
\n\"RS\" - SERBIA
\n\"SK\" - SLOVAKIA
\n\"SI\" - SLOVENIA
\n\"ZA\" - SOUTH AFRICA
\n\"ES\" - SPAIN
\n\"SE\" - SWEDEN
\n\"CH\" - SWITZERLAND
\n\"UA\" - UKRAINE
\n\"AE\" - UNITED ARAB EMIRATES
\n\"US\" - UNITED STATES
\n\"UK\" - UNITED KINGDOM
\n\"UY\" - URUGUAY
\n\"VE\" - VENEZUELA
\nCreates an Amazon Forecast predictor.
\nAmazon Forecast creates predictors with AutoPredictor, which involves applying the\n optimal combination of algorithms to each time series in your datasets. You can use\n CreateAutoPredictor to create new predictors or upgrade/retrain existing\n predictors.
\n\n Creating new predictors\n
\nThe following parameters are required when creating a new predictor:
\n\n PredictorName - A unique name for the predictor.
\n DatasetGroupArn - The ARN of the dataset group used to train the\n predictor.
\n ForecastFrequency - The granularity of your forecasts (hourly,\n daily, weekly, etc).
\n ForecastHorizon - The number of time steps being\n forecasted.
When creating a new predictor, do not specify a value for\n ReferencePredictorArn.
\n Upgrading and retraining predictors\n
\nThe following parameters are required when retraining or upgrading a predictor:
\n\n PredictorName - A unique name for the predictor.
\n ReferencePredictorArn - The ARN of the predictor to retrain or\n upgrade.
When upgrading or retraining a predictor, only specify values for the\n ReferencePredictorArn and PredictorName.
Creates an Amazon Forecast predictor.
\nAmazon Forecast creates predictors with AutoPredictor, which involves applying the\n optimal combination of algorithms to each time series in your datasets. You can use\n CreateAutoPredictor to create new predictors or upgrade/retrain existing\n predictors.
\n\n Creating new predictors\n
\nThe following parameters are required when creating a new predictor:
\n\n PredictorName - A unique name for the predictor.
\n DatasetGroupArn - The ARN of the dataset group used to train the\n predictor.
\n ForecastFrequency - The granularity of your forecasts (hourly,\n daily, weekly, etc).
\n ForecastHorizon - The number of time steps being\n forecasted.
When creating a new predictor, do not specify a value for\n ReferencePredictorArn.
\n Upgrading and retraining predictors\n
\nThe following parameters are required when retraining or upgrading a predictor:
\n\n PredictorName - A unique name for the predictor.
\n ReferencePredictorArn - The ARN of the predictor to retrain or\n upgrade.
When upgrading or retraining a predictor, only specify values for the\n ReferencePredictorArn and PredictorName.
Create an Explainability resource for the predictor.
" + } }, "Tags": { "target": "com.amazonaws.forecast#Tags", @@ -590,7 +593,7 @@ "Tags": { "target": "com.amazonaws.forecast#Tags", "traits": { - "smithy.api#documentation": "The optional metadata that you apply to the dataset group to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
The optional metadata that you apply to the dataset group to help you categorize and\n organize them. Each tag consists of a key and an optional value, both of which you\n define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one\n value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that\n other services may have restrictions on allowed characters. Generally allowed characters\n are: letters, numbers, and spaces representable in UTF-8, and the following characters: +\n - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination\n of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag\n keys with this prefix. Values can have this prefix. If a tag value has aws as\n its prefix but the key does not, then Forecast considers it to be a user tag and will\n count against the limit of 50 tags. Tags with only the key prefix of aws do\n not count against your tags per resource limit.
The optional metadata that you apply to the dataset import job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
The optional metadata that you apply to the dataset import job to help you categorize and\n organize them. Each tag consists of a key and an optional value, both of which you\n define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one\n value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that\n other services may have restrictions on allowed characters. Generally allowed characters\n are: letters, numbers, and spaces representable in UTF-8, and the following characters: +\n - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination\n of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag\n keys with this prefix. Values can have this prefix. If a tag value has aws as\n its prefix but the key does not, then Forecast considers it to be a user tag and will\n count against the limit of 50 tags. Tags with only the key prefix of aws do\n not count against your tags per resource limit.
The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
The optional metadata that you apply to the dataset to help you categorize and organize\n them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one\n value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that\n other services may have restrictions on allowed characters. Generally allowed characters\n are: letters, numbers, and spaces representable in UTF-8, and the following characters: +\n - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination\n of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag\n keys with this prefix. Values can have this prefix. If a tag value has aws as\n its prefix but the key does not, then Forecast considers it to be a user tag and will\n count against the limit of 50 tags. Tags with only the key prefix of aws do\n not count against your tags per resource limit.
Explainability is only available for Forecasts and Predictors generated from an\n AutoPredictor (CreateAutoPredictor)
\nCreates an Amazon Forecast Explainability.
\nExplainability helps you better understand how the attributes in your datasets impact\n forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative\n impact of each attribute and determine whether they increase or decrease forecast\n values.
\nTo enable Forecast Explainability, your predictor must include at least one of the\n following: related time series, item metadata, or additional datasets like Holidays and\n the Weather Index.
\nCreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive\n aggregated Impact scores for all time series and time points in your datasets, provide a\n Predictor ARN. To receive Impact scores for specific time series and time points,\n provide a Forecast ARN.
\n\n CreateExplainability with a Predictor ARN\n
\nYou can only have one Explainability resource per predictor. If you already\n enabled ExplainPredictor in CreateAutoPredictor, that\n predictor already has an Explainability resource.
The following parameters are required when providing a Predictor ARN:
\n\n ExplainabilityName - A unique name for the Explainability.
\n ResourceArn - The Arn of the predictor.
\n TimePointGranularity - Must be set to “ALL”.
\n TimeSeriesGranularity - Must be set to “ALL”.
Do not specify a value for the following parameters:
\n\n DataSource - Only valid when TimeSeriesGranularity is\n “SPECIFIC”.
\n Schema - Only valid when TimeSeriesGranularity is\n “SPECIFIC”.
\n StartDateTime - Only valid when TimePointGranularity is\n “SPECIFIC”.
\n EndDateTime - Only valid when TimePointGranularity is\n “SPECIFIC”.
\n CreateExplainability with a Forecast ARN\n
\nYou can specify a maximum of 50 time series and 1500 time points.
\nThe following parameters are required when providing a Predictor ARN:
\n\n ExplainabilityName - A unique name for the Explainability.
\n ResourceArn - The Arn of the forecast.
\n TimePointGranularity - Either “ALL” or “SPECIFIC”.
\n TimeSeriesGranularity - Either “ALL” or “SPECIFIC”.
If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the\n following:
\n\n DataSource - The S3 location of the CSV file specifying your time\n series.
\n Schema - The Schema defines the attributes and attribute types\n listed in the Data Source.
If you set TimePointGranularity to “SPECIFIC”, you must also provide the\n following:
\n\n StartDateTime - The first timestamp in the range of time\n points.
\n EndDateTime - The last timestamp in the range of time\n points.
Explainability is only available for Forecasts and Predictors generated from an\n AutoPredictor (CreateAutoPredictor)
\nCreates an Amazon Forecast Explainability.
\nExplainability helps you better understand how the attributes in your datasets impact\n forecast. Amazon Forecast uses a metric called Impact scores to quantify the relative\n impact of each attribute and determine whether they increase or decrease forecast\n values.
\nTo enable Forecast Explainability, your predictor must include at least one of the\n following: related time series, item metadata, or additional datasets like Holidays and\n the Weather Index.
\nCreateExplainability accepts either a Predictor ARN or Forecast ARN. To receive\n aggregated Impact scores for all time series and time points in your datasets, provide a\n Predictor ARN. To receive Impact scores for specific time series and time points,\n provide a Forecast ARN.
\n\n CreateExplainability with a Predictor ARN\n
\nYou can only have one Explainability resource per predictor. If you already\n enabled ExplainPredictor in CreateAutoPredictor, that\n predictor already has an Explainability resource.
The following parameters are required when providing a Predictor ARN:
\n\n ExplainabilityName - A unique name for the Explainability.
\n ResourceArn - The Arn of the predictor.
\n TimePointGranularity - Must be set to “ALL”.
\n TimeSeriesGranularity - Must be set to “ALL”.
Do not specify a value for the following parameters:
\n\n DataSource - Only valid when TimeSeriesGranularity is\n “SPECIFIC”.
\n Schema - Only valid when TimeSeriesGranularity is\n “SPECIFIC”.
\n StartDateTime - Only valid when TimePointGranularity is\n “SPECIFIC”.
\n EndDateTime - Only valid when TimePointGranularity is\n “SPECIFIC”.
\n CreateExplainability with a Forecast ARN\n
\nYou can specify a maximum of 50 time series and 500 time points.
\nThe following parameters are required when providing a Predictor ARN:
\n\n ExplainabilityName - A unique name for the Explainability.
\n ResourceArn - The Arn of the forecast.
\n TimePointGranularity - Either “ALL” or “SPECIFIC”.
\n TimeSeriesGranularity - Either “ALL” or “SPECIFIC”.
If you set TimeSeriesGranularity to “SPECIFIC”, you must also provide the\n following:
\n\n DataSource - The S3 location of the CSV file specifying your time\n series.
\n Schema - The Schema defines the attributes and attribute types\n listed in the Data Source.
If you set TimePointGranularity to “SPECIFIC”, you must also provide the\n following:
\n\n StartDateTime - The first timestamp in the range of time\n points.
\n EndDateTime - The last timestamp in the range of time\n points.
If TimePointGranularity is set to SPECIFIC, define the first\n point for the Explainability.
If TimePointGranularity is set to SPECIFIC, define the first\n point for the Explainability.
Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)
" } }, "EndDateTime": { "target": "com.amazonaws.forecast#LocalDateTime", "traits": { - "smithy.api#documentation": "If TimePointGranularity is set to SPECIFIC, define the last\n time point for the Explainability.
If TimePointGranularity is set to SPECIFIC, define the last\n time point for the Explainability.
Use the following timestamp format: yyyy-MM-ddTHH:mm:ss (example: 2015-01-01T20:00:00)
" } }, "Tags": { @@ -1016,7 +1019,7 @@ "Tags": { "target": "com.amazonaws.forecast#Tags", "traits": { - "smithy.api#documentation": "The optional metadata that you apply to the forecast export job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
The optional metadata that you apply to the forecast export job to help you categorize and\n organize them. Each tag consists of a key and an optional value, both of which you\n define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one\n value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that\n other services may have restrictions on allowed characters. Generally allowed characters\n are: letters, numbers, and spaces representable in UTF-8, and the following characters: +\n - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination\n of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag\n keys with this prefix. Values can have this prefix. If a tag value has aws as\n its prefix but the key does not, then Forecast considers it to be a user tag and will\n count against the limit of 50 tags. Tags with only the key prefix of aws do\n not count against your tags per resource limit.
The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
The optional metadata that you apply to the forecast to help you categorize and organize\n them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one\n value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that\n other services may have restrictions on allowed characters. Generally allowed characters\n are: letters, numbers, and spaces representable in UTF-8, and the following characters: +\n - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination\n of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag\n keys with this prefix. Values can have this prefix. If a tag value has aws as\n its prefix but the key does not, then Forecast considers it to be a user tag and will\n count against the limit of 50 tags. Tags with only the key prefix of aws do\n not count against your tags per resource limit.
This operation creates a legacy predictor that does not include all the predictor\n functionalities provided by Amazon Forecast. To create a predictor that is compatible with all\n aspects of Forecast, use CreateAutoPredictor.
\nCreates an Amazon Forecast predictor.
\nIn the request, provide a dataset group and either specify an algorithm or let Amazon Forecast\n choose an algorithm for you using AutoML. If you specify an algorithm, you also can override\n algorithm-specific hyperparameters.
\nAmazon Forecast uses the algorithm to train a predictor using the latest version of the datasets\n in the specified dataset group. You can then generate a forecast using the CreateForecast operation.
\nTo see the evaluation metrics, use the GetAccuracyMetrics operation.
\nYou can specify a featurization configuration to fill and aggregate the data fields in the\n TARGET_TIME_SERIES dataset to improve model training. For more information, see\n FeaturizationConfig.
For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the\n DataFrequency specified when the dataset was created matches the\n ForecastFrequency. TARGET_TIME_SERIES datasets don't have this restriction.\n Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups.
By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9\n (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by\n setting the ForecastTypes.
\n AutoML\n
\nIf you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the\n objective function, set PerformAutoML to true. The\n objective function is defined as the mean of the weighted losses over the\n forecast types. By default, these are the p10, p50, and p90 quantile losses. For more\n information, see EvaluationResult.
When AutoML is enabled, the following properties are disallowed:
\n\n AlgorithmArn\n
\n HPOConfig\n
\n PerformHPO\n
\n TrainingParameters\n
To get a list of all of your predictors, use the ListPredictors\n operation.
\nBefore you can use the predictor to create a forecast, the Status of the\n predictor must be ACTIVE, signifying that training has completed. To get the\n status, use the DescribePredictor operation.
This operation creates a legacy predictor that does not include all the predictor\n functionalities provided by Amazon Forecast. To create a predictor that is compatible with all\n aspects of Forecast, use CreateAutoPredictor.
\nCreates an Amazon Forecast predictor.
\nIn the request, provide a dataset group and either specify an algorithm or let Amazon Forecast\n choose an algorithm for you using AutoML. If you specify an algorithm, you also can override\n algorithm-specific hyperparameters.
\nAmazon Forecast uses the algorithm to train a predictor using the latest version of the datasets\n in the specified dataset group. You can then generate a forecast using the CreateForecast operation.
\nTo see the evaluation metrics, use the GetAccuracyMetrics operation.
\nYou can specify a featurization configuration to fill and aggregate the data fields in the\n TARGET_TIME_SERIES dataset to improve model training. For more information, see\n FeaturizationConfig.
For RELATED_TIME_SERIES datasets, CreatePredictor verifies that the\n DataFrequency specified when the dataset was created matches the\n ForecastFrequency. TARGET_TIME_SERIES datasets don't have this restriction.\n Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups.
By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9\n (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor by\n setting the ForecastTypes.
\n AutoML\n
\nIf you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the\n objective function, set PerformAutoML to true. The\n objective function is defined as the mean of the weighted losses over the\n forecast types. By default, these are the p10, p50, and p90 quantile losses. For more\n information, see EvaluationResult.
When AutoML is enabled, the following properties are disallowed:
\n\n AlgorithmArn\n
\n HPOConfig\n
\n PerformHPO\n
\n TrainingParameters\n
To get a list of all of your predictors, use the ListPredictors\n operation.
\nBefore you can use the predictor to create a forecast, the Status of the\n predictor must be ACTIVE, signifying that training has completed. To get the\n status, use the DescribePredictor operation.
Exports backtest forecasts and accuracy metrics generated by the CreatePredictor operation. Two folders containing CSV files are exported\n to your specified S3 bucket.
\nThe export file names will match the following conventions:
\n\n
The
You must specify a DataDestination object that includes an Amazon S3\n bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3\n bucket. For more information, see aws-forecast-iam-roles.
\nThe Status of the export job must be ACTIVE before\n you can access the export in your Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.
Exports backtest forecasts and accuracy metrics generated by the CreateAutoPredictor or CreatePredictor operations. Two\n folders containing CSV files are exported to your specified S3 bucket.
\nThe export file names will match the following conventions:
\n\n
The
You must specify a DataDestination object that includes an Amazon S3\n bucket and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3\n bucket. For more information, see aws-forecast-iam-roles.
\nThe Status of the export job must be ACTIVE before you\n can access the export in your Amazon S3 bucket. To get the status, use the DescribePredictorBacktestExportJob operation.
Optional metadata to help you categorize and organize your backtests. Each tag consists\n of a key and an optional value, both of which you define. Tag keys and values are case\n sensitive.
\nThe following restrictions apply to tags:
\nFor each resource, each tag key must be unique and each tag key must have one\n value.
\nMaximum number of tags per resource: 50.
\nMaximum key length: 128 Unicode characters in UTF-8.
\nMaximum value length: 256 Unicode characters in UTF-8.
\nAccepted characters: all letters and numbers, spaces representable in UTF-8, and +\n - = . _ : / @. If your tagging schema is used across other services and resources,\n the character restrictions of those services also apply.
\nKey prefixes cannot include any upper or lowercase combination of\n aws: or AWS:. Values can have this prefix. If a tag\n value has aws as its prefix but the key does not, Forecast considers it\n to be a user tag and will count against the limit of 50 tags. Tags with only the key\n prefix of aws do not count against your tags per resource limit. You\n cannot edit or delete tag keys with this prefix.
Optional metadata to help you categorize and organize your backtests. Each tag\n consists of a key and an optional value, both of which you define. Tag keys and values\n are case sensitive.
\nThe following restrictions apply to tags:
\nFor each resource, each tag key must be unique and each tag key must have one\n value.
\nMaximum number of tags per resource: 50.
\nMaximum key length: 128 Unicode characters in UTF-8.
\nMaximum value length: 256 Unicode characters in UTF-8.
\nAccepted characters: all letters and numbers, spaces representable in UTF-8,\n and + - = . _ : / @. If your tagging schema is used across other services and\n resources, the character restrictions of those services also apply.
\nKey prefixes cannot include any upper or lowercase combination of\n aws: or AWS:. Values can have this prefix. If a\n tag value has aws as its prefix but the key does not, Forecast\n considers it to be a user tag and will count against the limit of 50 tags. Tags\n with only the key prefix of aws do not count against your tags per\n resource limit. You cannot edit or delete tag keys with this prefix.
The optional metadata that you apply to the predictor to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
The optional metadata that you apply to the predictor to help you categorize and organize\n them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one\n value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that\n other services may have restrictions on allowed characters. Generally allowed characters\n are: letters, numbers, and spaces representable in UTF-8, and the following characters: +\n - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination\n of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag\n keys with this prefix. Values can have this prefix. If a tag value has aws as\n its prefix but the key does not, then Forecast considers it to be a user tag and will\n count against the limit of 50 tags. Tags with only the key prefix of aws do\n not count against your tags per resource limit.
The path to the training data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the\n credentials to access the data.
", + "smithy.api#documentation": "The path to the data stored in an Amazon Simple Storage Service (Amazon S3) bucket along with the\n credentials to access the data.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The source of your training data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to\n access the data and, optionally, an AWS Key Management Service (KMS) key. This object is submitted in the\n CreateDatasetImportJob request.
" + "smithy.api#documentation": "The source of your data, an AWS Identity and Access Management (IAM) role that allows Amazon Forecast to\n access the data and, optionally, an AWS Key Management Service (KMS) key.
" } }, "com.amazonaws.forecast#DatasetGroupSummary": { @@ -1641,7 +1644,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an Explainability export job.
", + "smithy.api#documentation": "Deletes an Explainability export.
", "smithy.api#idempotent": {} } }, @@ -1752,7 +1755,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a predictor created using the CreatePredictor operation. You can\n delete only predictor that have a status of ACTIVE or CREATE_FAILED.\n To get the status, use the DescribePredictor operation.
Deletes a predictor created using the DescribePredictor or CreatePredictor operations. You can delete only predictor that have a status of\n ACTIVE or CREATE_FAILED. To get the status, use the DescribePredictor operation.
The frequency of predictions in a forecast.
\nValid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30\n minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute).\n For example, \"Y\" indicates every year and \"5min\" indicates every five minutes.
" } }, + "ForecastDimensions": { + "target": "com.amazonaws.forecast#ForecastDimensions", + "traits": { + "smithy.api#documentation": "An array of dimension (field) names that specify the attributes used to group your time series.
" + } + }, "DatasetImportJobArns": { "target": "com.amazonaws.forecast#ArnList", "traits": { @@ -1958,7 +1967,10 @@ } }, "ExplainabilityInfo": { - "target": "com.amazonaws.forecast#ExplainabilityInfo" + "target": "com.amazonaws.forecast#ExplainabilityInfo", + "traits": { + "smithy.api#documentation": "Provides the status and ARN of the Predictor Explainability.
" + } } } }, @@ -2668,7 +2680,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation is only valid for legacy predictors created with CreatePredictor. If you\n are not using a legacy predictor, use DescribeAutoPredictor.
\nTo upgrade a legacy predictor to AutoPredictor, see Upgrading to AutoPredictor.
\nDescribes a predictor created using the CreatePredictor\n operation.
\nIn addition to listing the properties provided in the CreatePredictor\n request, this operation lists the following properties:
\n DatasetImportJobArns - The dataset import jobs used to import training\n data.
\n AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were\n evaluated.
\n CreationTime\n
\n LastModificationTime\n
\n Status\n
\n Message - If an error occurred, information about the error.
This operation is only valid for legacy predictors created with CreatePredictor. If you\n are not using a legacy predictor, use DescribeAutoPredictor.
\nDescribes a predictor created using the CreatePredictor\n operation.
\nIn addition to listing the properties provided in the CreatePredictor\n request, this operation lists the following properties:
\n DatasetImportJobArns - The dataset import jobs used to import training\n data.
\n AutoMLAlgorithmArns - If AutoML is performed, the algorithms that were\n evaluated.
\n CreationTime\n
\n LastModificationTime\n
\n Status\n
\n Message - If an error occurred, information about the error.
Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.
\nIn addition to listing the properties provided by the user in the\n CreatePredictorBacktestExportJob request, this operation lists the\n following properties:
\n CreationTime\n
\n LastModificationTime\n
\n Status\n
\n Message (if an error occurred)
Describes a predictor backtest export job created using the CreatePredictorBacktestExportJob operation.
\nIn addition to listing the properties provided by the user in the\n CreatePredictorBacktestExportJob request, this operation lists the\n following properties:
\n CreationTime\n
\n LastModificationTime\n
\n Status\n
\n Message (if an error occurred)
The status of the predictor backtest export job. States include:
\n\n ACTIVE\n
\n CREATE_PENDING, CREATE_IN_PROGRESS,\n CREATE_FAILED\n
\n CREATE_STOPPING, CREATE_STOPPED\n
\n DELETE_PENDING, DELETE_IN_PROGRESS,\n DELETE_FAILED\n
The status of the predictor backtest export job. States include:
\n\n ACTIVE\n
\n CREATE_PENDING, CREATE_IN_PROGRESS,\n CREATE_FAILED\n
\n CREATE_STOPPING, CREATE_STOPPED\n
\n DELETE_PENDING, DELETE_IN_PROGRESS,\n DELETE_FAILED\n
The last time the resource was modified. The timestamp depends on the status of the job:
\n\n CREATE_PENDING - The CreationTime.
\n CREATE_IN_PROGRESS - The current timestamp.
\n CREATE_STOPPING - The current timestamp.
\n CREATE_STOPPED - When the job stopped.
\n ACTIVE or CREATE_FAILED - When the job finished or\n failed.
The last time the resource was modified. The timestamp depends on the status of the\n job:
\n\n CREATE_PENDING - The CreationTime.
\n CREATE_IN_PROGRESS - The current timestamp.
\n CREATE_STOPPING - The current timestamp.
\n CREATE_STOPPED - When the job stopped.
\n ACTIVE or CREATE_FAILED - When the job finished or\n failed.
The Amazon Resource Name (ARN) of the Explainability.
" + } }, "Status": { - "target": "com.amazonaws.forecast#Status" + "target": "com.amazonaws.forecast#Status", + "traits": { + "smithy.api#documentation": "The status of the Explainability. States include:
\n\n ACTIVE\n
\n CREATE_PENDING, CREATE_IN_PROGRESS,\n CREATE_FAILED\n
\n CREATE_STOPPING, CREATE_STOPPED\n
\n DELETE_PENDING, DELETE_IN_PROGRESS,\n DELETE_FAILED\n
Provides information about the Explainability resource.
" } }, "com.amazonaws.forecast#ExplainabilitySummary": { @@ -3235,7 +3256,7 @@ "AttributeName": { "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "The name of the schema attribute that specifies the data field to be featurized. Amazon Forecast supports the target field of \n the TARGET_TIME_SERIES and the RELATED_TIME_SERIES datasets. For example, for the RETAIL domain, the target is\n demand, and for the CUSTOM domain, the target is\n target_value.\n For more information, see howitworks-missing-values.
The name of the schema attribute that specifies the data field to be featurized. Amazon\n Forecast supports the target field of the TARGET_TIME_SERIES and the\n RELATED_TIME_SERIES datasets. For example, for the RETAIL domain,\n the target is demand, and for the CUSTOM domain, the target is\n target_value. For more information, see howitworks-missing-values.
Provides featurization (transformation) information for a dataset field. This object\n is part of the FeaturizationConfig object.
\nFor example:
\n\n {\n
\n \"AttributeName\": \"demand\",\n
\n FeaturizationPipeline [ {\n
\n \"FeaturizationMethodName\": \"filling\",\n
\n \"FeaturizationMethodParameters\": {\"aggregation\": \"avg\", \"backfill\": \"nan\"}\n
\n } ]\n
\n }\n
This object belongs to the CreatePredictor operation. If you created\n your predictor with CreateAutoPredictor, see AttributeConfig.
\nProvides featurization (transformation) information for a dataset field. This object is\n part of the FeaturizationConfig object.
\nFor example:
\n\n {\n
\n \"AttributeName\": \"demand\",\n
\n FeaturizationPipeline [ {\n
\n \"FeaturizationMethodName\": \"filling\",\n
\n \"FeaturizationMethodParameters\": {\"aggregation\": \"avg\", \"backfill\":\n \"nan\"}\n
\n } ]\n
\n }\n
The frequency of predictions in a forecast.
\nValid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes),\n 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute).\n For example, \"Y\" indicates every year and \"5min\" indicates every five minutes.
\nThe frequency must be greater than or equal to the TARGET_TIME_SERIES dataset\n frequency.
\nWhen a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the\n RELATED_TIME_SERIES dataset frequency.
", + "smithy.api#documentation": "The frequency of predictions in a forecast.
\nValid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes),\n 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example,\n \"Y\" indicates every year and \"5min\" indicates every five minutes.
\nThe frequency must be greater than or equal to the TARGET_TIME_SERIES dataset\n frequency.
\nWhen a RELATED_TIME_SERIES dataset is provided, the frequency must be equal to the\n RELATED_TIME_SERIES dataset frequency.
", "smithy.api#required": {} } }, "ForecastDimensions": { "target": "com.amazonaws.forecast#ForecastDimensions", "traits": { - "smithy.api#documentation": "An array of dimension (field) names that specify how to group the generated forecast.
\nFor example, suppose that you are generating a forecast for item sales across all of\n your stores, and your dataset contains a store_id field. If you want the sales\n forecast for each item by store, you would specify store_id as the dimension.
All forecast dimensions specified in the TARGET_TIME_SERIES dataset don't\n need to be specified in the CreatePredictor request.\n All forecast dimensions specified in the RELATED_TIME_SERIES dataset must\n be specified in the CreatePredictor request.
An array of dimension (field) names that specify how to group the generated\n forecast.
\nFor example, suppose that you are generating a forecast for item sales across all of your\n stores, and your dataset contains a store_id field. If you want the sales\n forecast for each item by store, you would specify store_id as the\n dimension.
All forecast dimensions specified in the TARGET_TIME_SERIES dataset don't\n need to be specified in the CreatePredictor request. All forecast dimensions\n specified in the RELATED_TIME_SERIES dataset must be specified in the\n CreatePredictor request.
In a CreatePredictor operation, the specified algorithm\n trains a model using the specified dataset group. You can optionally tell the operation\n to modify data fields prior to training a model. These modifications are referred to as\n featurization.
\nYou define featurization using the FeaturizationConfig object.\n You specify an array of transformations, one for each field that you want to\n featurize. You then include the FeaturizationConfig object in your\n CreatePredictor request. Amazon Forecast applies the featurization to the\n TARGET_TIME_SERIES and RELATED_TIME_SERIES datasets before model training.
You can create multiple featurization configurations. For example, you\n might call the CreatePredictor operation twice by specifying different\n featurization configurations.
This object belongs to the CreatePredictor operation. If you created\n your predictor with CreateAutoPredictor, see AttributeConfig.
\nIn a CreatePredictor operation, the specified algorithm trains a model\n using the specified dataset group. You can optionally tell the operation to modify data fields\n prior to training a model. These modifications are referred to as\n featurization.
\nYou define featurization using the FeaturizationConfig object. You specify an\n array of transformations, one for each field that you want to featurize. You then include the\n FeaturizationConfig object in your CreatePredictor request.\n Amazon Forecast applies the featurization to the TARGET_TIME_SERIES and\n RELATED_TIME_SERIES datasets before model training.
You can create multiple featurization configurations. For example, you might call the\n CreatePredictor operation twice by specifying different featurization\n configurations.
The method parameters (key-value pairs), which are a map of override parameters. Specify these parameters to override the default values. \n Related Time Series attributes do not accept aggregation parameters.
\nThe following list shows the parameters and their valid values for the \"filling\" featurization method for a Target Time Series dataset. Bold signifies the default\n value.
\n\n aggregation: sum, avg, first, min, max\n
\n frontfill: none\n
\n middlefill: zero, nan (not a number), value, median, mean, min, max\n
\n backfill: zero, nan, value, median, mean, min, max\n
The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):
\n\n middlefill: zero, value, median, mean, min, max\n
\n backfill: zero, value, median, mean, min, max\n
\n futurefill: zero, value, median, mean, min, max\n
To set a filling method to a specific value, set the fill parameter to value\n and define the value in a corresponding _value parameter. For example, to set\n backfilling to a value of 2, include the following: \"backfill\": \"value\" and\n \"backfill_value\":\"2\".
The method parameters (key-value pairs), which are a map of override parameters. Specify\n these parameters to override the default values. Related Time Series attributes do not accept\n aggregation parameters.
\nThe following list shows the parameters and their valid values for the \"filling\"\n featurization method for a Target Time Series dataset. Bold\n signifies the default value.
\n\n aggregation: sum, avg,\n first, min, max\n
\n frontfill: none\n
\n middlefill: zero, nan (not\n a number), value, median, mean, min,\n max\n
\n backfill: zero, nan,\n value, median, mean, min,\n max\n
The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):
\n\n middlefill: zero, value, median,\n mean, min, max\n
\n backfill: zero, value, median,\n mean, min, max\n
\n futurefill: zero, value, median,\n mean, min, max\n
To set a filling method to a specific value, set the fill parameter to value\n and define the value in a corresponding _value parameter. For example, to set\n backfilling to a value of 2, include the following: \"backfill\": \"value\" and\n \"backfill_value\":\"2\".
Provides information about the method that featurizes (transforms) a dataset field.\n The method is part of the FeaturizationPipeline of the\n Featurization object.
The following is an example of how you specify a FeaturizationMethod object.
\n {\n
\n \"FeaturizationMethodName\": \"filling\",\n
\n \"FeaturizationMethodParameters\": {\"aggregation\": \"sum\", \"middlefill\": \"zero\", \"backfill\": \"zero\"}\n
\n }\n
Provides information about the method that featurizes (transforms) a dataset field. The\n method is part of the FeaturizationPipeline of the Featurization object.
The following is an example of how you specify a FeaturizationMethod\n object.
\n {\n
\n \"FeaturizationMethodName\": \"filling\",\n
\n \"FeaturizationMethodParameters\": {\"aggregation\": \"sum\", \"middlefill\": \"zero\",\n \"backfill\": \"zero\"}\n
\n }\n
Whether the Forecast was created from an AutoPredictor.
" + } }, "DatasetGroupArn": { "target": "com.amazonaws.forecast#String", @@ -3679,7 +3703,7 @@ } }, "traits": { - "smithy.api#documentation": "The data used to train a predictor. The data includes a dataset group and any\n supplementary features. You specify this object in the CreatePredictor\n request.
" + "smithy.api#documentation": "This object belongs to the CreatePredictor operation. If you created\n your predictor with CreateAutoPredictor, see DataConfig.
\nThe data used to train a predictor. The data includes a dataset group and any\n supplementary features. You specify this object in the CreatePredictor\n request.
" } }, "com.amazonaws.forecast#Integer": { @@ -4006,7 +4030,7 @@ "Filters": { "target": "com.amazonaws.forecast#Filters", "traits": { - "smithy.api#documentation": "An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to\n include or exclude the resources that match the statement from the list. The match\n statement consists of a key and a value.
\n Filter properties\n
\n\n Condition - The condition to apply. Valid values are\n IS and IS_NOT.
\n Key - The name of the parameter to filter on. Valid values are\n PredictorArn and Status.
\n Value - The value to match.
An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to\n include or exclude the resources that match the statement from the list. The match\n statement consists of a key and a value.
\n Filter properties\n
\n\n Condition - The condition to apply. Valid values are\n IS and IS_NOT.
\n Key - The name of the parameter to filter on. Valid values are\n ResourceArn and Status.
\n Value - The value to match.
An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to\n include or exclude resources that match the statement from the list. The match statement\n consists of a key and a value.
\n Filter properties\n
\n\n Condition - The condition to apply. Valid values are\n IS and IS_NOT.
\n Key - The name of the parameter to filter on. Valid values are\n PredictorArn and Status.
\n Value - The value to match.
An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to\n include or exclude resources that match the statement from the list. The match statement\n consists of a key and a value.
\n Filter properties\n
\n\n Condition - The condition to apply. Valid values are\n IS and IS_NOT.
\n Key - The name of the parameter to filter on. Valid values are\n ResourceArn and Status.
\n Value - The value to match.
Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a summary\n for each backtest export job. You can filter the list using an array of Filter objects.
\nTo retrieve the complete set of properties for a particular backtest export job, use the\n ARN with the DescribePredictorBacktestExportJob operation.
", + "smithy.api#documentation": "Returns a list of predictor backtest export jobs created using the CreatePredictorBacktestExportJob operation. This operation returns a\n summary for each backtest export job. You can filter the list using an array of Filter objects.
\nTo retrieve the complete set of properties for a particular backtest export job, use\n the ARN with the DescribePredictorBacktestExportJob operation.
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -4256,7 +4280,7 @@ "NextToken": { "target": "com.amazonaws.forecast#NextToken", "traits": { - "smithy.api#documentation": "If the result of the previous request was truncated, the response includes a NextToken.\n To retrieve the next set of results, use the token in the next request. Tokens expire after\n 24 hours.
" + "smithy.api#documentation": "If the result of the previous request was truncated, the response includes a\n NextToken. To retrieve the next set of results, use the token in the next request.\n Tokens expire after 24 hours.
" } }, "MaxResults": { @@ -4268,7 +4292,7 @@ "Filters": { "target": "com.amazonaws.forecast#Filters", "traits": { - "smithy.api#documentation": "An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to\n include or exclude the predictor backtest export jobs that match the statement from the\n list. The match statement consists of a key and a value.
\n Filter properties\n
\n\n Condition - The condition to apply. Valid values are\n IS and IS_NOT. To include the predictor backtest\n export jobs that match the statement, specify IS. To exclude matching\n predictor backtest export jobs, specify IS_NOT.
\n Key - The name of the parameter to filter on. Valid values are\n PredictorArn and Status.
\n Value - The value to match.
An array of filters. For each filter, provide a condition and a match statement. The\n condition is either IS or IS_NOT, which specifies whether to\n include or exclude the predictor backtest export jobs that match the statement from the\n list. The match statement consists of a key and a value.
\n Filter properties\n
\n\n Condition - The condition to apply. Valid values are\n IS and IS_NOT. To include the predictor backtest\n export jobs that match the statement, specify IS. To exclude\n matching predictor backtest export jobs, specify IS_NOT.
\n Key - The name of the parameter to filter on. Valid values are\n PredictorArn and Status.
\n Value - The value to match.
Returns this token if the response is truncated. To retrieve the next\n set of results, use the token in the next request.
" + "smithy.api#documentation": "Returns this token if the response is truncated. To retrieve the next set of results,\n use the token in the next request.
" } } } @@ -4307,7 +4331,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of predictors created using the CreatePredictor\n operation. For each predictor, this operation returns a summary of its properties, including\n its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the\n ARN with the DescribePredictor operation. You can filter the list using an\n array of Filter objects.
", + "smithy.api#documentation": "Returns a list of predictors created using the CreateAutoPredictor or\n CreatePredictor operations. For each predictor, this operation returns a\n summary of its properties, including its Amazon Resource Name (ARN).
\nYou can retrieve the complete set of properties by using the ARN with the DescribeAutoPredictor and DescribePredictor operations. You\n can filter the list using an array of Filter objects.
", "smithy.api#idempotent": {}, "smithy.api#paginated": { "inputToken": "NextToken", @@ -4383,7 +4407,7 @@ "ResourceArn": { "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast export jobs.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.\n
", "smithy.api#required": {} } } @@ -4578,7 +4602,7 @@ "Status": { "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "The status of the predictor backtest export job. States include:
\n\n ACTIVE\n
\n CREATE_PENDING, CREATE_IN_PROGRESS,\n CREATE_FAILED\n
\n CREATE_STOPPING, CREATE_STOPPED\n
\n DELETE_PENDING, DELETE_IN_PROGRESS,\n DELETE_FAILED\n
The status of the predictor backtest export job. States include:
\n\n ACTIVE\n
\n CREATE_PENDING, CREATE_IN_PROGRESS,\n CREATE_FAILED\n
\n CREATE_STOPPING, CREATE_STOPPED\n
\n DELETE_PENDING, DELETE_IN_PROGRESS,\n DELETE_FAILED\n
The last time the resource was modified. The timestamp depends on the status of the job:
\n\n CREATE_PENDING - The CreationTime.
\n CREATE_IN_PROGRESS - The current timestamp.
\n CREATE_STOPPING - The current timestamp.
\n CREATE_STOPPED - When the job stopped.
\n ACTIVE or CREATE_FAILED - When the job finished or\n failed.
The last time the resource was modified. The timestamp depends on the status of the\n job:
\n\n CREATE_PENDING - The CreationTime.
\n CREATE_IN_PROGRESS - The current timestamp.
\n CREATE_STOPPING - The current timestamp.
\n CREATE_STOPPED - When the job stopped.
\n ACTIVE or CREATE_FAILED - When the job finished or\n failed.
Provides a summary of the predictor backtest export job properties used in the ListPredictorBacktestExportJobs operation. To get a complete set of properties, call\n the DescribePredictorBacktestExportJob operation, and provide the listed\n PredictorBacktestExportJobArn.
Provides a summary of the predictor backtest export job properties used in the ListPredictorBacktestExportJobs operation. To get a complete set of\n properties, call the DescribePredictorBacktestExportJob operation, and\n provide the listed PredictorBacktestExportJobArn.
Defines the fields of a dataset. You specify this object in the CreateDataset request.
" + "smithy.api#documentation": "Defines the fields of a dataset.
" } }, "com.amazonaws.forecast#SchemaAttribute": { @@ -5017,7 +5041,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops a resource.
\nThe resource undergoes the following states:\n CREATE_STOPPING and CREATE_STOPPED. You cannot resume\n a resource once it has been stopped.
This operation can be applied to the following resources (and their corresponding child\n resources):
\nDataset Import Job
\nPredictor Job
\nForecast Job
\nForecast Export Job
\nPredictor Backtest Export Job
\nStops a resource.
\nThe resource undergoes the following states: CREATE_STOPPING and\n CREATE_STOPPED. You cannot resume a resource once it has been\n stopped.
This operation can be applied to the following resources (and their corresponding child\n resources):
\nDataset Import Job
\nPredictor Job
\nForecast Job
\nForecast Export Job
\nPredictor Backtest Export Job
\nExplainability Job
\nExplainability Export Job
\nThe Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs\n are DatasetImportJobArn, PredictorArn,\n PredictorBacktestExportJobArn, ForecastArn, and\n ForecastExportJobArn.
The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs\n are DatasetImportJobArn, PredictorArn,\n PredictorBacktestExportJobArn, ForecastArn,\n ForecastExportJobArn, ExplainabilityArn, and\n ExplainabilityExportArn.
Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object. Forecast supports the Weather Index and Holidays built-in\n featurizations.
\n\n Weather Index\n
\nThe Amazon Forecast Weather Index is a built-in featurization that incorporates historical and\n projected weather information into your model. The Weather Index supplements your datasets\n with over two years of historical weather data and up to 14 days of projected weather data.\n For more information, see Amazon Forecast Weather\n Index.
\n\n Holidays\n
\nHolidays is a built-in featurization that incorporates a feature-engineered dataset of\n national holiday information into your model. It provides native support for the holiday\n calendars of 66 countries. To view the holiday calendars, refer to the Jollyday library. For more\n information, see Holidays Featurization.
" + "smithy.api#documentation": "This object belongs to the CreatePredictor operation. If you created\n your predictor with CreateAutoPredictor, see AdditionalDataset.
\nDescribes a supplementary feature of a dataset group. This object is part of the InputDataConfig object. Forecast supports the Weather Index and Holidays built-in\n featurizations.
\n\n Weather Index\n
\nThe Amazon Forecast Weather Index is a built-in featurization that incorporates historical and\n projected weather information into your model. The Weather Index supplements your datasets\n with over two years of historical weather data and up to 14 days of projected weather data.\n For more information, see Amazon Forecast Weather\n Index.
\n\n Holidays\n
\nHolidays is a built-in featurization that incorporates a feature-engineered dataset of\n national holiday information into your model. It provides native support for the holiday\n calendars of 66 countries. To view the holiday calendars, refer to the Jollyday library. For more\n information, see Holidays Featurization.
" } }, "com.amazonaws.forecast#SupplementaryFeatures": { @@ -5083,20 +5107,20 @@ "Key": { "target": "com.amazonaws.forecast#TagKey", "traits": { - "smithy.api#documentation": "One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.
One part of a key-value pair that makes up a tag. A key is a general label\n that acts like a category for more specific tag values.
The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).
The optional part of a key-value pair that makes up a tag. A value acts as a\n descriptor within a tag category (key).
The optional 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.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
The optional metadata that you apply to a resource to help you categorize and organize\n them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one\n value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that\n other services may have restrictions on allowed characters. Generally allowed characters\n are: letters, numbers, and spaces representable in UTF-8, and the following characters: +\n - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination\n of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag\n keys with this prefix. Values can have this prefix. If a tag value has aws as\n its prefix but the key does not, then Forecast considers it to be a user tag and will\n count against the limit of 50 tags. Tags with only the key prefix of aws do\n not count against your tags per resource limit.
Associates the specified tags to a resource with the specified resourceArn. 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 also deleted.
Associates the specified tags to a resource with the specified resourceArn.\n If existing tags on a resource are not specified in the request parameters, they are not\n changed. When a resource is deleted, the tags associated with that resource are also\n deleted.
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast export jobs.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.\n
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.forecast#Tags", "traits": { - "smithy.api#documentation": "The tags to add to the resource. A tag is an array of key-value pairs.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.
The tags to add to the resource. A tag is an array of key-value pairs.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one\n value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that\n other services may have restrictions on allowed characters. Generally allowed characters\n are: letters, numbers, and spaces representable in UTF-8, and the following characters: +\n - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:, AWS:, or any upper or lowercase combination\n of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag\n keys with this prefix. Values can have this prefix. If a tag value has aws as\n its prefix but the key does not, then Forecast considers it to be a user tag and will\n count against the limit of 50 tags. Tags with only the key prefix of aws do\n not count against your tags per resource limit.
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast exports.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags.\n
", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/glue.2017-03-31.json b/codegen/sdk/aws-models/glue.2017-03-31.json index 43d31192a0f..b0089974c26 100644 --- a/codegen/sdk/aws-models/glue.2017-03-31.json +++ b/codegen/sdk/aws-models/glue.2017-03-31.json @@ -363,6 +363,15 @@ { "target": "com.amazonaws.glue#GetTriggers" }, + { + "target": "com.amazonaws.glue#GetUnfilteredPartitionMetadata" + }, + { + "target": "com.amazonaws.glue#GetUnfilteredPartitionsMetadata" + }, + { + "target": "com.amazonaws.glue#GetUnfilteredTableMetadata" + }, { "target": "com.amazonaws.glue#GetUserDefinedFunction" }, @@ -563,6 +572,15 @@ "smithy.api#error": "client" } }, + "com.amazonaws.glue#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 12 + } + } + }, "com.amazonaws.glue#Action": { "type": "structure", "members": { @@ -640,6 +658,23 @@ "com.amazonaws.glue#AttemptCount": { "type": "integer" }, + "com.amazonaws.glue#AuditContext": { + "type": "structure", + "members": { + "AdditionalAuditContext": { + "target": "com.amazonaws.glue#AuditContextString" + } + } + }, + "com.amazonaws.glue#AuditContextString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + } + } + }, "com.amazonaws.glue#BackfillError": { "type": "structure", "members": { @@ -2302,6 +2337,12 @@ "smithy.api#documentation": "A list of the tables to be synchronized.
", "smithy.api#required": {} } + }, + "ConnectionName": { + "target": "com.amazonaws.glue#ConnectionName", + "traits": { + "smithy.api#documentation": "The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog connection type paired with a NETWORK Connection type.
The name of the SecurityConfiguration structure to be used by this\n crawler.
Specifies Glue Data Catalog targets.
" } + }, + "DeltaTargets": { + "target": "com.amazonaws.glue#DeltaTargetList", + "traits": { + "smithy.api#documentation": "Specifies Delta data store targets.
" + } } }, "traits": { @@ -4109,6 +4176,9 @@ "smithy.api#documentation": "Specifies data lineage configuration settings for the crawler.
" } }, + "LakeFormationConfiguration": { + "target": "com.amazonaws.glue#LakeFormationConfiguration" + }, "Configuration": { "target": "com.amazonaws.glue#CrawlerConfiguration", "traits": { @@ -7373,6 +7443,38 @@ } } }, + "com.amazonaws.glue#DeltaTarget": { + "type": "structure", + "members": { + "DeltaTables": { + "target": "com.amazonaws.glue#PathList", + "traits": { + "smithy.api#documentation": "A list of the Amazon S3 paths to the Delta tables.
" + } + }, + "ConnectionName": { + "target": "com.amazonaws.glue#ConnectionName", + "traits": { + "smithy.api#documentation": "The name of the connection to use to connect to the Delta table target.
" + } + }, + "WriteManifest": { + "target": "com.amazonaws.glue#NullableBoolean", + "traits": { + "smithy.api#documentation": "Specifies whether to write the manifest files to the Delta table path.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies a Delta data store to crawl one or more Delta tables.
" + } + }, + "com.amazonaws.glue#DeltaTargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#DeltaTarget" + } + }, "com.amazonaws.glue#DescriptionString": { "type": "string", "traits": { @@ -11619,6 +11721,256 @@ } } }, + "com.amazonaws.glue#GetUnfilteredPartitionMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetUnfilteredPartitionMetadataRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetUnfilteredPartitionMetadataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#PermissionTypeMismatchException" + } + ] + }, + "com.amazonaws.glue#GetUnfilteredPartitionMetadataRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#required": {} + } + }, + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#required": {} + } + }, + "PartitionValues": { + "target": "com.amazonaws.glue#ValueStringList", + "traits": { + "smithy.api#required": {} + } + }, + "AuditContext": { + "target": "com.amazonaws.glue#AuditContext" + }, + "SupportedPermissionTypes": { + "target": "com.amazonaws.glue#PermissionTypeList", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.glue#GetUnfilteredPartitionMetadataResponse": { + "type": "structure", + "members": { + "Partition": { + "target": "com.amazonaws.glue#Partition" + }, + "AuthorizedColumns": { + "target": "com.amazonaws.glue#NameStringList" + }, + "IsRegisteredWithLakeFormation": { + "target": "com.amazonaws.glue#Boolean" + } + } + }, + "com.amazonaws.glue#GetUnfilteredPartitionsMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetUnfilteredPartitionsMetadataRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetUnfilteredPartitionsMetadataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#PermissionTypeMismatchException" + } + ], + "traits": { + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.glue#GetUnfilteredPartitionsMetadataRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#required": {} + } + }, + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#required": {} + } + }, + "Expression": { + "target": "com.amazonaws.glue#PredicateString" + }, + "AuditContext": { + "target": "com.amazonaws.glue#AuditContext" + }, + "SupportedPermissionTypes": { + "target": "com.amazonaws.glue#PermissionTypeList", + "traits": { + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.glue#Token" + }, + "Segment": { + "target": "com.amazonaws.glue#Segment" + }, + "MaxResults": { + "target": "com.amazonaws.glue#PageSize" + } + } + }, + "com.amazonaws.glue#GetUnfilteredPartitionsMetadataResponse": { + "type": "structure", + "members": { + "UnfilteredPartitions": { + "target": "com.amazonaws.glue#UnfilteredPartitionList" + }, + "NextToken": { + "target": "com.amazonaws.glue#Token" + } + } + }, + "com.amazonaws.glue#GetUnfilteredTableMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.glue#GetUnfilteredTableMetadataRequest" + }, + "output": { + "target": "com.amazonaws.glue#GetUnfilteredTableMetadataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.glue#EntityNotFoundException" + }, + { + "target": "com.amazonaws.glue#GlueEncryptionException" + }, + { + "target": "com.amazonaws.glue#InternalServiceException" + }, + { + "target": "com.amazonaws.glue#InvalidInputException" + }, + { + "target": "com.amazonaws.glue#OperationTimeoutException" + }, + { + "target": "com.amazonaws.glue#PermissionTypeMismatchException" + } + ] + }, + "com.amazonaws.glue#GetUnfilteredTableMetadataRequest": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.glue#CatalogIdString", + "traits": { + "smithy.api#required": {} + } + }, + "DatabaseName": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.glue#NameString", + "traits": { + "smithy.api#required": {} + } + }, + "AuditContext": { + "target": "com.amazonaws.glue#AuditContext" + }, + "SupportedPermissionTypes": { + "target": "com.amazonaws.glue#PermissionTypeList", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.glue#GetUnfilteredTableMetadataResponse": { + "type": "structure", + "members": { + "Table": { + "target": "com.amazonaws.glue#Table" + }, + "AuthorizedColumns": { + "target": "com.amazonaws.glue#NameStringList" + }, + "IsRegisteredWithLakeFormation": { + "target": "com.amazonaws.glue#Boolean" + }, + "CellFilters": { + "target": "com.amazonaws.glue#ColumnRowFilterList" + } + } + }, "com.amazonaws.glue#GetUserDefinedFunction": { "type": "operation", "input": { @@ -13100,6 +13452,17 @@ "smithy.api#documentation": "Specifies configuration properties for a labeling set generation task run.
" } }, + "com.amazonaws.glue#LakeFormationConfiguration": { + "type": "structure", + "members": { + "UseLakeFormationCredentials": { + "target": "com.amazonaws.glue#NullableBoolean" + }, + "AccountId": { + "target": "com.amazonaws.glue#AccountId" + } + } + }, "com.amazonaws.glue#Language": { "type": "string", "traits": { @@ -13981,6 +14344,12 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, + "com.amazonaws.glue#LocationStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#LocationString" + } + }, "com.amazonaws.glue#LogGroup": { "type": "string", "traits": { @@ -15081,6 +15450,44 @@ "target": "com.amazonaws.glue#Permission" } }, + "com.amazonaws.glue#PermissionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "COLUMN_PERMISSION", + "name": "COLUMN_PERMISSION" + }, + { + "value": "CELL_FILTER_PERMISSION", + "name": "CELL_FILTER_PERMISSION" + } + ] + } + }, + "com.amazonaws.glue#PermissionTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#PermissionType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.glue#PermissionTypeMismatchException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.glue#MessageString" + } + }, + "traits": { + "smithy.api#error": "client" + } + }, "com.amazonaws.glue#PhysicalConnectionRequirements": { "type": "structure", "members": { @@ -17860,6 +18267,9 @@ "smithy.api#documentation": "The physical location of the table. By default, this takes the form of the warehouse\n location, followed by the database location in the warehouse, followed by the table\n name.
" } }, + "AdditionalLocations": { + "target": "com.amazonaws.glue#LocationStringList" + }, "InputFormat": { "target": "com.amazonaws.glue#FormatString", "traits": { @@ -19118,6 +19528,26 @@ "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*$" } }, + "com.amazonaws.glue#UnfilteredPartition": { + "type": "structure", + "members": { + "Partition": { + "target": "com.amazonaws.glue#Partition" + }, + "AuthorizedColumns": { + "target": "com.amazonaws.glue#NameStringList" + }, + "IsRegisteredWithLakeFormation": { + "target": "com.amazonaws.glue#Boolean" + } + } + }, + "com.amazonaws.glue#UnfilteredPartitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.glue#UnfilteredPartition" + } + }, "com.amazonaws.glue#UntagResource": { "type": "operation", "input": { @@ -19626,6 +20056,9 @@ "smithy.api#documentation": "Specifies data lineage configuration settings for the crawler.
" } }, + "LakeFormationConfiguration": { + "target": "com.amazonaws.glue#LakeFormationConfiguration" + }, "Configuration": { "target": "com.amazonaws.glue#CrawlerConfiguration", "traits": { diff --git a/codegen/sdk/aws-models/greengrassv2.2020-11-30.json b/codegen/sdk/aws-models/greengrassv2.2020-11-30.json index 8b7b51a59f5..4305dcc48dc 100644 --- a/codegen/sdk/aws-models/greengrassv2.2020-11-30.json +++ b/codegen/sdk/aws-models/greengrassv2.2020-11-30.json @@ -110,6 +110,56 @@ } } }, + "com.amazonaws.greengrassv2#AssociateServiceRoleToAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#AssociateServiceRoleToAccountRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#AssociateServiceRoleToAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Associates a Greengrass service role with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. IoT Greengrass\n uses this role to verify the identity of client devices and manage core device connectivity\n information. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy or a custom policy that\n defines equivalent permissions for the IoT Greengrass features that you use. For more information, see\n Greengrass service role in the IoT Greengrass Version 2 Developer Guide.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/greengrass/servicerole", + "code": 200 + } + } + }, + "com.amazonaws.greengrassv2#AssociateServiceRoleToAccountRequest": { + "type": "structure", + "members": { + "roleArn": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service role to associate with IoT Greengrass for your\n Amazon Web Services account in this Amazon Web Services Region.
", + "smithy.api#jsonName": "RoleArn", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#AssociateServiceRoleToAccountResponse": { + "type": "structure", + "members": { + "associatedAt": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "The time when the service role was associated with IoT Greengrass for your Amazon Web Services account in this\n Amazon Web Services Region.
", + "smithy.api#jsonName": "AssociatedAt" + } + } + } + }, "com.amazonaws.greengrassv2#AssociatedClientDevice": { "type": "structure", "members": { @@ -168,7 +218,7 @@ } ], "traits": { - "smithy.api#documentation": "Associate a list of client devices with a core device. Use this API operation to specify\n which client devices can discover a core device through cloud discovery. With cloud discovery,\n client devices connect to IoT Greengrass to retrieve associated core devices' connectivity information\n and certificates. For more information, see Configure cloud\n discovery in the IoT Greengrass V2 Developer Guide.
\n \nClient devices are local IoT devices that connect to and communicate with an IoT Greengrass core\n device over MQTT. You can connect client devices to a core device to sync MQTT messages and\n data to Amazon Web Services IoT Core and interact with client devices in Greengrass components. For more information,\n see Interact with\n local IoT devices in the IoT Greengrass V2 Developer Guide.
\nAssociates a list of client devices with a core device. Use this API operation to specify\n which client devices can discover a core device through cloud discovery. With cloud discovery,\n client devices connect to IoT Greengrass to retrieve associated core devices' connectivity information\n and certificates. For more information, see Configure cloud\n discovery in the IoT Greengrass V2 Developer Guide.
\n \nClient devices are local IoT devices that connect to and communicate with an IoT Greengrass core\n device over MQTT. You can connect client devices to a core device to sync MQTT messages and\n data to Amazon Web Services IoT Core and interact with client devices in Greengrass components. For more information,\n see Interact with\n local IoT devices in the IoT Greengrass V2 Developer Guide.
\nDisassociate a list of client devices from a core device. After you disassociate a client\n device from a core device, the client device won't be able to use cloud discovery to retrieve\n the core device's connectivity information and certificates.
", + "smithy.api#documentation": "Disassociates a list of client devices from a core device. After you disassociate a client\n device from a core device, the client device won't be able to use cloud discovery to retrieve\n the core device's connectivity information and certificates.
", "smithy.api#http": { "method": "POST", "uri": "/greengrass/v2/coreDevices/{coreDeviceThingName}/disassociateClientDevices", @@ -265,7 +315,7 @@ "errorEntries": { "target": "com.amazonaws.greengrassv2#DisassociateClientDeviceFromCoreDeviceErrorList", "traits": { - "smithy.api#documentation": "The list of errors (if any) for the entries in the request. Each error entry contains the\n name of the IoT thing that failed to disassociate.
" + "smithy.api#documentation": "The list of any errors for the entries in the request. Each error entry contains the name\n of the IoT thing that failed to disassociate.
" } } } @@ -803,6 +853,42 @@ "smithy.api#httpError": 409 } }, + "com.amazonaws.greengrassv2#ConnectivityInfo": { + "type": "structure", + "members": { + "id": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "An ID for the connectivity information.
", + "smithy.api#jsonName": "Id" + } + }, + "hostAddress": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "The IP address or DNS address where client devices can connect to an MQTT broker on the\n Greengrass core device.
", + "smithy.api#jsonName": "HostAddress" + } + }, + "portNumber": { + "target": "com.amazonaws.greengrassv2#PortNumberInt", + "traits": { + "smithy.api#documentation": "The port where the MQTT broker operates on the core device. This port is typically 8883,\n which is the default port for the MQTT broker component that runs on core devices.
", + "smithy.api#jsonName": "PortNumber" + } + }, + "metadata": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "Additional metadata to provide to client devices that connect to this core device.
", + "smithy.api#jsonName": "Metadata" + } + } + }, + "traits": { + "smithy.api#documentation": "Contains information about an endpoint and port where client devices can connect to an\n MQTT broker on a Greengrass core device.
" + } + }, "com.amazonaws.greengrassv2#CoreDevice": { "type": "structure", "members": { @@ -815,7 +901,7 @@ "status": { "target": "com.amazonaws.greengrassv2#CoreDeviceStatus", "traits": { - "smithy.api#documentation": "The status of the core device. Core devices can have the following statuses:
\n\n HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.
\n UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state\n on the core device.
The status of the core device. Core devices can have the following\n statuses:
\n\n HEALTHY – The IoT Greengrass Core software and all components run on the core device without issue.
\n UNHEALTHY – The IoT Greengrass Core software or a component is in a failed state\n on the core device.
Disassociates the Greengrass service role from IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.\n Without a service role, IoT Greengrass can't verify the identity of client devices or manage core device\n connectivity information. For more information, see Greengrass service role in\n the IoT Greengrass Version 2 Developer Guide.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/greengrass/servicerole", + "code": 200 + } + } + }, + "com.amazonaws.greengrassv2#DisassociateServiceRoleFromAccountRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.greengrassv2#DisassociateServiceRoleFromAccountResponse": { + "type": "structure", + "members": { + "disassociatedAt": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "The time when the service role was disassociated from IoT Greengrass for your Amazon Web Services account in this\n Amazon Web Services Region.
", + "smithy.api#jsonName": "DisassociatedAt" + } + } + } + }, "com.amazonaws.greengrassv2#EffectiveDeployment": { "type": "structure", "members": { @@ -1882,6 +2006,63 @@ } } }, + "com.amazonaws.greengrassv2#GetConnectivityInfo": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#GetConnectivityInfoRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#GetConnectivityInfoResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Retrieves connectivity information for a Greengrass core device.
\nConnectivity information includes endpoints and ports where client devices\n can connect to an MQTT broker on the core device. When a client device\n calls the Greengrass discovery API,\n IoT Greengrass returns connectivity information for all of the core devices where the client device can\n connect. For more information, see Connect client devices to\n core devices in the IoT Greengrass Version 2 Developer Guide.
", + "smithy.api#http": { + "method": "GET", + "uri": "/greengrass/things/{thingName}/connectivityInfo", + "code": 200 + } + } + }, + "com.amazonaws.greengrassv2#GetConnectivityInfoRequest": { + "type": "structure", + "members": { + "thingName": { + "target": "com.amazonaws.greengrassv2#CoreDeviceThingName", + "traits": { + "smithy.api#documentation": "The name of the core device. This is also the name of the IoT thing.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#GetConnectivityInfoResponse": { + "type": "structure", + "members": { + "connectivityInfo": { + "target": "com.amazonaws.greengrassv2#connectivityInfoList", + "traits": { + "smithy.api#documentation": "The connectivity information for the core device.
", + "smithy.api#jsonName": "ConnectivityInfo" + } + }, + "message": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "A message about the connectivity information request.
", + "smithy.api#jsonName": "Message" + } + } + } + }, "com.amazonaws.greengrassv2#GetCoreDevice": { "type": "operation", "input": { @@ -2106,6 +2287,51 @@ } } }, + "com.amazonaws.greengrassv2#GetServiceRoleForAccount": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#GetServiceRoleForAccountRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#GetServiceRoleForAccountResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + } + ], + "traits": { + "smithy.api#documentation": "Gets the service role associated with IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.\n IoT Greengrass uses this role to verify the identity of client devices and manage core device\n connectivity information. For more information, see Greengrass service role in\n the IoT Greengrass Version 2 Developer Guide.
", + "smithy.api#http": { + "method": "GET", + "uri": "/greengrass/servicerole", + "code": 200 + } + } + }, + "com.amazonaws.greengrassv2#GetServiceRoleForAccountRequest": { + "type": "structure", + "members": {} + }, + "com.amazonaws.greengrassv2#GetServiceRoleForAccountResponse": { + "type": "structure", + "members": { + "associatedAt": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "The time when the service role was associated with IoT Greengrass for your Amazon Web Services account in this\n Amazon Web Services Region.
", + "smithy.api#jsonName": "AssociatedAt" + } + }, + "roleArn": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "The ARN of the service role that is associated with IoT Greengrass for your Amazon Web Services account in this\n Amazon Web Services Region.
", + "smithy.api#jsonName": "RoleArn" + } + } + } + }, "com.amazonaws.greengrassv2#GreengrassV2": { "type": "service", "traits": { @@ -2125,6 +2351,9 @@ }, "version": "2020-11-30", "operations": [ + { + "target": "com.amazonaws.greengrassv2#AssociateServiceRoleToAccount" + }, { "target": "com.amazonaws.greengrassv2#BatchAssociateClientDeviceWithCoreDevice" }, @@ -2149,18 +2378,27 @@ { "target": "com.amazonaws.greengrassv2#DescribeComponent" }, + { + "target": "com.amazonaws.greengrassv2#DisassociateServiceRoleFromAccount" + }, { "target": "com.amazonaws.greengrassv2#GetComponent" }, { "target": "com.amazonaws.greengrassv2#GetComponentVersionArtifact" }, + { + "target": "com.amazonaws.greengrassv2#GetConnectivityInfo" + }, { "target": "com.amazonaws.greengrassv2#GetCoreDevice" }, { "target": "com.amazonaws.greengrassv2#GetDeployment" }, + { + "target": "com.amazonaws.greengrassv2#GetServiceRoleForAccount" + }, { "target": "com.amazonaws.greengrassv2#ListClientDevicesAssociatedWithCoreDevice" }, @@ -2193,6 +2431,9 @@ }, { "target": "com.amazonaws.greengrassv2#UntagResource" + }, + { + "target": "com.amazonaws.greengrassv2#UpdateConnectivityInfo" } ] }, @@ -3624,6 +3865,15 @@ "target": "com.amazonaws.greengrassv2#NonEmptyString" } }, + "com.amazonaws.greengrassv2#PortNumberInt": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 65535 + } + } + }, "com.amazonaws.greengrassv2#PublisherString": { "type": "string" }, @@ -4080,6 +4330,72 @@ "type": "structure", "members": {} }, + "com.amazonaws.greengrassv2#UpdateConnectivityInfo": { + "type": "operation", + "input": { + "target": "com.amazonaws.greengrassv2#UpdateConnectivityInfoRequest" + }, + "output": { + "target": "com.amazonaws.greengrassv2#UpdateConnectivityInfoResponse" + }, + "errors": [ + { + "target": "com.amazonaws.greengrassv2#InternalServerException" + }, + { + "target": "com.amazonaws.greengrassv2#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Updates connectivity information for a Greengrass core device.
\nConnectivity information includes endpoints and ports where client devices\n can connect to an MQTT broker on the core device. When a client device\n calls the Greengrass discovery API,\n IoT Greengrass returns connectivity information for all of the core devices where the client device can\n connect. For more information, see Connect client devices to\n core devices in the IoT Greengrass Version 2 Developer Guide.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/greengrass/things/{thingName}/connectivityInfo", + "code": 200 + } + } + }, + "com.amazonaws.greengrassv2#UpdateConnectivityInfoRequest": { + "type": "structure", + "members": { + "thingName": { + "target": "com.amazonaws.greengrassv2#CoreDeviceThingName", + "traits": { + "smithy.api#documentation": "The name of the core device. This is also the name of the IoT thing.
", + "smithy.api#httpLabel": {}, + "smithy.api#jsonName": "ThingName", + "smithy.api#required": {} + } + }, + "connectivityInfo": { + "target": "com.amazonaws.greengrassv2#connectivityInfoList", + "traits": { + "smithy.api#documentation": "The connectivity information for the core device.
", + "smithy.api#jsonName": "ConnectivityInfo", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.greengrassv2#UpdateConnectivityInfoResponse": { + "type": "structure", + "members": { + "version": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "The new version of the connectivity information for the core device.
", + "smithy.api#jsonName": "Version" + } + }, + "message": { + "target": "com.amazonaws.greengrassv2#String", + "traits": { + "smithy.api#documentation": "A message about the connectivity information update request.
", + "smithy.api#jsonName": "Message" + } + } + } + }, "com.amazonaws.greengrassv2#ValidationException": { "type": "structure", "members": { @@ -4158,6 +4474,12 @@ } ] } + }, + "com.amazonaws.greengrassv2#connectivityInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.greengrassv2#ConnectivityInfo" + } } } } diff --git a/codegen/sdk/aws-models/imagebuilder.2019-12-02.json b/codegen/sdk/aws-models/imagebuilder.2019-12-02.json index f6285fd1f3d..1eee9f9140a 100644 --- a/codegen/sdk/aws-models/imagebuilder.2019-12-02.json +++ b/codegen/sdk/aws-models/imagebuilder.2019-12-02.json @@ -174,6 +174,25 @@ "com.amazonaws.imagebuilder#Boolean": { "type": "boolean" }, + "com.amazonaws.imagebuilder#BuildType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "USER_INITIATED", + "name": "USER_INITIATED" + }, + { + "value": "SCHEDULED", + "name": "SCHEDULED" + }, + { + "value": "IMPORT", + "name": "IMPORT" + } + ] + } + }, "com.amazonaws.imagebuilder#CallRateLimitExceededException": { "type": "structure", "members": { @@ -243,7 +262,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
", + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.
", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } @@ -262,7 +281,7 @@ "clientToken": { "target": "com.amazonaws.imagebuilder#ClientToken", "traits": { - "smithy.api#documentation": "The idempotency token used to make this request idempotent.
" + "smithy.api#documentation": "The idempotency token that was used for this request.
" } }, "imageBuildVersionArn": { @@ -2018,7 +2037,7 @@ "snsTopicArn": { "target": "com.amazonaws.imagebuilder#SnsTopicArn", "traits": { - "smithy.api#documentation": "The SNS topic on which to send image build events.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.
\n\t\tEC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys \n\t\t\t\tfrom other accounts. The key that is used to encrypt the SNS topic must reside in the \n\t\t\t\taccount that the Image Builder service runs under.
\n\t\tA group of launchTemplateConfiguration settings that apply to image distribution \n\t\t\tfor specified accounts.
" } + }, + "s3ExportConfiguration": { + "target": "com.amazonaws.imagebuilder#S3ExportConfiguration", + "traits": { + "smithy.api#documentation": "Configure export settings to deliver disk images created from your image build, \n\t\t\tusing a file format that is compatible with your VMs in that Region.
" + } } }, "traits": { @@ -3826,6 +3870,12 @@ "traits": { "smithy.api#documentation": "The tags of the image.
" } + }, + "buildType": { + "target": "com.amazonaws.imagebuilder#BuildType", + "traits": { + "smithy.api#documentation": "Indicates the type of build that created this image. The build can be initiated \n\t\t\tin the following ways:
\n\t\t\n USER_INITIATED – A manual \n\t\t\t\t\tpipeline build request.
\n\t\t\t\n SCHEDULED – A pipeline build \n\t\t\t\t\tinitiated by a cron expression in the Image Builder pipeline, or from EventBridge.
\n\t\t\t\n IMPORT – A VM import created \n\t\t\t\t\tthe image to use as the base image for the recipe.
\n\t\t\tThe tags of the image.
" } + }, + "buildType": { + "target": "com.amazonaws.imagebuilder#BuildType", + "traits": { + "smithy.api#documentation": "Indicates the type of build that created this image. The build can be initiated \n\t\t\tin the following ways:
\n\t\t\n USER_INITIATED – A manual \n\t\t\t\t\tpipeline build request.
\n\t\t\t\n SCHEDULED – A pipeline build \n\t\t\t\t\tinitiated by a cron expression in the Image Builder pipeline, or from EventBridge.
\n\t\t\t\n IMPORT – A VM import created \n\t\t\t\t\tthe image to use as the base image for the recipe.
\n\t\t\tDefines if tests should be executed when building this image.
" + "smithy.api#documentation": "Determines if tests should run after building the image. Image Builder defaults \n\t\t\tto enable tests to run following the image build, before image distribution.
" } }, "timeoutMinutes": { @@ -4314,7 +4370,7 @@ } }, "traits": { - "smithy.api#documentation": "Image tests configuration.
" + "smithy.api#documentation": "Configure image tests for your pipeline build. Tests run after building \n\t\t\tthe image, to verify that the AMI or container image is valid before \n\t\t\tdistributing it.
" } }, "com.amazonaws.imagebuilder#ImageTestsTimeoutMinutes": { @@ -4392,6 +4448,12 @@ "traits": { "smithy.api#documentation": "The date on which this specific version of the Image Builder image was created.
" } + }, + "buildType": { + "target": "com.amazonaws.imagebuilder#BuildType", + "traits": { + "smithy.api#documentation": "Indicates the type of build that created this image. The build can be initiated \n\t\t\tin the following ways:
\n\t\t\n USER_INITIATED – A manual \n\t\t\t\t\tpipeline build request.
\n\t\t\t\n SCHEDULED – A pipeline build \n\t\t\t\t\tinitiated by a cron expression in the Image Builder pipeline, or from EventBridge.
\n\t\t\t\n IMPORT – A VM import created \n\t\t\t\t\tthe image to use as the base image for the recipe.
\n\t\t\tWhen you export your virtual machine (VM) from its virtualization environment, \n\t\t\tthat process creates a set of one or more disk container files that act as \n\t\t\tsnapshots of your VM’s environment, settings, and data. The Amazon EC2 API \n\t\t\tImportImage \n\t\t\taction uses those files to import your VM and create an AMI. To import using the \n\t\t\tCLI command, see import-image\n\t\t
\n\t\tYou can reference the task ID from the VM import to pull in the AMI that \n\t\t\tthe import created as the base image for your Image Builder recipe.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/ImportVmImage", + "code": 200 + } + } + }, + "com.amazonaws.imagebuilder#ImportVmImageRequest": { + "type": "structure", + "members": { + "name": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "The name of the base image that is created by the import process.
", + "smithy.api#required": {} + } + }, + "semanticVersion": { + "target": "com.amazonaws.imagebuilder#VersionNumber", + "traits": { + "smithy.api#documentation": "The semantic version to attach to the base image that was created during the \n\t\t\timport process. This version follows the semantic version syntax.
\n\t\tThe semantic version has four nodes:
\n Assignment: For the first three nodes you can assign any positive integer value, including \n\tzero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the \n\tbuild number to the fourth node.
\n\t\t\t\n Patterns: You can use any numeric pattern that adheres to the assignment requirements for \n\tthe nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or \n\ta date, such as 2021.01.01.
\n\t\tThe description for the base image that is created by the import process.
" + } + }, + "platform": { + "target": "com.amazonaws.imagebuilder#Platform", + "traits": { + "smithy.api#documentation": "The operating system platform for the imported VM.
", + "smithy.api#required": {} + } + }, + "osVersion": { + "target": "com.amazonaws.imagebuilder#OsVersion", + "traits": { + "smithy.api#documentation": "The operating system version for the imported VM.
" + } + }, + "vmImportTaskId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "The importTaskId (API) or ImportTaskId (CLI) from the \n\t\t\tAmazon EC2 VM import process. Image Builder retrieves information from the import process to pull \n\t\t\tin the AMI that is created from the VM source as the base image for your recipe.
Tags that are attached to the import resources.
" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "Unique, case-sensitive identifier you provide to ensure\n idempotency of the request. For more information, see Ensuring idempotency \n in the Amazon EC2 API Reference.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.imagebuilder#ImportVmImageResponse": { + "type": "structure", + "members": { + "requestId": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "The request ID that uniquely identifies this request.
" + } + }, + "imageArn": { + "target": "com.amazonaws.imagebuilder#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AMI that was created during the VM \n\t\t\timport process. This AMI is used as the base image for the recipe that \n\t\t\timported the VM.
" + } + }, + "clientToken": { + "target": "com.amazonaws.imagebuilder#ClientToken", + "traits": { + "smithy.api#documentation": "The idempotency token that was used for this request.
" + } + } + } + }, "com.amazonaws.imagebuilder#InfrastructureConfiguration": { "type": "structure", "members": { @@ -4638,7 +4810,7 @@ "snsTopicArn": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "The SNS topic Amazon Resource Name (ARN) of the infrastructure configuration.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.
\n\t\tEC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys \n\t\t\t\tfrom other accounts. The key that is used to encrypt the SNS topic must reside in the \n\t\t\t\taccount that the Image Builder service runs under.
\n\t\tThe name of the role that grants VM Import/Export permission to \n\t\t\texport images to your S3 bucket.
", + "smithy.api#required": {} + } + }, + "diskImageFormat": { + "target": "com.amazonaws.imagebuilder#DiskImageFormat", + "traits": { + "smithy.api#documentation": "Export the updated image to one of the following supported disk \n\t\t\timage formats:
\n\t\t\n Virtual Hard Disk (VHD) – \n\t\t\t\t\tCompatible with Citrix Xen and Microsoft Hyper-V virtualization products.
\n\t\t\t\n Stream-optimized ESX Virtual Machine Disk \n\t\t\t\t\t(VMDK) – Compatible with VMware ESX and \n\t\t\t\t\tVMware vSphere versions 4, 5, and 6.
\n\t\t\t\n Raw – Raw format.
\n\t\t\tThe S3 bucket in which to store the output disk images for your VM.
", + "smithy.api#required": {} + } + }, + "s3Prefix": { + "target": "com.amazonaws.imagebuilder#NonEmptyString", + "traits": { + "smithy.api#documentation": "The Amazon S3 path for the bucket where the output disk images for your VM are stored.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Properties that configure export from your build instance \n\t\t\tto a compatible file format for your VM.
" + } + }, "com.amazonaws.imagebuilder#S3Logs": { "type": "structure", "members": { "s3BucketName": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "The Amazon S3 bucket in which to store the logs.
" + "smithy.api#documentation": "The S3 bucket in which to store the logs.
" } }, "s3KeyPrefix": { "target": "com.amazonaws.imagebuilder#NonEmptyString", "traits": { - "smithy.api#documentation": "The Amazon S3 path in which to store the logs.
" + "smithy.api#documentation": "The Amazon S3 path to the bucket where the logs are stored.
" } } }, @@ -7496,7 +7703,7 @@ "snsTopicArn": { "target": "com.amazonaws.imagebuilder#SnsTopicArn", "traits": { - "smithy.api#documentation": "The SNS topic on which to send image build events.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the SNS topic to which we send image build event notifications.
\n\t\tEC2 Image Builder is unable to send notifications to SNS topics that are encrypted using keys \n\t\t\t\tfrom other accounts. The key that is used to encrypt the SNS topic must reside in the \n\t\t\t\taccount that the Image Builder service runs under.
\n\t\tAllows you to create criteria to abort a job.
" + "smithy.api#documentation": "Allows you to create the criteria to abort a job.
" } }, "timeoutConfig": { @@ -5844,6 +5844,12 @@ "smithy.api#documentation": "The ARN of the job template used to create the job.
" } }, + "jobExecutionsRetryConfig": { + "target": "com.amazonaws.iot#JobExecutionsRetryConfig", + "traits": { + "smithy.api#documentation": "Allows you to create the criteria to retry a job.
" + } + }, "documentParameters": { "target": "com.amazonaws.iot#ParameterMap", "traits": { @@ -5965,6 +5971,12 @@ "traits": { "smithy.api#documentation": "Metadata that can be used to manage the job template.
" } + }, + "jobExecutionsRetryConfig": { + "target": "com.amazonaws.iot#JobExecutionsRetryConfig", + "traits": { + "smithy.api#documentation": "Allows you to create the criteria to retry a job.
" + } } } }, @@ -11146,6 +11158,12 @@ }, "timeoutConfig": { "target": "com.amazonaws.iot#TimeoutConfig" + }, + "jobExecutionsRetryConfig": { + "target": "com.amazonaws.iot#JobExecutionsRetryConfig", + "traits": { + "smithy.api#documentation": "The configuration that determines how many retries are allowed for each failure type\n for a job.
" + } } } }, @@ -15882,6 +15900,12 @@ "smithy.api#documentation": "The ARN of the job template used to create the job.
" } }, + "jobExecutionsRetryConfig": { + "target": "com.amazonaws.iot#JobExecutionsRetryConfig", + "traits": { + "smithy.api#documentation": "The configuration for the criteria to retry the job.
" + } + }, "documentParameters": { "target": "com.amazonaws.iot#ParameterMap", "traits": { @@ -16106,6 +16130,12 @@ "traits": { "smithy.api#documentation": "A string (consisting of the digits \"0\" through \"9\") which identifies this particular job execution on\n this particular device. It can be used later in commands which return or update job execution\n information.
" } + }, + "retryAttempt": { + "target": "com.amazonaws.iot#RetryAttempt", + "traits": { + "smithy.api#documentation": "The number that indicates how many retry attempts have been completed for this \n job on this device.
" + } } }, "traits": { @@ -16164,6 +16194,21 @@ "target": "com.amazonaws.iot#JobExecutionSummaryForThing" } }, + "com.amazonaws.iot#JobExecutionsRetryConfig": { + "type": "structure", + "members": { + "criteriaList": { + "target": "com.amazonaws.iot#RetryCriteriaList", + "traits": { + "smithy.api#documentation": "The list of criteria that determines how many retries are allowed for each failure\n type for a job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The configuration that determines how many retries are allowed for each failure \n type for a job.
" + } + }, "com.amazonaws.iot#JobExecutionsRolloutConfig": { "type": "structure", "members": { @@ -18435,6 +18480,13 @@ "smithy.api#documentation": "The token to retrieve the next set of results.
", "smithy.api#httpQuery": "nextToken" } + }, + "jobId": { + "target": "com.amazonaws.iot#JobId", + "traits": { + "smithy.api#documentation": "The unique identifier you assigned to this job when it was created.
", + "smithy.api#httpQuery": "jobId" + } } } }, @@ -22174,6 +22226,16 @@ "target": "com.amazonaws.iot#Number" } }, + "com.amazonaws.iot#NumberOfRetries": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 10 + } + } + }, "com.amazonaws.iot#NumberOfThings": { "type": "integer", "traits": { @@ -24276,6 +24338,65 @@ "target": "com.amazonaws.iot#Resource" } }, + "com.amazonaws.iot#RetryAttempt": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.iot#RetryCriteria": { + "type": "structure", + "members": { + "failureType": { + "target": "com.amazonaws.iot#RetryableFailureType", + "traits": { + "smithy.api#documentation": "The type of job execution failures that can initiate a job retry.
", + "smithy.api#required": {} + } + }, + "numberOfRetries": { + "target": "com.amazonaws.iot#NumberOfRetries", + "traits": { + "smithy.api#documentation": "The number of retries allowed for a failure type for the job.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The criteria that determines how many retries are allowed for each failure\n type for a job.
" + } + }, + "com.amazonaws.iot#RetryCriteriaList": { + "type": "list", + "member": { + "target": "com.amazonaws.iot#RetryCriteria" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.iot#RetryableFailureType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "TIMED_OUT", + "name": "TIMED_OUT" + }, + { + "value": "ALL", + "name": "ALL" + } + ] + } + }, "com.amazonaws.iot#RoleAlias": { "type": "string", "traits": { @@ -29142,6 +29263,12 @@ "smithy.api#documentation": "The namespace used to indicate that a job is a customer-managed job.
\nWhen you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that \n contain the value in the following format.
\n\n $aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/\n
The namespaceId feature is in public preview.
Allows you to create the criteria to retry a job.
" + } } } }, diff --git a/codegen/sdk/aws-models/iotwireless.2020-11-22.json b/codegen/sdk/aws-models/iotwireless.2020-11-22.json index ec91da5ae10..d88e65bbb83 100644 --- a/codegen/sdk/aws-models/iotwireless.2020-11-22.json +++ b/codegen/sdk/aws-models/iotwireless.2020-11-22.json @@ -1793,6 +1793,72 @@ "type": "structure", "members": {} }, + "com.amazonaws.iotwireless#DeleteQueuedMessages": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#DeleteQueuedMessagesRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#DeleteQueuedMessagesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "The operation to delete queued messages.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/wireless-devices/{Id}/data", + "code": 204 + } + } + }, + "com.amazonaws.iotwireless#DeleteQueuedMessagesRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessDeviceId", + "traits": { + "smithy.api#documentation": "Id of a given wireless device which messages will be deleted
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MessageId": { + "target": "com.amazonaws.iotwireless#MessageId", + "traits": { + "smithy.api#documentation": "if messageID==\"*\", the queue for a particular wireless deviceId will be purged, otherwise, the specific message with messageId will be deleted
", + "smithy.api#httpQuery": "messageId", + "smithy.api#required": {} + } + }, + "WirelessDeviceType": { + "target": "com.amazonaws.iotwireless#WirelessDeviceType", + "traits": { + "smithy.api#documentation": "The wireless device type, it is either Sidewalk or LoRaWAN.
", + "smithy.api#httpQuery": "WirelessDeviceType" + } + } + } + }, + "com.amazonaws.iotwireless#DeleteQueuedMessagesResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.iotwireless#DeleteServiceProfile": { "type": "operation", "input": { @@ -2712,6 +2778,41 @@ "smithy.api#box": {} } }, + "com.amazonaws.iotwireless#DownlinkQueueMessage": { + "type": "structure", + "members": { + "MessageId": { + "target": "com.amazonaws.iotwireless#MessageId", + "traits": { + "smithy.api#documentation": "The messageId allocated by IoT Wireless for tracing purpose
" + } + }, + "TransmitMode": { + "target": "com.amazonaws.iotwireless#TransmitMode", + "traits": { + "smithy.api#documentation": "The transmit mode to use to send data to the wireless device. Can be: 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode).
The timestamp that Iot Wireless received the message.
" + } + }, + "LoRaWAN": { + "target": "com.amazonaws.iotwireless#LoRaWANSendDataToDevice" + } + }, + "traits": { + "smithy.api#documentation": "The message in downlink queue.
" + } + }, + "com.amazonaws.iotwireless#DownlinkQueueMessagesList": { + "type": "list", + "member": { + "target": "com.amazonaws.iotwireless#DownlinkQueueMessage" + } + }, "com.amazonaws.iotwireless#DrMax": { "type": "integer", "traits": { @@ -5042,6 +5143,96 @@ } } }, + "com.amazonaws.iotwireless#ListQueuedMessages": { + "type": "operation", + "input": { + "target": "com.amazonaws.iotwireless#ListQueuedMessagesRequest" + }, + "output": { + "target": "com.amazonaws.iotwireless#ListQueuedMessagesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.iotwireless#AccessDeniedException" + }, + { + "target": "com.amazonaws.iotwireless#InternalServerException" + }, + { + "target": "com.amazonaws.iotwireless#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.iotwireless#ThrottlingException" + }, + { + "target": "com.amazonaws.iotwireless#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "The operation to list queued messages.
", + "smithy.api#http": { + "method": "GET", + "uri": "/wireless-devices/{Id}/data", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.iotwireless#ListQueuedMessagesRequest": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.iotwireless#WirelessDeviceId", + "traits": { + "smithy.api#documentation": "Id of a given wireless device which the downlink packets are targeted
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The maximum number of results to return in this operation.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "WirelessDeviceType": { + "target": "com.amazonaws.iotwireless#WirelessDeviceType", + "traits": { + "smithy.api#documentation": "The wireless device type, it is either Sidewalk or LoRaWAN.
", + "smithy.api#httpQuery": "WirelessDeviceType" + } + } + } + }, + "com.amazonaws.iotwireless#ListQueuedMessagesResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.iotwireless#NextToken", + "traits": { + "smithy.api#documentation": "To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
The messages in downlink queue.
" + } + } + } + }, "com.amazonaws.iotwireless#ListServiceProfiles": { "type": "operation", "input": { @@ -9268,7 +9459,7 @@ "name": "iotwireless" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "AWS IoT Wireless API documentation
", + "smithy.api#documentation": "AWS IoT Wireless provides bi-directional communication between internet-connected wireless\n\t devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS IoT, use the \n\t IoT Wireless API. These wireless devices use the Low Power Wide Area Networking (LPWAN) \n\t communication protocol to communicate with AWS IoT.
\n\tUsing the API, you can perform create, read, update, and delete operations for your wireless\n\t devices, gateways, destinations, and profiles. After onboarding your devices, you \n\t can use the API operations to set log levels and monitor your devices with CloudWatch.
\n\tYou can also use the API operations to create multicast groups and schedule a multicast session for\n\t sending a downlink message to devices in the group. By using Firmware Updates Over-The-Air\n\t (FUOTA) API operations, you can create a FUOTA task and schedule a session to update the firmware\n\t of individual devices or an entire group of devices in a multicast group.
", "smithy.api#title": "AWS IoT Wireless" }, "version": "2020-11-22", @@ -9336,6 +9527,9 @@ { "target": "com.amazonaws.iotwireless#DeleteMulticastGroup" }, + { + "target": "com.amazonaws.iotwireless#DeleteQueuedMessages" + }, { "target": "com.amazonaws.iotwireless#DeleteServiceProfile" }, @@ -9450,6 +9644,9 @@ { "target": "com.amazonaws.iotwireless#ListPartnerAccounts" }, + { + "target": "com.amazonaws.iotwireless#ListQueuedMessages" + }, { "target": "com.amazonaws.iotwireless#ListServiceProfiles" }, diff --git a/codegen/sdk/aws-models/lakeformation.2017-03-31.json b/codegen/sdk/aws-models/lakeformation.2017-03-31.json index e1563a317bb..20b8a326776 100644 --- a/codegen/sdk/aws-models/lakeformation.2017-03-31.json +++ b/codegen/sdk/aws-models/lakeformation.2017-03-31.json @@ -111,6 +111,12 @@ { "target": "com.amazonaws.lakeformation#GetTableObjects" }, + { + "target": "com.amazonaws.lakeformation#GetTemporaryGluePartitionCredentials" + }, + { + "target": "com.amazonaws.lakeformation#GetTemporaryGlueTableCredentials" + }, { "target": "com.amazonaws.lakeformation#GetWorkUnitResults" }, @@ -192,6 +198,9 @@ "smithy.api#httpError": 403 } }, + "com.amazonaws.lakeformation#AccessKeyIdString": { + "type": "string" + }, "com.amazonaws.lakeformation#AddLFTagsToResource": { "type": "operation", "input": { @@ -322,6 +331,36 @@ "smithy.api#error": "client" } }, + "com.amazonaws.lakeformation#AuditContext": { + "type": "structure", + "members": { + "AdditionalAuditContext": { + "target": "com.amazonaws.lakeformation#AuditContextString", + "traits": { + "smithy.api#documentation": "The filter engine can populate the 'AdditionalAuditContext' information with the request ID for you to track. This information will be displayed in CloudTrail log in your account.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A structure used to include auditing information on the privileged API.
" + } + }, + "com.amazonaws.lakeformation#AuditContextString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#pattern": "^[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*$" + } + }, + "com.amazonaws.lakeformation#AuthorizedSessionTagValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.lakeformation#NameString" + } + }, "com.amazonaws.lakeformation#BatchGrantPermissions": { "type": "operation", "input": { @@ -874,6 +913,16 @@ "type": "structure", "members": {} }, + "com.amazonaws.lakeformation#CredentialTimeoutDurationSecondInteger": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 900, + "max": 43200 + } + } + }, "com.amazonaws.lakeformation#DataCellsFilter": { "type": "structure", "members": { @@ -920,7 +969,7 @@ "ColumnWildcard": { "target": "com.amazonaws.lakeformation#ColumnWildcard", "traits": { - "smithy.api#documentation": "A wildcard with exclusions.
" + "smithy.api#documentation": "A wildcard with exclusions.
\n \nYou must specify either a ColumnNames list or the\n ColumnWildCard.
The AWS Lake Formation principal. Supported principals are IAM users or IAM roles.
" + "smithy.api#documentation": "The Lake Formation principal. Supported principals are IAM users\n or IAM roles.
" } }, "com.amazonaws.lakeformation#DataLakePrincipalList": { @@ -1066,6 +1115,24 @@ "traits": { "smithy.api#documentation": "A list of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). The user ARNs can be logged in the resource owner's CloudTrail log.
\n\t\n\tYou may want to specify this property when you are in a high-trust boundary, such as the same team or company.
" } + }, + "AllowExternalDataFiltering": { + "target": "com.amazonaws.lakeformation#NullableBoolean", + "traits": { + "smithy.api#documentation": "Whether to allow Amazon EMR clusters to access data managed by Lake Formation.
\n\t\nIf true, you allow Amazon EMR clusters to access data in Amazon S3 locations that are registered with Lake Formation.
\n\t\nIf false or null, no Amazon EMR clusters will be able to access data in Amazon S3 locations that are registered with Lake Formation.
\n \nFor more information, see (Optional) Allow Data Filtering on Amazon EMR.
" + } + }, + "ExternalDataFilteringAllowList": { + "target": "com.amazonaws.lakeformation#DataLakePrincipalList", + "traits": { + "smithy.api#documentation": "A list of the account IDs of Amazon Web Services accounts with Amazon EMR clusters that are to perform data filtering.>
" + } + }, + "AuthorizedSessionTagValueList": { + "target": "com.amazonaws.lakeformation#AuthorizedSessionTagValueList", + "traits": { + "smithy.api#documentation": "Lake Formation relies on a privileged process secured by Amazon EMR or the third party integrator to tag the user's role while assuming it. Lake Formation will publish the acceptable key-value pair, for example key = \"LakeFormationTrustedCaller\" and value = \"TRUE\" and the third party integrator must properly tag the temporary security credentials that will be used to call Lake Formation's administrative APIs.
" + } } }, "traits": { @@ -1615,6 +1682,9 @@ "smithy.api#documentation": "Statistics related to the processing of a query statement.
" } }, + "com.amazonaws.lakeformation#ExpirationTimestamp": { + "type": "timestamp" + }, "com.amazonaws.lakeformation#ExpiredException": { "type": "structure", "members": { @@ -2321,6 +2391,219 @@ } } }, + "com.amazonaws.lakeformation#GetTemporaryGluePartitionCredentials": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#GetTemporaryGluePartitionCredentialsRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#GetTemporaryGluePartitionCredentialsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#AccessDeniedException" + }, + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + }, + { + "target": "com.amazonaws.lakeformation#PermissionTypeMismatchException" + } + ], + "traits": { + "smithy.api#documentation": "This API is identical to GetTemporaryTableCredentials except that this is used when the target Data Catalog resource is of type Partition. Lake Formation restricts the permission of the vended credentials with the same scope down policy which restricts access to a single Amazon S3 prefix.
The ARN of the partitions' table.
", + "smithy.api#required": {} + } + }, + "Partition": { + "target": "com.amazonaws.lakeformation#PartitionValueList", + "traits": { + "smithy.api#documentation": "A list of partition values identifying a single partition.
", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.lakeformation#PermissionList", + "traits": { + "smithy.api#documentation": "Filters the request based on the user having been granted a list of specified permissions on the requested resource(s).
" + } + }, + "DurationSeconds": { + "target": "com.amazonaws.lakeformation#CredentialTimeoutDurationSecondInteger", + "traits": { + "smithy.api#documentation": "The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.
" + } + }, + "AuditContext": { + "target": "com.amazonaws.lakeformation#AuditContext", + "traits": { + "smithy.api#documentation": "A structure representing context to access a resource (column names, query ID, etc).
" + } + }, + "SupportedPermissionTypes": { + "target": "com.amazonaws.lakeformation#PermissionTypeList", + "traits": { + "smithy.api#documentation": "A list of supported permission types for the partition. Valid values are COLUMN_PERMISSION and CELL_FILTER_PERMISSION.
The access key ID for the temporary credentials.
" + } + }, + "SecretAccessKey": { + "target": "com.amazonaws.lakeformation#SecretAccessKeyString", + "traits": { + "smithy.api#documentation": "The secret key for the temporary credentials.
" + } + }, + "SessionToken": { + "target": "com.amazonaws.lakeformation#SessionTokenString", + "traits": { + "smithy.api#documentation": "The session token for the temporary credentials.
" + } + }, + "Expiration": { + "target": "com.amazonaws.lakeformation#ExpirationTimestamp", + "traits": { + "smithy.api#documentation": "The date and time when the temporary credentials expire.
" + } + } + } + }, + "com.amazonaws.lakeformation#GetTemporaryGlueTableCredentials": { + "type": "operation", + "input": { + "target": "com.amazonaws.lakeformation#GetTemporaryGlueTableCredentialsRequest" + }, + "output": { + "target": "com.amazonaws.lakeformation#GetTemporaryGlueTableCredentialsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lakeformation#AccessDeniedException" + }, + { + "target": "com.amazonaws.lakeformation#EntityNotFoundException" + }, + { + "target": "com.amazonaws.lakeformation#InternalServiceException" + }, + { + "target": "com.amazonaws.lakeformation#InvalidInputException" + }, + { + "target": "com.amazonaws.lakeformation#OperationTimeoutException" + }, + { + "target": "com.amazonaws.lakeformation#PermissionTypeMismatchException" + } + ], + "traits": { + "smithy.api#documentation": "Allows a caller in a secure environment to assume a role with permission to access Amazon S3. In order to vend such credentials, Lake Formation assumes the role associated with a registered location, for example an Amazon S3 bucket, with a scope down policy which restricts the access to a single prefix.
", + "smithy.api#http": { + "method": "POST", + "uri": "/GetTemporaryGlueTableCredentials", + "code": 200 + } + } + }, + "com.amazonaws.lakeformation#GetTemporaryGlueTableCredentialsRequest": { + "type": "structure", + "members": { + "TableArn": { + "target": "com.amazonaws.lakeformation#ResourceArnString", + "traits": { + "smithy.api#documentation": "The ARN identifying a table in the Data Catalog for the temporary credentials request.
", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.lakeformation#PermissionList", + "traits": { + "smithy.api#documentation": "Filters the request based on the user having been granted a list of specified permissions on the requested resource(s).
" + } + }, + "DurationSeconds": { + "target": "com.amazonaws.lakeformation#CredentialTimeoutDurationSecondInteger", + "traits": { + "smithy.api#documentation": "The time period, between 900 and 21,600 seconds, for the timeout of the temporary credentials.
" + } + }, + "AuditContext": { + "target": "com.amazonaws.lakeformation#AuditContext", + "traits": { + "smithy.api#documentation": "A structure representing context to access a resource (column names, query ID, etc).
" + } + }, + "SupportedPermissionTypes": { + "target": "com.amazonaws.lakeformation#PermissionTypeList", + "traits": { + "smithy.api#documentation": "A list of supported permission types for the table. Valid values are COLUMN_PERMISSION and CELL_FILTER_PERMISSION.
The access key ID for the temporary credentials.
" + } + }, + "SecretAccessKey": { + "target": "com.amazonaws.lakeformation#SecretAccessKeyString", + "traits": { + "smithy.api#documentation": "The secret key for the temporary credentials.
" + } + }, + "SessionToken": { + "target": "com.amazonaws.lakeformation#SessionTokenString", + "traits": { + "smithy.api#documentation": "The session token for the temporary credentials.
" + } + }, + "Expiration": { + "target": "com.amazonaws.lakeformation#ExpirationTimestamp", + "traits": { + "smithy.api#documentation": "The date and time when the temporary credentials expire.
" + } + } + } + }, "com.amazonaws.lakeformation#GetWorkUnitResults": { "type": "operation", "input": { @@ -3421,6 +3704,21 @@ "smithy.api#documentation": "A structure containing a list of partition values and table objects.
" } }, + "com.amazonaws.lakeformation#PartitionValueList": { + "type": "structure", + "members": { + "Values": { + "target": "com.amazonaws.lakeformation#ValueStringList", + "traits": { + "smithy.api#documentation": "The list of partition values.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Contains a list of values defining partitions.
" + } + }, "com.amazonaws.lakeformation#PartitionValueString": { "type": "string", "traits": { @@ -3521,6 +3819,48 @@ "target": "com.amazonaws.lakeformation#Permission" } }, + "com.amazonaws.lakeformation#PermissionType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "COLUMN_PERMISSION", + "name": "COLUMN_PERMISSION" + }, + { + "value": "CELL_FILTER_PERMISSION", + "name": "CELL_FILTER_PERMISSION" + } + ] + } + }, + "com.amazonaws.lakeformation#PermissionTypeList": { + "type": "list", + "member": { + "target": "com.amazonaws.lakeformation#PermissionType" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.lakeformation#PermissionTypeMismatchException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.lakeformation#MessageString", + "traits": { + "smithy.api#documentation": "A message describing the problem.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The engine does not support filtering data based on the enforced permissions. For example, if you call the GetTemporaryGlueTableCredentials operation with SupportedPermissionType equal to ColumnPermission, but cell-level permissions exist on the table, this exception is thrown.
Determines the strategy that Amazon Lex uses to select a value from the\n list of possible values. The field can be set to one of the following\n values:
\n\n OriginalValue - Returns the value entered by the\n user, if the user value is similar to the slot value.
\n TopResolution - If there is a resolution list for\n the slot, return the first value in the resolution list. If there\n is no resolution list, return null.
If you don't specify the valueSelectionSetting\n parameter, the default is OriginalValue.
Determines the strategy that Amazon Lex uses to select a value from the\n list of possible values. The field can be set to one of the following\n values:
\n\n OriginalValue - Returns the value entered by the\n user, if the user value is similar to the slot value.
\n TopResolution - If there is a resolution list for\n the slot, return the first value in the resolution list. If there\n is no resolution list, return null.
If you don't specify the valueSelectionSetting\n parameter, the default is OriginalValue.
Sets the type of external information used to create the slot\n type.
" + } } } }, @@ -3171,6 +3176,12 @@ "traits": { "smithy.api#documentation": "A timestamp of the date and time that the slot type was\n created.
" } + }, + "externalSourceSetting": { + "target": "com.amazonaws.lexmodelsv2#ExternalSourceSetting", + "traits": { + "smithy.api#documentation": "The type of external information used to create the slot\n type.
" + } } } }, @@ -4758,6 +4769,12 @@ "traits": { "smithy.api#documentation": "History of changes, such as when a locale is used in an alias, that\n have taken place for the locale.
" } + }, + "recommendedActions": { + "target": "com.amazonaws.lexmodelsv2#RecommendedActions", + "traits": { + "smithy.api#documentation": "Recommended actions to take to resolve an error in the\n failureReasons field.
A timestamp of the date and time that the slot type was last\n updated.
" } + }, + "externalSourceSetting": { + "target": "com.amazonaws.lexmodelsv2#ExternalSourceSetting" } } }, @@ -6235,6 +6255,20 @@ "target": "com.amazonaws.lexmodelsv2#ExportSummary" } }, + "com.amazonaws.lexmodelsv2#ExternalSourceSetting": { + "type": "structure", + "members": { + "grammarSlotTypeSetting": { + "target": "com.amazonaws.lexmodelsv2#GrammarSlotTypeSetting", + "traits": { + "smithy.api#documentation": "Settings required for a slot type based on a grammar that you\n provide.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Provides information about the external source of the slot type's\n definition.
" + } + }, "com.amazonaws.lexmodelsv2#FailureReason": { "type": "string" }, @@ -6422,6 +6456,48 @@ "smithy.api#documentation": "Provides information for updating the user on the progress of\n fulfilling an intent.
" } }, + "com.amazonaws.lexmodelsv2#GrammarSlotTypeSetting": { + "type": "structure", + "members": { + "source": { + "target": "com.amazonaws.lexmodelsv2#GrammarSlotTypeSource", + "traits": { + "smithy.api#documentation": "The source of the grammar used to create the slot type.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Settings requried for a slot type based on a grammar that you\n provide.
" + } + }, + "com.amazonaws.lexmodelsv2#GrammarSlotTypeSource": { + "type": "structure", + "members": { + "s3BucketName": { + "target": "com.amazonaws.lexmodelsv2#S3BucketName", + "traits": { + "smithy.api#documentation": "The name of the S3 bucket that contains the grammar source.
", + "smithy.api#required": {} + } + }, + "s3ObjectKey": { + "target": "com.amazonaws.lexmodelsv2#S3ObjectPath", + "traits": { + "smithy.api#documentation": "The path to the grammar in the S3 bucket.
", + "smithy.api#required": {} + } + }, + "kmsKeyArn": { + "target": "com.amazonaws.lexmodelsv2#KmsKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon KMS key required to decrypt the contents of the grammar,\n if any.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the Amazon S3 bucket name and location for the grammar\n that is the source for the slot type.
" + } + }, "com.amazonaws.lexmodelsv2#HitCount": { "type": "integer", "traits": { @@ -9331,6 +9407,15 @@ } } }, + "com.amazonaws.lexmodelsv2#RecommendedAction": { + "type": "string" + }, + "com.amazonaws.lexmodelsv2#RecommendedActions": { + "type": "list", + "member": { + "target": "com.amazonaws.lexmodelsv2#RecommendedAction" + } + }, "com.amazonaws.lexmodelsv2#RecommendedIntentSummary": { "type": "structure", "members": { @@ -9545,6 +9630,16 @@ "smithy.api#documentation": "The object representing the Amazon S3 bucket containing the transcript,\n as well as the associated metadata.
" } }, + "com.amazonaws.lexmodelsv2#S3ObjectPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^[\\.\\-\\!\\*\\_\\'\\(\\)a-zA-Z0-9][\\.\\-\\!\\*\\_\\'\\(\\)\\/a-zA-Z0-9]*$" + } + }, "com.amazonaws.lexmodelsv2#SSMLMessage": { "type": "structure", "members": { @@ -10084,6 +10179,25 @@ "target": "com.amazonaws.lexmodelsv2#SlotSummary" } }, + "com.amazonaws.lexmodelsv2#SlotTypeCategory": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "Custom", + "name": "Custom" + }, + { + "value": "Extended", + "name": "Extended" + }, + { + "value": "ExternalGrammar", + "name": "ExternalGrammar" + } + ] + } + }, "com.amazonaws.lexmodelsv2#SlotTypeFilter": { "type": "structure", "members": { @@ -10120,6 +10234,10 @@ { "value": "SlotTypeName", "name": "SlotTypeName" + }, + { + "value": "ExternalSourceType", + "name": "ExternalSourceType" } ] } @@ -10237,6 +10355,12 @@ "traits": { "smithy.api#documentation": "A timestamp of the date and time that the slot type was last\n updated.
" } + }, + "slotTypeCategory": { + "target": "com.amazonaws.lexmodelsv2#SlotTypeCategory", + "traits": { + "smithy.api#documentation": "Indicates the type of the slot type.
\n\n Custom - A slot type that you created using\n custom values. For more information, see Creating custom slot\n types.
\n Extended - A slot type created by extending the\n AMAZON.AlphaNumeric built-in slot type. For more information, see\n AMAZON.AlphaNumeric.
\n ExternalGrammar - A slot type using a custom\n GRXML grammar to define values. For more information, see Using a custom grammar slot type.
A timestamp of the date and time that the locale was last\n updated.
" } + }, + "recommendedActions": { + "target": "com.amazonaws.lexmodelsv2#RecommendedActions", + "traits": { + "smithy.api#documentation": "Recommended actions to take to resolve an error in the\n failureReasons field.
The strategy that Amazon Lex should use when deciding on a value from the\n list of slot type values.
", - "smithy.api#required": {} + "smithy.api#documentation": "The strategy that Amazon Lex should use when deciding on a value from the\n list of slot type values.
" } }, "parentSlotTypeSignature": { @@ -12339,6 +12468,9 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "externalSourceSetting": { + "target": "com.amazonaws.lexmodelsv2#ExternalSourceSetting" } } }, @@ -12410,6 +12542,9 @@ "traits": { "smithy.api#documentation": "A timestamp of the date and time that the slot type was last\n updated.
" } + }, + "externalSourceSetting": { + "target": "com.amazonaws.lexmodelsv2#ExternalSourceSetting" } } }, @@ -12484,7 +12619,7 @@ "engine": { "target": "com.amazonaws.lexmodelsv2#VoiceEngine", "traits": { - "smithy.api#documentation": "Indicates the type of Amazon Polly\n voice that Amazon Lex should use for voice interaction with the user. \n For more information, see Voices in Amazon Polly.
" + "smithy.api#documentation": "Indicates the type of Amazon Polly voice that Amazon Lex should use for voice interaction with the user. For more\n information, see the \n engine parameter of the\n SynthesizeSpeech operation in the\n Amazon Polly developer guide.
If you do not specify a value, the default is\n standard.
Evaluates device positions against the geofence geometries from a given geofence\n collection.
\nThis operation always returns an empty response because geofences are asynchronously\n evaluated. The evaluation determines if the device has entered or exited a geofenced\n area, and then publishes one of the following events to Amazon EventBridge:
\n\n ENTER if Amazon Location determines that the tracked device has entered\n a geofenced area.
\n EXIT if Amazon Location determines that the tracked device has exited a\n geofenced area.
The last geofence that a device was observed within is tracked for 30 days after\n the most recent device position update.
\nGeofence evaluation uses the given device position. It does not account for the \n optional Accuracy of a DevicePositionUpdate.
Specifies the pricing plan for the geofence collection.
\nFor additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing\n page.
", - "smithy.api#required": {} + "smithy.api#documentation": "Optionally specifies the pricing plan for the geofence collection. Defaults to\n RequestBasedUsage.
For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing\n page.
" } }, "PricingPlanDataSource": { @@ -1308,8 +1306,7 @@ "PricingPlan": { "target": "com.amazonaws.location#PricingPlan", "traits": { - "smithy.api#documentation": "Specifies the pricing plan for your map resource.
\nFor additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
", - "smithy.api#required": {} + "smithy.api#documentation": "Optionally specifies the pricing plan for the map resource. Defaults to\n RequestBasedUsage.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
" } }, "Description": { @@ -1410,8 +1407,7 @@ "PricingPlan": { "target": "com.amazonaws.location#PricingPlan", "traits": { - "smithy.api#documentation": "Specifies the pricing plan for your place index resource.
\nFor additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
", - "smithy.api#required": {} + "smithy.api#documentation": "Optionally specifies the pricing plan for the place index resource. Defaults to\n RequestBasedUsage.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
" } }, "Description": { @@ -1518,8 +1514,7 @@ "PricingPlan": { "target": "com.amazonaws.location#PricingPlan", "traits": { - "smithy.api#documentation": "Specifies the pricing plan for your route calculator resource.
\nFor additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
", - "smithy.api#required": {} + "smithy.api#documentation": "Optionally specifies the pricing plan for the route calculator resource. Defaults to\n RequestBasedUsage.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
" } }, "Description": { @@ -1613,8 +1608,7 @@ "PricingPlan": { "target": "com.amazonaws.location#PricingPlan", "traits": { - "smithy.api#documentation": "Specifies the pricing plan for the tracker resource.
\nFor additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
", - "smithy.api#required": {} + "smithy.api#documentation": "Optionally specifies the pricing plan for the tracker resource. Defaults to\n RequestBasedUsage.
For additional details and restrictions on each pricing plan option, see Amazon Location Service pricing.
" } }, "KmsKeyId": { @@ -1990,7 +1984,6 @@ } ], "traits": { - "smithy.api#auth": [], "smithy.api#documentation": "Retrieves the geofence collection details.
", "smithy.api#endpoint": { "hostPrefix": "geofencing." @@ -2107,7 +2100,6 @@ } ], "traits": { - "smithy.api#auth": [], "smithy.api#documentation": "Retrieves the map resource details.
", "smithy.api#endpoint": { "hostPrefix": "maps." @@ -2226,7 +2218,6 @@ } ], "traits": { - "smithy.api#auth": [], "smithy.api#documentation": "Retrieves the place index resource details.
", "smithy.api#endpoint": { "hostPrefix": "places." @@ -2345,7 +2336,6 @@ } ], "traits": { - "smithy.api#auth": [], "smithy.api#documentation": "Retrieves the route calculator resource details.
", "smithy.api#endpoint": { "hostPrefix": "routes." @@ -2457,7 +2447,6 @@ } ], "traits": { - "smithy.api#auth": [], "smithy.api#documentation": "Retrieves the tracker resource details.
", "smithy.api#endpoint": { "hostPrefix": "tracking." diff --git a/codegen/sdk/aws-models/lookoutmetrics.2017-07-25.json b/codegen/sdk/aws-models/lookoutmetrics.2017-07-25.json index 34a4825b8b2..44b7951dc15 100644 --- a/codegen/sdk/aws-models/lookoutmetrics.2017-07-25.json +++ b/codegen/sdk/aws-models/lookoutmetrics.2017-07-25.json @@ -2168,6 +2168,44 @@ "com.amazonaws.lookoutmetrics#Integer": { "type": "integer" }, + "com.amazonaws.lookoutmetrics#InterMetricImpactDetails": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.lookoutmetrics#MetricName", + "traits": { + "smithy.api#documentation": "The name of the measure.
" + } + }, + "AnomalyGroupId": { + "target": "com.amazonaws.lookoutmetrics#UUID", + "traits": { + "smithy.api#documentation": "The ID of the anomaly group.
" + } + }, + "RelationshipType": { + "target": "com.amazonaws.lookoutmetrics#RelationshipType", + "traits": { + "smithy.api#documentation": "Whether a measure is a potential cause of the anomaly group\n (CAUSE_OF_INPUT_ANOMALY_GROUP), or whether the measure is impacted by the\n anomaly group (EFFECT_OF_INPUT_ANOMALY_GROUP).
For potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP), the percentage\n contribution the measure has in causing the anomalies.
Aggregated details about the measures contributing to the anomaly group, and the measures\n potentially impacted by the anomaly group.
\n " + } + }, + "com.amazonaws.lookoutmetrics#InterMetricImpactList": { + "type": "list", + "member": { + "target": "com.amazonaws.lookoutmetrics#InterMetricImpactDetails" + } + }, "com.amazonaws.lookoutmetrics#InternalServerException": { "type": "structure", "members": { @@ -2431,6 +2469,100 @@ } } }, + "com.amazonaws.lookoutmetrics#ListAnomalyGroupRelatedMetrics": { + "type": "operation", + "input": { + "target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupRelatedMetricsRequest" + }, + "output": { + "target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupRelatedMetricsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.lookoutmetrics#AccessDeniedException" + }, + { + "target": "com.amazonaws.lookoutmetrics#InternalServerException" + }, + { + "target": "com.amazonaws.lookoutmetrics#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.lookoutmetrics#TooManyRequestsException" + }, + { + "target": "com.amazonaws.lookoutmetrics#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns a list of measures that are potential causes or effects of an\n anomaly group.
", + "smithy.api#http": { + "method": "POST", + "uri": "/ListAnomalyGroupRelatedMetrics", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.lookoutmetrics#ListAnomalyGroupRelatedMetricsRequest": { + "type": "structure", + "members": { + "AnomalyDetectorArn": { + "target": "com.amazonaws.lookoutmetrics#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the anomaly detector.
", + "smithy.api#required": {} + } + }, + "AnomalyGroupId": { + "target": "com.amazonaws.lookoutmetrics#UUID", + "traits": { + "smithy.api#documentation": "The ID of the anomaly group.
", + "smithy.api#required": {} + } + }, + "RelationshipTypeFilter": { + "target": "com.amazonaws.lookoutmetrics#RelationshipType", + "traits": { + "smithy.api#documentation": "Filter for potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP) or\n downstream effects (EFFECT_OF_INPUT_ANOMALY_GROUP) of the anomaly group.
The maximum number of results to return.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lookoutmetrics#NextToken", + "traits": { + "smithy.api#documentation": "Specify the pagination token that's returned by a previous request to retrieve the next\n page of results.
" + } + } + } + }, + "com.amazonaws.lookoutmetrics#ListAnomalyGroupRelatedMetricsResponse": { + "type": "structure", + "members": { + "InterMetricImpactList": { + "target": "com.amazonaws.lookoutmetrics#InterMetricImpactList", + "traits": { + "smithy.api#documentation": "Aggregated details about the measures contributing to the anomaly group, and the measures\n potentially impacted by the anomaly group.
" + } + }, + "NextToken": { + "target": "com.amazonaws.lookoutmetrics#NextToken", + "traits": { + "smithy.api#documentation": "The pagination token that's included if more results are available.
" + } + } + } + }, "com.amazonaws.lookoutmetrics#ListAnomalyGroupSummaries": { "type": "operation", "input": { @@ -2774,6 +2906,21 @@ }, "com.amazonaws.lookoutmetrics#LookoutMetrics": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "LookoutMetrics", + "arnNamespace": "lookoutmetrics", + "cloudFormationName": "LookoutMetrics", + "cloudTrailEventSource": "lookoutmetrics.amazonaws.com", + "endpointPrefix": "lookoutmetrics" + }, + "aws.auth#sigv4": { + "name": "lookoutmetrics" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "This is the Amazon Lookout for Metrics API Reference. For an introduction to the service\n with tutorials for getting started, visit Amazon\n Lookout for Metrics Developer Guide.
", + "smithy.api#title": "Amazon Lookout for Metrics" + }, "version": "2017-07-25", "operations": [ { @@ -2824,6 +2971,9 @@ { "target": "com.amazonaws.lookoutmetrics#ListAnomalyDetectors" }, + { + "target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupRelatedMetrics" + }, { "target": "com.amazonaws.lookoutmetrics#ListAnomalyGroupSummaries" }, @@ -2851,22 +3001,7 @@ { "target": "com.amazonaws.lookoutmetrics#UpdateMetricSet" } - ], - "traits": { - "aws.api#service": { - "sdkId": "LookoutMetrics", - "arnNamespace": "lookoutmetrics", - "cloudFormationName": "LookoutMetrics", - "cloudTrailEventSource": "lookoutmetrics.amazonaws.com", - "endpointPrefix": "lookoutmetrics" - }, - "aws.auth#sigv4": { - "name": "lookoutmetrics" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "This is the Amazon Lookout for Metrics API Reference. For an introduction to the service\n with tutorials for getting started, visit Amazon\n Lookout for Metrics Developer Guide.
", - "smithy.api#title": "Amazon Lookout for Metrics" - } + ] }, "com.amazonaws.lookoutmetrics#MaxResults": { "type": "integer", @@ -2908,6 +3043,16 @@ "smithy.api#documentation": "A calculation made by contrasting a measure and a dimension from your source data.
" } }, + "com.amazonaws.lookoutmetrics#MetricChangePercentage": { + "type": "double", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0.0, + "max": 100.0 + } + } + }, "com.amazonaws.lookoutmetrics#MetricLevelImpact": { "type": "structure", "members": { @@ -3363,6 +3508,21 @@ "smithy.api#documentation": "Provides information about the Amazon Redshift database configuration.
" } }, + "com.amazonaws.lookoutmetrics#RelationshipType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CAUSE_OF_INPUT_ANOMALY_GROUP", + "name": "CAUSE_OF_INPUT_ANOMALY_GROUP" + }, + { + "value": "EFFECT_OF_INPUT_ANOMALY_GROUP", + "name": "EFFECT_OF_INPUT_ANOMALY_GROUP" + } + ] + } + }, "com.amazonaws.lookoutmetrics#ResourceId": { "type": "string" }, diff --git a/codegen/sdk/aws-models/mediaconnect.2018-11-14.json b/codegen/sdk/aws-models/mediaconnect.2018-11-14.json index c7e7e7e6406..02e6b48bb75 100644 --- a/codegen/sdk/aws-models/mediaconnect.2018-11-14.json +++ b/codegen/sdk/aws-models/mediaconnect.2018-11-14.json @@ -468,7 +468,7 @@ "MaxLatency": { "target": "com.amazonaws.mediaconnect#__integer", "traits": { - "smithy.api#documentation": "The maximum latency in milliseconds for Zixi-based streams.", + "smithy.api#documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.", "smithy.api#jsonName": "maxLatency" } }, @@ -515,6 +515,13 @@ "smithy.api#jsonName": "remoteId" } }, + "SenderControlPort": { + "target": "com.amazonaws.mediaconnect#__integer", + "traits": { + "smithy.api#documentation": "The port that the flow uses to send outbound requests to initiate connection with the sender.", + "smithy.api#jsonName": "senderControlPort" + } + }, "SmoothingLatency": { "target": "com.amazonaws.mediaconnect#__integer", "traits": { @@ -1500,7 +1507,7 @@ } }, "traits": { - "smithy.api#documentation": "The settings for source failover" + "smithy.api#documentation": "The settings for source failover." } }, "com.amazonaws.mediaconnect#FailoverMode": { @@ -2482,6 +2489,21 @@ }, "com.amazonaws.mediaconnect#MediaConnect": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "MediaConnect", + "arnNamespace": "mediaconnect", + "cloudFormationName": "MediaConnect", + "cloudTrailEventSource": "mediaconnect.amazonaws.com", + "endpointPrefix": "mediaconnect" + }, + "aws.auth#sigv4": { + "name": "mediaconnect" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "API for AWS Elemental MediaConnect", + "smithy.api#title": "AWS MediaConnect" + }, "version": "2018-11-14", "operations": [ { @@ -2574,22 +2596,7 @@ { "target": "com.amazonaws.mediaconnect#UpdateFlowSource" } - ], - "traits": { - "aws.api#service": { - "sdkId": "MediaConnect", - "arnNamespace": "mediaconnect", - "cloudFormationName": "MediaConnect", - "cloudTrailEventSource": "mediaconnect.amazonaws.com", - "endpointPrefix": "mediaconnect" - }, - "aws.auth#sigv4": { - "name": "mediaconnect" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "API for AWS Elemental MediaConnect", - "smithy.api#title": "AWS MediaConnect" - } + ] }, "com.amazonaws.mediaconnect#MediaStream": { "type": "structure", @@ -3129,6 +3136,10 @@ { "value": "srt-listener", "name": "srt_listener" + }, + { + "value": "fujitsu-qos", + "name": "fujitsu_qos" } ] } @@ -3872,7 +3883,7 @@ "MaxLatency": { "target": "com.amazonaws.mediaconnect#__integer", "traits": { - "smithy.api#documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.", + "smithy.api#documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.", "smithy.api#jsonName": "maxLatency" } }, @@ -3911,6 +3922,20 @@ "smithy.api#jsonName": "protocol" } }, + "SenderControlPort": { + "target": "com.amazonaws.mediaconnect#__integer", + "traits": { + "smithy.api#documentation": "The port that the flow uses to send outbound requests to initiate connection with the sender.", + "smithy.api#jsonName": "senderControlPort" + } + }, + "SenderIpAddress": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The IP address that the flow communicates with to initiate connection with the sender.", + "smithy.api#jsonName": "senderIpAddress" + } + }, "StreamId": { "target": "com.amazonaws.mediaconnect#__string", "traits": { @@ -3997,6 +4022,20 @@ "smithy.api#required": {} } }, + "SenderControlPort": { + "target": "com.amazonaws.mediaconnect#__integer", + "traits": { + "smithy.api#documentation": "The port that the flow uses to send outbound requests to initiate connection with the sender.", + "smithy.api#jsonName": "senderControlPort" + } + }, + "SenderIpAddress": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The IP address that the flow communicates with to initiate connection with the sender.", + "smithy.api#jsonName": "senderIpAddress" + } + }, "SourceArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { @@ -4381,7 +4420,7 @@ "MaxLatency": { "target": "com.amazonaws.mediaconnect#__integer", "traits": { - "smithy.api#documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.", + "smithy.api#documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.", "smithy.api#jsonName": "maxLatency" } }, @@ -4414,6 +4453,20 @@ "smithy.api#jsonName": "remoteId" } }, + "SenderControlPort": { + "target": "com.amazonaws.mediaconnect#__integer", + "traits": { + "smithy.api#documentation": "The port that the flow uses to send outbound requests to initiate connection with the sender.", + "smithy.api#jsonName": "senderControlPort" + } + }, + "SenderIpAddress": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The IP address that the flow communicates with to initiate connection with the sender.", + "smithy.api#jsonName": "senderIpAddress" + } + }, "SmoothingLatency": { "target": "com.amazonaws.mediaconnect#__integer", "traits": { @@ -4582,7 +4635,7 @@ } }, "traits": { - "smithy.api#documentation": "The settings for source failover" + "smithy.api#documentation": "The settings for source failover." } }, "com.amazonaws.mediaconnect#UpdateFlow": { @@ -4925,7 +4978,7 @@ "MaxLatency": { "target": "com.amazonaws.mediaconnect#__integer", "traits": { - "smithy.api#documentation": "The maximum latency in milliseconds for Zixi-based streams.", + "smithy.api#documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.", "smithy.api#jsonName": "maxLatency" } }, @@ -4972,6 +5025,20 @@ "smithy.api#jsonName": "remoteId" } }, + "SenderControlPort": { + "target": "com.amazonaws.mediaconnect#__integer", + "traits": { + "smithy.api#documentation": "The port that the flow uses to send outbound requests to initiate connection with the sender.", + "smithy.api#jsonName": "senderControlPort" + } + }, + "SenderIpAddress": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The IP address that the flow communicates with to initiate connection with the sender.", + "smithy.api#jsonName": "senderIpAddress" + } + }, "SmoothingLatency": { "target": "com.amazonaws.mediaconnect#__integer", "traits": { @@ -5136,7 +5203,7 @@ "MaxLatency": { "target": "com.amazonaws.mediaconnect#__integer", "traits": { - "smithy.api#documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based and Zixi-based streams.", + "smithy.api#documentation": "The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams.", "smithy.api#jsonName": "maxLatency" } }, @@ -5168,6 +5235,20 @@ "smithy.api#jsonName": "protocol" } }, + "SenderControlPort": { + "target": "com.amazonaws.mediaconnect#__integer", + "traits": { + "smithy.api#documentation": "The port that the flow uses to send outbound requests to initiate connection with the sender.", + "smithy.api#jsonName": "senderControlPort" + } + }, + "SenderIpAddress": { + "target": "com.amazonaws.mediaconnect#__string", + "traits": { + "smithy.api#documentation": "The IP address that the flow communicates with to initiate connection with the sender.", + "smithy.api#jsonName": "senderIpAddress" + } + }, "SourceArn": { "target": "com.amazonaws.mediaconnect#__string", "traits": { @@ -5227,7 +5308,7 @@ "Name": { "target": "com.amazonaws.mediaconnect#__string", "traits": { - "smithy.api#documentation": "Immutable and has to be a unique against other VpcInterfaces in this Flow", + "smithy.api#documentation": "Immutable and has to be a unique against other VpcInterfaces in this Flow.", "smithy.api#jsonName": "name", "smithy.api#required": {} } diff --git a/codegen/sdk/aws-models/mediaconvert.2017-08-29.json b/codegen/sdk/aws-models/mediaconvert.2017-08-29.json index 320ee32e249..5a745df5e73 100644 --- a/codegen/sdk/aws-models/mediaconvert.2017-08-29.json +++ b/codegen/sdk/aws-models/mediaconvert.2017-08-29.json @@ -1223,7 +1223,7 @@ } }, "ExternalAudioFileInput": { - "target": "com.amazonaws.mediaconvert#__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSSHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSS", + "target": "com.amazonaws.mediaconvert#__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSSOOGGGGaAHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSSOOGGGGaA", "traits": { "smithy.api#documentation": "Specifies audio data from an external file source.", "smithy.api#jsonName": "externalAudioFileInput" @@ -15023,7 +15023,7 @@ "com.amazonaws.mediaconvert#NoiseFilterPostTemporalSharpening": { "type": "string", "traits": { - "smithy.api#documentation": "Optional. When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), you can use this setting to apply sharpening. The default behavior, Auto (AUTO), allows the transcoder to determine whether to apply filtering, depending on input type and quality. When you set Noise reducer to Temporal, your output bandwidth is reduced. When Post temporal sharpening is also enabled, that bandwidth reduction is smaller.", + "smithy.api#documentation": "When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), the sharpness of your output is reduced. You can optionally use Post temporal sharpening (PostTemporalSharpening) to apply sharpening to the edges of your output. The default behavior, Auto (AUTO), allows the transcoder to determine whether to apply sharpening, depending on your input type and quality. When you set Post temporal sharpening to Enabled (ENABLED), specify how much sharpening is applied using Post temporal sharpening strength (PostTemporalSharpeningStrength). Set Post temporal sharpening to Disabled (DISABLED) to not apply sharpening.", "smithy.api#enum": [ { "value": "DISABLED", @@ -15040,6 +15040,26 @@ ] } }, + "com.amazonaws.mediaconvert#NoiseFilterPostTemporalSharpeningStrength": { + "type": "string", + "traits": { + "smithy.api#documentation": "Use Post temporal sharpening strength (PostTemporalSharpeningStrength) to define the amount of sharpening the transcoder applies to your output. Set Post temporal sharpening strength to Low (LOW), or leave blank, to apply a low amount of sharpening. Set Post temporal sharpening strength to Medium (MEDIUM) to apply medium amount of sharpening. Set Post temporal sharpening strength to High (HIGH) to apply a high amount of sharpening.", + "smithy.api#enum": [ + { + "value": "LOW", + "name": "LOW" + }, + { + "value": "MEDIUM", + "name": "MEDIUM" + }, + { + "value": "HIGH", + "name": "HIGH" + } + ] + } + }, "com.amazonaws.mediaconvert#NoiseReducer": { "type": "structure", "members": { @@ -15173,10 +15193,17 @@ "PostTemporalSharpening": { "target": "com.amazonaws.mediaconvert#NoiseFilterPostTemporalSharpening", "traits": { - "smithy.api#documentation": "Optional. When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), you can use this setting to apply sharpening. The default behavior, Auto (AUTO), allows the transcoder to determine whether to apply filtering, depending on input type and quality. When you set Noise reducer to Temporal, your output bandwidth is reduced. When Post temporal sharpening is also enabled, that bandwidth reduction is smaller.", + "smithy.api#documentation": "When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), the sharpness of your output is reduced. You can optionally use Post temporal sharpening (PostTemporalSharpening) to apply sharpening to the edges of your output. The default behavior, Auto (AUTO), allows the transcoder to determine whether to apply sharpening, depending on your input type and quality. When you set Post temporal sharpening to Enabled (ENABLED), specify how much sharpening is applied using Post temporal sharpening strength (PostTemporalSharpeningStrength). Set Post temporal sharpening to Disabled (DISABLED) to not apply sharpening.", "smithy.api#jsonName": "postTemporalSharpening" } }, + "PostTemporalSharpeningStrength": { + "target": "com.amazonaws.mediaconvert#NoiseFilterPostTemporalSharpeningStrength", + "traits": { + "smithy.api#documentation": "Use Post temporal sharpening strength (PostTemporalSharpeningStrength) to define the amount of sharpening the transcoder applies to your output. Set Post temporal sharpening strength to Low (LOW), or leave blank, to apply a low amount of sharpening. Set Post temporal sharpening strength to Medium (MEDIUM) to apply medium amount of sharpening. Set Post temporal sharpening strength to High (HIGH) to apply a high amount of sharpening.", + "smithy.api#jsonName": "postTemporalSharpeningStrength" + } + }, "Speed": { "target": "com.amazonaws.mediaconvert#__integerMinNegative1Max3", "traits": { @@ -20849,10 +20876,10 @@ "smithy.api#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]|[aA][tT][mM][oO][sS]))))|(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]|[aA][tT][mM][oO][sS])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$" } }, - "com.amazonaws.mediaconvert#__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSSHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSS": { + "com.amazonaws.mediaconvert#__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSSOOGGGGaAHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVaAAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEAATTMMOOSSOOGGGGaA": { "type": "string", "traits": { - "smithy.api#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]|[aA][tT][mM][oO][sS]))))|(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]|[aA][tT][mM][oO][sS])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$" + "smithy.api#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]|[aA][tT][mM][oO][sS]|[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|[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]|[aA][tT][mM][oO][sS]|[oO][gG][gGaA])))(\\?([^&=]+=[^&]+&)*[^&=]+=[^&]+)?))$" } }, "com.amazonaws.mediaconvert#__stringPatternSNManifestConfirmConditionNotificationNS": { diff --git a/codegen/sdk/aws-models/mediatailor.2018-04-23.json b/codegen/sdk/aws-models/mediatailor.2018-04-23.json index 6a92b0bef20..b182713bd0d 100644 --- a/codegen/sdk/aws-models/mediatailor.2018-04-23.json +++ b/codegen/sdk/aws-models/mediatailor.2018-04-23.json @@ -281,7 +281,7 @@ "FillerSlate": { "target": "com.amazonaws.mediatailor#SlateSource", "traits": { - "smithy.api#documentation": "Contains information about the slate used to fill gaps between programs in the schedule. You must configure FillerSlate if your channel uses an LINEAR PlaybackMode.
" + "smithy.api#documentation": "The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.
" } }, "LastModifiedTime": { @@ -454,7 +454,7 @@ "FillerSlate": { "target": "com.amazonaws.mediatailor#SlateSource", "traits": { - "smithy.api#documentation": "The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses a LINEAR PlaybackMode.
" + "smithy.api#documentation": "The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.
" } }, "Outputs": { @@ -2586,6 +2586,21 @@ }, "com.amazonaws.mediatailor#MediaTailor": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "MediaTailor", + "arnNamespace": "mediatailor", + "cloudFormationName": "MediaTailor", + "cloudTrailEventSource": "mediatailor.amazonaws.com", + "endpointPrefix": "api.mediatailor" + }, + "aws.auth#sigv4": { + "name": "mediatailor" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "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 AWS Elemental MediaTailor User Guide.
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).
", + "smithy.api#title": "AWS MediaTailor" + }, "version": "2018-04-23", "operations": [ { @@ -2699,22 +2714,7 @@ { "target": "com.amazonaws.mediatailor#UpdateVodSource" } - ], - "traits": { - "aws.api#service": { - "sdkId": "MediaTailor", - "arnNamespace": "mediatailor", - "cloudFormationName": "MediaTailor", - "cloudTrailEventSource": "mediatailor.amazonaws.com", - "endpointPrefix": "api.mediatailor" - }, - "aws.auth#sigv4": { - "name": "mediatailor" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "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 AWS Elemental MediaTailor User Guide.
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).
", - "smithy.api#title": "AWS MediaTailor" - } + ] }, "com.amazonaws.mediatailor#MessageType": { "type": "string", @@ -3874,6 +3874,12 @@ "smithy.api#required": {} } }, + "FillerSlate": { + "target": "com.amazonaws.mediatailor#SlateSource", + "traits": { + "smithy.api#documentation": "The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.
" + } + }, "Outputs": { "target": "com.amazonaws.mediatailor#RequestOutputs", "traits": { diff --git a/codegen/sdk/aws-models/mwaa.2020-07-01.json b/codegen/sdk/aws-models/mwaa.2020-07-01.json index f3e312eddc7..899f27a2f54 100644 --- a/codegen/sdk/aws-models/mwaa.2020-07-01.json +++ b/codegen/sdk/aws-models/mwaa.2020-07-01.json @@ -9,7 +9,7 @@ } }, "traits": { - "smithy.api#documentation": "Access to the Airflow Web UI or CLI has been Denied. Please follow the MWAA user guide to setup permissions to access the Web UI and CLI functionality.
", + "smithy.api#documentation": "Access to the Apache Airflow Web UI or CLI has been denied due to insufficient permissions. To learn more, see Accessing an Amazon MWAA environment.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -35,6 +35,21 @@ }, "com.amazonaws.mwaa#AmazonMWAA": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "MWAA", + "arnNamespace": "airflow", + "cloudFormationName": "AmazonMWAA", + "cloudTrailEventSource": "airflow.amazonaws.com", + "endpointPrefix": "airflow" + }, + "aws.auth#sigv4": { + "name": "airflow" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more information, see What Is Amazon MWAA?.
\n\n\n Endpoints\n
\n\n api.airflow.{region}.amazonaws.com - This endpoint is used for environment management.
\n CreateEnvironment\n
\n\n DeleteEnvironment\n
\n\n GetEnvironment\n
\n\n ListEnvironments\n
\n\n ListTagsForResource\n
\n\n TagResource\n
\n\n UntagResource\n
\n\n UpdateEnvironment\n
\n\n env.airflow.{region}.amazonaws.com - This endpoint is used to operate the Airflow environment.
\n CreateCliToken\n
\n\n CreateWebLoginToken\n
\n\n ops.airflow.{region}.amazonaws.com - This endpoint is used to push environment metrics that track environment health.
\n PublishMetrics\n
\n\n Regions\n
\nFor a list of regions that Amazon MWAA supports, see Region availability in the Amazon MWAA User Guide.
", + "smithy.api#title": "AmazonMWAA" + }, "version": "2020-07-01", "operations": [ { @@ -70,22 +85,7 @@ { "target": "com.amazonaws.mwaa#UpdateEnvironment" } - ], - "traits": { - "aws.api#service": { - "sdkId": "MWAA", - "arnNamespace": "airflow", - "cloudFormationName": "AmazonMWAA", - "cloudTrailEventSource": "airflow.amazonaws.com", - "endpointPrefix": "airflow" - }, - "aws.auth#sigv4": { - "name": "airflow" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation. For more information, see What Is Amazon MWAA?.
", - "smithy.api#title": "AmazonMWAA" - } + ] }, "com.amazonaws.mwaa#CloudWatchLogGroupArn": { "type": "string", @@ -104,7 +104,7 @@ "min": 1, "max": 64 }, - "smithy.api#pattern": "^[a-z]+([a-z._]*[a-z]+)?$" + "smithy.api#pattern": "^[a-z]+([a-z0-9._]*[a-z0-9_]+)?$" } }, "com.amazonaws.mwaa#ConfigValue": { @@ -112,9 +112,9 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 256 + "max": 65536 }, - "smithy.api#pattern": ".*" + "smithy.api#pattern": "^[ -~]+$" } }, "com.amazonaws.mwaa#CreateCliToken": { @@ -131,7 +131,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a CLI token to use Airflow CLI.
", + "smithy.api#documentation": "Creates a CLI token for the Airflow CLI. To learn more, see Creating an Apache Airflow CLI token.
", "smithy.api#endpoint": { "hostPrefix": "env." }, @@ -148,7 +148,7 @@ "Name": { "target": "com.amazonaws.mwaa#EnvironmentName", "traits": { - "smithy.api#documentation": "Create a CLI token request for a MWAA environment.
", + "smithy.api#documentation": "The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
Create an Airflow CLI login token response for the provided JWT token.
", + "smithy.api#documentation": "An Airflow CLI login token.
", "smithy.api#sensitive": {} } }, "WebServerHostname": { "target": "com.amazonaws.mwaa#Hostname", "traits": { - "smithy.api#documentation": "Create an Airflow CLI login token response for the provided webserver hostname.
" + "smithy.api#documentation": "The Airflow web server hostname for the environment.
" } } } @@ -216,7 +216,7 @@ "ExecutionRoleArn": { "target": "com.amazonaws.mwaa#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an AWS Identity and Access Management (IAM) role that grants MWAA permission to access AWS services and resources used by your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.
The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an Amazon Web Services Identity and Access Management (IAM) role that grants MWAA permission to access Amazon Web Services services and resources used by your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. To learn more, see About networking on Amazon MWAA.
", + "smithy.api#documentation": "The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.
", "smithy.api#required": {} } }, @@ -287,31 +287,31 @@ "KmsKey": { "target": "com.amazonaws.mwaa#KmsKey", "traits": { - "smithy.api#documentation": "The AWS Key Management Service (KMS) key to encrypt the data in your environment. You can use an AWS owned CMK, or a Customer managed CMK (advanced). To learn more, see Get started with Amazon Managed Workflows for Apache Airflow.
" + "smithy.api#documentation": "The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment. You can use an Amazon Web Services owned CMK, or a Customer managed CMK (advanced). To learn more, see Create an Amazon MWAA environment.
" } }, "AirflowVersion": { "target": "com.amazonaws.mwaa#AirflowVersion", "traits": { - "smithy.api#documentation": "The Apache Airflow version for your environment. For example, v1.10.12. If no value is specified, defaults to the latest version. Valid values: v1.10.12.
The Apache Airflow version for your environment. If no value is specified, defaults to the latest version. Valid values: 1.10.12, 2.0.2. To learn more, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).
Defines the Apache Airflow logs to send to CloudWatch Logs: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, WorkerLogs.
Defines the Apache Airflow logs to send to CloudWatch Logs.
" } }, "WeeklyMaintenanceWindowStart": { "target": "com.amazonaws.mwaa#WeeklyMaintenanceWindowStart", "traits": { - "smithy.api#documentation": "The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM. For example: TUE:03:30. You can specify a start time in 30 minute increments only. Supported input includes the following:
MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\\\d|2[0-3]):(00|30)
\nThe day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time to start weekly maintenance updates of your environment in the following format: DAY:HH:MM. For example: TUE:03:30. You can specify a start time in 30 minute increments only.
The key-value tag pairs you want to associate to your environment. For example, \"Environment\": \"Staging\". To learn more, see Tagging AWS resources.
The key-value tag pairs you want to associate to your environment. For example, \"Environment\": \"Staging\". To learn more, see Tagging Amazon Web Services resources.
The number of Apache Airflow schedulers to run in your environment.
" + "smithy.api#documentation": "The number of Apache Airflow schedulers to run in your environment. Valid values:
\nv2.0.2 - Accepts between 2 to 5. Defaults to 2.
\nv1.10.12 - Accepts 1.
\nCreate a JWT token to be used to login to Airflow Web UI with claims based Authentication.
", + "smithy.api#documentation": "Creates a web login token for the Airflow Web UI. To learn more, see Creating an Apache Airflow web login token.
", "smithy.api#endpoint": { "hostPrefix": "env." }, @@ -389,7 +389,7 @@ "Name": { "target": "com.amazonaws.mwaa#EnvironmentName", "traits": { - "smithy.api#documentation": "Create an Airflow Web UI login token request for a MWAA environment.
", + "smithy.api#documentation": "The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
Create an Airflow Web UI login token response for the provided JWT token.
", + "smithy.api#documentation": "An Airflow web server login token.
", "smithy.api#sensitive": {} } }, "WebServerHostname": { "target": "com.amazonaws.mwaa#Hostname", "traits": { - "smithy.api#documentation": "Create an Airflow Web UI login token response for the provided webserver hostname.
" + "smithy.api#documentation": "The Airflow web server hostname for the environment.
" } } } @@ -472,20 +472,20 @@ "Name": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Internal only API.
", + "smithy.api#documentation": "\n Internal only. The name of the dimension.
", "smithy.api#required": {} } }, "Value": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Internal only API.
", + "smithy.api#documentation": "\n Internal only. The value of the dimension.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Internal only API.
" + "smithy.api#documentation": "\n Internal only. Represents the dimensions of a metric. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.
" } }, "com.amazonaws.mwaa#Dimensions": { @@ -530,7 +530,7 @@ "ExecutionRoleArn": { "target": "com.amazonaws.mwaa#IamRoleArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.
The Key Management Service (KMS) encryption key used to encrypt the data in your environment.
" + "smithy.api#documentation": "The Amazon Web Services Key Management Service (KMS) encryption key used to encrypt the data in your environment.
" } }, "AirflowVersion": { "target": "com.amazonaws.mwaa#AirflowVersion", "traits": { - "smithy.api#documentation": "The Apache Airflow version on your environment. For example, v1.10.12.
The Apache Airflow version on your environment. Valid values: 1.10.12, 2.0.2.
Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.
" + } }, "LoggingConfiguration": { "target": "com.amazonaws.mwaa#LoggingConfiguration", "traits": { - "smithy.api#documentation": "The Apache Airflow logs being sent to CloudWatch Logs: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, WorkerLogs.
The Apache Airflow logs published to CloudWatch Logs.
" } }, "LastUpdate": { - "target": "com.amazonaws.mwaa#LastUpdate" + "target": "com.amazonaws.mwaa#LastUpdate", + "traits": { + "smithy.api#documentation": "The status of the last update on the environment.
" + } }, "WeeklyMaintenanceWindowStart": { "target": "com.amazonaws.mwaa#WeeklyMaintenanceWindowStart", "traits": { - "smithy.api#documentation": "The day and time of the week that weekly maintenance updates are scheduled. For example: TUE:03:30.
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.
The key-value tag pairs associated to your environment. For example, \"Environment\": \"Staging\". To learn more, see Tagging AWS resources.
The key-value tag pairs associated to your environment. For example, \"Environment\": \"Staging\". To learn more, see Tagging Amazon Web Services resources.
The Amazon Managed Workflows for Apache Airflow (MWAA) environment.
" + "smithy.api#documentation": "Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
" } }, "com.amazonaws.mwaa#EnvironmentArn": { @@ -759,7 +765,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the details of an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
", + "smithy.api#documentation": "Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
", "smithy.api#endpoint": { "hostPrefix": "api." }, @@ -844,7 +850,7 @@ "Status": { "target": "com.amazonaws.mwaa#UpdateStatus", "traits": { - "smithy.api#documentation": "The status of the last update on the environment. Valid values: SUCCESS, PENDING, FAILED.
The status of the last update on the environment.
" } }, "CreatedAt": { @@ -858,10 +864,16 @@ "traits": { "smithy.api#documentation": "The error that was encountered during the last update of the environment.
" } + }, + "Source": { + "target": "com.amazonaws.mwaa#UpdateSource", + "traits": { + "smithy.api#documentation": "The source of the last update to the environment. Includes internal processes by Amazon MWAA, such as an environment maintenance update.
" + } } }, "traits": { - "smithy.api#documentation": "The status of the last update on the environment, and any errors that were encountered.
" + "smithy.api#documentation": "Describes the status of the last update on the environment, and any errors that were encountered.
" } }, "com.amazonaws.mwaa#ListEnvironments": { @@ -928,7 +940,7 @@ "Environments": { "target": "com.amazonaws.mwaa#EnvironmentList", "traits": { - "smithy.api#documentation": "Returns the list of Amazon MWAA environments.
", + "smithy.api#documentation": "Returns a list of Amazon MWAA environments.
", "smithy.api#required": {} } }, @@ -991,7 +1003,7 @@ "Tags": { "target": "com.amazonaws.mwaa#TagMap", "traits": { - "smithy.api#documentation": "The key-value tag pairs associated to your environment. To learn more, see Tagging AWS resources.
" + "smithy.api#documentation": "The key-value tag pairs associated to your environment. To learn more, see Tagging Amazon Web Services resources.
" } } } @@ -1000,46 +1012,76 @@ "type": "structure", "members": { "DagProcessingLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration" + "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration", + "traits": { + "smithy.api#documentation": "The Airflow DAG processing logs published to CloudWatch Logs and the log level.
" + } }, "SchedulerLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration" + "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration", + "traits": { + "smithy.api#documentation": "The Airflow scheduler logs published to CloudWatch Logs and the log level.
" + } }, "WebserverLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration" + "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration", + "traits": { + "smithy.api#documentation": "The Airflow web server logs published to CloudWatch Logs and the log level.
" + } }, "WorkerLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration" + "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration", + "traits": { + "smithy.api#documentation": "The Airflow worker logs published to CloudWatch Logs and the log level.
" + } }, "TaskLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration" + "target": "com.amazonaws.mwaa#ModuleLoggingConfiguration", + "traits": { + "smithy.api#documentation": "The Airflow task logs published to CloudWatch Logs and the log level.
" + } } }, "traits": { - "smithy.api#documentation": "Defines the Apache Airflow logs to send to CloudWatch Logs: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, WorkerLogs.
Describes the Apache Airflow log types that are published to CloudWatch Logs.
" } }, "com.amazonaws.mwaa#LoggingConfigurationInput": { "type": "structure", "members": { "DagProcessingLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput" + "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput", + "traits": { + "smithy.api#documentation": "Publishes Airflow DAG processing logs to CloudWatch Logs.
" + } }, "SchedulerLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput" + "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput", + "traits": { + "smithy.api#documentation": "Publishes Airflow scheduler logs to CloudWatch Logs.
" + } }, "WebserverLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput" + "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput", + "traits": { + "smithy.api#documentation": "Publishes Airflow web server logs to CloudWatch Logs.
" + } }, "WorkerLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput" + "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput", + "traits": { + "smithy.api#documentation": "Publishes Airflow worker logs to CloudWatch Logs.
" + } }, "TaskLogs": { - "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput" + "target": "com.amazonaws.mwaa#ModuleLoggingConfigurationInput", + "traits": { + "smithy.api#documentation": "Publishes Airflow task logs to CloudWatch Logs.
" + } } }, "traits": { - "smithy.api#documentation": "Defines the Apache Airflow logs to send to CloudWatch Logs: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, WorkerLogs.
Defines the Apache Airflow log types to send to CloudWatch Logs.
" } }, "com.amazonaws.mwaa#LoggingEnabled": { @@ -1096,41 +1138,44 @@ "MetricName": { "target": "smithy.api#String", "traits": { - "smithy.api#documentation": "Internal only API.
", + "smithy.api#documentation": "\n Internal only. The name of the metric.
", "smithy.api#required": {} } }, "Timestamp": { "target": "smithy.api#Timestamp", "traits": { - "smithy.api#documentation": "Internal only API.
", + "smithy.api#documentation": "\n Internal only. The time the metric data was received.
", "smithy.api#required": {} } }, "Dimensions": { "target": "com.amazonaws.mwaa#Dimensions", "traits": { - "smithy.api#documentation": "Internal only API.
" + "smithy.api#documentation": "\n Internal only. The dimensions associated with the metric.
" } }, "Value": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "Internal only API.
" + "smithy.api#documentation": "\n Internal only. The value for the metric.
" } }, "Unit": { - "target": "com.amazonaws.mwaa#Unit" + "target": "com.amazonaws.mwaa#Unit", + "traits": { + "smithy.api#documentation": "\n Internal only. The unit used to store the metric.
" + } }, "StatisticValues": { "target": "com.amazonaws.mwaa#StatisticSet", "traits": { - "smithy.api#documentation": "Internal only API.
" + "smithy.api#documentation": "\n Internal only. The statistical values for the metric.
" } } }, "traits": { - "smithy.api#documentation": "Internal only API.
" + "smithy.api#documentation": "\n Internal only. Collects Apache Airflow metrics. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.
" } }, "com.amazonaws.mwaa#MinWorkers": { @@ -1148,13 +1193,13 @@ "Enabled": { "target": "com.amazonaws.mwaa#LoggingEnabled", "traits": { - "smithy.api#documentation": "Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs) in CloudWatch Logs.
Indicates whether the Apache Airflow log type (e.g. DagProcessingLogs) is enabled.
Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs) to CloudWatch Logs. Valid values: CRITICAL, ERROR, WARNING, INFO.
The Apache Airflow log level for the log type (e.g. DagProcessingLogs).
Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs). Valid values: CloudWatchLogGroupArn, Enabled, LogLevel.
Describes the Apache Airflow log details for the log type (e.g. DagProcessingLogs).
Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs) in CloudWatch Logs.
Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).
Defines the Apache Airflow logs to send for the log type (e.g. DagProcessingLogs) to CloudWatch Logs. Valid values: CRITICAL, ERROR, WARNING, INFO.
Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.
Defines the type of logs to send for the Apache Airflow log type (e.g. DagProcessingLogs). Valid values: CloudWatchLogGroupArn, Enabled, LogLevel.
Enables the Apache Airflow log type (e.g. DagProcessingLogs) and defines the log level to send to CloudWatch Logs (e.g. INFO).
A list of 2 subnet IDs. Required to create an environment. Must be private subnets in two different availability zones. A subnet must be attached to the same VPC as the security group.
" + "smithy.api#documentation": "A list of subnet IDs. To learn more, see About networking on Amazon MWAA.
" } }, "SecurityGroupIds": { "target": "com.amazonaws.mwaa#SecurityGroupList", "traits": { - "smithy.api#documentation": "A list of 1 or more security group IDs. Accepts up to 5 security group IDs. A security group must be attached to the same VPC as the subnets. To learn more, see Security in your VPC on Amazon MWAA.
" + "smithy.api#documentation": "A list of security group IDs. To learn more, see Security in your VPC on Amazon MWAA.
" } } }, "traits": { - "smithy.api#documentation": "The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. To learn more, see About networking on Amazon MWAA.
" + "smithy.api#documentation": "Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.
" } }, "com.amazonaws.mwaa#NextToken": { @@ -1235,7 +1280,7 @@ } ], "traits": { - "smithy.api#documentation": "An operation for publishing metrics from the customers to the Ops plane.", + "smithy.api#documentation": "\n Internal only. Publishes environment health metrics to Amazon CloudWatch.
", "smithy.api#endpoint": { "hostPrefix": "ops." }, @@ -1252,7 +1297,7 @@ "EnvironmentName": { "target": "com.amazonaws.mwaa#EnvironmentName", "traits": { - "smithy.api#documentation": "Publishes environment metric data to Amazon CloudWatch.
", + "smithy.api#documentation": "\n Internal only. The name of the environment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1260,7 +1305,7 @@ "MetricData": { "target": "com.amazonaws.mwaa#MetricData", "traits": { - "smithy.api#documentation": "Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metrica.
", + "smithy.api#documentation": "\n Internal only. Publishes metrics to Amazon CloudWatch. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.
", "smithy.api#required": {} } } @@ -1349,30 +1394,30 @@ "SampleCount": { "target": "smithy.api#Integer", "traits": { - "smithy.api#documentation": "Internal only API.
" + "smithy.api#documentation": "\n Internal only. The number of samples used for the statistic set.
" } }, "Sum": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "Internal only API.
" + "smithy.api#documentation": "\n Internal only. The sum of values for the sample set.
" } }, "Minimum": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "Internal only API.
" + "smithy.api#documentation": "\n Internal only. The minimum value of the sample set.
" } }, "Maximum": { "target": "smithy.api#Double", "traits": { - "smithy.api#documentation": "Internal only API.
" + "smithy.api#documentation": "\n Internal only. The maximum value of the sample set.
" } } }, "traits": { - "smithy.api#documentation": "Internal only API.
" + "smithy.api#documentation": "\n Internal only. Represents a set of statistics that describe a specific metric. To learn more about the metrics published to Amazon CloudWatch, see Amazon MWAA performance metrics in Amazon CloudWatch.
" } }, "com.amazonaws.mwaa#SubnetId": { @@ -1478,7 +1523,7 @@ "Tags": { "target": "com.amazonaws.mwaa#TagMap", "traits": { - "smithy.api#documentation": "The key-value tag pairs you want to associate to your environment. For example, \"Environment\": \"Staging\". To learn more, see Tagging AWS resources.
The key-value tag pairs you want to associate to your environment. For example, \"Environment\": \"Staging\". To learn more, see Tagging Amazon Web Services resources.
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.
The Apache Airflow version for your environment. For example, v1.10.12. If no value is specified, defaults to the latest version. Valid values: v1.10.12.
The Apache Airflow version for your environment. If no value is specified, defaults to the latest version. Valid values: 1.10.12, 2.0.2.
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. To learn more, see About networking on Amazon MWAA.
" + "smithy.api#documentation": "The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.
" } }, "LoggingConfiguration": { "target": "com.amazonaws.mwaa#LoggingConfigurationInput", "traits": { - "smithy.api#documentation": "Defines the Apache Airflow logs to send to CloudWatch Logs: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, WorkerLogs.
The Apache Airflow log types to send to CloudWatch Logs.
" } }, "WeeklyMaintenanceWindowStart": { "target": "com.amazonaws.mwaa#WeeklyMaintenanceWindowStart", "traits": { - "smithy.api#documentation": "The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM. For example: TUE:03:30. You can specify a start time in 30 minute increments only. Supported input includes the following:
MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\\\d|2[0-3]):(00|30)
\nThe day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time to start weekly maintenance updates of your environment in the following format: DAY:HH:MM. For example: TUE:03:30. You can specify a start time in 30 minute increments only.
An object containing the error encountered with the last update: ErrorCode, ErrorMessage.
Describes the error(s) encountered with the last update of the environment.
" } }, "com.amazonaws.mwaa#UpdateNetworkConfigurationInput": { @@ -1861,13 +1905,23 @@ "SecurityGroupIds": { "target": "com.amazonaws.mwaa#SecurityGroupList", "traits": { - "smithy.api#documentation": "A list of 1 or more security group IDs. Accepts up to 5 security group IDs. A security group must be attached to the same VPC as the subnets. To learn more, see Security in your VPC on Amazon MWAA.
", + "smithy.api#documentation": "A list of security group IDs. A security group must be attached to the same VPC as the subnets. To learn more, see Security in your VPC on Amazon MWAA.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. To learn more, see About networking on Amazon MWAA.
" + "smithy.api#documentation": "Defines the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.
" + } + }, + "com.amazonaws.mwaa#UpdateSource": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^.+$" } }, "com.amazonaws.mwaa#UpdateStatus": { diff --git a/codegen/sdk/aws-models/networkfirewall.2020-11-12.json b/codegen/sdk/aws-models/networkfirewall.2020-11-12.json index ce6800cf36e..3fccf706bb5 100644 --- a/codegen/sdk/aws-models/networkfirewall.2020-11-12.json +++ b/codegen/sdk/aws-models/networkfirewall.2020-11-12.json @@ -1186,6 +1186,95 @@ "smithy.api#documentation": "Returns the data objects for the specified rule group.
" } }, + "com.amazonaws.networkfirewall#DescribeRuleGroupMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.networkfirewall#DescribeRuleGroupMetadataRequest" + }, + "output": { + "target": "com.amazonaws.networkfirewall#DescribeRuleGroupMetadataResponse" + }, + "errors": [ + { + "target": "com.amazonaws.networkfirewall#InternalServerError" + }, + { + "target": "com.amazonaws.networkfirewall#InvalidRequestException" + }, + { + "target": "com.amazonaws.networkfirewall#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.networkfirewall#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "High-level information about a rule group, returned by operations like create and describe. \n You can use the information provided in the metadata to retrieve and manage a rule group. \n You can retrieve all objects for a rule group by calling DescribeRuleGroup.\n
" + } + }, + "com.amazonaws.networkfirewall#DescribeRuleGroupMetadataRequest": { + "type": "structure", + "members": { + "RuleGroupName": { + "target": "com.amazonaws.networkfirewall#ResourceName", + "traits": { + "smithy.api#documentation": "The descriptive name of the rule group. You can't change the name of a rule group after you create it.
\nYou must specify the ARN or the name, and you can specify both.
" + } + }, + "RuleGroupArn": { + "target": "com.amazonaws.networkfirewall#ResourceArn", + "traits": { + "smithy.api#documentation": "The descriptive name of the rule group. You can't change the name of a rule group after you create it.
\nYou must specify the ARN or the name, and you can specify both.
" + } + }, + "Type": { + "target": "com.amazonaws.networkfirewall#RuleGroupType", + "traits": { + "smithy.api#documentation": "Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains \nstateless rules. If it is stateful, it contains stateful rules.
\nThis setting is required for requests that do not include the RuleGroupARN.
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
\nYou must specify the ARN or the name, and you can specify both.
", + "smithy.api#required": {} + } + }, + "RuleGroupName": { + "target": "com.amazonaws.networkfirewall#ResourceName", + "traits": { + "smithy.api#documentation": "The descriptive name of the rule group. You can't change the name of a rule group after you create it.
\nYou must specify the ARN or the name, and you can specify both.
", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.networkfirewall#Description", + "traits": { + "smithy.api#documentation": "Returns the metadata objects for the specified rule group.\n
" + } + }, + "Type": { + "target": "com.amazonaws.networkfirewall#RuleGroupType", + "traits": { + "smithy.api#documentation": "Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains \nstateless rules. If it is stateful, it contains stateful rules.
\nThis setting is required for requests that do not include the RuleGroupARN.
The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. \n When you update a rule group, you are limited to this capacity. When you reference a rule group \n from a firewall policy, Network Firewall reserves this capacity for the rule group.
\nYou can retrieve the capacity that would be required for a rule group before you create the rule group by calling \n CreateRuleGroup with DryRun set to TRUE.
The default actions to take on a packet that doesn't match any stateful rules.
" + "smithy.api#documentation": "The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional, \n and is only valid when using the strict rule order.
\nValid values of the stateful default action:
\naws:drop_strict
\naws:drop_established
\naws:alert_strict
\naws:alert_established
\nFor more information, see \n Strict evaluation order in the AWS Network Firewall Developer Guide.\n
" } }, "StatefulEngineOptions": { @@ -2063,6 +2152,12 @@ "traits": { "smithy.api#documentation": "The maximum number of objects that you want Network Firewall to return for this request. If more \n objects are available, in the response, Network Firewall provides a \n NextToken value that you can use in a subsequent call to get the next batch of objects.
The scope of the request. The default setting of ACCOUNT or a setting of \n NULL returns all of the rule groups in your account. A setting of \n MANAGED returns all available managed rule groups.
This is the API Reference for AWS Network Firewall. This guide is for developers who need\n detailed information about the Network Firewall API actions, data types, and errors.
\nThe REST API requires you to handle connection details, such as calculating\n signatures, handling request retries, and error handling. For general information\n about using the AWS REST APIs, see AWS APIs.
\nTo access Network Firewall using the REST API endpoint:\n https://network-firewall.\n
Alternatively, you can use one of the AWS SDKs to access an API that's tailored to\n the programming language or platform that you're using. For more information, see\n AWS SDKs.
\nFor descriptions of Network Firewall features, including and step-by-step\n instructions on how to use them through the Network Firewall console, see the Network Firewall Developer\n Guide.
\nNetwork Firewall is a stateful, managed, network firewall and intrusion detection and\n prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the\n perimeter of your VPC. This includes filtering traffic going to and coming from an internet\n gateway, NAT gateway, or over VPN or AWS Direct Connect. Network Firewall uses rules that are compatible\n with Suricata, a free, open source intrusion detection system (IDS) engine. \n AWS Network Firewall supports Suricata version 5.0.2. For information about Suricata, \n see the Suricata website.
\nYou can use Network Firewall to monitor and protect your VPC traffic in a number of ways.\n The following are just a few examples:
\nAllow domains or IP addresses for known AWS service endpoints, such as Amazon S3, and\n block all other forms of traffic.
\nUse custom lists of known bad domains to limit the types of domain names that your\n applications can access.
\nPerform deep packet inspection on traffic entering or leaving your VPC.
\nUse stateful protocol detection to filter protocols like HTTPS, regardless of the\n port used.
\nTo enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in\n Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide.
\nTo start using Network Firewall, do the following:
\n(Optional) If you don't already have a VPC that you want to protect, create it in\n Amazon VPC.
\nIn Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a\n subnet for the sole use of Network Firewall.
\nIn Network Firewall, create stateless and stateful rule groups, \n to define the components of the network traffic filtering behavior that you want your firewall to have.
\nIn Network Firewall, create a firewall policy that uses your rule groups and\n specifies additional default traffic filtering behavior.
\nIn Network Firewall, create a firewall and specify your new firewall policy and \n VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you\n specify, with the behavior that's defined in the firewall policy.
\nIn Amazon VPC, use ingress routing enhancements to route traffic through the new firewall\n endpoints.
\nThis is the API Reference for AWS Network Firewall. This guide is for developers who need\n detailed information about the Network Firewall API actions, data types, and errors.
\nThe REST API requires you to handle connection details, such as calculating\n signatures, handling request retries, and error handling. For general information\n about using the AWS REST APIs, see AWS APIs.
\nTo access Network Firewall using the REST API endpoint:\n https://network-firewall.\n
Alternatively, you can use one of the AWS SDKs to access an API that's tailored to\n the programming language or platform that you're using. For more information, see\n AWS SDKs.
\nFor descriptions of Network Firewall features, including and step-by-step\n instructions on how to use them through the Network Firewall console, see the Network Firewall Developer\n Guide.
\nNetwork Firewall is a stateful, managed, network firewall and intrusion detection and\n prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the\n perimeter of your VPC. This includes filtering traffic going to and coming from an internet\n gateway, NAT gateway, or over VPN or AWS Direct Connect. Network Firewall uses rules that are compatible\n with Suricata, a free, open source intrusion detection system (IDS) engine. \n AWS Network Firewall supports Suricata version 5.0.2. For information about Suricata, \n see the Suricata website.
\nYou can use Network Firewall to monitor and protect your VPC traffic in a number of ways.\n The following are just a few examples:
\nAllow domains or IP addresses for known AWS service endpoints, such as Amazon S3, and\n block all other forms of traffic.
\nUse custom lists of known bad domains to limit the types of domain names that your\n applications can access.
\nPerform deep packet inspection on traffic entering or leaving your VPC.
\nUse stateful protocol detection to filter protocols like HTTPS, regardless of the\n port used.
\nTo enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in\n Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide.
\nTo start using Network Firewall, do the following:
\n(Optional) If you don't already have a VPC that you want to protect, create it in\n Amazon VPC.
\nIn Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a\n subnet for the sole use of Network Firewall.
\nIn Network Firewall, create stateless and stateful rule groups, \n to define the components of the network traffic filtering behavior that you want your firewall to have.
\nIn Network Firewall, create a firewall policy that uses your rule groups and\n specifies additional default traffic filtering behavior.
\nIn Network Firewall, create a firewall and specify your new firewall policy and \n VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you\n specify, with the behavior that's defined in the firewall policy.
\nIn Amazon VPC, use ingress routing enhancements to route traffic through the new firewall\n endpoints.
\nThe domains that you want to inspect for in your traffic flows. To provide multiple\n domains, separate them with commas. Valid domain specifications are the following:
\nExplicit names. For example, abc.example.com matches only the domain abc.example.com.
Names that use a domain wildcard, which you indicate with an initial '.'. For example,.example.com matches example.com and matches all subdomains of example.com, such as abc.example.com and www.example.com.
The domains that you want to inspect for in your traffic flows. Valid domain specifications are the following:
\nExplicit names. For example, abc.example.com matches only the domain abc.example.com.
Names that use a domain wildcard, which you indicate with an initial '.'. For example,.example.com matches example.com and matches all subdomains of example.com, such as abc.example.com and www.example.com.
Indicates how to manage the order of stateful rule evaluation for the policy. By default, Network Firewall\n leaves the rule evaluation order up to the Suricata rule processing engine. If you set \n this to STRICT_ORDER, your rules are evaluated in the exact order that you provide them\n in the policy. With strict ordering, the rule groups are evaluated by order of priority, starting from the lowest number, and \n the rules in each rule group are processed in the order that they're defined.
Indicates how to manage the order of stateful rule evaluation for the policy. DEFAULT_ACTION_ORDER is\n the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them\n based on certain settings. For more information, see \n Evaluation order for stateful rules in the AWS Network Firewall Developer Guide.\n
The action that changes the rule group from DROP to ALERT. This only applies to\n managed rule groups.
The setting that allows the policy owner to change the behavior of the rule group within a policy.
" + } + }, "com.amazonaws.networkfirewall#StatefulRuleGroupReference": { "type": "structure", "members": { @@ -3152,6 +3296,12 @@ "smithy.api#box": {}, "smithy.api#documentation": "An integer setting that indicates the order in which to run the stateful rule groups in\n a single FirewallPolicy. This setting only applies to firewall policies\n that specify the STRICT_ORDER rule order in the stateful engine options settings.
Network Firewall evalutes each stateful rule group\n against a packet starting with the group that has the lowest priority setting. You must ensure\n that the priority settings are unique within each policy.
\nYou can change the priority settings of your rule groups at any time. To make it easier to\n insert rule groups later, number them so there's a wide range in between, for example use 100,\n 200, and so on.
" } + }, + "Override": { + "target": "com.amazonaws.networkfirewall#StatefulRuleGroupOverride", + "traits": { + "smithy.api#documentation": "The action that allows the policy owner to override the behavior of the rule group within a policy.
" + } } }, "traits": { @@ -3170,7 +3320,7 @@ "RuleOrder": { "target": "com.amazonaws.networkfirewall#RuleOrder", "traits": { - "smithy.api#documentation": "Indicates how to manage the order of the rule evaluation for the rule group. By default, Network Firewall\n leaves the rule evaluation order up to the Suricata rule processing engine. If you set \n this to STRICT_ORDER, your rules are evaluated in the exact order that they're listed \n in your Suricata rules string.
Indicates how to manage the order of the rule evaluation for the rule group. DEFAULT_ACTION_ORDER is\n the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them\n based on certain settings. For more information, see \n Evaluation order for stateful rules in the AWS Network Firewall Developer Guide.\n
A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates\n that the firewall is protected against deletion. Use this setting to protect against\n accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
Modifies the flag, ChangeProtection, which indicates whether it \n is possible to change the firewall. If the flag is set to TRUE, the firewall is protected \n from changes. This setting helps protect against accidentally changing a firewall that's in use.
A collection of EULA acceptances.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#AccessDeniedException": { @@ -195,10 +189,7 @@ } }, "com.amazonaws.nimble#ActiveDirectoryDnsIpAddress": { - "type": "string", - "traits": { - "smithy.api#documentation": "" - } + "type": "string" }, "com.amazonaws.nimble#ActiveDirectoryDnsIpAddressList": { "type": "list", @@ -206,7 +197,6 @@ "target": "com.amazonaws.nimble#ActiveDirectoryDnsIpAddress" }, "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 10 @@ -314,9 +304,18 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create a launch profile", + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], "aws.iam#requiredActions": [ "ec2:CreateNetworkInterface", - "ec2:RunInstances" + "ec2:RunInstances", + "ec2:DescribeSubnets", + "ec2:DescribeRouteTables", + "ec2:DescribeNetworkAcls", + "ec2:DescribeVpcEndpoints", + "ec2:DescribeNatGateways" ], "smithy.api#documentation": "Create a launch profile.
", "smithy.api#http": { @@ -398,7 +397,6 @@ } }, "traits": { - "smithy.api#documentation": "", "smithy.api#references": [ { "resource": "com.amazonaws.nimble#StudioResource" @@ -415,9 +413,6 @@ "smithy.api#documentation": "The launch profile.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#CreateStreamingImage": { @@ -453,6 +448,10 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create a streaming image", + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], "aws.iam#requiredActions": [ "ec2:ModifyInstanceAttribute", "ec2:ModifySnapshotAttribute", @@ -520,7 +519,6 @@ } }, "traits": { - "smithy.api#documentation": "", "smithy.api#references": [ { "resource": "com.amazonaws.nimble#StudioResource" @@ -537,9 +535,6 @@ "smithy.api#documentation": "The streaming image.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#CreateStreamingSession": { @@ -575,6 +570,10 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create a streaming session", + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], "aws.iam#requiredActions": [ "ec2:CreateNetworkInterface", "ec2:CreateNetworkInterfacePermission", @@ -641,7 +640,6 @@ } }, "traits": { - "smithy.api#documentation": "", "smithy.api#references": [ { "resource": "com.amazonaws.nimble#LaunchProfileResource" @@ -658,9 +656,6 @@ "smithy.api#documentation": "The session.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#CreateStreamingSessionStream": { @@ -696,6 +691,9 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create a streaming session stream", + "aws.iam#conditionKeys": [ + "nimble:requesterPrincipalId" + ], "smithy.api#documentation": "Creates a streaming session stream for a streaming session.
\nAfter invoking this API, invoke GetStreamingSessionStream with the returned streamId\n to poll the resource until it is in state READY.
", "smithy.api#http": { "method": "POST", @@ -740,7 +738,6 @@ } }, "traits": { - "smithy.api#documentation": "", "smithy.api#references": [ { "resource": "com.amazonaws.nimble#StreamingSessionResource" @@ -757,9 +754,6 @@ "smithy.api#documentation": "The stream.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#CreateStudio": { @@ -795,6 +789,10 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create a studio", + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], "aws.iam#requiredActions": [ "sso:CreateManagedApplicationInstance", "iam:PassRole" @@ -840,6 +838,10 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to create a studio component. A studio component designates a network resource to which a launch profile will provide access", + "aws.iam#conditionKeys": [ + "aws:TagKeys", + "aws:RequestTag/${TagKey}" + ], "aws.iam#requiredActions": [ "ec2:DescribeSecurityGroups", "fsx:DescribeFileSystems", @@ -934,7 +936,6 @@ } }, "traits": { - "smithy.api#documentation": "", "smithy.api#references": [ { "resource": "com.amazonaws.nimble#StudioResource" @@ -951,9 +952,6 @@ "smithy.api#documentation": "Information about the studio component.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#CreateStudioRequest": { @@ -1012,9 +1010,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#CreateStudioResponse": { @@ -1026,9 +1021,6 @@ "smithy.api#documentation": "Information about a studio.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#DeleteLaunchProfile": { @@ -1154,10 +1146,7 @@ }, "com.amazonaws.nimble#DeleteLaunchProfileMemberResponse": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "" - } + "members": {} }, "com.amazonaws.nimble#DeleteLaunchProfileRequest": { "type": "structure", @@ -1198,9 +1187,6 @@ "smithy.api#documentation": "The launch profile.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#DeleteStreamingImage": { @@ -1290,9 +1276,6 @@ "smithy.api#documentation": "The streaming image.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#DeleteStreamingSession": { @@ -1328,6 +1311,9 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to delete a streaming session", + "aws.iam#conditionKeys": [ + "nimble:requesterPrincipalId" + ], "aws.iam#requiredActions": [ "ec2:DeleteNetworkInterface" ], @@ -1378,9 +1364,6 @@ "smithy.api#documentation": "The session.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#DeleteStudio": { @@ -1509,9 +1492,6 @@ "smithy.api#documentation": "Information about the studio component.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#DeleteStudioMember": { @@ -1587,10 +1567,7 @@ }, "com.amazonaws.nimble#DeleteStudioMemberResponse": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "" - } + "members": {} }, "com.amazonaws.nimble#DeleteStudioRequest": { "type": "structure", @@ -1623,29 +1600,19 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#DirectoryId": { - "type": "string", - "traits": { - "smithy.api#documentation": "" - } + "type": "string" }, "com.amazonaws.nimble#EC2ImageId": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#pattern": "^ami-[0-9A-z]+$" } }, "com.amazonaws.nimble#EC2SubnetId": { - "type": "string", - "traits": { - "smithy.api#documentation": "" - } + "type": "string" }, "com.amazonaws.nimble#EC2SubnetIdList": { "type": "list", @@ -1653,7 +1620,6 @@ "target": "com.amazonaws.nimble#EC2SubnetId" }, "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 6 @@ -1751,9 +1717,6 @@ "type": "list", "member": { "target": "com.amazonaws.nimble#EulaAcceptance" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#EulaAcceptanceResource": { @@ -1801,24 +1764,17 @@ "type": "list", "member": { "target": "com.amazonaws.nimble#String" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#EulaList": { "type": "list", "member": { "target": "com.amazonaws.nimble#Eula" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#EulaName": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 64 @@ -1851,7 +1807,7 @@ "aws:TagKeys" ], "aws.iam#disableConditionKeyInference": {}, - "smithy.api#documentation": "Represents a EULA" + "smithy.api#documentation": "Represents a EULA that is required to be accepted before the use of certain streaming images" } }, "com.amazonaws.nimble#ExceptionContext": { @@ -1930,9 +1886,6 @@ "smithy.api#documentation": "The EULA.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetLaunchProfile": { @@ -2127,9 +2080,6 @@ "smithy.api#documentation": "A collection of studio component summaries.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetLaunchProfileInitialization": { @@ -2233,9 +2183,6 @@ "smithy.api#documentation": "The launch profile initialization.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetLaunchProfileMember": { @@ -2318,9 +2265,6 @@ "smithy.api#documentation": "The member.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetLaunchProfileRequest": { @@ -2354,9 +2298,6 @@ "smithy.api#documentation": "The launch profile.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetStreamingImage": { @@ -2494,9 +2435,6 @@ "smithy.api#documentation": "The streaming image.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetStreamingSession": { @@ -2532,6 +2470,9 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to get a streaming session", + "aws.iam#conditionKeys": [ + "nimble:requesterPrincipalId" + ], "smithy.api#documentation": "Gets StreamingSession resource.
\nanvoke this operation to poll for a streaming session state while creating or deleting\n a session.
", "smithy.api#http": { "method": "GET", @@ -2664,9 +2605,6 @@ "smithy.api#documentation": "The session.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetStreamingSessionStream": { @@ -2702,6 +2640,9 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to get a streaming session", + "aws.iam#conditionKeys": [ + "nimble:requesterPrincipalId" + ], "smithy.api#documentation": "Gets a StreamingSessionStream for a streaming session.
\nInvoke this operation to poll the resource after invoking\n CreateStreamingSessionStream.
\nAfter the StreamingSessionStream changes to the state READY, the url property will\n contain a stream to be used with the DCV streaming client.
", "smithy.api#http": { "method": "GET", @@ -2778,9 +2719,6 @@ "smithy.api#documentation": "The stream.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetStudio": { @@ -3023,9 +2961,6 @@ "smithy.api#documentation": "Information about the studio component.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetStudioMember": { @@ -3100,9 +3035,6 @@ "smithy.api#documentation": "The member.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#GetStudioRequest": { @@ -3129,9 +3061,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#InternalServerErrorException": { @@ -3296,7 +3225,6 @@ "com.amazonaws.nimble#LaunchProfileId": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 22 @@ -3363,7 +3291,7 @@ } }, "traits": { - "smithy.api#documentation": "A Launch Profile Initialization contains information required for a workstation or\n server to connect to a launch profile
\nThis includes scripts, endpoints, security groups, subnets, and other\n configuration.
" + "smithy.api#documentation": "A Launch Profile Initialization contains information required for a workstation or\n server to connect to a launch profile.
\nThis includes scripts, endpoints, security groups, subnets, and other\n configuration.
" } }, "com.amazonaws.nimble#LaunchProfileInitializationActiveDirectory": { @@ -3413,7 +3341,7 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "The Launch Profile Initialization Active Directory contains information required for\n the launch profile to connect to the Active Directory.
" } }, "com.amazonaws.nimble#LaunchProfileInitializationScript": { @@ -3439,25 +3367,19 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "The Launch Profile Initialization Script is used when start streaming session\n runs.
" } }, "com.amazonaws.nimble#LaunchProfileInitializationScriptList": { "type": "list", "member": { "target": "com.amazonaws.nimble#LaunchProfileInitializationScript" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#LaunchProfileList": { "type": "list", "member": { "target": "com.amazonaws.nimble#LaunchProfile" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#LaunchProfileMembership": { @@ -3489,7 +3411,7 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "Launch profile membership enables your studio admins to delegate launch profile access\n to other studio users in the Nimble Studio portal without needing to write or\n maintain complex IAM policies. A launch profile member is a user association from your\n studio identity source who is granted permissions to a launch profile.
\nA launch profile member (type USER) provides the following permissions to that launch\n profile:
\nGetLaunchProfile
\nGetLaunchProfileInitialization
\nGetLaunchProfileMembers
\nGetLaunchProfileMember
\nCreateStreamingSession
\nGetLaunchProfileDetails
\nThe token for the next set of results, or null if there are no more results.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ListEulas": { @@ -3973,9 +3880,6 @@ "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ListLaunchProfileMembers": { @@ -4076,9 +3980,6 @@ "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ListLaunchProfiles": { @@ -4114,6 +4015,10 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list launch profiles", + "aws.iam#conditionKeys": [ + "nimble:principalId", + "nimble:requesterPrincipalId" + ], "smithy.api#documentation": "List all the launch profiles a studio.
", "smithy.api#http": { "method": "GET", @@ -4185,9 +4090,6 @@ "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ListStreamingImages": { @@ -4279,9 +4181,6 @@ "smithy.api#documentation": "A collection of streaming images.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ListStreamingSessions": { @@ -4319,7 +4218,8 @@ "aws.iam#actionPermissionDescription": "Grants permission to list streaming sessions", "aws.iam#conditionKeys": [ "nimble:createdBy", - "nimble:ownedBy" + "nimble:ownedBy", + "nimble:requesterPrincipalId" ], "smithy.api#documentation": "Lists the streaming image resources in a studio.
", "smithy.api#http": { @@ -4391,9 +4291,6 @@ "smithy.api#documentation": "A collection of streaming sessions.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ListStudioComponents": { @@ -4500,9 +4397,6 @@ "smithy.api#documentation": "A collection of studio components.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ListStudioMembers": { @@ -4538,7 +4432,7 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to list studio members", - "smithy.api#documentation": "Get all users in a given studio membership.
", + "smithy.api#documentation": "Get all users in a given studio membership.
\n\n ListStudioMembers only returns admin members.
A list of members.
" + "smithy.api#documentation": "A list of admin members.
" } }, "nextToken": { @@ -4595,9 +4489,6 @@ "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ListStudios": { @@ -4675,9 +4566,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ListTagsForResource": { @@ -4778,9 +4666,6 @@ "smithy.api#documentation": "A collection of labels, in the form of key:value pairs, that apply to this\n resource.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#MaxResults": { @@ -4811,7 +4696,7 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "A new member that is added to a launch profile.
" } }, "com.amazonaws.nimble#NewLaunchProfileMemberList": { @@ -4820,7 +4705,6 @@ "target": "com.amazonaws.nimble#NewLaunchProfileMember" }, "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 1, "max": 20 @@ -4846,7 +4730,7 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "A new studio user's membership.
" } }, "com.amazonaws.nimble#NewStudioMemberList": { @@ -4855,7 +4739,6 @@ "target": "com.amazonaws.nimble#NewStudioMember" }, "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 1, "max": 20 @@ -4947,9 +4830,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#PutLaunchProfileMembersResponse": { @@ -5033,22 +4913,15 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#PutStudioMembersResponse": { "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "" - } + "members": {} }, "com.amazonaws.nimble#Region": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 50 @@ -5126,10 +4999,7 @@ } }, "com.amazonaws.nimble#SecurityGroupId": { - "type": "string", - "traits": { - "smithy.api#documentation": "" - } + "type": "string" }, "com.amazonaws.nimble#ServiceQuotaExceededException": { "type": "structure", @@ -5232,6 +5102,9 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to start a streaming session", + "aws.iam#conditionKeys": [ + "nimble:requesterPrincipalId" + ], "aws.iam#requiredActions": [ "nimble:GetLaunchProfile", "nimble:GetLaunchProfileMember" @@ -5362,9 +5235,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#StopStreamingSession": { @@ -5400,6 +5270,9 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to stop a streaming session", + "aws.iam#conditionKeys": [ + "nimble:requesterPrincipalId" + ], "aws.iam#requiredActions": [ "nimble:GetLaunchProfile" ], @@ -5472,7 +5345,7 @@ "maxSessionLengthInMinutes": { "target": "com.amazonaws.nimble#StreamConfigurationMaxSessionLengthInMinutes", "traits": { - "smithy.api#documentation": "The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates\n or stops the session. The default length of time is 690 minutes, and the maximum length\n of time is 30 days.
" + "smithy.api#documentation": "The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates or\n stops the session. The default length of time is 690 minutes, and the maximum length of\n time is 30 days.
" } }, "streamingImageIds": { @@ -5490,6 +5363,15 @@ "stop_start_streaming_session" ] } + }, + "sessionStorage": { + "target": "com.amazonaws.nimble#StreamConfigurationSessionStorage", + "traits": { + "smithy.api#documentation": "(Optional) The upload storage for a streaming session.
", + "smithy.api#tags": [ + "session_storage" + ] + } } }, "traits": { @@ -5516,7 +5398,7 @@ "maxSessionLengthInMinutes": { "target": "com.amazonaws.nimble#StreamConfigurationMaxSessionLengthInMinutes", "traits": { - "smithy.api#documentation": "The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates\n or stops the session. The default length of time is 690 minutes, and the maximum length\n of time is 30 days.
" + "smithy.api#documentation": "The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates or\n stops the session. The default length of time is 690 minutes, and the maximum length of\n time is 30 days.
" } }, "streamingImageIds": { @@ -5529,11 +5411,20 @@ "maxStoppedSessionLengthInMinutes": { "target": "com.amazonaws.nimble#StreamConfigurationMaxStoppedSessionLengthInMinutes", "traits": { - "smithy.api#documentation": "The length of time, in minutes, that a streaming session can be active before it is\n stopped or terminated. After this point, Nimble Studio automatically terminates or\n stops the session. The default length of time is 690 minutes, and the maximum length of\n time is 30 days.
", + "smithy.api#documentation": "Integer that determines if you can start and stop your sessions and how long a session\n can stay in the STOPPED state. The default value is 0. The maximum value is 5760.
\nIf the value is missing or set to 0, your sessions can’t be stopped. If you then call\n StopStreamingSession, the session fails. If the time that a session stays in the READY\n state exceeds the maxSessionLengthInMinutes value, the session will automatically be\n terminated by AWS (instead of stopped).
\nIf the value is set to a positive number, the session can be stopped. You can call\n StopStreamingSession to stop sessions in the READY state. If the time that a session\n stays in the READY state exceeds the maxSessionLengthInMinutes value, the session will\n automatically be stopped by AWS (instead of terminated).
", "smithy.api#tags": [ "stop_start_streaming_session" ] } + }, + "sessionStorage": { + "target": "com.amazonaws.nimble#StreamConfigurationSessionStorage", + "traits": { + "smithy.api#documentation": "(Optional) The upload storage for a streaming workstation that is created using this\n launch profile.
", + "smithy.api#tags": [ + "session_storage" + ] + } } }, "traits": { @@ -5543,7 +5434,6 @@ "com.amazonaws.nimble#StreamConfigurationMaxSessionLengthInMinutes": { "type": "integer", "traits": { - "smithy.api#documentation": "", "smithy.api#range": { "min": 1, "max": 43200 @@ -5559,10 +5449,30 @@ } } }, + "com.amazonaws.nimble#StreamConfigurationSessionStorage": { + "type": "structure", + "members": { + "root": { + "target": "com.amazonaws.nimble#StreamingSessionStorageRoot", + "traits": { + "smithy.api#documentation": "The configuration for the upload storage root of the streaming session.
" + } + }, + "mode": { + "target": "com.amazonaws.nimble#StreamingSessionStorageModeList", + "traits": { + "smithy.api#documentation": "Allows artists to upload files to their workstations. The only valid option is\n UPLOAD.
The configuration for a streaming session’s upload storage.
" + } + }, "com.amazonaws.nimble#StreamingClipboardMode": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "ENABLED", @@ -5709,7 +5619,6 @@ "com.amazonaws.nimble#StreamingImageEncryptionConfigurationKeyArn": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 4 }, @@ -5719,7 +5628,6 @@ "com.amazonaws.nimble#StreamingImageEncryptionConfigurationKeyType": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "CUSTOMER_MANAGED_KEY", @@ -5731,7 +5639,6 @@ "com.amazonaws.nimble#StreamingImageId": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 22 @@ -5756,9 +5663,6 @@ "type": "list", "member": { "target": "com.amazonaws.nimble#StreamingImage" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#StreamingImageName": { @@ -5835,7 +5739,6 @@ "com.amazonaws.nimble#StreamingImageState": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "CREATE_IN_PROGRESS", @@ -5900,6 +5803,10 @@ { "value": "INTERNAL_ERROR", "name": "INTERNAL_ERROR" + }, + { + "value": "ACCESS_DENIED", + "name": "ACCESS_DENIED" } ] } @@ -5907,7 +5814,6 @@ "com.amazonaws.nimble#StreamingInstanceType": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "g4dn.xlarge", @@ -6093,18 +5999,12 @@ } }, "com.amazonaws.nimble#StreamingSessionId": { - "type": "string", - "traits": { - "smithy.api#documentation": "" - } + "type": "string" }, "com.amazonaws.nimble#StreamingSessionList": { "type": "list", "member": { "target": "com.amazonaws.nimble#StreamingSession" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#StreamingSessionResource": { @@ -6153,7 +6053,8 @@ "nimble:createdBy", "nimble:ownedBy" ], - "aws.iam#disableConditionKeyInference": {} + "aws.iam#disableConditionKeyInference": {}, + "smithy.api#documentation": "Represents a streaming session that a studio user launches applications and connects to studio components within a studio" } }, "com.amazonaws.nimble#StreamingSessionState": { @@ -6211,7 +6112,6 @@ "com.amazonaws.nimble#StreamingSessionStatusCode": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "STREAMING_SESSION_READY", @@ -6276,6 +6176,70 @@ ] } }, + "com.amazonaws.nimble#StreamingSessionStorageMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "UPLOAD", + "name": "UPLOAD" + } + ] + } + }, + "com.amazonaws.nimble#StreamingSessionStorageModeList": { + "type": "list", + "member": { + "target": "com.amazonaws.nimble#StreamingSessionStorageMode" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.nimble#StreamingSessionStorageRoot": { + "type": "structure", + "members": { + "linux": { + "target": "com.amazonaws.nimble#StreamingSessionStorageRootPathLinux", + "traits": { + "smithy.api#documentation": "The folder path in Linux workstations where files are uploaded. The default path is\n $HOME/Downloads.
The folder path in Windows workstations where files are uploaded. The default path is\n %HOMEPATH%\\Downloads.
The upload storage root location (folder) on streaming workstations where files are\n uploaded.
" + } + }, + "com.amazonaws.nimble#StreamingSessionStorageRootPathLinux": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^(\\$HOME|/)[/]?([A-Za-z0-9-_]+/)*([A-Za-z0-9_-]+)$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.nimble#StreamingSessionStorageRootPathWindows": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^((\\%HOMEPATH\\%)|[a-zA-Z]:)[\\\\/](?:[a-zA-Z0-9_-]+[\\\\/])*[a-zA-Z0-9_-]+$", + "smithy.api#sensitive": {} + } + }, "com.amazonaws.nimble#StreamingSessionStream": { "type": "structure", "members": { @@ -6336,7 +6300,6 @@ "com.amazonaws.nimble#StreamingSessionStreamExpirationInSeconds": { "type": "integer", "traits": { - "smithy.api#documentation": "", "smithy.api#range": { "min": 60, "max": 3600 @@ -6346,7 +6309,6 @@ "com.amazonaws.nimble#StreamingSessionStreamState": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "READY", @@ -6378,7 +6340,6 @@ "com.amazonaws.nimble#StreamingSessionStreamStatusCode": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "STREAM_CREATE_IN_PROGRESS", @@ -6701,7 +6662,6 @@ "com.amazonaws.nimble#StudioComponentDescription": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 256 @@ -6712,7 +6672,6 @@ "com.amazonaws.nimble#StudioComponentId": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 22 @@ -6755,7 +6714,6 @@ "com.amazonaws.nimble#StudioComponentInitializationScriptContent": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 1, "max": 5120 @@ -6767,15 +6725,11 @@ "type": "list", "member": { "target": "com.amazonaws.nimble#StudioComponentInitializationScript" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#StudioComponentInitializationScriptRunContext": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "SYSTEM_INITIALIZATION", @@ -6794,7 +6748,6 @@ "target": "com.amazonaws.nimble#StudioComponent" }, "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 50 @@ -6804,7 +6757,6 @@ "com.amazonaws.nimble#StudioComponentName": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 64 @@ -6854,7 +6806,7 @@ "nimble:studioId" ], "aws.iam#disableConditionKeyInference": {}, - "smithy.api#documentation": "Represents a studio component which connects a non-Nimble Studio resource in your account to your studio", + "smithy.api#documentation": "Represents a studio component that connects a non-Nimble Studio resource in your account to your studio", "smithy.api#externalDocumentation": { "CFNSourceUrl": "https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-nimblestudio" } @@ -6866,7 +6818,6 @@ "target": "com.amazonaws.nimble#ScriptParameterKeyValue" }, "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 30 @@ -6880,9 +6831,8 @@ "target": "com.amazonaws.nimble#SecurityGroupId" }, "traits": { - "smithy.api#documentation": "", "smithy.api#length": { - "min": 1, + "min": 0, "max": 30 } } @@ -6978,7 +6928,6 @@ "com.amazonaws.nimble#StudioComponentSubtype": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "AWS_MANAGED_MICROSOFT_AD", @@ -7058,22 +7007,18 @@ } }, "traits": { - "smithy.api#documentation": "" + "smithy.api#documentation": "The studio component's summary.
" } }, "com.amazonaws.nimble#StudioComponentSummaryList": { "type": "list", "member": { "target": "com.amazonaws.nimble#StudioComponentSummary" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#StudioComponentType": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "ACTIVE_DIRECTORY", @@ -7101,7 +7046,6 @@ "com.amazonaws.nimble#StudioDisplayName": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 64 @@ -7159,9 +7103,6 @@ "type": "list", "member": { "target": "com.amazonaws.nimble#Studio" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#StudioMembership": { @@ -7202,7 +7143,6 @@ "target": "com.amazonaws.nimble#StudioMembership" }, "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 0, "max": 20 @@ -7212,7 +7152,6 @@ "com.amazonaws.nimble#StudioName": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#length": { "min": 3, "max": 64 @@ -7223,7 +7162,6 @@ "com.amazonaws.nimble#StudioPersona": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "ADMINISTRATOR", @@ -7300,7 +7238,6 @@ "com.amazonaws.nimble#StudioState": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#enum": [ { "value": "CREATE_IN_PROGRESS", @@ -7477,7 +7414,6 @@ } }, "traits": { - "smithy.api#documentation": "", "smithy.api#references": [ { "resource": "com.amazonaws.nimble#StudioResource", @@ -7523,9 +7459,6 @@ }, "value": { "target": "com.amazonaws.nimble#String" - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ThrottlingException": { @@ -7560,7 +7493,6 @@ "com.amazonaws.nimble#Timestamp": { "type": "timestamp", "traits": { - "smithy.api#documentation": "", "smithy.api#timestampFormat": "date-time" } }, @@ -7698,6 +7630,13 @@ ], "traits": { "aws.iam#actionPermissionDescription": "Grants permission to update a launch profile", + "aws.iam#requiredActions": [ + "ec2:DescribeSubnets", + "ec2:DescribeRouteTables", + "ec2:DescribeNetworkAcls", + "ec2:DescribeVpcEndpoints", + "ec2:DescribeNatGateways" + ], "smithy.api#documentation": "Update a launch profile.
", "smithy.api#http": { "method": "PATCH", @@ -7789,9 +7728,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#UpdateLaunchProfileMemberResponse": { @@ -7864,9 +7800,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#UpdateLaunchProfileResponse": { @@ -7878,9 +7811,6 @@ "smithy.api#documentation": "The launch profile.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#UpdateStreamingImage": { @@ -7966,23 +7896,14 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#UpdateStreamingImageResponse": { "type": "structure", "members": { "streamingImage": { - "target": "com.amazonaws.nimble#StreamingImage", - "traits": { - "smithy.api#documentation": "" - } + "target": "com.amazonaws.nimble#StreamingImage" } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#UpdateStudio": { @@ -8151,9 +8072,6 @@ "smithy.api#documentation": "The type of the studio component.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#UpdateStudioComponentResponse": { @@ -8165,9 +8083,6 @@ "smithy.api#documentation": "Information about the studio component.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#UpdateStudioRequest": { @@ -8209,9 +8124,6 @@ "smithy.api#documentation": "The IAM role that Studio Users will assume when logging in to the Nimble Studio\n portal.
" } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#UpdateStudioResponse": { @@ -8224,9 +8136,6 @@ "smithy.api#required": {} } } - }, - "traits": { - "smithy.api#documentation": "" } }, "com.amazonaws.nimble#ValidationException": { @@ -8260,7 +8169,6 @@ "com.amazonaws.nimble#WindowsMountDrive": { "type": "string", "traits": { - "smithy.api#documentation": "", "smithy.api#pattern": "^[A-Z]$" } }, @@ -8280,22 +8188,22 @@ "aws.iam#defineConditionKeys": { "nimble:ownedBy": { "type": "String", - "documentation": "Filters access based on the ownedBy request parameter or the ID of the owner of the resource", + "documentation": "Filters access by the ownedBy request parameter or the ID of the owner of the resource", "externalDocumentation": "${ContextKeysDocRoot}" }, "nimble:principalId": { "type": "String", - "documentation": "Filters access based on the principalId request parameter", + "documentation": "Filters access by the principalId request parameter", "externalDocumentation": "${ContextKeysDocRoot}" }, "nimble:createdBy": { "type": "String", - "documentation": "Filters access based on the createdBy request parameter or the ID of the creator of the resource", + "documentation": "Filters access by the createdBy request parameter or the ID of the creator of the resource", "externalDocumentation": "${ContextKeysDocRoot}" }, "nimble:studioId": { "type": "String", - "documentation": "Filters access to resources in a specific studio", + "documentation": "Filters access by a specific studio", "externalDocumentation": "${ContextKeysDocRoot}" }, "aws:RequestTag/${TagKey}": { @@ -8310,7 +8218,7 @@ }, "nimble:requesterPrincipalId": { "type": "String", - "documentation": "Filters access to Nimble Studio portal using the ID of the logged in user", + "documentation": "Filters access by the ID of the logged in user", "externalDocumentation": "${ContextKeysDocRoot}" }, "aws:ResourceTag/${TagKey}": { diff --git a/codegen/sdk/aws-models/opensearch.2021-01-01.json b/codegen/sdk/aws-models/opensearch.2021-01-01.json index dceaa996590..c3a990d311c 100644 --- a/codegen/sdk/aws-models/opensearch.2021-01-01.json +++ b/codegen/sdk/aws-models/opensearch.2021-01-01.json @@ -283,6 +283,18 @@ "traits": { "smithy.api#documentation": "Describes the SAML application configured for a domain.
" } + }, + "AnonymousAuthDisableDate": { + "target": "com.amazonaws.opensearch#DisableTimestamp", + "traits": { + "smithy.api#documentation": "Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
" + } + }, + "AnonymousAuthEnabled": { + "target": "com.amazonaws.opensearch#Boolean", + "traits": { + "smithy.api#documentation": "True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
" + } } }, "traits": { @@ -315,6 +327,12 @@ "traits": { "smithy.api#documentation": "The SAML application configuration for the domain.
" } + }, + "AnonymousAuthEnabled": { + "target": "com.amazonaws.opensearch#Boolean", + "traits": { + "smithy.api#documentation": "True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
" + } } }, "traits": { @@ -345,6 +363,24 @@ }, "com.amazonaws.opensearch#AmazonOpenSearchService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "OpenSearch", + "arnNamespace": "es", + "cloudFormationName": "OpenSearch", + "cloudTrailEventSource": "opensearch.amazonaws.com", + "endpointPrefix": "es" + }, + "aws.auth#sigv4": { + "name": "es" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Use the Amazon OpenSearch configuration API to create, configure, and manage Amazon OpenSearch Service domains.
\nFor sample code that uses the configuration API, see the \n Amazon OpenSearch Service Developer Guide.\n The guide also contains \n sample\n code for sending signed HTTP requests to the OpenSearch APIs.\n
\nThe endpoint for configuration service requests is region-specific: es.region.amazonaws.com.\n For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints,\n see Regions and Endpoints.\n
", + "smithy.api#title": "Amazon OpenSearch Service", + "smithy.api#xmlNamespace": { + "uri": "http://es.amazonaws.com/doc/2021-01-01/" + } + }, "version": "2021-01-01", "operations": [ { @@ -464,25 +500,7 @@ { "target": "com.amazonaws.opensearch#UpgradeDomain" } - ], - "traits": { - "aws.api#service": { - "sdkId": "OpenSearch", - "arnNamespace": "es", - "cloudFormationName": "OpenSearch", - "cloudTrailEventSource": "opensearch.amazonaws.com", - "endpointPrefix": "es" - }, - "aws.auth#sigv4": { - "name": "es" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Use the Amazon OpenSearch configuration API to create, configure, and manage Amazon OpenSearch Service domains.
\nFor sample code that uses the configuration API, see the \n Amazon OpenSearch Service Developer Guide.\n The guide also contains \n sample\n code for sending signed HTTP requests to the OpenSearch APIs.\n
\nThe endpoint for configuration service requests is region-specific: es.region.amazonaws.com.\n For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints,\n see Regions and Endpoints.\n
", - "smithy.api#title": "Amazon OpenSearch Service", - "smithy.api#xmlNamespace": { - "uri": "http://es.amazonaws.com/doc/2021-01-01/" - } - } + ] }, "com.amazonaws.opensearch#AssociatePackage": { "type": "operation", @@ -2614,6 +2632,9 @@ "smithy.api#documentation": "Container for results from\n DescribeReservedInstances\n
The control plane for Amazon QLDB
", + "smithy.api#title": "Amazon QLDB", + "smithy.api#xmlNamespace": { + "uri": "http://ledger.amazonaws.com/doc/2019-01-02/" + } + }, "version": "2019-01-02", "operations": [ { @@ -93,25 +111,7 @@ { "target": "com.amazonaws.qldb#UpdateLedgerPermissionsMode" } - ], - "traits": { - "aws.api#service": { - "sdkId": "QLDB", - "arnNamespace": "qldb", - "cloudFormationName": "QLDB", - "cloudTrailEventSource": "qldb.amazonaws.com", - "endpointPrefix": "qldb" - }, - "aws.auth#sigv4": { - "name": "qldb" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "The control plane for Amazon QLDB
", - "smithy.api#title": "Amazon QLDB", - "smithy.api#xmlNamespace": { - "uri": "http://ledger.amazonaws.com/doc/2019-01-02/" - } - } + ] }, "com.amazonaws.qldb#Arn": { "type": "string", @@ -211,7 +211,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new ledger in your account in the current Region.
", + "smithy.api#documentation": "Creates a new ledger in your Amazon Web Services account in the current Region.
", "smithy.api#http": { "method": "POST", "uri": "/ledgers", @@ -225,7 +225,7 @@ "Name": { "target": "com.amazonaws.qldb#LedgerName", "traits": { - "smithy.api#documentation": "The name of the ledger that you want to create. The name must be unique among all of\n the ledgers in your account in the current Region.
\nNaming constraints for ledger names are defined in Quotas in Amazon QLDB\n in the Amazon QLDB Developer Guide.
", + "smithy.api#documentation": "The name of the ledger that you want to create. The name must be unique among all of the\n ledgers in your Amazon Web Services account in the current Region.
\nNaming constraints for ledger names are defined in Quotas in Amazon QLDB\n in the Amazon QLDB Developer Guide.
", "smithy.api#required": {} } }, @@ -251,7 +251,7 @@ "KmsKey": { "target": "com.amazonaws.qldb#KmsKey", "traits": { - "smithy.api#documentation": "The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For\n more information, see Encryption at rest in\n the Amazon QLDB Developer Guide.
\nUse one of the following options to specify this parameter:
\n\n AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed by Amazon Web Services\n on your behalf.
\n Undefined: By default, use an Amazon Web Services owned KMS\n key.
\n\n A valid symmetric customer managed KMS key: Use\n the specified KMS key in your account that you create, own, and manage.
\nAmazon QLDB does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer\n Guide.
\nTo specify a customer managed KMS key, you can use its key ID, Amazon Resource Name\n (ARN), alias name, or alias ARN. When using an alias name, prefix it with\n \"alias/\". To specify a key in a different account, you must use the key\n ARN or alias ARN.
For example:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias ARN:\n arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias\n
For more information, see Key identifiers (KeyId) in\n the Key Management Service Developer Guide.
" + "smithy.api#documentation": "The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For\n more information, see Encryption at rest in\n the Amazon QLDB Developer Guide.
\nUse one of the following options to specify this parameter:
\n\n AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed by Amazon Web Services\n on your behalf.
\n Undefined: By default, use an Amazon Web Services owned KMS\n key.
\n\n A valid symmetric customer managed KMS key: Use\n the specified KMS key in your account that you create, own, and manage.
\nAmazon QLDB does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer\n Guide.
\nTo specify a customer managed KMS key, you can use its key ID, Amazon Resource Name\n (ARN), alias name, or alias ARN. When using an alias name, prefix it with\n \"alias/\". To specify a key in a different Amazon Web Services account, you must use the key\n ARN or alias ARN.
For example:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias ARN:\n arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias\n
For more information, see Key identifiers (KeyId) in\n the Key Management Service Developer Guide.
" } } } @@ -613,7 +613,7 @@ } ], "traits": { - "smithy.api#documentation": "Exports journal contents within a date and time range from a ledger into a specified\n Amazon Simple Storage Service (Amazon S3) bucket. The data is written as files in Amazon Ion format.
\nIf the ledger with the given Name doesn't exist, then throws\n ResourceNotFoundException.
If the ledger with the given Name is in CREATING status, then\n throws ResourcePreconditionNotMetException.
You can initiate up to two concurrent journal export requests for each ledger. Beyond\n this limit, journal export requests throw LimitExceededException.
Exports journal contents within a date and time range from a ledger into a specified\n Amazon Simple Storage Service (Amazon S3) bucket. A journal export job can write the data objects in either the text\n or binary representation of Amazon Ion format, or in JSON Lines text\n format.
\nIn JSON Lines format, each journal block in the exported data object is a valid JSON\n object that is delimited by a newline. You can use this format to easily integrate JSON\n exports with analytics tools such as Glue and Amazon Athena\n because these services can parse newline-delimited JSON automatically. For more information\n about the format, see JSON Lines.
\nIf the ledger with the given Name doesn't exist, then throws\n ResourceNotFoundException.
If the ledger with the given Name is in CREATING status, then\n throws ResourcePreconditionNotMetException.
You can initiate up to two concurrent journal export requests for each ledger. Beyond\n this limit, journal export requests throw LimitExceededException.
The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal export job to do the following:
\nWrite objects into your Amazon Simple Storage Service (Amazon S3) bucket.
\n(Optional) Use your customer master key (CMK) in Key Management Service (KMS) for server-side\n encryption of your exported data.
\nThe Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal export job to do the following:
\nWrite objects into your Amazon Simple Storage Service (Amazon S3) bucket.
\n(Optional) Use your customer managed key in Key Management Service (KMS) for server-side\n encryption of your exported data.
\nTo pass a role to QLDB when requesting a journal export, you must have permissions to\n perform the iam:PassRole action on the IAM role resource. This is required for\n all journal export requests.
The output format of your exported journal data. If this parameter is not specified, the\n exported data defaults to ION_TEXT format.
The inclusive start date and time for the range of journal contents that are specified\n in the original export request.
", + "smithy.api#documentation": "The inclusive start date and time for the range of journal contents that was specified\n in the original export request.
", "smithy.api#required": {} } }, "ExclusiveEndTime": { "target": "com.amazonaws.qldb#Timestamp", "traits": { - "smithy.api#documentation": "The exclusive end date and time for the range of journal contents that are specified in\n the original export request.
", + "smithy.api#documentation": "The exclusive end date and time for the range of journal contents that was specified in\n the original export request.
", "smithy.api#required": {} } }, @@ -1073,9 +1079,15 @@ "RoleArn": { "target": "com.amazonaws.qldb#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal export job to do the following:
\nWrite objects into your Amazon Simple Storage Service (Amazon S3) bucket.
\n(Optional) Use your customer master key (CMK) in Key Management Service (KMS) for server-side\n encryption of your exported data.
\nThe Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal export job to do the following:
\nWrite objects into your Amazon Simple Storage Service (Amazon S3) bucket.
\n(Optional) Use your customer managed key in Key Management Service (KMS) for server-side\n encryption of your exported data.
\nThe output format of the exported journal data.
" + } } }, "traits": { @@ -1316,7 +1328,7 @@ "target": "com.amazonaws.qldb#ListJournalS3ExportsResponse" }, "traits": { - "smithy.api#documentation": "Returns an array of journal export job descriptions for all ledgers that are associated\n with the current account and Region.
\nThis action returns a maximum of MaxResults items, and is paginated so that\n you can retrieve all the items by calling ListJournalS3Exports multiple\n times.
This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer\n Guide.
", + "smithy.api#documentation": "Returns an array of journal export job descriptions for all ledgers that are associated\n with the current Amazon Web Services account and Region.
\nThis action returns a maximum of MaxResults items, and is paginated so that\n you can retrieve all the items by calling ListJournalS3Exports multiple\n times.
This action does not return any expired export jobs. For more information, see Export job expiration in the Amazon QLDB Developer\n Guide.
", "smithy.api#http": { "method": "GET", "uri": "/journal-s3-exports", @@ -1420,7 +1432,7 @@ "JournalS3Exports": { "target": "com.amazonaws.qldb#JournalS3ExportList", "traits": { - "smithy.api#documentation": "The array of journal export job descriptions for all ledgers that are associated with\n the current account and Region.
" + "smithy.api#documentation": "The array of journal export job descriptions for all ledgers that are associated with\n the current Amazon Web Services account and Region.
" } }, "NextToken": { @@ -1440,7 +1452,7 @@ "target": "com.amazonaws.qldb#ListLedgersResponse" }, "traits": { - "smithy.api#documentation": "Returns an array of ledger summaries that are associated with the current account\n and Region.
\nThis action returns a maximum of 100 items and is paginated so that you can\n retrieve all the items by calling ListLedgers multiple times.
Returns an array of ledger summaries that are associated with the current Amazon Web Services account\n and Region.
\nThis action returns a maximum of 100 items and is paginated so that you can\n retrieve all the items by calling ListLedgers multiple times.
The array of ledger summaries that are associated with the current account and\n Region.
" + "smithy.api#documentation": "The array of ledger summaries that are associated with the current Amazon Web Services account and\n Region.
" } }, "NextToken": { @@ -1558,6 +1570,25 @@ "smithy.api#pattern": "^[A-Za-z-0-9+/=]+$" } }, + "com.amazonaws.qldb#OutputFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ION_BINARY", + "name": "ION_BINARY" + }, + { + "value": "ION_TEXT", + "name": "ION_TEXT" + }, + { + "value": "JSON", + "name": "JSON" + } + ] + } + }, "com.amazonaws.qldb#ParameterName": { "type": "string" }, @@ -1705,7 +1736,7 @@ "KmsKeyArn": { "target": "com.amazonaws.qldb#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) in Key Management Service\n (KMS). Amazon S3 does not support asymmetric CMKs.
\nYou must provide a KmsKeyArn if you specify SSE_KMS as the\n ObjectEncryptionType.
\n KmsKeyArn is not required if you specify SSE_S3 as the\n ObjectEncryptionType.
The Amazon Resource Name (ARN) of a symmetric key in Key Management Service (KMS). Amazon S3 does not\n support asymmetric KMS keys.
\nYou must provide a KmsKeyArn if you specify SSE_KMS as the\n ObjectEncryptionType.
\n KmsKeyArn is not required if you specify SSE_S3 as the\n ObjectEncryptionType.
The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal stream to write data records to a Kinesis Data Streams resource.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions for a\n journal stream to write data records to a Kinesis Data Streams resource.
\nTo pass a role to QLDB when requesting a journal stream, you must have permissions to\n perform the iam:PassRole action on the IAM role resource. This is required for\n all journal stream requests.
The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For\n more information, see Encryption at rest in\n the Amazon QLDB Developer Guide.
\nUse one of the following options to specify this parameter:
\n\n AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed by Amazon Web Services\n on your behalf.
\n Undefined: Make no changes to the KMS key of the\n ledger.
\n\n A valid symmetric customer managed KMS key: Use\n the specified KMS key in your account that you create, own, and manage.
\nAmazon QLDB does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer\n Guide.
\nTo specify a customer managed KMS key, you can use its key ID, Amazon Resource Name\n (ARN), alias name, or alias ARN. When using an alias name, prefix it with\n \"alias/\". To specify a key in a different account, you must use the key\n ARN or alias ARN.
For example:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias ARN:\n arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias\n
For more information, see Key identifiers (KeyId) in\n the Key Management Service Developer Guide.
" + "smithy.api#documentation": "The key in Key Management Service (KMS) to use for encryption of data at rest in the ledger. For\n more information, see Encryption at rest in\n the Amazon QLDB Developer Guide.
\nUse one of the following options to specify this parameter:
\n\n AWS_OWNED_KMS_KEY: Use an KMS key that is owned and managed by Amazon Web Services\n on your behalf.
\n Undefined: Make no changes to the KMS key of the\n ledger.
\n\n A valid symmetric customer managed KMS key: Use\n the specified KMS key in your account that you create, own, and manage.
\nAmazon QLDB does not support asymmetric keys. For more information, see Using symmetric and asymmetric keys in the Key Management Service Developer\n Guide.
\nTo specify a customer managed KMS key, you can use its key ID, Amazon Resource Name\n (ARN), alias name, or alias ARN. When using an alias name, prefix it with\n \"alias/\". To specify a key in a different Amazon Web Services account, you must use the key\n ARN or alias ARN.
For example:
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Alias name: alias/ExampleAlias\n
Alias ARN:\n arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias\n
For more information, see Key identifiers (KeyId) in\n the Key Management Service Developer Guide.
" } } } diff --git a/codegen/sdk/aws-models/quicksight.2018-04-01.json b/codegen/sdk/aws-models/quicksight.2018-04-01.json index 13908731666..f631f0fecd1 100644 --- a/codegen/sdk/aws-models/quicksight.2018-04-01.json +++ b/codegen/sdk/aws-models/quicksight.2018-04-01.json @@ -1681,7 +1681,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a dataset.
", + "smithy.api#documentation": "Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/data-sets", @@ -2580,7 +2580,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates and starts a new SPICE ingestion on a dataset
\n\t\t\n\t\tAny ingestions operating on tagged datasets inherit the same tags automatically for use in\n\t\t\taccess control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using\n\t\t\t\ttags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
", + "smithy.api#documentation": "Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in\n\t\t\tan Enterprise edition account 32 times in a 24-hour period. You can manually refresh\n\t\t\tdatasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period\n\t\t\tis measured starting 24 hours before the current date and time.
\n\t\t\n\t\tAny ingestions operating on tagged datasets inherit the same tags automatically for use in\n\t\t\taccess control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using\n\t\t\t\ttags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}", @@ -6800,7 +6800,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes a dataset.
", + "smithy.api#documentation": "Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", @@ -17602,7 +17602,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates a dataset.
", + "smithy.api#documentation": "Updates a dataset. This operation doesn't support datasets that include uploaded files as a source.
", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", diff --git a/codegen/sdk/aws-models/rds.2014-10-31.json b/codegen/sdk/aws-models/rds.2014-10-31.json index f56820ee0d1..0da9516f189 100644 --- a/codegen/sdk/aws-models/rds.2014-10-31.json +++ b/codegen/sdk/aws-models/rds.2014-10-31.json @@ -1900,7 +1900,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific\n AMI. The only supported engine is Oracle Database 19c Enterprise Edition with the January 2021 or later\n RU/RUR.
\nAmazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software.\n The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create\n your database. With Amazon RDS Custom, you upload your database installation files in Amazon S3.
\nWhen you create a custom engine version, you specify the files in a JSON document called a CEV manifest. \n This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from \n the installation files that you provided. This service model is called Bring Your Own Media (BYOM).
\nCreation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with \n the message Creation failed for custom engine version, and includes details about the failure. \n For example, the event prints missing files.
After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple \n RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or\n inactive.
\nThe MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the CreateCustomDbEngineVersion event.
For more information, see \n Creating a CEV in the Amazon RDS User Guide.
" + "smithy.api#documentation": "Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific\n AMI. The only supported engine is Oracle Database 19c Enterprise Edition with the January 2021 or later\n RU/RUR.
\nAmazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software.\n The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create\n your database. With Amazon RDS Custom for Oracle, you upload your database installation files in Amazon S3.
\nWhen you create a custom engine version, you specify the files in a JSON document called a CEV manifest. \n This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from \n the installation files that you provided. This service model is called Bring Your Own Media (BYOM).
\nCreation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with \n the message Creation failed for custom engine version, and includes details about the failure. \n For example, the event prints missing files.
After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple \n RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or\n inactive.
\nThe MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with \n Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the \n CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the \n API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for \n the CreateCustomDbEngineVersion event.
For more information, see \n Creating a CEV in the Amazon RDS User Guide.
" } }, "com.amazonaws.rds#CreateCustomDBEngineVersionMessage": { @@ -1916,7 +1916,7 @@ "EngineVersion": { "target": "com.amazonaws.rds#CustomEngineVersion", "traits": { - "smithy.api#documentation": "The name of your CEV. The name format is 19.customized_string\n . For example, \n a valid name is 19.my_cev1. This setting is required for RDS Custom, but optional for Amazon RDS. \n The combination of Engine and EngineVersion is unique per customer per Region.
The name of your CEV. The name format is 19.customized_string\n . For example, \n a valid name is 19.my_cev1. This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. \n The combination of Engine and EngineVersion is unique per customer per Region.
The name of the database engine to be used for this DB cluster.
\nValid Values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible Aurora)
\n aurora-postgresql\n
\n mysql\n
\n postgres\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", + "smithy.api#documentation": "The name of the database engine to be used for this DB cluster.
\nValid Values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
\n aurora-postgresql\n
\n mysql\n
\n postgres\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
", "smithy.api#required": {} } }, "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The version number of the database engine to use.
\nTo list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for MySQL 5.7-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nFor information, see MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.\n
\n\n Aurora PostgreSQL\n
\nFor information, see Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.\n
\n\n MySQL\n
\nFor information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n\n PostgreSQL\n
\nFor information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The version number of the database engine to use.
\nTo list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nFor information, see MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.\n
\n\n Aurora PostgreSQL\n
\nFor information, see Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.\n
\n\n MySQL\n
\nFor information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n\n PostgreSQL\n
\nFor information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Port": { @@ -2320,7 +2320,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the DB cluster.
\nThis setting is required to create a Multi-AZ DB cluster.
\n\n Valid values: standard | gp2 | io1\n
\n If you specify io1, also include a value for the\n Iops parameter.\n
\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
Valid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "Specifies the storage type to be associated with the DB cluster.
\nThis setting is required to create a Multi-AZ DB cluster.
\n\n Valid values: io1\n
\n When specified, a value for the Iops parameter is required.\n
\n Default: io1\n
Valid for: Multi-AZ DB clusters only
" } }, "Iops": { @@ -2409,7 +2409,7 @@ "DBParameterGroupFamily": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster \n parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
\n\n Aurora MySQL\n
\nExample: aurora5.6, aurora-mysql5.7\n
\n Aurora PostgreSQL\n
\nExample: aurora-postgresql9.6\n
\n RDS for MySQL\n
\nExample: mysql8.0\n
\n RDS for PostgreSQL\n
\nExample: postgres12\n
To list all of the available parameter group families for a DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql\n
The output contains duplicates.
\nThe following are the valid DB engine values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible Aurora)
\n aurora-postgresql\n
\n mysql\n
\n postgres\n
The DB cluster parameter group family name. A DB cluster parameter group can be associated with one and only one DB cluster \n parameter group family, and can be applied only to a DB cluster running a database engine and engine version compatible with that DB cluster parameter group family.
\n\n Aurora MySQL\n
\nExample: aurora5.6, aurora-mysql5.7, aurora-mysql8.0\n
\n Aurora PostgreSQL\n
\nExample: aurora-postgresql9.6\n
\n RDS for MySQL\n
\nExample: mysql8.0\n
\n RDS for PostgreSQL\n
\nExample: postgres12\n
To list all of the available parameter group families for a DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n
For example, to list all of the available parameter group families for the Aurora PostgreSQL DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine aurora-postgresql\n
The output contains duplicates.
\nThe following are the valid DB engine values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
\n aurora-postgresql\n
\n mysql\n
\n postgres\n
The meaning of this parameter differs according to the database engine you use.
\n\n MySQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n MariaDB\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n PostgreSQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.
Constraints:
\nMust contain 1 to 63 letters, numbers, or underscores.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n Oracle\n
\nThe Oracle System ID (SID) of the created DB instance.\n If you specify null, the default value ORCL is used.\n You can't specify the string NULL, or any other reserved word, for DBName. \n
Default: ORCL\n
Constraints:
\nCan't be longer than 8 characters
\n\n Amazon RDS Custom\n
\nThe Oracle System ID (SID) of the created RDS Custom DB instance.\n If you don't specify a value, the default value is ORCL.\n
Default: ORCL\n
Constraints:
\nIt must contain 1 to 8 alphanumeric characters.
\nIt must contain a letter.
\nIt can't be a word reserved by the database engine.
\n\n SQL Server\n
\nNot applicable. Must be null.
\n\n Amazon Aurora MySQL\n
\nThe name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.
\nConstraints:
\nIt must contain 1 to 64 alphanumeric characters.
\nIt can't be a word reserved by the database engine.
\n\n Amazon Aurora PostgreSQL\n
\nThe name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.
Constraints:
\nIt must contain 1 to 63 alphanumeric characters.
\nIt must begin with a letter or an underscore.\n Subsequent characters can be letters, underscores, or digits\n (0 to 9).
\nIt can't be a word reserved by the\n database engine.
\nThe meaning of this parameter differs according to the database engine you use.
\n\n MySQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n MariaDB\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance.
\nConstraints:
\nMust contain 1 to 64 letters or numbers.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n PostgreSQL\n
\nThe name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres \n is created in the DB instance.
Constraints:
\nMust contain 1 to 63 letters, numbers, or underscores.
\nMust begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).
\nCan't be a word reserved by the specified database engine
\n\n Oracle\n
\nThe Oracle System ID (SID) of the created DB instance.\n If you specify null, the default value ORCL is used.\n You can't specify the string NULL, or any other reserved word, for DBName. \n
Default: ORCL\n
Constraints:
\nCan't be longer than 8 characters
\n\n Amazon RDS Custom for Oracle\n
\nThe Oracle System ID (SID) of the created RDS Custom DB instance.\n If you don't specify a value, the default value is ORCL.\n
Default: ORCL\n
Constraints:
\nIt must contain 1 to 8 alphanumeric characters.
\nIt must contain a letter.
\nIt can't be a word reserved by the database engine.
\n\n Amazon RDS Custom for SQL Server\n
\nNot applicable. Must be null.
\n\n SQL Server\n
\nNot applicable. Must be null.
\n\n Amazon Aurora MySQL\n
\nThe name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is\n created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created \n in the DB cluster.
\nConstraints:
\nIt must contain 1 to 64 alphanumeric characters.
\nIt can't be a word reserved by the database engine.
\n\n Amazon Aurora PostgreSQL\n
\nThe name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is\n created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, \n a database named postgres is created in the DB cluster.
Constraints:
\nIt must contain 1 to 63 alphanumeric characters.
\nIt must begin with a letter or an underscore.\n Subsequent characters can be letters, underscores, or digits\n (0 to 9).
\nIt can't be a word reserved by the\n database engine.
\nThe amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nType: Integer
\n\n Amazon Aurora\n
\nNot applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.
\n\n\n Amazon RDS Custom\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 40 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 40 to 65536.
\n\n MySQL\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n MariaDB\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n PostgreSQL\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n Oracle\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 10 to 3072.
\n\n SQL Server\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2):
\nEnterprise and Standard editions: Must be an integer from 200 to 16384.
\nWeb and Express editions: Must be an integer from 20 to 16384.
\nProvisioned IOPS storage (io1):
\nEnterprise and Standard editions: Must be an integer from 200 to 16384.
\nWeb and Express editions: Must be an integer from 100 to 16384.
\nMagnetic storage (standard):
\nEnterprise and Standard editions: Must be an integer from 200 to 1024.
\nWeb and Express editions: Must be an integer from 20 to 1024.
\nThe amount of storage in gibibytes (GiB) to allocate for the DB instance.
\nType: Integer
\n\n Amazon Aurora\n
\nNot applicable. Aurora cluster volumes automatically grow as the amount of data in your \n database increases, though you are only charged for the space that you use in an Aurora cluster volume.
\n\n\n Amazon RDS Custom\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.
\nProvisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS Custom for Oracle, \n 16384 for RDS Custom for SQL Server.
\n\n MySQL\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n MariaDB\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n PostgreSQL\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 5 to 3072.
\n\n Oracle\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.
\nProvisioned IOPS storage (io1): Must be an integer from 100 to 65536.
\nMagnetic storage (standard): Must be an integer from 10 to 3072.
\n\n SQL Server\n
\nConstraints to the amount of storage for each storage type are the following:\n
\nGeneral Purpose (SSD) storage (gp2):
\nEnterprise and Standard editions: Must be an integer from 20 to 16384.
\nWeb and Express editions: Must be an integer from 20 to 16384.
\nProvisioned IOPS storage (io1):
\nEnterprise and Standard editions: Must be an integer from 100 to 16384.
\nWeb and Express editions: Must be an integer from 100 to 16384.
\nMagnetic storage (standard):
\nEnterprise and Standard editions: Must be an integer from 20 to 1024.
\nWeb and Express editions: Must be an integer from 20 to 1024.
\nThe name of the database engine to be used for this instance.\n
\n \nNot every database engine is available for every Amazon Web Services Region.\n
\n\nValid Values:\n
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible Aurora)
\n aurora-postgresql\n
\n custom-oracle-ee (for RDS Custom instances)\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The name of the database engine to be used for this instance.\n
\n \nNot every database engine is available for every Amazon Web Services Region.\n
\n\nValid Values:\n
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
\n aurora-postgresql\n
\n custom-oracle-ee (for RDS Custom for Oracle instances)\n
\n custom-sqlserver-ee (for RDS Custom for SQL Server instances)\n
\n custom-sqlserver-se (for RDS Custom for SQL Server instances)\n
\n custom-sqlserver-web (for RDS Custom for SQL Server instances)\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
\n The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.\n
\nDefault: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
\n\n Example: us-east-1d\n
\n Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.\n
If you're creating a DB instance in an RDS on VMware environment,\n specify the identifier of the custom Availability Zone to create the DB instance\n in.
\nFor more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n
\n\n The Availability Zone (AZ) where the database will be created. For information on\n Amazon Web Services Regions and Availability Zones, see \n Regions\n and Availability Zones.\n
\n\n Amazon Aurora\n
\nNot applicable. Availability Zones are managed by the DB cluster.\n
\nDefault: A random, system-chosen Availability Zone in the endpoint's Amazon Web Services Region.
\n\n Example: us-east-1d\n
\n Constraint: The AvailabilityZone parameter can't be specified if the DB instance is a Multi-AZ deployment. \n The specified Availability Zone must be in the same Amazon Web Services Region as the current endpoint.\n
If you're creating a DB instance in an RDS on VMware environment,\n specify the identifier of the custom Availability Zone to create the DB instance\n in.
\nFor more information about RDS on VMware, see the \n \n RDS on VMware User Guide.\n
\nThe number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.
\n\n Amazon Aurora\n
\nNot applicable. The retention period for automated backups is managed by the DB cluster.
\nDefault: 1
\nConstraints:
\nMust be a value from 0 to 35
\nCan't be set to 0 if the DB instance is a source to read replicas
\nCan't be set to 0 or 35 for an RDS Custom DB instance
\nThe number of days for which automated backups are retained. Setting this parameter to a positive number enables \n backups. Setting this parameter to 0 disables automated backups.
\n\n Amazon Aurora\n
\nNot applicable. The retention period for automated backups is managed by the DB cluster.
\nDefault: 1
\nConstraints:
\nMust be a value from 0 to 35
\nCan't be set to 0 if the DB instance is a source to read replicas
\nCan't be set to 0 or 35 for an RDS Custom for Oracle DB instance
\nThe version number of the database engine to use.
\nFor a list of valid engine versions, use the DescribeDBEngineVersions action.
The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
\n \n\n Amazon Aurora\n
\nNot applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.
\n \n\n Amazon RDS Custom\n
\nA custom engine version (CEV) that you have previously created. This setting is required for RDS Custom. The CEV \n name has the following format: 19.customized_string\n . An example identifier is \n 19.my_cev1. For more information, see \n Creating an RDS Custom DB instance in the Amazon RDS User Guide..
\n MariaDB\n
\n\nFor information, see MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n \n\n Microsoft SQL Server\n
\n \nFor information, see Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.\n
\n \n\n MySQL\n
\n\nFor information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n \n\n Oracle\n
\n \nFor information, see Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.\n
\n\n\n PostgreSQL\n
\n\nFor information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n
" + "smithy.api#documentation": "The version number of the database engine to use.
\nFor a list of valid engine versions, use the DescribeDBEngineVersions action.
The following are the database engines and links to information about the major and minor versions that are available with \n Amazon RDS. Not every database engine is available for every Amazon Web Services Region.
\n \n\n Amazon Aurora\n
\nNot applicable. The version number of the database engine to be used by the DB\n instance is managed by the DB cluster.
\n \n\n Amazon RDS Custom for Oracle\n
\nA custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. The CEV \n name has the following format: 19.customized_string\n . An example identifier is \n 19.my_cev1. For more information, see \n Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide..
\n Amazon RDS Custom for SQL Server\n
\nSee RDS Custom for SQL Server general requirements \n in the Amazon RDS User Guide.\n
\n \n\n MariaDB\n
\nFor information, see MariaDB on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n \n\n Microsoft SQL Server\n
\nFor information, see Microsoft SQL Server Versions on Amazon RDS in the \n Amazon RDS User Guide.\n
\n \n\n MySQL\n
\nFor information, see MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n \n\n Oracle\n
\nFor information, see Oracle Database Engine Release Notes in the \n Amazon RDS User Guide.\n
\n\n\n PostgreSQL\n
\nFor information, see Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n
" } }, "AutoMinorVersionUpgrade": { @@ -2772,13 +2772,13 @@ "StorageEncrypted": { "target": "com.amazonaws.rds#BooleanOptional", "traits": { - "smithy.api#documentation": "A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
\nFor RDS Custom Oracle instances, either set this parameter to true or leave it unset. \n If you set this parameter to false, RDS reports an error.
\n Amazon Aurora\n
\nNot applicable. The encryption for DB instances is managed by the DB cluster.
" + "smithy.api#documentation": "A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted.
\nFor RDS Custom instances, either set this parameter to true or leave it unset. \n If you set this parameter to false, RDS reports an error.
\n Amazon Aurora\n
\nNot applicable. The encryption for DB instances is managed by the DB cluster.
" } }, "KmsKeyId": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The Amazon Web Services KMS key identifier for an encrypted DB instance.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\n\n Amazon Aurora\n
\nNot applicable. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.
If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.
\n Amazon RDS Custom\n
\nA KMS key is required for RDS Custom Oracle instances. For most RDS engines, if you leave this parameter empty \n while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom for Oracle \n doesn't use the default key when this parameter is empty. You must explicitly specify a key.
The Amazon Web Services KMS key identifier for an encrypted DB instance.
\nThe Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN.
\n\n Amazon Aurora\n
\nNot applicable. The Amazon Web Services KMS key identifier is managed by\n the DB cluster. For more information, see CreateDBCluster.
If StorageEncrypted is enabled, and you do\n not specify a value for the KmsKeyId parameter, then\n Amazon RDS uses your default KMS key. There is a \n default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different\n default KMS key for each Amazon Web Services Region.
\n Amazon RDS Custom\n
\nA KMS key is required for RDS Custom instances. For most RDS engines, if you leave this parameter empty \n while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom \n doesn't use the default key when this parameter is empty. You must explicitly specify a key.
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
\nTo list all of the available parameter group families for a DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql\n
The output contains duplicates.
\nThe following are the valid DB engine values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible Aurora)
\n aurora-postgresql\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.
\nTo list all of the available parameter group families for a DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine \n
For example, to list all of the available parameter group families for the MySQL DB engine, use the following command:
\n\n aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\" --engine mysql\n
The output contains duplicates.
\nThe following are the valid DB engine values:
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
\n aurora-postgresql\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The storage type associated with DB instance.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" + "smithy.api#documentation": "The storage type associated with the DB cluster.
\nThis setting is only for non-Aurora Multi-AZ DB clusters.
" } }, "Iops": { @@ -5153,7 +5153,7 @@ "Status": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the status of this DB cluster snapshot.
" + "smithy.api#documentation": "Specifies the status of this DB cluster snapshot. Valid statuses are the following:
\n\n available\n
\n copying\n
\n creating\n
The database engine to return.
\nValid Values:\n
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible Aurora)
\n aurora-postgresql\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The database engine to return.
\nValid Values:\n
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
\n aurora-postgresql\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The name of the engine to retrieve DB instance options for.
\nValid Values:\n
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible Aurora)
\n aurora-postgresql\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The name of the engine to retrieve DB instance options for.
\nValid Values:\n
\n\n aurora (for MySQL 5.6-compatible Aurora)
\n aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
\n aurora-postgresql\n
\n mariadb\n
\n mysql\n
\n oracle-ee\n
\n oracle-ee-cdb\n
\n oracle-se2\n
\n oracle-se2-cdb\n
\n postgres\n
\n sqlserver-ee\n
\n sqlserver-se\n
\n sqlserver-ex\n
\n sqlserver-web\n
The custom engine version (CEV) that you want to modify. This option is required for \n RDS Custom, but optional for Amazon RDS. The combination of Engine and \n EngineVersion is unique per customer per Amazon Web Services Region.
The custom engine version (CEV) that you want to modify. This option is required for \n RDS Custom for Oracle, but optional for Amazon RDS. The combination of Engine and \n EngineVersion is unique per customer per Amazon Web Services Region.
The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.
To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for MySQL 5.7-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.
To list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "AllowMajorVersionUpgrade": { @@ -14026,7 +14026,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the DB cluster.
\n\n Valid values: standard | gp2 | io1\n
\n If you specify io1, you must also include a value for the\n Iops parameter.\n
\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
Valid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "Specifies the storage type to be associated with the DB cluster.
\n\n Valid values: io1\n
\n When specified, a value for the Iops parameter is required.\n
\n Default: io1\n
Valid for: Multi-AZ DB clusters only
" } }, "Iops": { @@ -14281,7 +14281,7 @@ "DBInstanceClass": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The new compute and memory capacity of the DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
\nIf you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.\n
This setting doesn't apply to RDS Custom.
\nDefault: Uses existing setting
" + "smithy.api#documentation": "The new compute and memory capacity of the DB instance, for example db.m4.large.\n Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines.\n For the full list of DB instance classes,\n and availability for your engine, see\n DB Instance Class in the Amazon RDS User Guide.\n
\nIf you modify the DB instance class, an outage occurs during the change.\n The change is applied during the next maintenance window,\n unless ApplyImmediately is enabled for this request.\n
This setting doesn't apply to RDS Custom for Oracle.
\nDefault: Uses existing setting
" } }, "DBSubnetGroupName": { @@ -14299,13 +14299,13 @@ "VpcSecurityGroupIds": { "target": "com.amazonaws.rds#VpcSecurityGroupIdList", "traits": { - "smithy.api#documentation": "A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is \n asynchronously applied as soon as possible.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.
Constraints:
\nIf supplied, must match existing VpcSecurityGroupIds.
\nA list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is \n asynchronously applied as soon as possible.
\nThis setting doesn't apply to RDS Custom.
\n\n Amazon Aurora\n
\nNot applicable. The associated list of EC2 VPC security groups is managed by\n the DB cluster. For more information, see ModifyDBCluster.
Constraints:
\nIf supplied, must match existing VpcSecurityGroupIds.
\nA value that indicates whether the modifications in this request and\n any pending modifications are asynchronously applied\n as soon as possible, regardless of the\n PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is \n disabled.\n
\n If this parameter is disabled, changes to the\n DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. \n Review the table of parameters in Modifying a DB Instance \n in the Amazon RDS User Guide. to see the impact of enabling\n or disabling ApplyImmediately for each modified parameter and to determine when the changes are applied.\n
A value that indicates whether the modifications in this request and any pending modifications are asynchronously applied as soon as possible, \n regardless of the PreferredMaintenanceWindow setting for the DB instance. By default, this parameter is disabled.
\n If this parameter is disabled, changes to the DB instance are applied during the next maintenance window. Some parameter changes can cause an outage\n and are applied on the next call to RebootDBInstance, or the next failure reboot. Review the table of parameters in \n Modifying a DB Instance in the \n Amazon RDS User Guide to see the impact of enabling or disabling ApplyImmediately for each modified parameter and to \n determine when the changes are applied.\n
The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
\nEnabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
\nThese changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.
\n Amazon Aurora\n
\nNot applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
\nConstraints:
\nIt must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to \n read replicas. It can't be set to 0 or 35 for an RDS Custom DB instance.
\nIt can be specified for a MySQL read replica only if the source is running MySQL 5.6 or\n later.
\nIt can be specified for a PostgreSQL read replica only if the source is running PostgreSQL\n 9.3.5.
\nThe number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.
\nEnabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance.
\nThese changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled\n for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously\n applied as soon as possible.
\n Amazon Aurora\n
\nNot applicable. The retention period for automated backups is managed by the DB\n cluster. For more information, see ModifyDBCluster.
Default: Uses existing setting
\nConstraints:
\nIt must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to \n read replicas. It can't be set to 0 or 35 for an RDS Custom for Oracle DB instance.
\nIt can be specified for a MySQL read replica only if the source is running MySQL 5.6 or\n later.
\nIt can be specified for a PostgreSQL read replica only if the source is running PostgreSQL\n 9.3.5.
\n\n The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n
For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.
\nIf you specify only a major version, Amazon RDS will update the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.
In RDS Custom, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.\n
\n The version number of the database engine to upgrade to. \n Changing this parameter results in an outage and the change \n is applied during the next maintenance window\n unless the ApplyImmediately parameter is enabled for this request.\n
For major version upgrades, if a nondefault DB parameter group is currently in use, a\n new DB parameter group in the DB parameter group family for the new engine version must\n be specified. The new DB parameter group can be the default for that DB parameter group\n family.
\nIf you specify only a major version, Amazon RDS will update the DB instance to the \n default minor version if the current minor version is lower.\n For information about valid engine versions, see CreateDBInstance, \n or call DescribeDBEngineVersions.
In RDS Custom for Oracle, this parameter is supported for read replicas only if they are in the \n PATCH_DB_FAILURE lifecycle.\n
A value that indicates whether the DB instance is publicly accessible.\n
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\n\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.\n
Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.
This setting doesn't apply to RDS Custom.
" + "smithy.api#documentation": "A value that indicates whether the DB instance is publicly accessible.\n
\nWhen the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint\n resolves to the private IP address from within the DB cluster's virtual private cloud\n (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access\n to the DB cluster is ultimately controlled by the security group it uses. That public\n access isn't permitted if the security group assigned to the DB cluster doesn't permit\n it.
\nWhen the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address.
\n\n PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a \n public subnet and PubliclyAccessible must be enabled for it to be publicly accessible.\n
Changes to the PubliclyAccessible parameter are applied immediately regardless\n of the value of the ApplyImmediately parameter.
An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and \n application method method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.
\nValid Values (for the application method): immediate | pending-reboot\n
You can use the immediate value with dynamic parameters only. You can use the \n pending-reboot value for both dynamic and static parameters.
When the application method is immediate, changes to dynamic parameters are applied immediately \n to the DB instances associated with the parameter group. When the application method is pending-reboot, \n changes to dynamic and static parameters are applied after a reboot without failover to the DB instances associated with the \n parameter group.
An array of parameter names, values, and the application methods for the parameter update. At least one parameter name, value, and \n application method must be supplied; later arguments are optional. A maximum of 20 parameters can be modified in a single request.
\nValid Values (for the application method): immediate | pending-reboot\n
You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both dynamic \n and static parameters.
When the application method is immediate, changes to dynamic parameters are applied immediately to the DB instances associated with \n the parameter group.
When the application method is pending-reboot, changes to dynamic and static parameters are applied after a reboot without failover \n to the DB instances associated with the parameter group.
You can't use pending-reboot with dynamic parameters on RDS for SQL Server DB instances. Use immediate.
For more information on modifying DB parameters, see Working \n with DB parameter groups in the Amazon RDS User Guide.
", "smithy.api#required": {} } } @@ -15125,7 +15125,7 @@ "EngineVersion": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.
To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n
To list all of the available engine versions for aurora-postgresql, use the following command:
\n aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n
The version number of the database engine to which you want to upgrade. \n Changing this parameter results in an outage. The change is applied during\n the next maintenance window unless ApplyImmediately is enabled.
To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n
To list all of the available engine versions for aurora-postgresql, use the following command:
\n aws rds describe-db-engine-versions --engine aurora-postgresql --query '*[]|[?SupportsGlobalDatabases == `true`].[EngineVersion]'\n
The name of the database engine to be used for this DB cluster.
\nValid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible Aurora), and aurora-postgresql \n
The name of the database engine to be used for this DB cluster.
\nValid Values: aurora (for MySQL 5.6-compatible Aurora), aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), and aurora-postgresql \n
The version number of the database engine to use.
\nTo list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-postgresql, use the following command:
\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nExample: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5\n
\n Aurora PostgreSQL\n
\nExample: 9.6.3, 10.7\n
The version number of the database engine to use.
\nTo list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command:
\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for aurora-postgresql, use the following command:
\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nExample: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.12, 5.7.mysql_aurora.2.04.5, 8.0.mysql_aurora.3.01.0\n
\n Aurora PostgreSQL\n
\nExample: 9.6.3, 10.7\n
The version of the database engine to use for the new DB cluster.
\nTo list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for MySQL 5.7-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nSee MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.\n
\n\n Aurora PostgreSQL\n
\nSee Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.\n
\n\n MySQL\n
\nSee MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n\n PostgreSQL\n
\nSee Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "The version of the database engine to use for the new DB cluster.
\nTo list all of the available engine versions for MySQL 5.6-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for Aurora PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for MySQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"\n
To list all of the available engine versions for RDS for PostgreSQL, use the following command:
\n\n aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"\n
\n Aurora MySQL\n
\nSee MySQL on Amazon RDS Versions in the \n Amazon Aurora User Guide.\n
\n\n Aurora PostgreSQL\n
\nSee Amazon Aurora PostgreSQL releases and engine versions in the \n Amazon Aurora User Guide.\n
\n\n MySQL\n
\nSee MySQL on Amazon RDS Versions in the \n Amazon RDS User Guide.\n
\n\n PostgreSQL\n
\nSee Amazon RDS for PostgreSQL versions and extensions in the \n Amazon RDS User Guide.\n
\nValid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Port": { @@ -17995,7 +17995,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
\n\n Valid values: standard | gp2 | io1\n
\n If you specify io1, you must also include a value for the\n Iops parameter.\n
\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" + "smithy.api#documentation": "Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
\n\n Valid values: io1\n
\n When specified, a value for the Iops parameter is required.\n
\n Default: io1\n
Valid for: Aurora DB clusters and Multi-AZ DB clusters
" } }, "Iops": { @@ -18228,7 +18228,7 @@ "StorageType": { "target": "com.amazonaws.rds#String", "traits": { - "smithy.api#documentation": "Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
\n\n Valid values: standard | gp2 | io1\n
\n If you specify io1, also include a value for the\n Iops parameter.\n
\n Default: io1 if the Iops parameter\n is specified, otherwise gp2\n
Valid for: Multi-AZ DB clusters only
" + "smithy.api#documentation": "Specifies the storage type to be associated with the each DB instance in the Multi-AZ DB cluster.
\n\n Valid values: io1\n
\n When specified, a value for the Iops parameter is required.\n
\n Default: io1\n
Valid for: Multi-AZ DB clusters only
" } }, "PubliclyAccessible": { diff --git a/codegen/sdk/aws-models/redshift.2012-12-01.json b/codegen/sdk/aws-models/redshift.2012-12-01.json index 55fe8c09cac..a8138555998 100644 --- a/codegen/sdk/aws-models/redshift.2012-12-01.json +++ b/codegen/sdk/aws-models/redshift.2012-12-01.json @@ -616,7 +616,7 @@ } ], "traits": { - "smithy.api#documentation": "From a data producer account, authorizes the sharing of a datashare with one or more\n consumer accounts. To authorize a datashare for a data consumer, the producer account\n must have the correct access privileges.
" + "smithy.api#documentation": "From a data producer account, authorizes the sharing of a datashare with one or more\n consumer accounts or managing entities. To authorize a datashare for a data consumer, the producer account\n must have the correct access privileges.
" } }, "com.amazonaws.redshift#AuthorizeDataShareMessage": { @@ -632,7 +632,7 @@ "ConsumerIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The identifier of the data consumer that is authorized to access the datashare. This identifier is an Amazon Web Services account ID.
", + "smithy.api#documentation": "The identifier of the data consumer that is authorized to access the datashare. This identifier is an Amazon Web Services account ID or a keyword, such as ADX.
", "smithy.api#required": {} } } @@ -3717,6 +3717,12 @@ "traits": { "smithy.api#documentation": "A value that specifies when the datashare has an association between a producer and data consumers.
" } + }, + "ManagedBy": { + "target": "com.amazonaws.redshift#String", + "traits": { + "smithy.api#documentation": "The identifier of a datashare to show its managing entity.
" + } } } }, @@ -3920,7 +3926,7 @@ "ConsumerIdentifier": { "target": "com.amazonaws.redshift#String", "traits": { - "smithy.api#documentation": "The identifier of the data consumer that is to have authorization removed from the datashare. \n This identifier is an Amazon Web Services account ID.
", + "smithy.api#documentation": "The identifier of the data consumer that is to have authorization removed from the datashare. \n This identifier is an Amazon Web Services account ID or a keyword, such as ADX.
", "smithy.api#required": {} } } diff --git a/codegen/sdk/aws-models/rekognition.2016-06-27.json b/codegen/sdk/aws-models/rekognition.2016-06-27.json index 14f39001b9f..6882826d790 100644 --- a/codegen/sdk/aws-models/rekognition.2016-06-27.json +++ b/codegen/sdk/aws-models/rekognition.2016-06-27.json @@ -805,7 +805,7 @@ "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "Version number of the face detection model associated with the collection you are creating.
" + "smithy.api#documentation": "Latest face model being used with the collection. For more information, see Model versioning.
" } } } @@ -3128,6 +3128,12 @@ "traits": { "smithy.api#documentation": "Confidence level that the bounding box contains a face (and not a different object such\n as a tree).
" } + }, + "IndexFacesModelVersion": { + "target": "com.amazonaws.rekognition#IndexFacesModelVersion", + "traits": { + "smithy.api#documentation": "\n The version of the face detect and storage model that was used when indexing the face vector.\n
" + } } }, "traits": { @@ -4687,7 +4693,13 @@ } ], "traits": { - "smithy.api#documentation": "Detects faces in the input image and adds them to the specified collection.
\nAmazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying\n detection algorithm first detects the faces in the input image. For each face, the algorithm\n extracts facial features into a feature vector, and stores it in the backend database.\n Amazon Rekognition uses feature vectors when it performs face match and search operations using the\n SearchFaces and SearchFacesByImage\n operations.
\n \nFor more information, see Adding Faces to a Collection in the Amazon Rekognition\n Developer Guide.
\nTo get the number of faces in a collection, call DescribeCollection.
\n\nIf you're using version 1.0 of the face detection model, IndexFaces\n indexes the 15 largest faces in the input image. Later versions of the face detection model\n index the 100 largest faces in the input image.
If you're using version 4 or later of the face model, image orientation information\n is not returned in the OrientationCorrection field.
To determine which version of the model you're using, call DescribeCollection\n and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response\n from IndexFaces\n
For more information, see Model Versioning in the Amazon Rekognition Developer\n Guide.
\nIf you provide the optional ExternalImageId for the input image you\n provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this\n external image ID to create a client-side index to associate the faces with each image. You\n can then use the index to find all faces in an image.
You can specify the maximum number of faces to index with the MaxFaces input\n parameter. This is useful when you want to index the largest faces in an image and don't want to index\n smaller faces, such as those belonging to people standing in the background.
The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. By default, IndexFaces chooses the quality bar that's \n used to filter faces. You can also explicitly choose\n the quality bar. Use QualityFilter, to set the quality bar\n by specifying LOW, MEDIUM, or HIGH.\n If you do not want to filter detected faces, specify NONE.
To use quality filtering, you need a collection associated with version 3 of the \n face model or higher. To get the version of the face model associated with a collection, call \n DescribeCollection.
\nInformation about faces detected in an image, but not indexed, is returned in an array of\n UnindexedFace objects, UnindexedFaces. Faces aren't\n indexed for reasons such as:
The number of faces detected exceeds the value of the MaxFaces request\n parameter.
The face is too small compared to the image dimensions.
\nThe face is too blurry.
\nThe image is too dark.
\nThe face has an extreme pose.
\nThe face doesn’t have enough detail to be suitable for face search.
\nIn response, the IndexFaces operation returns an array of metadata for \n all detected faces, FaceRecords. This includes:
The bounding box, BoundingBox, of the detected face.
A confidence value, Confidence, which indicates the confidence that the\n bounding box contains a face.
A face ID, FaceId, assigned by the service for each face that's detected\n and stored.
An image ID, ImageId, assigned by the service for the input image.
If you request all facial attributes (by using the detectionAttributes\n parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for\n example, location of eye and mouth) and other facial attributes. If you provide\n the same image, specify the same collection, and use the same external ID in the\n IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.
The input image is passed either as base64-encoded image bytes, or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.
\nThis operation requires permissions to perform the rekognition:IndexFaces\n action.
Detects faces in the input image and adds them to the specified collection.
\nAmazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying\n detection algorithm first detects the faces in the input image. For each face, the algorithm\n extracts facial features into a feature vector, and stores it in the backend database.\n Amazon Rekognition uses feature vectors when it performs face match and search operations using the\n SearchFaces and SearchFacesByImage\n operations.
\n \nFor more information, see Adding Faces to a Collection in the Amazon Rekognition\n Developer Guide.
\nTo get the number of faces in a collection, call DescribeCollection.
\n\nIf you're using version 1.0 of the face detection model, IndexFaces\n indexes the 15 largest faces in the input image. Later versions of the face detection model\n index the 100 largest faces in the input image.
If you're using version 4 or later of the face model, image orientation information\n is not returned in the OrientationCorrection field.
To determine which version of the model you're using, call DescribeCollection\n and supply the collection ID. You can also get the model version from the value of FaceModelVersion in the response\n from IndexFaces\n
For more information, see Model Versioning in the Amazon Rekognition Developer\n Guide.
\nIf you provide the optional ExternalImageId for the input image you\n provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the ListFaces operation, the response returns the external ID. You can use this\n external image ID to create a client-side index to associate the faces with each image. You\n can then use the index to find all faces in an image.
You can specify the maximum number of faces to index with the MaxFaces input\n parameter. This is useful when you want to index the largest faces in an image and don't want to index\n smaller faces, such as those belonging to people standing in the background.
The QualityFilter input parameter allows you to filter out detected faces\n that don’t meet a required quality bar. The quality bar is based on a\n variety of common use cases. By default, IndexFaces chooses the quality bar that's \n used to filter faces. You can also explicitly choose\n the quality bar. Use QualityFilter, to set the quality bar\n by specifying LOW, MEDIUM, or HIGH.\n If you do not want to filter detected faces, specify NONE.
To use quality filtering, you need a collection associated with version 3 of the \n face model or higher. To get the version of the face model associated with a collection, call \n DescribeCollection.
\nInformation about faces detected in an image, but not indexed, is returned in an array of\n UnindexedFace objects, UnindexedFaces. Faces aren't\n indexed for reasons such as:
The number of faces detected exceeds the value of the MaxFaces request\n parameter.
The face is too small compared to the image dimensions.
\nThe face is too blurry.
\nThe image is too dark.
\nThe face has an extreme pose.
\nThe face doesn’t have enough detail to be suitable for face search.
\nIn response, the IndexFaces operation returns an array of metadata for \n all detected faces, FaceRecords. This includes:
The bounding box, BoundingBox, of the detected face.
A confidence value, Confidence, which indicates the confidence that the\n bounding box contains a face.
A face ID, FaceId, assigned by the service for each face that's detected\n and stored.
An image ID, ImageId, assigned by the service for the input image.
If you request all facial attributes (by using the detectionAttributes\n parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for\n example, location of eye and mouth) and other facial attributes. If you provide\n the same image, specify the same collection, use the same external ID, and use the same model version in the\n IndexFaces operation, Amazon Rekognition doesn't save duplicate face metadata.
The input image is passed either as base64-encoded image bytes, or as a reference to an\n image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations,\n passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file.
\nThis operation requires permissions to perform the rekognition:IndexFaces\n action.
The version number of the face detection model that's associated with the input\n collection (CollectionId).
Latest face model being used with the collection. For more information, see Model versioning.
" } }, "UnindexedFaces": { @@ -5351,7 +5363,7 @@ "FaceModelVersions": { "target": "com.amazonaws.rekognition#FaceModelVersionList", "traits": { - "smithy.api#documentation": "Version numbers of the face detection models associated with the collections in the array CollectionIds.\n For example, the value of FaceModelVersions[2] is the version number for the face detection model used\n by the collection in CollectionId[2].
Latest face models being used with the corresponding collections in the array. For more information, see Model versioning. \n For example, the value of FaceModelVersions[2] is the version number for the face detection model used\n by the collection in CollectionId[2].
Version number of the face detection model associated with the input collection (CollectionId).
Latest face model being used with the collection. For more information, see Model versioning.
" } } } @@ -7276,7 +7288,7 @@ "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "Version number of the face detection model associated with the input collection (CollectionId).
Latest face model being used with the collection. For more information, see Model versioning.
" } } } @@ -7330,7 +7342,7 @@ "FaceModelVersion": { "target": "com.amazonaws.rekognition#String", "traits": { - "smithy.api#documentation": "Version number of the face detection model associated with the input collection (CollectionId).
Latest face model being used with the collection. For more information, see Model versioning.
" } } } diff --git a/codegen/sdk/aws-models/route53domains.2014-05-15.json b/codegen/sdk/aws-models/route53domains.2014-05-15.json index b788a17ce37..8859304000f 100644 --- a/codegen/sdk/aws-models/route53domains.2014-05-15.json +++ b/codegen/sdk/aws-models/route53domains.2014-05-15.json @@ -46,10 +46,13 @@ }, { "target": "com.amazonaws.route53domains#OperationLimitExceeded" + }, + { + "target": "com.amazonaws.route53domains#UnsupportedTLD" } ], "traits": { - "smithy.api#documentation": "Accepts the transfer of a domain from another AWS account to the current AWS account. You initiate a transfer between AWS accounts using \n\t\t\tTransferDomainToAnotherAwsAccount.\n\t\t
\n\n\t\tUse either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t
Accepts the transfer of a domain from another Amazon Web Services account to the\n\t\t\t\tcurrentAmazon Web Services account. You initiate a transfer between Amazon Web Services accounts using TransferDomainToAnotherAwsAccount.
\n\t\tIf you use the CLI command at accept-domain-transfer-from-another-aws-account, use JSON format as input\n\t\t\tinstead of text because otherwise CLI will throw an error from domain\n\t\t\ttransfer input that includes single quotes.
\n\n\t\tUse either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t
The name of the domain that was specified when another AWS account submitted a \n\t\t\tTransferDomainToAnotherAwsAccount\n\t\t\trequest.\n\t\t
", + "smithy.api#documentation": "The name of the domain that was specified when another Amazon Web Services account submitted a \n\t\t\tTransferDomainToAnotherAwsAccount\n\t\t\trequest.\n\t\t
", "smithy.api#required": {} } }, @@ -91,6 +94,10 @@ "com.amazonaws.route53domains#AccountId": { "type": "string", "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, "smithy.api#pattern": "^(\\d{12})$" } }, @@ -167,10 +174,13 @@ }, { "target": "com.amazonaws.route53domains#OperationLimitExceeded" + }, + { + "target": "com.amazonaws.route53domains#UnsupportedTLD" } ], "traits": { - "smithy.api#documentation": "Cancels the transfer of a domain from the current AWS account to another AWS account. You initiate a transfer between AWS accounts using \n\t\t\tTransferDomainToAnotherAwsAccount.\n\t\t
\n\t\t\n\t\tYou must cancel the transfer before the other AWS account accepts the transfer using \n\t\t\t\tAcceptDomainTransferFromAnotherAwsAccount.
\n\t\tUse either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t
Cancels the transfer of a domain from the current Amazon Web Services account to another Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using \n\t\t\tTransferDomainToAnotherAwsAccount.\n\t\t
\n\t\t\n\t\tYou must cancel the transfer before the other Amazon Web Services account accepts the transfer using \n\t\t\t\tAcceptDomainTransferFromAnotherAwsAccount.
\n\t\tUse either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t
The name of the domain for which you want to cancel the transfer to another AWS account.
", + "smithy.api#documentation": "The name of the domain for which you want to cancel the transfer to another Amazon Web Services account.
", "smithy.api#required": {} } } @@ -341,7 +351,7 @@ "ContactType": { "target": "com.amazonaws.route53domains#ContactType", "traits": { - "smithy.api#documentation": "Indicates whether the contact is a person, company, association, or public organization. Note the following:
\n\t\tIf you specify a value other than PERSON, you must also specify a value for \n\t\t\t\tOrganizationName.
For some TLDs, the privacy protection available depends on the value that you specify for \n\t\t\t\tContact Type. For the privacy protection settings for your TLD, see \n\t\t\t\tDomains that You Can \n\t\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer Guide\n
For .es domains, if you specify PERSON, you must specify INDIVIDUAL \n\t\t\t\tfor the value of ES_LEGAL_FORM.
Indicates whether the contact is a person, company, association, or public organization. Note the following:
\n\t\tIf you specify a value other than PERSON, you must also specify a value for \n\t\t\t\tOrganizationName.
For some TLDs, the privacy protection available depends on the value that you specify for \n\t\t\t\tContact Type. For the privacy protection settings for your TLD, see \n\t\t\t\tDomains that You Can \n\t\t\t\t\tRegister with Amazon Route 53 in the Amazon Route 53 Developer Guide\n
For .es domains, the value of ContactType must be PERSON for all three contacts.
This operation deletes the specified domain. This action is permanent. For more information,\n\t\t\tsee Deleting a domain name registration.
\n\t\tTo transfer the domain registration to another registrar, use the transfer process that’s\n\t\t\tprovided by the registrar to which you want to transfer the registration. Otherwise,\n\t\t\tthe following apply:
\n\t\tYou can’t get a refund for the cost of a deleted domain registration.
\nThe registry for the top-level domain might hold the domain name for a brief time before releasing it for other users to register (varies by registry).
\nWhen the registration has been deleted, we'll send you a confirmation to the registrant\n\t\t\t\tcontact. The email will come from\n\t\t\t\tnoreply@domainnameverification.net or\n\t\t\t\tnoreply@registrar.amazon.com.
Name of the domain to be deleted.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53domains#DeleteDomainResponse": { + "type": "structure", + "members": { + "OperationId": { + "target": "com.amazonaws.route53domains#OperationId", + "traits": { + "smithy.api#documentation": "Identifier for tracking the progress of the request. \n\t\t\tTo query the operation status, use GetOperationDetail.
" + } + } + } + }, "com.amazonaws.route53domains#DeleteTagsForDomain": { "type": "operation", "input": { @@ -1608,6 +1764,65 @@ } } }, + "com.amazonaws.route53domains#DomainPrice": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53domains#DomainPriceName", + "traits": { + "smithy.api#documentation": "The name of the TLD for which the prices apply.
" + } + }, + "RegistrationPrice": { + "target": "com.amazonaws.route53domains#PriceWithCurrency", + "traits": { + "smithy.api#documentation": "The price for domain registration with Route 53.
" + } + }, + "TransferPrice": { + "target": "com.amazonaws.route53domains#PriceWithCurrency", + "traits": { + "smithy.api#documentation": "The price for transferring the domain registration to Route 53.
" + } + }, + "RenewalPrice": { + "target": "com.amazonaws.route53domains#PriceWithCurrency", + "traits": { + "smithy.api#documentation": "The price for renewing domain registration with Route 53.
" + } + }, + "ChangeOwnershipPrice": { + "target": "com.amazonaws.route53domains#PriceWithCurrency", + "traits": { + "smithy.api#documentation": "The price for changing domain ownership.
" + } + }, + "RestorationPrice": { + "target": "com.amazonaws.route53domains#PriceWithCurrency", + "traits": { + "smithy.api#documentation": "The price for restoring the domain with Route 53.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the domain price associated with a TLD.
" + } + }, + "com.amazonaws.route53domains#DomainPriceList": { + "type": "list", + "member": { + "target": "com.amazonaws.route53domains#DomainPrice" + } + }, + "com.amazonaws.route53domains#DomainPriceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, "com.amazonaws.route53domains#DomainStatus": { "type": "string" }, @@ -1748,7 +1963,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. \n\t\t\tThe cost of renewing your domain registration is billed to your AWS account.
\n\t\tThe period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see \n\t\t\tDomains That You Can Register with Amazon Route 53 \n\t\t\tin the Amazon Route 53 Developer Guide. Route 53 requires that you renew before the end of the renewal period \n\t\t\tso we can complete processing before the deadline.
" + "smithy.api#documentation": "This operation configures Amazon Route 53 to automatically renew the specified domain before the domain registration expires. \n\t\t\tThe cost of renewing your domain registration is billed to your Amazon Web Services account.
\n\t\tThe period during which you can renew a domain name varies by TLD. For a list of TLDs and their renewal policies, see \n\t\t\tDomains That You Can Register with Amazon Route 53 \n\t\t\tin the Amazon Route 53 Developer Guide. Route 53 requires that you renew before the end of the renewal period \n\t\t\tso we can complete processing before the deadline.
" } }, "com.amazonaws.route53domains#EnableDomainAutoRenewRequest": { @@ -1835,7 +2050,7 @@ "Name": { "target": "com.amazonaws.route53domains#ExtraParamName", "traits": { - "smithy.api#documentation": "The name of an additional parameter that is required by a top-level domain. Here are the top-level domains that require \n\t\t\tadditional parameters and the names of the parameters that they require:
\n\n\t\t\n AU_ID_NUMBER\n
\n AU_ID_TYPE\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n ABN (Australian business number)
\n ACN (Australian company number)
\n TM (Trademark number)
\n BRAND_NUMBER\n
\n CA_BUSINESS_ENTITY_TYPE\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n BANK (Bank)
\n COMMERCIAL_COMPANY (Commercial company)
\n COMPANY (Company)
\n COOPERATION (Cooperation)
\n COOPERATIVE (Cooperative)
\n COOPRIX (Cooprix)
\n CORP (Corporation)
\n CREDIT_UNION (Credit union)
\n FOMIA (Federation of mutual insurance associations)
\n INC (Incorporated)
\n LTD (Limited)
\n LTEE (Limitée)
\n LLC (Limited liability corporation)
\n LLP (Limited liability partnership)
\n LTE (Lte.)
\n MBA (Mutual benefit association)
\n MIC (Mutual insurance company)
\n NFP (Not-for-profit corporation)
\n SA (S.A.)
\n SAVINGS_COMPANY (Savings company)
\n SAVINGS_UNION (Savings union)
\n SARL (Société à responsabilité limitée)
\n TRUST (Trust)
\n ULC (Unlimited liability corporation)
\n CA_LEGAL_TYPE\n
When ContactType is PERSON, valid values include the following:
\n ABO (Aboriginal Peoples indigenous to Canada)
\n CCT (Canadian citizen)
\n LGR (Legal Representative of a Canadian Citizen or Permanent Resident)
\n RES (Permanent resident of Canada)
When ContactType is a value other than PERSON, valid values include the following:
\n ASS (Canadian unincorporated association)
\n CCO (Canadian corporation)
\n EDU (Canadian educational institution)
\n GOV (Government or government entity in Canada)
\n HOP (Canadian Hospital)
\n INB (Indian Band recognized by the Indian Act of Canada)
\n LAM (Canadian Library, Archive, or Museum)
\n MAJ (Her/His Majesty the Queen/King)
\n OMK (Official mark registered in Canada)
\n PLT (Canadian Political Party)
\n PRT (Partnership Registered in Canada)
\n TDM (Trademark registered in Canada)
\n TRD (Canadian Trade Union)
\n TRS (Trust established in Canada)
\n ES_IDENTIFICATION\n
Specify the applicable value:
\n\t\t\t\t\t\t\t\n For contacts inside Spain: Enter your passport ID.
\n\n For contacts outside of Spain: Enter the VAT identification number \n\t\t\t\t\t\t\t\t\tfor the company.
\n\t\t\t\t\t\t\t\t\tFor .es domains, the value of ContactType must be PERSON.
\n ES_IDENTIFICATION_TYPE\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n DNI_AND_NIF (For Spanish contacts)
\n NIE (For foreigners with legal residence)
\n OTHER (For contacts outside of Spain)
\n ES_LEGAL_FORM\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n ASSOCIATION\n
\n CENTRAL_GOVERNMENT_BODY\n
\n CIVIL_SOCIETY\n
\n COMMUNITY_OF_OWNERS\n
\n COMMUNITY_PROPERTY\n
\n CONSULATE\n
\n COOPERATIVE\n
\n DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL\n
\n ECONOMIC_INTEREST_GROUP\n
\n EMBASSY\n
\n ENTITY_MANAGING_NATURAL_AREAS\n
\n FARM_PARTNERSHIP\n
\n FOUNDATION\n
\n GENERAL_AND_LIMITED_PARTNERSHIP\n
\n GENERAL_PARTNERSHIP\n
\n INDIVIDUAL\n
\n LIMITED_COMPANY\n
\n LOCAL_AUTHORITY\n
\n LOCAL_PUBLIC_ENTITY\n
\n MUTUAL_INSURANCE_COMPANY\n
\n NATIONAL_PUBLIC_ENTITY\n
\n ORDER_OR_RELIGIOUS_INSTITUTION\n
\n OTHERS (Only for contacts outside of Spain)\n
\n POLITICAL_PARTY\n
\n PROFESSIONAL_ASSOCIATION\n
\n PUBLIC_LAW_ASSOCIATION\n
\n PUBLIC_LIMITED_COMPANY\n
\n REGIONAL_GOVERNMENT_BODY\n
\n REGIONAL_PUBLIC_ENTITY\n
\n SAVINGS_BANK\n
\n SPANISH_OFFICE\n
\n SPORTS_ASSOCIATION\n
\n SPORTS_FEDERATION\n
\n SPORTS_LIMITED_COMPANY\n
\n TEMPORARY_ALLIANCE_OF_ENTERPRISES\n
\n TRADE_UNION\n
\n WORKER_OWNED_COMPANY\n
\n WORKER_OWNED_LIMITED_COMPANY\n
\n BIRTH_DATE_IN_YYYY_MM_DD\n
\n FI_BUSINESS_NUMBER\n
\n FI_ID_NUMBER\n
\n FI_NATIONALITY\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n FINNISH\n
\n NOT_FINNISH\n
\n FI_ORGANIZATION_TYPE\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n COMPANY\n
\n CORPORATION\n
\n GOVERNMENT\n
\n INSTITUTION\n
\n POLITICAL_PARTY\n
\n PUBLIC_COMMUNITY\n
\n TOWNSHIP\n
\n BIRTH_CITY\n
\n BIRTH_COUNTRY\n
\n BIRTH_DATE_IN_YYYY_MM_DD\n
\n BIRTH_DEPARTMENT: Specify the INSEE code that corresponds with the department where the contact was born. \n\t\t\t\t\t\t\tIf the contact was born somewhere other than France or its overseas departments, specify 99. For more information, \n\t\t\t\t\t\t\tincluding a list of departments and the corresponding INSEE numbers, see the Wikipedia entry \n\t\t\t\t\t\t\tDepartments of France.
\n BRAND_NUMBER\n
\n IT_NATIONALITY\n
\n IT_PIN\n
\n IT_REGISTRANT_ENTITY_TYPE\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n FOREIGNERS\n
\n FREELANCE_WORKERS (Freelance workers and professionals)
\n ITALIAN_COMPANIES (Italian companies and one-person companies)
\n NON_PROFIT_ORGANIZATIONS\n
\n OTHER_SUBJECTS\n
\n PUBLIC_ORGANIZATIONS\n
\n BIRTH_DATE_IN_YYYY_MM_DD\n
\n RU_PASSPORT_DATA\n
\n BIRTH_COUNTRY\n
\n SE_ID_NUMBER\n
\n SG_ID_NUMBER\n
\n UK_CONTACT_TYPE\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n CRC (UK Corporation by Royal Charter)
\n FCORP (Non-UK Corporation)
\n FIND (Non-UK Individual, representing self)
\n FOTHER (Non-UK Entity that does not fit into any other category)
\n GOV (UK Government Body)
\n IND (UK Individual (representing self))
\n IP (UK Industrial/Provident Registered Company)
\n LLP (UK Limited Liability Partnership)
\n LTD (UK Limited Company)
\n OTHER (UK Entity that does not fit into any other category)
\n PLC (UK Public Limited Company)
\n PTNR (UK Partnership)
\n RCHAR (UK Registered Charity)
\n SCH (UK School)
\n STAT (UK Statutory Body)
\n STRA (UK Sole Trader)
\n UK_COMPANY_NUMBER\n
In addition, many TLDs require a VAT_NUMBER.
The name of an additional parameter that is required by a top-level domain. Here are the top-level domains that require \n\t\t\tadditional parameters and the names of the parameters that they require:
\n\n\t\t\n AU_ID_NUMBER\n
\n AU_ID_TYPE\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n ABN (Australian business number)
\n ACN (Australian company number)
\n TM (Trademark number)
\n BRAND_NUMBER\n
\n CA_BUSINESS_ENTITY_TYPE\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n BANK (Bank)
\n COMMERCIAL_COMPANY (Commercial company)
\n COMPANY (Company)
\n COOPERATION (Cooperation)
\n COOPERATIVE (Cooperative)
\n COOPRIX (Cooprix)
\n CORP (Corporation)
\n CREDIT_UNION (Credit union)
\n FOMIA (Federation of mutual insurance associations)
\n INC (Incorporated)
\n LTD (Limited)
\n LTEE (Limitée)
\n LLC (Limited liability corporation)
\n LLP (Limited liability partnership)
\n LTE (Lte.)
\n MBA (Mutual benefit association)
\n MIC (Mutual insurance company)
\n NFP (Not-for-profit corporation)
\n SA (S.A.)
\n SAVINGS_COMPANY (Savings company)
\n SAVINGS_UNION (Savings union)
\n SARL (Société à responsabilité limitée)
\n TRUST (Trust)
\n ULC (Unlimited liability corporation)
\n CA_LEGAL_TYPE\n
When ContactType is PERSON, valid values include the following:
\n ABO (Aboriginal Peoples indigenous to Canada)
\n CCT (Canadian citizen)
\n LGR (Legal Representative of a Canadian Citizen or Permanent Resident)
\n RES (Permanent resident of Canada)
When ContactType is a value other than PERSON, valid values include the following:
\n ASS (Canadian unincorporated association)
\n CCO (Canadian corporation)
\n EDU (Canadian educational institution)
\n GOV (Government or government entity in Canada)
\n HOP (Canadian Hospital)
\n INB (Indian Band recognized by the Indian Act of Canada)
\n LAM (Canadian Library, Archive, or Museum)
\n MAJ (Her/His Majesty the Queen/King)
\n OMK (Official mark registered in Canada)
\n PLT (Canadian Political Party)
\n PRT (Partnership Registered in Canada)
\n TDM (Trademark registered in Canada)
\n TRD (Canadian Trade Union)
\n TRS (Trust established in Canada)
\n ES_IDENTIFICATION\n
The value of ES_IDENTIFICATION depends on the following values:
The value of ES_LEGAL_FORM\n
The value of ES_IDENTIFICATION_TYPE\n
\n If ES_LEGAL_FORM is any value other than INDIVIDUAL:\n
Specify 1 letter + 8 numbers (CIF [Certificado de Identificación Fiscal])
\nExample: B12345678
\n\n If ES_LEGAL_FORM is INDIVIDUAL, the value that you specify for \n\t\t\t\t\t\t\t\tES_IDENTIFICATION depends on the value of ES_IDENTIFICATION_TYPE:\n
If ES_IDENTIFICATION_TYPE is DNI_AND_NIF (for Spanish contacts):
Specify 8 numbers + 1 letter (DNI [Documento Nacional de Identidad], NIF [Número de Identificación Fiscal])
\nExample: 12345678M
\nIf ES_IDENTIFICATION_TYPE is NIE (for foreigners with legal residence):
Specify 1 letter + 7 numbers + 1 letter ( NIE [Número de Identidad de Extranjero])
\nExample: Y1234567X
\nIf ES_IDENTIFICATION_TYPE is OTHER (for contacts outside of Spain):
Specify a passport number, drivers license number, or national identity card number
\n\n ES_IDENTIFICATION_TYPE\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n DNI_AND_NIF (For Spanish contacts)
\n NIE (For foreigners with legal residence)
\n OTHER (For contacts outside of Spain)
\n ES_LEGAL_FORM\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n ASSOCIATION\n
\n CENTRAL_GOVERNMENT_BODY\n
\n CIVIL_SOCIETY\n
\n COMMUNITY_OF_OWNERS\n
\n COMMUNITY_PROPERTY\n
\n CONSULATE\n
\n COOPERATIVE\n
\n DESIGNATION_OF_ORIGIN_SUPERVISORY_COUNCIL\n
\n ECONOMIC_INTEREST_GROUP\n
\n EMBASSY\n
\n ENTITY_MANAGING_NATURAL_AREAS\n
\n FARM_PARTNERSHIP\n
\n FOUNDATION\n
\n GENERAL_AND_LIMITED_PARTNERSHIP\n
\n GENERAL_PARTNERSHIP\n
\n INDIVIDUAL\n
\n LIMITED_COMPANY\n
\n LOCAL_AUTHORITY\n
\n LOCAL_PUBLIC_ENTITY\n
\n MUTUAL_INSURANCE_COMPANY\n
\n NATIONAL_PUBLIC_ENTITY\n
\n ORDER_OR_RELIGIOUS_INSTITUTION\n
\n OTHERS (Only for contacts outside of Spain)\n
\n POLITICAL_PARTY\n
\n PROFESSIONAL_ASSOCIATION\n
\n PUBLIC_LAW_ASSOCIATION\n
\n PUBLIC_LIMITED_COMPANY\n
\n REGIONAL_GOVERNMENT_BODY\n
\n REGIONAL_PUBLIC_ENTITY\n
\n SAVINGS_BANK\n
\n SPANISH_OFFICE\n
\n SPORTS_ASSOCIATION\n
\n SPORTS_FEDERATION\n
\n SPORTS_LIMITED_COMPANY\n
\n TEMPORARY_ALLIANCE_OF_ENTERPRISES\n
\n TRADE_UNION\n
\n WORKER_OWNED_COMPANY\n
\n WORKER_OWNED_LIMITED_COMPANY\n
\n EU_COUNTRY_OF_CITIZENSHIP\n
\n BIRTH_DATE_IN_YYYY_MM_DD\n
\n FI_BUSINESS_NUMBER\n
\n FI_ID_NUMBER\n
\n FI_NATIONALITY\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n FINNISH\n
\n NOT_FINNISH\n
\n FI_ORGANIZATION_TYPE\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n COMPANY\n
\n CORPORATION\n
\n GOVERNMENT\n
\n INSTITUTION\n
\n POLITICAL_PARTY\n
\n PUBLIC_COMMUNITY\n
\n TOWNSHIP\n
\n BIRTH_CITY\n
\n BIRTH_COUNTRY\n
\n BIRTH_DATE_IN_YYYY_MM_DD\n
\n BIRTH_DEPARTMENT: Specify the INSEE code that corresponds with the department where the contact was born. \n\t\t\t\t\t\t\tIf the contact was born somewhere other than France or its overseas departments, specify 99. For more information, \n\t\t\t\t\t\t\tincluding a list of departments and the corresponding INSEE numbers, see the Wikipedia entry \n\t\t\t\t\t\t\tDepartments of France.
\n BRAND_NUMBER\n
\n IT_NATIONALITY\n
\n IT_PIN\n
\n IT_REGISTRANT_ENTITY_TYPE\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n FOREIGNERS\n
\n FREELANCE_WORKERS (Freelance workers and professionals)
\n ITALIAN_COMPANIES (Italian companies and one-person companies)
\n NON_PROFIT_ORGANIZATIONS\n
\n OTHER_SUBJECTS\n
\n PUBLIC_ORGANIZATIONS\n
\n BIRTH_DATE_IN_YYYY_MM_DD\n
\n RU_PASSPORT_DATA\n
\n BIRTH_COUNTRY\n
\n SE_ID_NUMBER\n
\n SG_ID_NUMBER\n
\n UK_CONTACT_TYPE\n
Valid values include the following:
\n\t\t\t\t\t\t\t\n CRC (UK Corporation by Royal Charter)
\n FCORP (Non-UK Corporation)
\n FIND (Non-UK Individual, representing self)
\n FOTHER (Non-UK Entity that does not fit into any other category)
\n GOV (UK Government Body)
\n IND (UK Individual (representing self))
\n IP (UK Industrial/Provident Registered Company)
\n LLP (UK Limited Liability Partnership)
\n LTD (UK Limited Company)
\n OTHER (UK Entity that does not fit into any other category)
\n PLC (UK Public Limited Company)
\n PTNR (UK Partnership)
\n RCHAR (UK Registered Charity)
\n SCH (UK School)
\n STAT (UK Statutory Body)
\n STRA (UK Sole Trader)
\n UK_COMPANY_NUMBER\n
In addition, many TLDs require a VAT_NUMBER.
Name of the field which should be used for filtering the list of domains.
", + "smithy.api#required": {} + } + }, + "Operator": { + "target": "com.amazonaws.route53domains#Operator", + "traits": { + "smithy.api#documentation": "The operator values for filtering domain names. The values can be:
\n\t\t\n LE: Less than, or equal to
\n GE: Greater than, or equal to
\n BEGINS_WITH: Begins with
An array of strings presenting values to compare. Only 1 item in the list is currently supported.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Information for the filtering of a list of domains returned by \n\t\t\tListDomains.
" + } + }, + "com.amazonaws.route53domains#FilterConditions": { + "type": "list", + "member": { + "target": "com.amazonaws.route53domains#FilterCondition" + } }, "com.amazonaws.route53domains#GetContactReachabilityStatus": { "type": "operation", @@ -2060,7 +2322,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation returns detailed information about a specified domain that is associated with the current AWS account. \n\t\t\tContact information for the domain is also returned as part of the output.
" + "smithy.api#documentation": "This operation returns detailed information about a specified domain that is associated with the current Amazon Web Services account. \n\t\t\tContact information for the domain is also returned as part of the output.
" } }, "com.amazonaws.route53domains#GetDomainDetailRequest": { @@ -2091,7 +2353,7 @@ "Nameservers": { "target": "com.amazonaws.route53domains#NameserverList", "traits": { - "smithy.api#documentation": "The name of the domain.
", + "smithy.api#documentation": "The\n\t\t\tname of the domain.
", "smithy.api#required": {} } }, @@ -2125,7 +2387,7 @@ "AdminPrivacy": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "Specifies whether contact information is concealed from WHOIS queries. If the value is true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If the value is false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.
Specifies whether contact information is concealed from WHOIS\n\t\t\tqueries. If the value is true, WHOIS (\"who is\") queries return contact\n\t\t\tinformation either for Amazon Registrar (for .com, .net, and .org domains) or for our\n\t\t\tregistrar associate, Gandi (for all other TLDs). If the value is false,\n\t\t\tWHOIS queries return the information that you entered for the admin contact.
Reserved for future use.
" + "smithy.api#documentation": "Deprecated.
" } }, "StatusList": { @@ -2372,7 +2634,7 @@ "min": 0, "max": 255 }, - "smithy.api#pattern": "[a-zA-Z0-9_\\-.]*" + "smithy.api#pattern": "^[a-zA-Z0-9_\\-.]*$" } }, "com.amazonaws.route53domains#Integer": { @@ -2420,7 +2682,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation returns all the domain names registered with Amazon Route 53 for the current AWS account.
", + "smithy.api#documentation": "This operation returns all the domain names registered with Amazon Route 53 for the current Amazon Web Services account\n\t\t\t if no filtering conditions are used.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextPageMarker", @@ -2429,13 +2691,40 @@ } } }, + "com.amazonaws.route53domains#ListDomainsAttributeName": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DomainName", + "name": "DomainName" + }, + { + "value": "Expiry", + "name": "Expiry" + } + ] + } + }, "com.amazonaws.route53domains#ListDomainsRequest": { "type": "structure", "members": { + "FilterConditions": { + "target": "com.amazonaws.route53domains#FilterConditions", + "traits": { + "smithy.api#documentation": "A complex type that contains information about the filters applied during the ListDomains request. The filter conditions can\n\t\t\tinclude domain name and domain expiration.
A complex type that contains information about the requested ordering of domains in the returned list.
" + } + }, "Marker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { - "smithy.api#documentation": "For an initial request for a list of domains, omit this element. If the number of domains\n\t\t\tthat are associated with the current AWS account is greater than the value that you specified for\n\t\t\tMaxItems, you can use Marker to return additional domains. Get the value of\n\t\t\tNextPageMarker from the previous response, and submit another request that includes the\n\t\t\tvalue of NextPageMarker in the Marker element.
Constraints: The marker must match the value specified in the previous request.
" + "smithy.api#documentation": "For an initial request for a list of domains, omit this element. If the number of domains\n\t\t\tthat are associated with the current Amazon Web Services account is greater than the value that you specified for\n\t\t\tMaxItems, you can use Marker to return additional domains. Get the value of\n\t\t\tNextPageMarker from the previous response, and submit another request that includes the\n\t\t\tvalue of NextPageMarker in the Marker element.
Constraints: The marker must match the value specified in the previous request.
" } }, "MaxItems": { @@ -2455,7 +2744,7 @@ "Domains": { "target": "com.amazonaws.route53domains#DomainSummaryList", "traits": { - "smithy.api#documentation": "A summary of domains.
", + "smithy.api#documentation": "A list of domains.
", "smithy.api#required": {} } }, @@ -2484,7 +2773,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns information about all of the operations that return an operation ID and that have ever been \n\t\t\tperformed on domains that were registered by the current account.
", + "smithy.api#documentation": "Returns information about all of the operations that return an operation ID and that have ever been \n\t\t\tperformed on domains that were registered by the current account.
\n\t\tThis command runs only in the us-east-1 Region.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextPageMarker", @@ -2540,6 +2829,73 @@ "smithy.api#documentation": "The ListOperations response includes the following elements.
" } }, + "com.amazonaws.route53domains#ListPrices": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53domains#ListPricesRequest" + }, + "output": { + "target": "com.amazonaws.route53domains#ListPricesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53domains#InvalidInput" + }, + { + "target": "com.amazonaws.route53domains#UnsupportedTLD" + } + ], + "traits": { + "smithy.api#documentation": "Lists the following prices for either all the TLDs supported by Route 53, or the specified TLD:
\n\t\tRegistration
\nTransfer
\nOwner change
\nDomain renewal
\nDomain restoration
\nThe TLD for which you want to receive the pricing information. For example.\n\t\t\t\t.net.
If a Tld value is not provided, a list of prices for all TLDs supported by Route 53\n\t\tis returned.
For an initial request for a list of prices, omit this element. \n\t\t\tIf the number of prices that are not yet complete is greater than the value that you specified for MaxItems, \n\t\t\tyou can use Marker to return additional prices. Get the value of NextPageMarker from the previous response, \n\t\t\tand submit another request that includes the value of NextPageMarker in the Marker element.
Used only for all TLDs. If you specify a TLD, don't specify a Marker.
Number of Prices to be returned.
Used only for all TLDs. If you specify a TLD, don't specify a MaxItems.
A complex type that includes all the pricing information. If you specify a TLD, this array\n\t\t\tcontains only the pricing for that TLD.
", + "smithy.api#required": {} + } + }, + "NextPageMarker": { + "target": "com.amazonaws.route53domains#PageMarker", + "traits": { + "smithy.api#documentation": "If there are more prices than you specified for MaxItems in the request, submit another request and include the value of \n\t\t\tNextPageMarker in the value of Marker.
Used only for all TLDs. If you specify a TLD, don't specify a\n\t\t\tNextPageMarker.
The price of a domain, in a specific currency.
", + "smithy.api#required": {} + } + }, + "Currency": { + "target": "com.amazonaws.route53domains#Currency", + "traits": { + "smithy.api#documentation": "The currency specifier.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Currency-specific price information.
" + } + }, "com.amazonaws.route53domains#ReachabilityStatus": { "type": "string", "traits": { @@ -2862,7 +3259,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by \n\t\t\tour registrar associate, Gandi (for all other domains). For some top-level domains (TLDs), this operation requires extra parameters.
\n\t\tWhen you register a domain, Amazon Route 53 does the following:
\n\t\t\tCreates a Route 53 hosted zone that has the same name as the domain. Route 53 assigns four name servers \n\t\t\t\t\tto your hosted zone and automatically updates your domain registration with the names of these name servers.
\nEnables autorenew, so your domain registration will renew automatically each year. We'll notify you \n\t\t\t\t\tin advance of the renewal date so you can choose whether to renew the registration.
\nOptionally enables privacy protection, so WHOIS queries return contact information either for Amazon Registrar \n\t\t\t\t\t(for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy \n\t\t\t\t\tprotection, WHOIS queries return the information that you entered for the registrant, admin, and tech contacts.
\nIf registration is successful, returns an operation ID that you can use to track the progress and \n\t\t\t\t\tcompletion of the action. If the request is not completed successfully, the domain registrant is notified by email.
\nCharges your AWS account an amount based on the top-level domain. For more information, see \n\t\t\t\t\tAmazon Route 53 Pricing.
\nThis operation registers a domain. Domains are registered either by Amazon Registrar (for .com, .net, and .org domains) or by \n\t\t\tour registrar associate, Gandi (for all other domains). For some top-level domains (TLDs), this operation requires extra parameters.
\n\t\tWhen you register a domain, Amazon Route 53 does the following:
\n\t\t\tCreates a Route 53 hosted zone that has the same name as the domain. Route 53 assigns four name servers \n\t\t\t\t\tto your hosted zone and automatically updates your domain registration with the names of these name servers.
\nEnables autorenew, so your domain registration will renew automatically each year. We'll notify you \n\t\t\t\t\tin advance of the renewal date so you can choose whether to renew the registration.
\nOptionally enables privacy protection, so WHOIS queries return contact information either for Amazon Registrar \n\t\t\t\t\t(for .com, .net, and .org domains) or for our registrar associate, Gandi (for all other TLDs). If you don't enable privacy \n\t\t\t\t\tprotection, WHOIS queries return the information that you entered for the administrative, registrant, and technical contacts.
\n\t\t\t\t\tYou must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\t\t\t\tIf registration is successful, returns an operation ID that you can use to track the progress and \n\t\t\t\t\tcompletion of the action. If the request is not completed successfully, the domain registrant is notified by email.
\nCharges your Amazon Web Services account an amount based on the top-level domain. For more information, see \n\t\t\t\t\tAmazon Route 53 Pricing.
\nWhether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.
Default: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tDefault: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (the domain owner).
Default: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (the domain owner).
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tDefault: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.
Default: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tDefault: true\n
Rejects the transfer of a domain from another AWS account to the current AWS account. You initiate a transfer between AWS accounts using \n\t\t\tTransferDomainToAnotherAwsAccount.\n\t\t
\n\t\t\n\t\tUse either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t
Rejects the transfer of a domain from another Amazon Web Services account to the current Amazon Web Services account. You initiate a transfer betweenAmazon Web Services accounts using \n\t\t\tTransferDomainToAnotherAwsAccount.\n\t\t
\n\t\t\n\t\tUse either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t
The name of the domain that was specified when another AWS account submitted a \n\t\t\tTransferDomainToAnotherAwsAccount\n\t\t\trequest.\n\t\t
", + "smithy.api#documentation": "The name of the domain that was specified when another Amazon Web Services account submitted a \n\t\t\tTransferDomainToAnotherAwsAccount\n\t\t\trequest.\n\t\t
", "smithy.api#required": {} } } @@ -3040,7 +3440,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your AWS account.
\n\t\tWe recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the \n\t\t\texpiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see \n\t\t\tRenewing Registration for a Domain \n\t\t\tin the Amazon Route 53 Developer Guide.
" + "smithy.api#documentation": "This operation renews a domain for the specified number of years. The cost of renewing your domain is billed to your Amazon Web Services account.
\n\t\tWe recommend that you renew your domain several weeks before the expiration date. Some TLD registries delete domains before the \n\t\t\texpiration date if you haven't renewed far enough in advance. For more information about renewing domain registration, see \n\t\t\tRenewing Registration for a Domain \n\t\t\tin the Amazon Route 53 Developer Guide.
" } }, "com.amazonaws.route53domains#RenewDomainRequest": { @@ -3195,6 +3595,24 @@ }, "com.amazonaws.route53domains#Route53Domains_v20140515": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Route 53 Domains", + "arnNamespace": "route53domains", + "cloudFormationName": "Route53Domains", + "cloudTrailEventSource": "route53domains.amazonaws.com", + "endpointPrefix": "route53domains" + }, + "aws.auth#sigv4": { + "name": "route53domains" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon Route 53 API actions let you register domain names and perform related operations.
", + "smithy.api#title": "Amazon Route 53 Domains", + "smithy.api#xmlNamespace": { + "uri": "https://route53domains.amazonaws.com/doc/2014-05-15/" + } + }, "version": "2014-05-15", "operations": [ { @@ -3209,6 +3627,9 @@ { "target": "com.amazonaws.route53domains#CheckDomainTransferability" }, + { + "target": "com.amazonaws.route53domains#DeleteDomain" + }, { "target": "com.amazonaws.route53domains#DeleteTagsForDomain" }, @@ -3242,6 +3663,9 @@ { "target": "com.amazonaws.route53domains#ListOperations" }, + { + "target": "com.amazonaws.route53domains#ListPrices" + }, { "target": "com.amazonaws.route53domains#ListTagsForDomain" }, @@ -3281,24 +3705,43 @@ { "target": "com.amazonaws.route53domains#ViewBilling" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Route 53 Domains", - "arnNamespace": "route53domains", - "cloudFormationName": "Route53Domains", - "cloudTrailEventSource": "route53domains.amazonaws.com", - "endpointPrefix": "route53domains" - }, - "aws.auth#sigv4": { - "name": "route53domains" + ] + }, + "com.amazonaws.route53domains#SortCondition": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.route53domains#ListDomainsAttributeName", + "traits": { + "smithy.api#documentation": "Field to be used for sorting the list of domains. It can be either the name or the expiration for a domain. Note that if \n\t\t\tfilterCondition is used in the same \n\t\t\tListDomains\n\t\t\t call, the field used for sorting has to be the same as the field used for filtering.
Amazon Route 53 API actions let you register domain names and perform related operations.
", - "smithy.api#title": "Amazon Route 53 Domains", - "smithy.api#xmlNamespace": { - "uri": "https://route53domains.amazonaws.com/doc/2014-05-15/" + "SortOrder": { + "target": "com.amazonaws.route53domains#SortOrder", + "traits": { + "smithy.api#documentation": "The sort order for a list of domains. Either ascending (ASC) or descending (DES).
", + "smithy.api#required": {} + } } + }, + "traits": { + "smithy.api#documentation": "Information for sorting a list of domains.
" + } + }, + "com.amazonaws.route53domains#SortOrder": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASC", + "name": "ASC" + }, + { + "value": "DESC", + "name": "DESC" + } + ] } }, "com.amazonaws.route53domains#State": { @@ -3350,7 +3793,13 @@ } }, "com.amazonaws.route53domains#TagKey": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } }, "com.amazonaws.route53domains#TagKeyList": { "type": "list", @@ -3365,11 +3814,26 @@ } }, "com.amazonaws.route53domains#TagValue": { - "type": "string" + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } }, "com.amazonaws.route53domains#Timestamp": { "type": "timestamp" }, + "com.amazonaws.route53domains#TldName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, "com.amazonaws.route53domains#TransferDomain": { "type": "operation", "input": { @@ -3399,7 +3863,7 @@ } ], "traits": { - "smithy.api#documentation": "Transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered either with \n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or with our registrar associate, Gandi (for all other TLDs).
\n\t\tFor more information about transferring domains, see the following topics:
\n\t\tFor transfer requirements, a detailed procedure, and information about viewing the status of a domain that you're transferring \n\t\t\t\tto Route 53, see \n\t\t\t\tTransferring Registration for a \n\t\t\t\tDomain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
\nFor information about how to transfer a domain from one AWS account to another, see \n\t\t\t\tTransferDomainToAnotherAwsAccount.\n\t\t\t\t
\n\t\t\tFor information about how to transfer a domain to another domain registrar, see \n\t\t\t\tTransferring a Domain from \n\t\t\t\tAmazon Route 53 to Another Registrar in the Amazon Route 53 Developer Guide.
\nIf the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you \n\t\t\ttransfer your DNS service to Route 53 or to another DNS service provider before you transfer your registration. Some registrars \n\t\t\tprovide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar \n\t\t\twill not renew your domain registration and could end your DNS service at any time.
\n\t\t\n\t\t\tIf the registrar for your domain is also the DNS service provider for the domain and you don't \n\t\t\t\t\ttransfer DNS service to another provider, your website, email, and the web applications associated with the domain \n\t\t\t\t\tmight become unavailable.
\n\t\t\tIf the transfer is successful, this method returns an operation ID that you can use to track the progress and \n\t\t\tcompletion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email.
" + "smithy.api#documentation": "Transfers a domain from another registrar to Amazon Route 53. When the transfer is complete, the domain is registered either with \n\t\t\tAmazon Registrar (for .com, .net, and .org domains) or with our registrar associate, Gandi (for all other TLDs).
\n\t\tFor more information about transferring domains, see the following topics:
\n\t\tFor transfer requirements, a detailed procedure, and information about viewing the status of a domain that you're transferring \n\t\t\t\tto Route 53, see \n\t\t\t\tTransferring Registration for a \n\t\t\t\tDomain to Amazon Route 53 in the Amazon Route 53 Developer Guide.
\nFor information about how to transfer a domain from one Amazon Web Services account to another, see \n\t\t\t\tTransferDomainToAnotherAwsAccount.\n\t\t\t\t
\n\t\t\tFor information about how to transfer a domain to another domain registrar, see \n\t\t\t\tTransferring a Domain from \n\t\t\t\tAmazon Route 53 to Another Registrar in the Amazon Route 53 Developer Guide.
\nIf the registrar for your domain is also the DNS service provider for the domain, we highly recommend that you \n\t\t\ttransfer your DNS service to Route 53 or to another DNS service provider before you transfer your registration. Some registrars \n\t\t\tprovide free DNS service when you purchase a domain registration. When you transfer the registration, the previous registrar \n\t\t\twill not renew your domain registration and could end your DNS service at any time.
\n\t\t\n\t\t\tIf the registrar for your domain is also the DNS service provider for the domain and you don't \n\t\t\t\t\ttransfer DNS service to another provider, your website, email, and the web applications associated with the domain \n\t\t\t\t\tmight become unavailable.
\n\t\t\tIf the transfer is successful, this method returns an operation ID that you can use to track the progress and \n\t\t\tcompletion of the action. If the transfer doesn't complete successfully, the domain registrant will be notified by email.
" } }, "com.amazonaws.route53domains#TransferDomainRequest": { @@ -3467,19 +3931,19 @@ "PrivacyProtectAdminContact": { "target": "com.amazonaws.route53domains#Boolean", "traits": { - "smithy.api#documentation": "Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.
Default: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tDefault: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (domain owner).
Default: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (domain owner).
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tDefault: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.
Default: true\n
Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tDefault: true\n
Transfers a domain from the current AWS account to another AWS account. Note the following:
\n\t\tThe AWS account that you're transferring the domain to must accept the transfer. If the other account \n\t\t\t\tdoesn't accept the transfer within 3 days, we cancel the transfer. See \n\t\t\t\tAcceptDomainTransferFromAnotherAwsAccount.\n\t\t\t\t
\n\t\t\tYou can cancel the transfer before the other account accepts it. See \n\t\t\t\tCancelDomainTransferToAnotherAwsAccount.\n\t\t\t\t
\n\t\t\tThe other account can reject the transfer. See \n\t\t\t\t\tRejectDomainTransferFromAnotherAwsAccount.\n\t\t\t\t
\n\t\t\tWhen you transfer a domain from one AWS account to another, Route 53 doesn't transfer the hosted zone that is associated \n\t\t\t\twith the domain. DNS resolution isn't affected if the domain and the hosted zone are owned by separate accounts, \n\t\t\t\tso transferring the hosted zone is optional. For information about transferring the hosted zone to another AWS account, see \n\t\t\t\tMigrating a Hosted Zone to a \n\t\t\t\tDifferent AWS Account in the Amazon Route 53 Developer Guide.
\n\t\tUse either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t
Transfers a domain from the current Amazon Web Services account to another Amazon Web Services account. Note the following:
\n\t\tThe Amazon Web Services account that you're transferring the domain to must accept the transfer. If the other account \n\t\t\t\tdoesn't accept the transfer within 3 days, we cancel the transfer. See \n\t\t\t\tAcceptDomainTransferFromAnotherAwsAccount.\n\t\t\t\t
\n\t\t\tYou can cancel the transfer before the other account accepts it. See \n\t\t\t\tCancelDomainTransferToAnotherAwsAccount.\n\t\t\t\t
\n\t\t\tThe other account can reject the transfer. See \n\t\t\t\t\tRejectDomainTransferFromAnotherAwsAccount.\n\t\t\t\t
\n\t\t\tWhen you transfer a domain from one Amazon Web Services account to another, Route 53 doesn't transfer the hosted zone that is associated \n\t\t\t\twith the domain. DNS resolution isn't affected if the domain and the hosted zone are owned by separate accounts, \n\t\t\t\tso transferring the hosted zone is optional. For information about transferring the hosted zone to another Amazon Web Services account, see \n\t\t\t\tMigrating a Hosted Zone to a \n\t\t\t\t\tDifferent Amazon Web Services Account in the Amazon Route 53 Developer Guide.
\n\t\tUse either \n\t\t\tListOperations or \n\t\t\tGetOperationDetail \n\t\t\tto determine whether the operation succeeded. \n\t\t\tGetOperationDetail \n\t\t\tprovides additional information, for example, Domain Transfer from Aws Account 111122223333 has been cancelled. \n\t\t
The name of the domain that you want to transfer from the current AWS account to another account.
", + "smithy.api#documentation": "The name of the domain that you want to transfer from the current Amazon Web Services account to another account.
", "smithy.api#required": {} } }, "AccountId": { "target": "com.amazonaws.route53domains#AccountId", "traits": { - "smithy.api#documentation": "The account ID of the AWS account that you want to transfer the domain to, for example, 111122223333.
The account ID of the Amazon Web Services account that you want to transfer the domain to, for example, 111122223333.
To finish transferring a domain to another AWS account, the account that the domain is being transferred to must submit an \n\t\t\tAcceptDomainTransferFromAnotherAwsAccount\n\t\t\trequest. The request must include the value of the Password element that was returned in the \n\t\t\tTransferDomainToAnotherAwsAccount response.
To finish transferring a domain to another Amazon Web Services account, the account that the domain is being transferred to must submit an \n\t\t\tAcceptDomainTransferFromAnotherAwsAccount\n\t\t\trequest. The request must include the value of the Password element that was returned in the \n\t\t\tTransferDomainToAnotherAwsAccount response.
This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, \n\t\t\tcontact information such as email address is replaced either with contact information for Amazon Registrar (for .com, .net, and .org \n\t\t\tdomains) or with contact information for our registrar associate, Gandi.
\n\t\tThis operation affects only the contact information for the specified contact type (registrant, administrator, or tech). \n\t\t\tIf the request succeeds, Amazon Route 53 returns an operation ID that you can use with \n\t\t\tGetOperationDetail\n\t\t\tto track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email.
\n\t\tBy disabling the privacy service via API, you consent to the publication of the contact information provided for this domain \n\t\t\tvia the public WHOIS database. You certify that you are the registrant of this domain name and have the authority to make this decision. \n\t\t\tYou may withdraw your consent at any time by enabling privacy protection using either UpdateDomainContactPrivacy or the \n\t\t\tRoute 53 console. Enabling privacy protection removes the contact information provided for this domain from the WHOIS database. \n\t\t\tFor more information on our privacy practices, see \n\t\t\thttps://aws.amazon.com/privacy/.
This operation updates the specified domain contact's privacy setting. When privacy protection is enabled, \n\t\t\tcontact information such as email address is replaced either with contact information for Amazon Registrar (for .com, .net, and .org \n\t\t\tdomains) or with contact information for our registrar associate, Gandi.
\n\t\tYou must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tThis operation affects only the contact information for the specified contact type (administrative, registrant, or technical). \n\t\t\tIf the request succeeds, Amazon Route 53 returns an operation ID that you can use with \n\t\t\tGetOperationDetail\n\t\t\tto track the progress and completion of the action. If the request doesn't complete successfully, the domain registrant will be notified by email.
\n\t\tBy disabling the privacy service via API, you consent to the publication of the contact information provided for this domain \n\t\t\tvia the public WHOIS database. You certify that you are the registrant of this domain name and have the authority to make this decision. \n\t\t\tYou may withdraw your consent at any time by enabling privacy protection using either UpdateDomainContactPrivacy or the \n\t\t\tRoute 53 console. Enabling privacy protection removes the contact information provided for this domain from the WHOIS database. \n\t\t\tFor more information on our privacy practices, see \n\t\t\thttps://aws.amazon.com/privacy/.
Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.
Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the admin contact.
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tWhether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (domain owner).
Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the registrant contact (domain owner).
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tWhether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.
Whether you want to conceal contact information from WHOIS queries. If you specify true, \n\t\t\tWHOIS (\"who is\") queries return contact information either for Amazon Registrar (for .com, .net, and .org domains) \n\t\t\tor for our registrar associate, Gandi (for all other TLDs). If you specify false, \n\t\t\tWHOIS queries return the information that you entered for the technical contact.
You must specify the same privacy setting for the administrative, registrant, and technical contacts.
\n\t\tReturns all the domain-related billing records for the current AWS account for a specified period
" + "smithy.api#documentation": "Returns all the domain-related billing records for the current Amazon Web Services account for a specified period
", + "smithy.api#paginated": { + "inputToken": "Marker", + "outputToken": "NextPageMarker", + "items": "BillingRecords", + "pageSize": "MaxItems" + } } }, "com.amazonaws.route53domains#ViewBillingRequest": { @@ -3913,7 +4407,7 @@ "Marker": { "target": "com.amazonaws.route53domains#PageMarker", "traits": { - "smithy.api#documentation": "For an initial request for a list of billing records, omit this element. If the number of billing records \n\t\t\tthat are associated with the current AWS account during the specified period is greater than the value that \n\t\t\tyou specified for MaxItems, you can use Marker to return additional billing records. \n\t\t\tGet the value of NextPageMarker from the previous response, and submit another request that includes \n\t\t\tthe value of NextPageMarker in the Marker element.\n\t\t
Constraints: The marker must match the value of NextPageMarker that was returned in the previous response.
For an initial request for a list of billing records, omit this element. If the number of billing records \n\t\t\tthat are associated with the current Amazon Web Services account during the specified period is greater than the value that \n\t\t\tyou specified for MaxItems, you can use Marker to return additional billing records. \n\t\t\tGet the value of NextPageMarker from the previous response, and submit another request that includes \n\t\t\tthe value of NextPageMarker in the Marker element.\n\t\t
Constraints: The marker must match the value of NextPageMarker that was returned in the previous response.
403 response - AccessDeniedException. You do not have sufficient access to perform this action.
", + "smithy.api#documentation": "403 response - You do not have sufficient access to perform this action.
", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -50,14 +50,14 @@ "type": "structure", "members": { "AssertedControls": { - "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.
", "smithy.api#required": {} } }, "ControlPanelArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the control panel.
", "smithy.api#required": {} @@ -73,12 +73,12 @@ "RuleConfig": { "target": "com.amazonaws.route53recoverycontrolconfig#RuleConfig", "traits": { - "smithy.api#documentation": "The criteria that you set for specific assertion controls (routing controls) that designate how many controls must be enabled as the result of a transaction. For example, if you have three assertion controls, you might specify atleast 2 for your rule configuration. This means that at least two assertion controls must be enabled, so that at least two Amazon Web Services Regions are enabled.
", + "smithy.api#documentation": "The criteria that you set for specific assertion routing controls (AssertedControls) that designate how many routing control states must be ON as the result of a transaction. For example, if you have three assertion routing controls, you might specify atleast 2 for your rule configuration. This means that at least two assertion routing control states must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.
", "smithy.api#required": {} } }, "SafetyRuleArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assertion rule.
", "smithy.api#required": {} @@ -100,7 +100,7 @@ } }, "traits": { - "smithy.api#documentation": "An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.
" + "smithy.api#documentation": "An assertion rule enforces that, when you change a routing control state, that the criteria that you set in the rule configuration is met. Otherwise, the change to the routing control is not accepted. For example, the criteria might be that at least one routing control state is On after the transation so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.
" } }, "com.amazonaws.route53recoverycontrolconfig#AssertionRuleUpdate": { @@ -114,7 +114,7 @@ } }, "SafetyRuleArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the assertion rule.
", "smithy.api#required": {} @@ -136,7 +136,7 @@ "type": "structure", "members": { "ClusterArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster.
" } @@ -144,7 +144,7 @@ "ClusterEndpoints": { "target": "com.amazonaws.route53recoverycontrolconfig#__listOfClusterEndpoint", "traits": { - "smithy.api#documentation": "Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.
To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Cluster (Data Plane) Actions.
" + "smithy.api#documentation": "Endpoints for a cluster. Specify one of these endpoints when you want to set or retrieve a routing control state in the cluster.
To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.
" } }, "Name": { @@ -161,20 +161,20 @@ } }, "traits": { - "smithy.api#documentation": "A cluster is a set of five consensus-forming Regional endpoints that represent the infrastructure that hosts your routing controls. Typically, you host together on one cluster all of the routing controls for your applications.
" + "smithy.api#documentation": "A set of five redundant Regional endpoints against which you can execute API calls to update or get the state of routing controls. You can host multiple control panels and routing controls on one cluster.
" } }, "com.amazonaws.route53recoverycontrolconfig#ClusterEndpoint": { "type": "structure", "members": { "Endpoint": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max128", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max128PatternAZaZ09", "traits": { - "smithy.api#documentation": "A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.
To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Cluster (Data Plane) Actions.
" + "smithy.api#documentation": "A cluster endpoint. Specify an endpoint and Amazon Web Services Region when you want to set or retrieve a routing control state in the cluster.
To get or update the routing control state, see the Amazon Route 53 Application Recovery Controller Routing Control Actions.
" } }, "Region": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max32", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max32PatternS", "traits": { "smithy.api#documentation": "The Amazon Web Services Region for a cluster endpoint.
" } @@ -196,7 +196,7 @@ } }, "traits": { - "smithy.api#documentation": "409 response - ConflictException.
", + "smithy.api#documentation": "409 response - ConflictException. You might be using a predefined variable.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -205,13 +205,13 @@ "type": "structure", "members": { "ClusterArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster that includes the control panel.
" } }, "ControlPanelArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the control panel.
" } @@ -277,7 +277,7 @@ } ], "traits": { - "smithy.api#documentation": "Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the Amazon Route 53 Application Recovery Controller cluster data plane.
", + "smithy.api#documentation": "Create a new cluster. A cluster is a set of redundant Regional endpoints against which you can run API calls to update or get the state of one or more routing controls. Each cluster has a name, status, Amazon Resource Name (ARN), and an array of the five cluster endpoints (one for each supported Amazon Web Services Region) that you can use with API calls to the cluster data plane.
", "smithy.api#http": { "method": "POST", "uri": "/cluster", @@ -289,9 +289,9 @@ "type": "structure", "members": { "ClientToken": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax64", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max64PatternS", "traits": { - "smithy.api#documentation": "Unique client idempotency token.
", + "smithy.api#documentation": "A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.
", "smithy.api#idempotencyToken": {} } }, @@ -301,6 +301,12 @@ "smithy.api#documentation": "The name of the cluster.
", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.route53recoverycontrolconfig#__mapOf__stringMin0Max256PatternS", + "traits": { + "smithy.api#documentation": "The tags associated with the cluster.
" + } } }, "traits": { @@ -350,7 +356,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or AWS Region.
", + "smithy.api#documentation": "Creates a new control panel. A control panel represents a group of routing controls that can be changed together in a single transaction. You can use a control panel to centrally view the operational status of applications across your organization, and trigger multi-app failovers in a single transaction, for example, to fail over an Availability Zone or Amazon Web Services Region.
", "smithy.api#http": { "method": "POST", "uri": "/controlpanel", @@ -362,14 +368,14 @@ "type": "structure", "members": { "ClientToken": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax64", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max64PatternS", "traits": { - "smithy.api#documentation": "Unique client idempotency token.
", + "smithy.api#documentation": "A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.
", "smithy.api#idempotencyToken": {} } }, "ClusterArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster for the control panel.
", "smithy.api#required": {} @@ -381,6 +387,12 @@ "smithy.api#documentation": "The name of the control panel.
", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.route53recoverycontrolconfig#__mapOf__stringMin0Max256PatternS", + "traits": { + "smithy.api#documentation": "The tags associated with the control panel.
" + } } }, "traits": { @@ -442,21 +454,21 @@ "type": "structure", "members": { "ClientToken": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax64", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max64PatternS", "traits": { - "smithy.api#documentation": "Unique client idempotency token.
", + "smithy.api#documentation": "A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.
", "smithy.api#idempotencyToken": {} } }, "ClusterArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster that includes the routing control.
", "smithy.api#required": {} } }, "ControlPanelArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the control panel that includes the routing control.
" } @@ -501,7 +513,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a safety rule in a control panel. Safety rules let you add safeguards around enabling and disabling routing controls, to help prevent unexpected outcomes.
There are two types of safety rules: assertion rules and gating rules.
Assertion rule: An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.
Gating rule: A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.
", + "smithy.api#documentation": "Creates a safety rule in a control panel. Safety rules let you add safeguards around changing routing control states, and for enabling and disabling routing controls, to help prevent unexpected outcomes.
There are two types of safety rules: assertion rules and gating rules.
Assertion rule: An assertion rule enforces that, when you change a routing control state, that a certain criteria is met. For example, the criteria might be that at least one routing control state is On after the transation so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.
Gating rule: A gating rule lets you configure a gating routing control as an overall \"on/off\" switch for a group of routing controls. Or, you can configure more complex gating scenarios, for example by configuring multiple gating routing controls.
For more information, see Safety rules in the Amazon Route 53 Application Recovery Controller Developer Guide.
", "smithy.api#http": { "method": "POST", "uri": "/safetyrule", @@ -513,17 +525,29 @@ "type": "structure", "members": { "AssertionRule": { - "target": "com.amazonaws.route53recoverycontrolconfig#NewAssertionRule" + "target": "com.amazonaws.route53recoverycontrolconfig#NewAssertionRule", + "traits": { + "smithy.api#documentation": "The assertion rule requested.
" + } }, "ClientToken": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax64", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max64PatternS", "traits": { - "smithy.api#documentation": "Unique client idempotency token.
", + "smithy.api#documentation": "A unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request with an action, specify a client token in the request.
", "smithy.api#idempotencyToken": {} } }, "GatingRule": { - "target": "com.amazonaws.route53recoverycontrolconfig#NewGatingRule" + "target": "com.amazonaws.route53recoverycontrolconfig#NewGatingRule", + "traits": { + "smithy.api#documentation": "The gating rule requested.
" + } + }, + "Tags": { + "target": "com.amazonaws.route53recoverycontrolconfig#__mapOf__stringMin0Max256PatternS", + "traits": { + "smithy.api#documentation": "The tags associated with the safety rule.
" + } } }, "traits": { @@ -534,10 +558,16 @@ "type": "structure", "members": { "AssertionRule": { - "target": "com.amazonaws.route53recoverycontrolconfig#AssertionRule" + "target": "com.amazonaws.route53recoverycontrolconfig#AssertionRule", + "traits": { + "smithy.api#documentation": "The assertion rule created.
" + } }, "GatingRule": { - "target": "com.amazonaws.route53recoverycontrolconfig#GatingRule" + "target": "com.amazonaws.route53recoverycontrolconfig#GatingRule", + "traits": { + "smithy.api#documentation": "The gating rule created.
" + } } } }, @@ -638,7 +668,7 @@ "ControlPanelArn": { "target": "com.amazonaws.route53recoverycontrolconfig#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the control panel that you're deleting.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the control panel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -737,7 +767,7 @@ "SafetyRuleArn": { "target": "com.amazonaws.route53recoverycontrolconfig#__string", "traits": { - "smithy.api#documentation": "The request body that you include when you update a safety rule.
", + "smithy.api#documentation": "The ARN of the safety rule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -853,7 +883,7 @@ "ClusterArn": { "target": "com.amazonaws.route53recoverycontrolconfig#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster that you're getting details for.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -976,7 +1006,7 @@ "ControlPanelArn": { "target": "com.amazonaws.route53recoverycontrolconfig#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the control panel that you're getting details for.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the control panel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1099,7 +1129,7 @@ "RoutingControlArn": { "target": "com.amazonaws.route53recoverycontrolconfig#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the routing control that you're getting details for.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the routing control.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1134,7 +1164,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the safety rules (that is, the assertion rules and gating rules) for the routing controls in a control panel.
", + "smithy.api#documentation": "Returns information about a safety rule.
", "smithy.api#http": { "method": "GET", "uri": "/safetyrule/{SafetyRuleArn}", @@ -1148,7 +1178,7 @@ "SafetyRuleArn": { "target": "com.amazonaws.route53recoverycontrolconfig#__string", "traits": { - "smithy.api#documentation": "The request body that you include when you update a safety rule.
", + "smithy.api#documentation": "The ARN of the safety rule.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1159,10 +1189,16 @@ "type": "structure", "members": { "AssertionRule": { - "target": "com.amazonaws.route53recoverycontrolconfig#AssertionRule" + "target": "com.amazonaws.route53recoverycontrolconfig#AssertionRule", + "traits": { + "smithy.api#documentation": "The assertion rule in the response.
" + } }, "GatingRule": { - "target": "com.amazonaws.route53recoverycontrolconfig#GatingRule" + "target": "com.amazonaws.route53recoverycontrolconfig#GatingRule", + "traits": { + "smithy.api#documentation": "The gating rule in the response.
" + } } } }, @@ -1170,35 +1206,35 @@ "type": "structure", "members": { "ControlPanelArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the control panel.
", "smithy.api#required": {} } }, "GatingControls": { - "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__stringMin1Max256PatternAZaZ09", "traits": { - "smithy.api#documentation": "The gating controls for the gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
", + "smithy.api#documentation": "An array of gating routing control Amazon Resource Names (ARNs). For a simple \"on/off\" switch, specify the ARN for one routing control. The gating routing controls are evaluated by the rule configuration that you specify to determine if the target routing control states can be changed.
", "smithy.api#required": {} } }, "Name": { "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max64PatternS", "traits": { - "smithy.api#documentation": "The name for the gating rule.
", + "smithy.api#documentation": "The name for the gating rule. You can use any non-white space character in the name.
", "smithy.api#required": {} } }, "RuleConfig": { "target": "com.amazonaws.route53recoverycontrolconfig#RuleConfig", "traits": { - "smithy.api#documentation": "The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.
", + "smithy.api#documentation": "The criteria that you set for gating routing controls that designates how many of the routing control states must be ON to allow you to update target routing control states.
", "smithy.api#required": {} } }, "SafetyRuleArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gating rule.
", "smithy.api#required": {} @@ -1212,9 +1248,9 @@ } }, "TargetControls": { - "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__stringMin1Max256PatternAZaZ09", "traits": { - "smithy.api#documentation": "Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify ATLEAST 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.
In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
", + "smithy.api#documentation": "An array of target routing control Amazon Resource Names (ARNs) for which the states can only be updated if the rule configuration that you specify evaluates to true for the gating routing control. As a simple example, if you have a single gating control, it acts as an overall \"on/off\" switch for a set of target routing controls. You can use this to manually override automated fail over, for example.
", "smithy.api#required": {} } }, @@ -1227,7 +1263,7 @@ } }, "traits": { - "smithy.api#documentation": "A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.
" + "smithy.api#documentation": "A gating rule verifies that a gating routing control or set of gating rounting controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete.
For example, if you specify one gating routing control and you set the Type in the rule configuration to OR, that indicates that you must set the gating routing control to On for the rule to evaluate as true; that is, for the gating control \"switch\" to be \"On\". When you do that, then you can update the routing control states for the target routing controls that you specify in the gating rule.
" } }, "com.amazonaws.route53recoverycontrolconfig#GatingRuleUpdate": { @@ -1236,12 +1272,12 @@ "Name": { "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max64PatternS", "traits": { - "smithy.api#documentation": "The name for the gating rule.
", + "smithy.api#documentation": "The name for the gating rule. You can use any non-white space character in the name.
", "smithy.api#required": {} } }, "SafetyRuleArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gating rule.
", "smithy.api#required": {} @@ -1329,7 +1365,7 @@ "RoutingControlArn": { "target": "com.amazonaws.route53recoverycontrolconfig#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the routing control that you're getting details for.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the routing control.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1340,15 +1376,15 @@ "type": "structure", "members": { "HealthCheckIds": { - "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__stringMax36PatternS", "traits": { "smithy.api#documentation": "Identifiers for the health checks.
" } }, "NextToken": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax8096", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max8096PatternS", "traits": { - "smithy.api#documentation": "The token that identifies which batch of results you want to see.
" + "smithy.api#documentation": "Next token for listing health checks.
" } } } @@ -1421,7 +1457,7 @@ } }, "NextToken": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax8096", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max8096PatternS", "traits": { "smithy.api#documentation": "The token that identifies which batch of results you want to see.
" } @@ -1454,7 +1490,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns an array of control panels for a cluster.
", + "smithy.api#documentation": "Returns an array of control panels in an account or in a cluster.
", "smithy.api#http": { "method": "GET", "uri": "/controlpanels", @@ -1503,7 +1539,7 @@ } }, "NextToken": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax8096", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max8096PatternS", "traits": { "smithy.api#documentation": "The token that identifies which batch of results you want to see.
" } @@ -1555,7 +1591,7 @@ "ControlPanelArn": { "target": "com.amazonaws.route53recoverycontrolconfig#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the control panel that you're getting routing control details for.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the control panel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1580,7 +1616,7 @@ "type": "structure", "members": { "NextToken": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax8096", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max8096PatternS", "traits": { "smithy.api#documentation": "The token that identifies which batch of results you want to see.
" } @@ -1638,7 +1674,7 @@ "ControlPanelArn": { "target": "com.amazonaws.route53recoverycontrolconfig#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the control panel that you're getting details for.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the control panel.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1663,7 +1699,7 @@ "type": "structure", "members": { "NextToken": { - "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax8096", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max8096PatternS", "traits": { "smithy.api#documentation": "The token that identifies which batch of results you want to see.
" } @@ -1676,6 +1712,58 @@ } } }, + "com.amazonaws.route53recoverycontrolconfig#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53recoverycontrolconfig#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.route53recoverycontrolconfig#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53recoverycontrolconfig#InternalServerException" + }, + { + "target": "com.amazonaws.route53recoverycontrolconfig#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53recoverycontrolconfig#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the tags for a resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.route53recoverycontrolconfig#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the resource that's tagged.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53recoverycontrolconfig#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.route53recoverycontrolconfig#__mapOf__stringMin0Max256PatternS", + "traits": { + "smithy.api#documentation": "The tags associated with the resource.
" + } + } + } + }, "com.amazonaws.route53recoverycontrolconfig#MaxResults": { "type": "integer", "traits": { @@ -1689,14 +1777,14 @@ "type": "structure", "members": { "AssertedControls": { - "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The routing controls that are part of transactions that are evaluated to determine if a request to change a routing control state is allowed. For example, you might include three routing controls, one for each of three Amazon Web Services Regions.
", "smithy.api#required": {} } }, "ControlPanelArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the control panel.
", "smithy.api#required": {} @@ -1712,7 +1800,7 @@ "RuleConfig": { "target": "com.amazonaws.route53recoverycontrolconfig#RuleConfig", "traits": { - "smithy.api#documentation": "The criteria that you set for specific assertion controls (routing controls) that designate how many controls must be enabled as the result of a transaction. For example, if you have three assertion controls, you might specify atleast 2 for your rule configuration. This means that at least two assertion controls must be enabled, so that at least two Amazon Web Services Regions are enabled.
", + "smithy.api#documentation": "The criteria that you set for specific assertion controls (routing controls) that designate how many control states must be ON as the result of a transaction. For example, if you have three assertion controls, you might specify ATLEAST 2for your rule configuration. This means that at least two assertion controls must be ON, so that at least two Amazon Web Services Regions have traffic flowing to them.
", "smithy.api#required": {} } }, @@ -1732,14 +1820,14 @@ "type": "structure", "members": { "ControlPanelArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the control panel.
", "smithy.api#required": {} } }, "GatingControls": { - "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The gating controls for the new gating rule. That is, routing controls that are evaluated by the rule configuration that you specify.
", "smithy.api#required": {} @@ -1755,12 +1843,12 @@ "RuleConfig": { "target": "com.amazonaws.route53recoverycontrolconfig#RuleConfig", "traits": { - "smithy.api#documentation": "The criteria that you set for specific gating controls (routing controls) that designates how many controls must be enabled to allow you to change (set or unset) the target controls.
", + "smithy.api#documentation": "The criteria that you set for specific gating controls (routing controls) that designates how many control states must be ON to allow you to change (set or unset) the target control states.
", "smithy.api#required": {} } }, "TargetControls": { - "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "Routing controls that can only be set or unset if the specified RuleConfig evaluates to true for the specified GatingControls. For example, say you have three gating controls, one for each of three Amazon Web Services Regions. Now you specify AtLeast 2 as your RuleConfig. With these settings, you can only change (set or unset) the routing controls that you have specified as TargetControls if that rule evaluates to true.
In other words, your ability to change the routing controls that you have specified as TargetControls is gated by the rule that you set for the routing controls in GatingControls.
", "smithy.api#required": {} @@ -1790,13 +1878,28 @@ } }, "traits": { - "smithy.api#documentation": "404 response - The query string contains a syntax error or resource not found.
", + "smithy.api#documentation": "404 response - MalformedQueryString. The query string contains a syntax error or resource not found..
", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.route53recoverycontrolconfig#Route53RecoveryControlConfig": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Route53 Recovery Control Config", + "arnNamespace": "route53-recovery-control-config", + "cloudFormationName": "Route53RecoveryControlConfig", + "cloudTrailEventSource": "route53recoverycontrolconfig.amazonaws.com", + "endpointPrefix": "route53-recovery-control-config" + }, + "aws.auth#sigv4": { + "name": "route53-recovery-control-config" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Recovery Control Configuration API Reference for Amazon Route 53 Application Recovery Controller
", + "smithy.api#title": "AWS Route53 Recovery Control Config" + }, "version": "2020-11-02", "operations": [ { @@ -1850,6 +1953,15 @@ { "target": "com.amazonaws.route53recoverycontrolconfig#ListSafetyRules" }, + { + "target": "com.amazonaws.route53recoverycontrolconfig#ListTagsForResource" + }, + { + "target": "com.amazonaws.route53recoverycontrolconfig#TagResource" + }, + { + "target": "com.amazonaws.route53recoverycontrolconfig#UntagResource" + }, { "target": "com.amazonaws.route53recoverycontrolconfig#UpdateControlPanel" }, @@ -1859,28 +1971,13 @@ { "target": "com.amazonaws.route53recoverycontrolconfig#UpdateSafetyRule" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Route53 Recovery Control Config", - "arnNamespace": "route53-recovery-control-config", - "cloudFormationName": "Route53RecoveryControlConfig", - "cloudTrailEventSource": "route53recoverycontrolconfig.amazonaws.com", - "endpointPrefix": "route53-recovery-control-config" - }, - "aws.auth#sigv4": { - "name": "route53-recovery-control-config" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Recovery Control Configuration API Reference for Amazon Route 53 Application Recovery Controller
", - "smithy.api#title": "AWS Route53 Recovery Control Config" - } + ] }, "com.amazonaws.route53recoverycontrolconfig#RoutingControl": { "type": "structure", "members": { "ControlPanelArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the control panel that includes the routing control.
" } @@ -1892,7 +1989,7 @@ } }, "RoutingControlArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the routing control.
" } @@ -1914,13 +2011,13 @@ "ASSERTION": { "target": "com.amazonaws.route53recoverycontrolconfig#AssertionRule", "traits": { - "smithy.api#documentation": "An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control is not accepted.
" + "smithy.api#documentation": "An assertion rule enforces that, when a routing control state is changed, the criteria set by the rule configuration is met. Otherwise, the change to the routing control state is not accepted. For example, the criteria might be that at least one routing control state is On after the transation so that traffic continues to flow to at least one cell for the application. This ensures that you avoid a fail-open scenario.
" } }, "GATING": { "target": "com.amazonaws.route53recoverycontrolconfig#GatingRule", "traits": { - "smithy.api#documentation": "A gating rule verifies that a set of gating controls evaluates as true, based on a rule configuration that you specify. If the gating rule evaluates to true, Amazon Route 53 Application Recovery Controller allows a set of routing control state changes to run and complete against the set of target controls.
" + "smithy.api#documentation": "A gating rule verifies that a gating routing control or set of gating rounting controls, evaluates as true, based on a rule configuration that you specify, which allows a set of routing control state changes to complete.
For example, if you specify one gating routing control and you set the Type in the rule configuration to OR, that indicates that you must set the gating routing control to On for the rule to evaluate as true; that is, for the gating control \"switch\" to be \"On\". When you do that, then you can update the routing control states for the target routing controls that you specify in the gating rule.
" } } }, @@ -1954,7 +2051,7 @@ } }, "traits": { - "smithy.api#documentation": "The rule configuration for an assertion rule. That is, the criteria that you set for specific assertion controls (routing controls) that specify how many controls must be enabled after a transaction completes.
" + "smithy.api#documentation": "The rule configuration for an assertion rule. That is, the criteria that you set for specific assertion controls (routing controls) that specify how many control states must be ON after a transaction completes.
" } }, "com.amazonaws.route53recoverycontrolconfig#RuleType": { @@ -1989,7 +2086,7 @@ } }, "traits": { - "smithy.api#documentation": "402 response
", + "smithy.api#documentation": "402 response - You attempted to create more resources than the service allows based on service quotas.
", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -2014,6 +2111,61 @@ ] } }, + "com.amazonaws.route53recoverycontrolconfig#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53recoverycontrolconfig#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.route53recoverycontrolconfig#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53recoverycontrolconfig#InternalServerException" + }, + { + "target": "com.amazonaws.route53recoverycontrolconfig#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53recoverycontrolconfig#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds a tag to a resource.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.route53recoverycontrolconfig#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the resource that's tagged.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.route53recoverycontrolconfig#__mapOf__stringMin0Max256PatternS", + "traits": { + "smithy.api#documentation": "The tags associated with the resource.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Request of adding tag to the resource
" + } + }, + "com.amazonaws.route53recoverycontrolconfig#TagResourceResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.route53recoverycontrolconfig#ThrottlingException": { "type": "structure", "members": { @@ -2026,11 +2178,64 @@ } }, "traits": { - "smithy.api#documentation": "429 response - ThrottlingException.
", + "smithy.api#documentation": "429 response - LimitExceededException or TooManyRequestsException.
", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, + "com.amazonaws.route53recoverycontrolconfig#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.route53recoverycontrolconfig#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.route53recoverycontrolconfig#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.route53recoverycontrolconfig#InternalServerException" + }, + { + "target": "com.amazonaws.route53recoverycontrolconfig#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.route53recoverycontrolconfig#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes a tag from a resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.route53recoverycontrolconfig#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the resource that's tagged.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.route53recoverycontrolconfig#__listOf__string", + "traits": { + "smithy.api#documentation": "Keys for the tags to be removed.
", + "smithy.api#httpQuery": "TagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.route53recoverycontrolconfig#UntagResourceResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.route53recoverycontrolconfig#UpdateControlPanel": { "type": "operation", "input": { @@ -2072,7 +2277,7 @@ "type": "structure", "members": { "ControlPanelArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the control panel.
", "smithy.api#required": {} @@ -2142,7 +2347,7 @@ "type": "structure", "members": { "RoutingControlArn": { - "target": "com.amazonaws.route53recoverycontrolconfig#__string", + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the routing control.
", "smithy.api#required": {} @@ -2191,7 +2396,7 @@ } ], "traits": { - "smithy.api#documentation": "Update a safety rule (an assertion rule or gating rule) for the routing controls in a control panel. You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new safety rule.
", + "smithy.api#documentation": "Update a safety rule (an assertion rule or gating rule). You can only update the name and the waiting period for a safety rule. To make other updates, delete the safety rule and create a new one.
", "smithy.api#http": { "method": "PUT", "uri": "/safetyrule", @@ -2203,21 +2408,36 @@ "type": "structure", "members": { "AssertionRuleUpdate": { - "target": "com.amazonaws.route53recoverycontrolconfig#AssertionRuleUpdate" + "target": "com.amazonaws.route53recoverycontrolconfig#AssertionRuleUpdate", + "traits": { + "smithy.api#documentation": "The assertion rule to update.
" + } }, "GatingRuleUpdate": { - "target": "com.amazonaws.route53recoverycontrolconfig#GatingRuleUpdate" + "target": "com.amazonaws.route53recoverycontrolconfig#GatingRuleUpdate", + "traits": { + "smithy.api#documentation": "The gating rule to update.
" + } } + }, + "traits": { + "smithy.api#documentation": "A rule that you add to Application Recovery Controller to ensure that recovery actions don't accidentally impair your application's availability.
" } }, "com.amazonaws.route53recoverycontrolconfig#UpdateSafetyRuleResponse": { "type": "structure", "members": { "AssertionRule": { - "target": "com.amazonaws.route53recoverycontrolconfig#AssertionRule" + "target": "com.amazonaws.route53recoverycontrolconfig#AssertionRule", + "traits": { + "smithy.api#documentation": "The assertion rule updated.
" + } }, "GatingRule": { - "target": "com.amazonaws.route53recoverycontrolconfig#GatingRule" + "target": "com.amazonaws.route53recoverycontrolconfig#GatingRule", + "traits": { + "smithy.api#documentation": "The gating rule updated.
" + } } } }, @@ -2233,7 +2453,7 @@ } }, "traits": { - "smithy.api#documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you used parameters together incorrectly.
", + "smithy.api#documentation": "400 response - Multiple causes. For example, you might have a malformed query string and input parameter might be out of range, or you might have used parameters together incorrectly.
", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -2280,43 +2500,78 @@ "target": "com.amazonaws.route53recoverycontrolconfig#__string" } }, + "com.amazonaws.route53recoverycontrolconfig#__listOf__stringMax36PatternS": { + "type": "list", + "member": { + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMax36PatternS" + } + }, + "com.amazonaws.route53recoverycontrolconfig#__listOf__stringMin1Max256PatternAZaZ09": { + "type": "list", + "member": { + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09" + } + }, + "com.amazonaws.route53recoverycontrolconfig#__mapOf__stringMin0Max256PatternS": { + "type": "map", + "key": { + "target": "com.amazonaws.route53recoverycontrolconfig#__string" + }, + "value": { + "target": "com.amazonaws.route53recoverycontrolconfig#__stringMin0Max256PatternS" + } + }, "com.amazonaws.route53recoverycontrolconfig#__string": { "type": "string" }, - "com.amazonaws.route53recoverycontrolconfig#__stringMax64": { + "com.amazonaws.route53recoverycontrolconfig#__stringMax36PatternS": { "type": "string", "traits": { "smithy.api#length": { "min": 0, - "max": 64 - } + "max": 36 + }, + "smithy.api#pattern": "^\\S+$" } }, - "com.amazonaws.route53recoverycontrolconfig#__stringMax8096": { + "com.amazonaws.route53recoverycontrolconfig#__stringMin0Max256PatternS": { "type": "string", "traits": { "smithy.api#length": { "min": 0, - "max": 8096 - } + "max": 256 + }, + "smithy.api#pattern": "^\\S+$" } }, - "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max128": { + "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max128PatternAZaZ09": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 - } + }, + "smithy.api#pattern": "^[A-Za-z0-9:.\\/_-]*$" + } + }, + "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max256PatternAZaZ09": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9:\\/_-]*$" } }, - "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max32": { + "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max32PatternS": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 - } + }, + "smithy.api#pattern": "^\\S+$" } }, "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max64PatternS": { @@ -2328,6 +2583,16 @@ }, "smithy.api#pattern": "^\\S+$" } + }, + "com.amazonaws.route53recoverycontrolconfig#__stringMin1Max8096PatternS": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8096 + }, + "smithy.api#pattern": "^[\\S]*$" + } } } } diff --git a/codegen/sdk/aws-models/s3.2006-03-01.json b/codegen/sdk/aws-models/s3.2006-03-01.json index 0cf4f2945f3..5c306b3a61b 100644 --- a/codegen/sdk/aws-models/s3.2006-03-01.json +++ b/codegen/sdk/aws-models/s3.2006-03-01.json @@ -1877,7 +1877,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a\n valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.
\nNot every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Bucket naming rules.
\nIf you want to create an Amazon S3 on Outposts bucket, see Create Bucket.
\nBy default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. You might choose a Region to optimize\n latency, minimize costs, or address regulatory requirements. For example, if you reside in\n Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)\n Region. For more information, see Accessing a\n bucket.
\nIf you send your create bucket request to the s3.amazonaws.com endpoint,\n the request goes to the us-east-1 Region. Accordingly, the signature calculations in\n Signature Version 4 must use us-east-1 as the Region, even if the location constraint in\n the request specifies another Region where the bucket is to be created. If you create a\n bucket in a Region other than US East (N. Virginia), your application must be able to\n handle 307 redirect. For more information, see Virtual hosting of buckets.
\n Access control lists (ACLs)\n
\nWhen creating a bucket using this operation, you can optionally configure the bucket ACL to specify the accounts or\n groups that should be granted specific permissions on the bucket.
\nIf your CreateBucket request includes the BucketOwnerEnforced value for\n the x-amz-object-ownership header, your request can either not specify\n an ACL or specify bucket owner full control ACLs, such as the bucket-owner-full-control\n canned ACL or an equivalent ACL expressed in the XML format. For\n more information, see Controlling object\n ownership in the Amazon S3 User Guide.
There are two ways to grant the appropriate permissions using the request headers.
\nSpecify a canned ACL using the x-amz-acl request header. Amazon S3\n supports a set of predefined ACLs, known as canned ACLs. Each\n canned ACL has a predefined set of grantees and permissions. For more information,\n see Canned ACL.
Specify access permissions explicitly using the x-amz-grant-read,\n x-amz-grant-write, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and x-amz-grant-full-control\n headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For\n more information, see Access control list\n (ACL) overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id – if the value specified is the canonical user ID of an Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email address of\n an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n
You can use either a canned ACL or specify access permissions explicitly. You cannot\n do both.
\n\n Permissions\n
\nIn addition to s3:CreateBucket, the following permissions are required when your CreateBucket includes specific headers:
\n ACLs - If your CreateBucket request specifies ACL permissions and the ACL is public-read, public-read-write, \n authenticated-read, or if you specify access permissions explicitly through any other ACL, both \n s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL the \n CreateBucket request is private or doesn't specify any ACLs, only s3:CreateBucket permission is needed.
\n Object Lock - If\n ObjectLockEnabledForBucket is set to true in your\n CreateBucket request,\n s3:PutBucketObjectLockConfiguration and\n s3:PutBucketVersioning permissions are required.
\n S3 Object Ownership - If your CreateBucket\n request includes the the x-amz-object-ownership header,\n s3:PutBucketOwnershipControls permission is required.
The following operations are related to CreateBucket:
\n PutObject\n
\n\n DeleteBucket\n
\nCreates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a\n valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.
\nNot every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Bucket naming rules.
\nIf you want to create an Amazon S3 on Outposts bucket, see Create Bucket.
\nBy default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. You might choose a Region to optimize\n latency, minimize costs, or address regulatory requirements. For example, if you reside in\n Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)\n Region. For more information, see Accessing a\n bucket.
\nIf you send your create bucket request to the s3.amazonaws.com endpoint,\n the request goes to the us-east-1 Region. Accordingly, the signature calculations in\n Signature Version 4 must use us-east-1 as the Region, even if the location constraint in\n the request specifies another Region where the bucket is to be created. If you create a\n bucket in a Region other than US East (N. Virginia), your application must be able to\n handle 307 redirect. For more information, see Virtual hosting of buckets.
\n Access control lists (ACLs)\n
\nWhen creating a bucket using this operation, you can optionally configure the bucket ACL to specify the accounts or\n groups that should be granted specific permissions on the bucket.
\nIf your CreateBucket request sets bucket owner enforced for S3 Object Ownership and\n specifies a bucket ACL that provides access to an external Amazon Web Services account, your request\n fails with a 400 error and returns the\n InvalidBucketAclWithObjectOwnership error code. For more information,\n see Controlling object\n ownership in the Amazon S3 User Guide.
There are two ways to grant the appropriate permissions using the request headers.
\nSpecify a canned ACL using the x-amz-acl request header. Amazon S3\n supports a set of predefined ACLs, known as canned ACLs. Each\n canned ACL has a predefined set of grantees and permissions. For more information,\n see Canned ACL.
Specify access permissions explicitly using the x-amz-grant-read,\n x-amz-grant-write, x-amz-grant-read-acp,\n x-amz-grant-write-acp, and x-amz-grant-full-control\n headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For\n more information, see Access control list\n (ACL) overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id – if the value specified is the canonical user ID of an Amazon Web Services account
\n uri – if you are granting permissions to a predefined\n group
\n emailAddress – if the value specified is the email address of\n an Amazon Web Services account
Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
\nFor example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\" \n
You can use either a canned ACL or specify access permissions explicitly. You cannot\n do both.
\n\n Permissions\n
\nIn addition to s3:CreateBucket, the following permissions are required when your CreateBucket includes specific headers:
\n ACLs - If your CreateBucket request specifies ACL permissions and the ACL is public-read, public-read-write, \n authenticated-read, or if you specify access permissions explicitly through any other ACL, both \n s3:CreateBucket and s3:PutBucketAcl permissions are needed. If the ACL the \n CreateBucket request is private or doesn't specify any ACLs, only s3:CreateBucket permission is needed.
\n Object Lock - If\n ObjectLockEnabledForBucket is set to true in your\n CreateBucket request,\n s3:PutBucketObjectLockConfiguration and\n s3:PutBucketVersioning permissions are required.
\n S3 Object Ownership - If your CreateBucket\n request includes the the x-amz-object-ownership header,\n s3:PutBucketOwnershipControls permission is required.
The following operations are related to CreateBucket:
\n PutObject\n
\n\n DeleteBucket\n
\nDownloads the specified range bytes of an object. For more information about the HTTP\n Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
\nAmazon S3 doesn't support retrieving multiple ranges of data per GET\n request.
Because HeadObject returns only the metadata for an object, this parameter\n has no effect.
This action filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses\n this format to parse object data into records, and returns only records that match the\n specified SQL expression. You must also specify the data serialization format for the\n response.
\nThis action is not supported by Amazon S3 on Outposts.
\nFor more information about Amazon S3 Select,\n see Selecting Content from\n Objects in the Amazon S3 User Guide.
\nFor more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select\n and S3 Glacier Select in the Amazon S3 User Guide.
\n \n\n Permissions\n
\nYou must have s3:GetObject permission for this operation. Amazon S3 Select does\n not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy\n in the Amazon S3 User Guide.
\n Object Data Formats\n
\nYou can use Amazon S3 Select to query objects that have the following format\n properties:
\n\n CSV, JSON, and Parquet - Objects must be in CSV, JSON, or\n Parquet format.
\n\n UTF-8 - UTF-8 is the only encoding type Amazon S3 Select\n supports.
\n\n GZIP or BZIP2 - CSV and JSON files can be compressed using\n GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select\n supports for CSV and JSON files. Amazon S3 Select supports columnar compression for\n Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression\n for Parquet objects.
\n\n Server-side encryption - Amazon S3 Select supports querying\n objects that are protected with server-side encryption.
\nFor objects that are encrypted with customer-provided encryption keys (SSE-C), you\n must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.
\nFor objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and\n Amazon Web Services KMS keys (SSE-KMS),\n server-side encryption is handled transparently, so you don't need to specify\n anything. For more information about server-side encryption, including SSE-S3 and\n SSE-KMS, see Protecting Data Using\n Server-Side Encryption in the Amazon S3 User Guide.
\n\n Working with the Response Body\n
\nGiven the response size is unknown, Amazon S3 Select streams the response as a series of\n messages and includes a Transfer-Encoding header with chunked as\n its value in the response. For more information, see Appendix: SelectObjectContent\n Response.
\n GetObject Support\n
\nThe SelectObjectContent action does not support the following\n GetObject functionality. For more information, see GetObject.
\n Range: Although you can specify a scan range for an Amazon S3 Select request\n (see SelectObjectContentRequest - ScanRange in the request parameters),\n you cannot specify the range of bytes of an object to return.
GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify\n the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For\n more information, about storage classes see Storage Classes\n in the Amazon S3 User Guide.
\n Special Errors\n
\n\nFor a list of special errors for this operation, see List of\n SELECT Object Content Error Codes\n
\n\n Related Resources\n
\n\n GetObject\n
\nThis action filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses\n this format to parse object data into records, and returns only records that match the\n specified SQL expression. You must also specify the data serialization format for the\n response.
\nThis action is not supported by Amazon S3 on Outposts.
\nFor more information about Amazon S3 Select,\n see Selecting Content from\n Objects and SELECT\n Command in the Amazon S3 User Guide.
\nFor more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select\n and S3 Glacier Select in the Amazon S3 User Guide.
\n \n\n Permissions\n
\nYou must have s3:GetObject permission for this operation. Amazon S3 Select does\n not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy\n in the Amazon S3 User Guide.
\n Object Data Formats\n
\nYou can use Amazon S3 Select to query objects that have the following format\n properties:
\n\n CSV, JSON, and Parquet - Objects must be in CSV, JSON, or\n Parquet format.
\n\n UTF-8 - UTF-8 is the only encoding type Amazon S3 Select\n supports.
\n\n GZIP or BZIP2 - CSV and JSON files can be compressed using\n GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select\n supports for CSV and JSON files. Amazon S3 Select supports columnar compression for\n Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression\n for Parquet objects.
\n\n Server-side encryption - Amazon S3 Select supports querying\n objects that are protected with server-side encryption.
\nFor objects that are encrypted with customer-provided encryption keys (SSE-C), you\n must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the\n Amazon S3 User Guide.
\nFor objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and\n Amazon Web Services KMS keys (SSE-KMS),\n server-side encryption is handled transparently, so you don't need to specify\n anything. For more information about server-side encryption, including SSE-S3 and\n SSE-KMS, see Protecting Data Using\n Server-Side Encryption in the Amazon S3 User Guide.
\n\n Working with the Response Body\n
\nGiven the response size is unknown, Amazon S3 Select streams the response as a series of\n messages and includes a Transfer-Encoding header with chunked as\n its value in the response. For more information, see Appendix: SelectObjectContent\n Response.
\n GetObject Support\n
\nThe SelectObjectContent action does not support the following\n GetObject functionality. For more information, see GetObject.
\n Range: Although you can specify a scan range for an Amazon S3 Select request\n (see SelectObjectContentRequest - ScanRange in the request parameters),\n you cannot specify the range of bytes of an object to return.
GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify\n the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes. For\n more information, about storage classes see Storage Classes\n in the Amazon S3 User Guide.
\n Special Errors\n
\n\nFor a list of special errors for this operation, see List of\n SELECT Object Content Error Codes\n
\n\n Related Resources\n
\n\n GetObject\n
\nAmazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default\n encryption. This parameter is allowed if and only if SSEAlgorithm is set to\n aws:kms.
You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if you\n are using encryption with cross-account operations, you must use a fully qualified KMS key ARN.\n For more information, see Using encryption for cross-account operations.
\n\n For example:\n
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see\n Using symmetric and\n asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.
\nAmazon Web Services Key Management Service (KMS) customer Amazon Web Services KMS key ID to use for the default\n encryption. This parameter is allowed if and only if SSEAlgorithm is set to\n aws:kms.
You can specify the key ID or the Amazon Resource Name (ARN) of the KMS key. However, if\n you are using encryption with cross-account or Amazon Web Services service operations you must use a fully qualified KMS\n key ARN. For more information, see Using encryption for cross-account operations.
\n\n For example:\n
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab\n
Key ARN:\n arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\n
Amazon S3 only supports symmetric KMS keys and not asymmetric KMS keys. For more information, see\n Using symmetric and\n asymmetric keys in the Amazon Web Services Key Management Service Developer Guide.
\nDescribes the default server-side encryption to apply to new objects in the bucket. If a\n PUT Object request doesn't specify any server-side encryption, this default encryption will\n be applied. For more information, see PUT Bucket encryption in\n the Amazon S3 API Reference.
" + "smithy.api#documentation": "Describes the default server-side encryption to apply to new objects in the bucket. If a\n PUT Object request doesn't specify any server-side encryption, this default encryption will\n be applied. If you don't specify a customer managed key at configuration, Amazon S3 automatically creates \n an Amazon Web Services KMS key in your Amazon Web Services account the first time that you add an object encrypted with\n SSE-KMS to a bucket. By default, Amazon S3 uses this KMS key for SSE-KMS. For more information, see PUT Bucket encryption in\n the Amazon S3 API Reference.
" } }, "com.amazonaws.s3#ServerSideEncryptionConfiguration": { diff --git a/codegen/sdk/aws-models/s3control.2018-08-20.json b/codegen/sdk/aws-models/s3control.2018-08-20.json index bce826ade44..177ff3b8a3b 100644 --- a/codegen/sdk/aws-models/s3control.2018-08-20.json +++ b/codegen/sdk/aws-models/s3control.2018-08-20.json @@ -6186,7 +6186,7 @@ "target": "com.amazonaws.s3control#S3ExpirationInDays", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "This argument specifies how long the S3 Glacier or S3 Glacier Deep Archive object remains available in Amazon S3.\n S3 Initiate Restore Object jobs that\n target S3 Glacier and S3 Glacier Deep Archive objects require ExpirationInDays set to 1\n or greater.
Conversely, do not set ExpirationInDays when\n creating S3 Initiate Restore Object jobs that target\n S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in\n S3 Intelligent-Tiering archive access tiers are not subject to restore expiry, so\n specifying ExpirationInDays results in restore request failure.
S3 Batch Operations jobs can operate either on S3 Glacier and S3 Glacier Deep Archive storage class\n objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier\n objects, but not both types in the same job. If you need to restore objects of both types\n you must create separate Batch Operations jobs.
" + "smithy.api#documentation": "This argument specifies how long the S3 Glacier Flexible Retrieval or S3 Glacier Deep Archive object remains available in Amazon S3.\n S3 Initiate Restore Object jobs that\n target S3 Glacier Flexible Retrieval and S3 Glacier Deep Archive objects require ExpirationInDays set to 1\n or greater.
Conversely, do not set ExpirationInDays when\n creating S3 Initiate Restore Object jobs that target\n S3 Intelligent-Tiering Archive Access and Deep Archive Access tier objects. Objects in\n S3 Intelligent-Tiering archive access tiers are not subject to restore expiry, so\n specifying ExpirationInDays results in restore request failure.
S3 Batch Operations jobs can operate either on S3 Glacier Flexible Retrieval and S3 Glacier Deep Archive storage class\n objects or on S3 Intelligent-Tiering Archive Access and Deep Archive Access storage tier\n objects, but not both types in the same job. If you need to restore objects of both types\n you must create separate Batch Operations jobs.
" } }, "GlacierJobTier": { diff --git a/codegen/sdk/aws-models/sagemaker.2017-07-24.json b/codegen/sdk/aws-models/sagemaker.2017-07-24.json index f0aff07bd4b..5c323ace03d 100644 --- a/codegen/sdk/aws-models/sagemaker.2017-07-24.json +++ b/codegen/sdk/aws-models/sagemaker.2017-07-24.json @@ -1899,6 +1899,12 @@ "smithy.api#documentation": "The name of the target variable in supervised learning, usually represented by\n 'y'.
", "smithy.api#required": {} } + }, + "ContentType": { + "target": "com.amazonaws.sagemaker#ContentType", + "traits": { + "smithy.api#documentation": "The content type of the data from the input source. You can use\n text/csv;header=present or x-application/vnd.amazon+parquet.\n The default value is text/csv;header=present.
This member is deprecated and replaced with KmsKeyId.
Use KmsKeyId.
The JSON pipeline definition of the pipeline.
", - "smithy.api#required": {} + "smithy.api#documentation": "The JSON pipeline definition of the pipeline.
" + } + }, + "PipelineDefinitionS3Location": { + "target": "com.amazonaws.sagemaker#PipelineDefinitionS3Location", + "traits": { + "smithy.api#documentation": "The location of the pipeline definition stored in Amazon S3. If specified, \n SageMaker will retrieve the pipeline definition from this location.
" } }, "PipelineDescription": { @@ -6924,6 +6945,12 @@ "traits": { "smithy.api#documentation": "A list of tags to apply to the created pipeline.
" } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "This is the configuration that controls the parallelism of the pipeline. \n If specified, it applies to all runs of this pipeline by default.
" + } } } }, @@ -11163,7 +11190,7 @@ "smithy.api#deprecated": { "message": "This property is deprecated, use KmsKeyId instead." }, - "smithy.api#documentation": "This member is deprecated and replaced with KmsKeyId.
Use KmsKeyId.
The parallelism configuration applied to the pipeline.
" + } } } }, @@ -14046,6 +14079,12 @@ }, "LastModifiedBy": { "target": "com.amazonaws.sagemaker#UserContext" + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "Lists the parallelism configuration applied to the pipeline.
" + } } } }, @@ -16110,6 +16149,38 @@ "smithy.api#documentation": "Represents the drift check model quality baselines that can be used when the model monitor is set using \n the model package.
" } }, + "com.amazonaws.sagemaker#EMRStepMetadata": { + "type": "structure", + "members": { + "ClusterId": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The identifier of the EMR cluster.
" + } + }, + "StepId": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The identifier of the EMR cluster step.
" + } + }, + "StepName": { + "target": "com.amazonaws.sagemaker#String256", + "traits": { + "smithy.api#documentation": "The name of the EMR cluster step.
" + } + }, + "LogFilePath": { + "target": "com.amazonaws.sagemaker#String1024", + "traits": { + "smithy.api#documentation": "The path to the log file where the cluster step's failure root cause \n is recorded.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The configurations and outcomes of an Amazon EMR step execution.
" + } + }, "com.amazonaws.sagemaker#Edge": { "type": "structure", "members": { @@ -20061,7 +20132,7 @@ "FrameworkVersion": { "target": "com.amazonaws.sagemaker#FrameworkVersion", "traits": { - "smithy.api#documentation": "Specifies the framework version to use.
\nThis API field is only supported for PyTorch framework versions 1.4, \n 1.5, and 1.6 for \n cloud instance target devices: ml_c4, ml_c5, ml_m4, \n ml_m5, ml_p2, ml_p3, and ml_g4dn.
Specifies the framework version to use. This API field is only supported for the PyTorch and TensorFlow frameworks.
\nFor information about framework versions supported for cloud targets and edge devices, see \n Cloud Supported Instance Types and Frameworks and \n Edge Supported Frameworks.
" } } }, @@ -20651,6 +20722,16 @@ } } }, + "com.amazonaws.sagemaker#Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^.+$" + } + }, "com.amazonaws.sagemaker#KmsKeyId": { "type": "string", "traits": { @@ -26537,6 +26618,14 @@ } } }, + "com.amazonaws.sagemaker#MaxParallelExecutionSteps": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, "com.amazonaws.sagemaker#MaxParallelOfTests": { "type": "integer", "traits": { @@ -30124,13 +30213,28 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.sagemaker#ParallelismConfiguration": { + "type": "structure", + "members": { + "MaxParallelExecutionSteps": { + "target": "com.amazonaws.sagemaker#MaxParallelExecutionSteps", + "traits": { + "smithy.api#documentation": "The max number of steps that can be executed in parallel.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration that controls the parallelism of the pipeline. \n By default, the parallelism configuration specified applies to all \n executions of the pipeline unless overridden.
" + } + }, "com.amazonaws.sagemaker#Parameter": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.sagemaker#PipelineParameterName", "traits": { - "smithy.api#documentation": "The name of the parameter to assign a value to. This parameter name must match a named parameter in the pipeline definition.
", + "smithy.api#documentation": "The name of the parameter to assign a value to. This \n parameter name must match a named parameter in the \n pipeline definition.
", "smithy.api#required": {} } }, @@ -30540,6 +30644,12 @@ "LastModifiedBy": { "target": "com.amazonaws.sagemaker#UserContext" }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "The parallelism configuration applied to the pipeline.
" + } + }, "Tags": { "target": "com.amazonaws.sagemaker#TagList", "traits": { @@ -30571,6 +30681,34 @@ "smithy.api#pattern": "(?:[ \\r\\n\\t].*)*$" } }, + "com.amazonaws.sagemaker#PipelineDefinitionS3Location": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.sagemaker#BucketName", + "traits": { + "smithy.api#documentation": "Name of the S3 bucket.
", + "smithy.api#required": {} + } + }, + "ObjectKey": { + "target": "com.amazonaws.sagemaker#Key", + "traits": { + "smithy.api#documentation": "The object key (or key name) uniquely identifies the \n object in an S3 bucket.
", + "smithy.api#required": {} + } + }, + "VersionId": { + "target": "com.amazonaws.sagemaker#VersionId", + "traits": { + "smithy.api#documentation": "Version Id of the pipeline definition file. If not specified, Amazon SageMaker \n will retrieve the latest version.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The location of the pipeline definition stored in Amazon S3.
" + } + }, "com.amazonaws.sagemaker#PipelineDescription": { "type": "string", "traits": { @@ -30641,6 +30779,12 @@ "LastModifiedBy": { "target": "com.amazonaws.sagemaker#UserContext" }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "The parallelism configuration applied to the pipeline execution.
" + } + }, "PipelineParameters": { "target": "com.amazonaws.sagemaker#ParameterList", "traits": { @@ -30728,6 +30872,18 @@ "smithy.api#documentation": "The name of the step that is executed.
" } }, + "StepDisplayName": { + "target": "com.amazonaws.sagemaker#StepDisplayName", + "traits": { + "smithy.api#documentation": "The display name of the step.
" + } + }, + "StepDescription": { + "target": "com.amazonaws.sagemaker#StepDescription", + "traits": { + "smithy.api#documentation": "The description of the step.
" + } + }, "StartTime": { "target": "com.amazonaws.sagemaker#Timestamp", "traits": { @@ -30753,7 +30909,10 @@ } }, "AttemptCount": { - "target": "com.amazonaws.sagemaker#IntegerValue" + "target": "com.amazonaws.sagemaker#IntegerValue", + "traits": { + "smithy.api#documentation": "The current attempt of the execution step. For more information, see Retry Policy for Amazon SageMaker Pipelines steps.
" + } }, "FailureReason": { "target": "com.amazonaws.sagemaker#FailureReason", @@ -30852,6 +31011,12 @@ "traits": { "smithy.api#documentation": "Container for the metadata for a Clarify check step. The configurations \n and outcomes of the check step execution. This includes:
\nThe type of the check conducted,
\nThe Amazon S3 URIs of baseline constraints and statistics files to be used for the drift check.
\nThe Amazon S3 URIs of newly calculated baseline constraints and statistics.
\nThe model package group name provided.
\nThe Amazon S3 URI of the violation report if violations detected.
\nThe Amazon Resource Name (ARN) of check processing job initiated by the step execution.
\nThe boolean flags indicating if the drift check is skipped.
\nIf step property BaselineUsedForDriftCheck is set the same as \n CalculatedBaseline.
The configurations and outcomes of an EMR step execution.
" + } } }, "traits": { @@ -34330,6 +34495,12 @@ "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline.
" + } } } }, @@ -36433,6 +36604,12 @@ "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline for this specific run.
" + } } } }, @@ -36460,7 +36637,17 @@ "com.amazonaws.sagemaker#StatusMessage": { "type": "string" }, - "com.amazonaws.sagemaker#StepName": { + "com.amazonaws.sagemaker#StepDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3072 + }, + "smithy.api#pattern": ".*" + } + }, + "com.amazonaws.sagemaker#StepDisplayName": { "type": "string", "traits": { "smithy.api#length": { @@ -36470,6 +36657,16 @@ "smithy.api#pattern": ".*" } }, + "com.amazonaws.sagemaker#StepName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[A-Za-z0-9\\-_]*$" + } + }, "com.amazonaws.sagemaker#StepStatus": { "type": "string", "traits": { @@ -36713,7 +36910,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops a pipeline execution.
\n\n\n Callback Step\n
\nA pipeline execution won't stop while a callback step is running.\n When you call StopPipelineExecution\n on a pipeline execution with a running callback step, SageMaker Pipelines sends an\n additional Amazon SQS message to the specified SQS queue. The body of the SQS message\n contains a \"Status\" field which is set to \"Stopping\".
You should add logic to your Amazon SQS message consumer to take any needed action (for\n example, resource cleanup) upon receipt of the message followed by a call to\n SendPipelineExecutionStepSuccess or\n SendPipelineExecutionStepFailure.
Only when SageMaker Pipelines receives one of these calls will it stop the pipeline execution.
\n\n\n Lambda Step\n
\nA pipeline execution can't be stopped while a lambda step is running because the Lambda\n function invoked by the lambda step can't be stopped. If you attempt to stop the execution\n while the Lambda function is running, the pipeline waits for the Lambda function to finish\n or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function\n finishes, the pipeline execution status is Stopped. If the timeout is hit\n the pipeline execution status is Failed.
Stops a pipeline execution.
\n\n\n Callback Step\n
\nA pipeline execution won't stop while a callback step is running.\n When you call StopPipelineExecution\n on a pipeline execution with a running callback step, Amazon SageMaker Pipelines sends an\n additional Amazon SQS message to the specified SQS queue. The body of the SQS message\n contains a \"Status\" field which is set to \"Stopping\".
You should add logic to your Amazon SQS message consumer to take any needed action (for\n example, resource cleanup) upon receipt of the message followed by a call to\n SendPipelineExecutionStepSuccess or\n SendPipelineExecutionStepFailure.
Only when Amazon SageMaker Pipelines receives one of these calls will it stop the pipeline execution.
\n\n\n Lambda Step\n
\nA pipeline execution can't be stopped while a lambda step is running because the Lambda\n function invoked by the lambda step can't be stopped. If you attempt to stop the execution\n while the Lambda function is running, the pipeline waits for the Lambda function to finish\n or until the timeout is hit, whichever occurs first, and then stops. If the Lambda function\n finishes, the pipeline execution status is Stopped. If the timeout is hit\n the pipeline execution status is Failed.
Stops a transform job.
\nWhen Amazon SageMaker receives a StopTransformJob request, the status of the job\n changes to Stopping. After Amazon SageMaker\n stops\n the job, the status is set to Stopped. When you stop a transform job before\n it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.
Stops a batch transform job.
\nWhen Amazon SageMaker receives a StopTransformJob request, the status of the job\n changes to Stopping. After Amazon SageMaker\n stops\n the job, the status is set to Stopped. When you stop a batch transform job before\n it is completed, Amazon SageMaker doesn't store the job's output in Amazon S3.
The name of the transform job to stop.
", + "smithy.api#documentation": "The name of the batch transform job to stop.
", "smithy.api#required": {} } } @@ -37936,6 +38133,38 @@ { "value": "ml.c5n.18xlarge", "name": "ML_C5N_18XLARGE" + }, + { + "value": "ml.g5.xlarge", + "name": "ML_G5_XLARGE" + }, + { + "value": "ml.g5.2xlarge", + "name": "ML_G5_2XLARGE" + }, + { + "value": "ml.g5.4xlarge", + "name": "ML_G5_4XLARGE" + }, + { + "value": "ml.g5.8xlarge", + "name": "ML_G5_8XLARGE" + }, + { + "value": "ml.g5.16xlarge", + "name": "ML_G5_16XLARGE" + }, + { + "value": "ml.g5.12xlarge", + "name": "ML_G5_12XLARGE" + }, + { + "value": "ml.g5.24xlarge", + "name": "ML_G5_24XLARGE" + }, + { + "value": "ml.g5.48xlarge", + "name": "ML_G5_48XLARGE" } ] } @@ -40870,6 +41099,12 @@ "traits": { "smithy.api#documentation": "The display name of the pipeline execution.
" } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "This configuration, if specified, overrides the parallelism configuration \n of the parent pipeline for this specific run.
" + } } } }, @@ -40906,6 +41141,12 @@ "smithy.api#documentation": "The JSON pipeline definition.
" } }, + "PipelineDefinitionS3Location": { + "target": "com.amazonaws.sagemaker#PipelineDefinitionS3Location", + "traits": { + "smithy.api#documentation": "The location of the pipeline definition stored in Amazon S3. If specified, \n SageMaker will retrieve the pipeline definition from this location.
" + } + }, "PipelineDescription": { "target": "com.amazonaws.sagemaker#PipelineDescription", "traits": { @@ -40917,6 +41158,12 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) that the pipeline uses to execute.
" } + }, + "ParallelismConfiguration": { + "target": "com.amazonaws.sagemaker#ParallelismConfiguration", + "traits": { + "smithy.api#documentation": "If specified, it applies to all executions of this pipeline by default.
" + } } } }, @@ -41663,6 +41910,16 @@ } } }, + "com.amazonaws.sagemaker#VersionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^.+$" + } + }, "com.amazonaws.sagemaker#VersionedArnOrName": { "type": "string", "traits": { diff --git a/codegen/sdk/aws-models/savingsplans.2019-06-28.json b/codegen/sdk/aws-models/savingsplans.2019-06-28.json index 616add24fd5..3ffaef2ae5b 100644 --- a/codegen/sdk/aws-models/savingsplans.2019-06-28.json +++ b/codegen/sdk/aws-models/savingsplans.2019-06-28.json @@ -31,6 +31,21 @@ "shapes": { "com.amazonaws.savingsplans#AWSSavingsPlan": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "savingsplans", + "arnNamespace": "savingsplans", + "cloudFormationName": "Savingsplans", + "cloudTrailEventSource": "savingsplans.amazonaws.com", + "endpointPrefix": "savingsplans" + }, + "aws.auth#sigv4": { + "name": "savingsplans" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Savings Plans are a pricing model that offer significant savings on AWS usage (for\n example, on Amazon EC2 instances). You commit to a consistent amount of usage, in USD\n per hour, for a term of 1 or 3 years, and receive a lower price for that usage. For\n more information, see the AWS Savings Plans User Guide.
", + "smithy.api#title": "AWS Savings Plans" + }, "version": "2019-06-28", "operations": [ { @@ -60,22 +75,7 @@ { "target": "com.amazonaws.savingsplans#UntagResource" } - ], - "traits": { - "aws.api#service": { - "sdkId": "savingsplans", - "arnNamespace": "savingsplans", - "cloudFormationName": "Savingsplans", - "cloudTrailEventSource": "savingsplans.amazonaws.com", - "endpointPrefix": "savingsplans" - }, - "aws.auth#sigv4": { - "name": "savingsplans" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Savings Plans are a pricing model that offer significant savings on AWS usage (for\n example, on Amazon EC2 instances). You commit to a consistent amount of usage, in USD\n per hour, for a term of 1 or 3 years, and receive a lower price for that usage. For\n more information, see the AWS Savings Plans User Guide.
", - "smithy.api#title": "AWS Savings Plans" - } + ] }, "com.amazonaws.savingsplans#Amount": { "type": "string" @@ -127,7 +127,7 @@ "commitment": { "target": "com.amazonaws.savingsplans#Amount", "traits": { - "smithy.api#documentation": "The hourly commitment, in USD. This is a value between 0.001 and 1 million. You cannot specify more\n than three digits after the decimal point.
", + "smithy.api#documentation": "The hourly commitment, in USD. This is a value between 0.001 and 1 million. You cannot specify more\n than five digits after the decimal point.
", "smithy.api#required": {} } }, diff --git a/codegen/sdk/aws-models/secretsmanager.2017-10-17.json b/codegen/sdk/aws-models/secretsmanager.2017-10-17.json index 0172190a2c8..db6095628ea 100644 --- a/codegen/sdk/aws-models/secretsmanager.2017-10-17.json +++ b/codegen/sdk/aws-models/secretsmanager.2017-10-17.json @@ -75,7 +75,7 @@ } ], "traits": { - "smithy.api#documentation": "Disables automatic scheduled rotation and cancels the rotation of a secret if currently in\n progress.
\nTo re-enable scheduled rotation, call RotateSecret with\n AutomaticallyRotateAfterDays set to a value greater than 0. This immediately\n rotates your secret and then enables the automatic schedule.
If you cancel a rotation while in progress, it can leave the VersionStage\n labels in an unexpected state. Depending on the step of the rotation in progress, you might\n need to remove the staging label AWSPENDING from the partially created version, specified\n by the VersionId response value. You should also evaluate the partially rotated\n new version to see if it should be deleted, which you can do by removing all staging labels\n from the new version VersionStage field.
To successfully start a rotation, the staging label AWSPENDING must be in one of the\n following states:
Not attached to any version at all
\nAttached to the same version as the staging label AWSCURRENT\n
If the staging label AWSPENDING attached to a different version than the version with\n AWSCURRENT then the attempt to rotate fails.
\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\nsecretsmanager:CancelRotateSecret
\n\n Related operations\n
\nTo configure rotation for a secret or to manually trigger a rotation, use RotateSecret.
\nTo get the rotation configuration details for a secret, use DescribeSecret.
\nTo list all of the currently available secrets, use ListSecrets.
\nTo list all of the versions currently associated with a secret, use ListSecretVersionIds.
\nTurns off automatic rotation, and if a rotation is currently in\n progress, cancels the rotation.
\nTo turn on automatic rotation again, call RotateSecret.
\nIf you cancel a rotation in progress, it can leave the VersionStage\n labels in an unexpected state. Depending on the step of the rotation in progress, you might\n need to remove the staging label AWSPENDING from the partially created version, specified\n by the VersionId response value. We recommend you also evaluate the partially rotated\n new version to see if it should be deleted. You can delete a version by removing all staging labels\n from it.
Specifies the secret to cancel a rotation request. You can specify either the Amazon\n Resource Name (ARN) or the friendly name of the secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", + "smithy.api#documentation": "The ARN or name of the secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", "smithy.api#required": {} } } @@ -96,19 +96,19 @@ "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "The ARN of the secret for which rotation was canceled.
" + "smithy.api#documentation": "The ARN of the secret.
" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "The friendly name of the secret for which rotation was canceled.
" + "smithy.api#documentation": "The name of the secret.
" } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { - "smithy.api#documentation": "The unique identifier of the version of the secret created during the rotation. This\n version might not be complete, and should be evaluated for possible deletion. At the very\n least, you should remove the VersionStage value AWSPENDING to enable this\n version to be deleted. Failing to clean up a cancelled rotation can block you from\n successfully starting future rotations.
The unique identifier of the version of the secret created during the rotation. This\n version might not be complete, and should be evaluated for possible deletion. We recommend \n that you remove the VersionStage value AWSPENDING from this version so that \n Secrets Manager can delete it. Failing to clean up a cancelled rotation can block you from\n starting future rotations.
Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the\n important information needed to manage the secret.
\nSecrets Manager stores the encrypted secret data in one of a collection of \"versions\"\n associated with the secret. Each version contains a copy of the encrypted secret data. Each\n version is associated with one or more \"staging labels\" that identify where the version is in\n the rotation cycle. The SecretVersionsToStages field of the secret contains the\n mapping of staging labels to the active versions of the secret. Versions without a staging\n label are considered deprecated and not included in the list.
You provide the secret data to be encrypted by putting text in either the\n SecretString parameter or binary data in the SecretBinary\n parameter, but not both. If you include SecretString or SecretBinary\n then Secrets Manager also creates an initial secret version and automatically attaches the staging\n label AWSCURRENT to the new version.
If you call an operation to encrypt or decrypt the SecretString \n or SecretBinary for a secret in the same account as the calling user and that \n secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default \n Amazon Web Services managed customer master key (CMK) with the alias aws/secretsmanager. If this key \n doesn't already exist in your account then Secrets Manager creates it for you automatically. All\n users and roles in the same Amazon Web Services account automatically have access to use the default CMK. \n Note that if an Secrets Manager API call results in Amazon Web Services creating the account's \n Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the \n result.
If the secret resides in a different Amazon Web Services account from the credentials calling an API that \n requires encryption or decryption of the secret value then you must create and use a custom \n Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials \n from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the \n secret or when you update it by including it in the KMSKeyId. If you call an \n API that must encrypt or decrypt SecretString or SecretBinary \n using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account\n access to that other account's user or role for both the kms:GenerateDataKey and \n kms:Decrypt operations.
\n
\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\nsecretsmanager:CreateSecret
\nkms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt\n the secret. You do not need this permission to use the account default Amazon Web Services managed CMK\n for Secrets Manager.
\nkms:Decrypt - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt the\n secret. You do not need this permission to use the account default Amazon Web Services managed CMK for\n Secrets Manager.
\nsecretsmanager:TagResource - needed only if you include the Tags\n parameter.
\n Related operations\n
\nTo delete a secret, use DeleteSecret.
\nTo modify an existing secret, use UpdateSecret.
\nTo create a new version of a secret, use PutSecretValue.
\nTo retrieve the encrypted secure string and secure binary values, use GetSecretValue.
\nTo retrieve all other details for a secret, use DescribeSecret. This\n does not include the encrypted secure string and secure binary values.
\nTo retrieve the list of secret versions associated with the current secret, use DescribeSecret and examine the SecretVersionsToStages response\n value.
Creates a new secret. A secret is a set of credentials, such as a \n user name and password, that you store in an encrypted form in Secrets Manager. The secret also \n includes the connection information to access a database or other service, which Secrets Manager \n doesn't encrypt. A secret in Secrets Manager consists of both the protected secret data and the\n important information needed to manage the secret.
\nFor information about creating a secret in the console, see Create a secret.
\nTo create a secret, you can provide the secret value to be encrypted in either the\n SecretString parameter or the SecretBinary parameter, but not both. \n If you include SecretString or SecretBinary\n then Secrets Manager creates an initial secret version and automatically attaches the staging\n label AWSCURRENT to it.
If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key \n aws/secretsmanager. If this key \n doesn't already exist in your account, then Secrets Manager creates it for you automatically. All\n users and roles in the Amazon Web Services account automatically have access to use aws/secretsmanager. \n Creating aws/secretsmanager can result in a one-time significant delay in returning the \n result.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then \n you can't use aws/secretsmanager to encrypt the secret, and you must create \n and use a customer managed KMS key.
Specifies the friendly name of the new secret.
\nThe secret name must be ASCII letters, digits, or the following characters :\n /_+=.@-
\nDo not end your secret name with a hyphen followed by six characters. If you do so, you\n risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager\n automatically adds a hyphen and six random characters at the end of the ARN.
\nThe name of the new secret.
\nThe secret name can contain ASCII letters, numbers, and the following characters:\n /_+=.@-
\n \nDo not end your secret name with a hyphen followed by six characters. If you do so, you\n risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager\n automatically adds a hyphen and six random characters after the secret name at the end of the ARN.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.secretsmanager#ClientRequestTokenType", "traits": { - "smithy.api#documentation": "(Optional) If you include SecretString or SecretBinary, then an\n initial version is created as part of the secret, and this parameter specifies a unique\n identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can\n leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it\n as the value for this parameter in the request. If you don't use the SDK and instead\n generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a\n ClientRequestToken yourself for the new version and include the value in the\n request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental\n creation of duplicate versions if there are failures and retries during a rotation. We\n recommend that you generate a UUID-type value to\n ensure uniqueness of your versions within the specified secret.
\nIf the ClientRequestToken value isn't already associated with a version\n of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString\n and SecretBinary values are the same as those in the request, then the\n request is ignored.
If a version with this value already exists and that version's\n SecretString and SecretBinary values are different from those\n in the request, then the request fails because you cannot modify an existing version.\n Instead, use PutSecretValue to create a new version.
This value becomes the VersionId of the new version.
If you include SecretString or SecretBinary, then \n Secrets Manager creates an initial version for the secret, and this parameter specifies the unique\n identifier for the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can\n leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it\n as the value for this parameter in the request. If you don't use the SDK and instead\n generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a\n ClientRequestToken yourself for the new version and include the value in the\n request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental\n creation of duplicate versions if there are failures and retries during a rotation. We\n recommend that you generate a UUID-type value to\n ensure uniqueness of your versions within the specified secret.
\nIf the ClientRequestToken value isn't already associated with a version\n of the secret then a new version of the secret is created.
If a version with this value already exists and the version SecretString\n and SecretBinary values are the same as those in the request, then the\n request is ignored.
If a version with this value already exists and that version's\n SecretString and SecretBinary values are different from those\n in the request, then the request fails because you cannot modify an existing version.\n Instead, use PutSecretValue to create a new version.
This value becomes the VersionId of the new version.
(Optional) Specifies a user-provided description of the secret.
" + "smithy.api#documentation": "The description of the secret.
" } }, "KmsKeyId": { "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { - "smithy.api#documentation": "(Optional) Specifies the ARN, Key ID, or alias of the Amazon Web Services KMS customer master key (CMK) to\n be used to encrypt the SecretString or SecretBinary values in the\n versions stored in this secret.
You can specify any of the supported ways to identify a Amazon Web Services KMS key ID. If you need to\n reference a CMK in a different account, you can use only the key ARN or the alias ARN.
\nIf you don't specify this value, then Secrets Manager defaults to using the Amazon Web Services account's\n default CMK (the one named aws/secretsmanager). If a Amazon Web Services KMS CMK with that name doesn't yet\n exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a\n version's SecretString or SecretBinary fields.
You can use the account default CMK to encrypt and decrypt only if you call this\n operation using credentials from the same account that owns the secret. If the secret\n resides in a different account, then you must create a custom CMK and specify the ARN in\n this field.
\nThe ARN, key ID, or alias of the KMS key that Secrets Manager uses to\n encrypt the secret value in the secret.
\nTo use a KMS key in a different account, use the key ARN or the alias ARN.
\nIf you don't specify this value, then Secrets Manager uses the key aws/secretsmanager. \n If that key doesn't yet exist, then Secrets Manager creates it for you automatically the first time it \n encrypts the secret value.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then \n you can't use aws/secretsmanager to encrypt the secret, and you must create \n and use a customer managed KMS key.
(Optional) Specifies binary data that you want to encrypt and store in the new version of\n the secret. To use this parameter in the command-line tools, we recommend that you store your\n binary data in a file and then use the appropriate technique for your tool to pass the\n contents of the file as a parameter.
\nEither SecretString or SecretBinary must have a value, but not\n both. They cannot both be empty.
This parameter is not available using the Secrets Manager console. It can be accessed only by\n using the Amazon Web Services CLI or one of the Amazon Web Services SDKs.
" + "smithy.api#documentation": "The binary data to encrypt and store in the new version of\n the secret. We recommend that you store your binary data in a file and then pass the\n contents of the file as a parameter.
\nEither SecretString or SecretBinary must have a value, but not\n both.
This parameter is not available in the Secrets Manager console.
" } }, "SecretString": { "target": "com.amazonaws.secretsmanager#SecretStringType", "traits": { - "smithy.api#documentation": "(Optional) Specifies text data that you want to encrypt and store in this new version of\n the secret.
\nEither SecretString or SecretBinary must have a value, but not\n both. They cannot both be empty.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected\n secret text in only the SecretString parameter. The Secrets Manager console stores the\n information as a JSON structure of key/value pairs that the Lambda rotation function knows how\n to parse.
For storing multiple values, we recommend that you use a JSON text \n string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI\n in the Amazon Web Services CLI User Guide.
" + "smithy.api#documentation": "The text data to encrypt and store in this new version of\n the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
\nEither SecretString or SecretBinary must have a value, but not\n both.
If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected\n secret text in only the SecretString parameter. The Secrets Manager console stores the\n information as a JSON structure of key/value pairs that a Lambda rotation function can parse.
(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag\n is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list\n of tags. To remove tags, you must use UntagResource.
\nSecrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag\n from one with key \"abc\".
\nIf you check tags in IAM policy Condition elements as part of your\n security strategy, then adding or removing a tag can change permissions. If the\n successful completion of this operation would result in you losing your permissions for\n this secret, then this operation is blocked and returns an Access Denied\n error.
This parameter requires a JSON text string argument. For information on how to format a\n JSON parameter for the various command line tool environments, see Using JSON for\n Parameters in the CLI User Guide. For example:
\n\n [{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]\n
If your command-line tool or SDK requires quotation marks around the parameter, you should\n use single quotes to avoid confusion with the double quotes required in the JSON text.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per secret—50
\nMaximum key length—127 Unicode characters in UTF-8
\nMaximum value length—255 Unicode characters in UTF-8
\nTag keys and values are case sensitive.
\nDo not use the aws: prefix in your tag names or values because Amazon Web Services reserves it\n for Amazon Web Services use. You can't edit or delete tag names or values with this \n prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources,\n remember other services might have restrictions on allowed characters. Generally\n allowed characters: letters, spaces, and numbers representable in UTF-8, plus the\n following special characters: + - = . _ : / @.
\nA list of tags to attach to the secret. Each tag\n is a key and value pair of strings in a JSON text string, for example:
\n\n [{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]\n
Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag\n from one with key \"abc\".
\nIf you check tags in permissions policies as part of your\n security strategy, then adding or removing a tag can change permissions. If the\n completion of this operation would result in you losing your permissions for\n this secret, then Secrets Manager blocks the operation and returns an Access Denied\n error. For more information, see Control \n access to secrets using tags and Limit access to identities with tags that match secrets' tags.
For information about how to format a\n JSON parameter for the various command line tool environments, see Using JSON for\n Parameters. If your command-line tool or SDK requires quotation marks around the parameter, you should\n use single quotes to avoid confusion with the double quotes required in the JSON text.
\nThe following restrictions apply to tags:
\nMaximum number of tags per secret: 50
\nMaximum key length: 127 Unicode characters in UTF-8
\nMaximum value length: 255 Unicode characters in UTF-8
\nTag keys and values are case sensitive.
\nDo not use the aws: prefix in your tag names or values because Amazon Web Services reserves it\n for Amazon Web Services use. You can't edit or delete tag names or values with this \n prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources,\n other services might have restrictions on allowed characters. Generally\n allowed characters: letters, spaces, and numbers representable in UTF-8, plus the\n following special characters: + - = . _ : / @.
\n(Optional) Add a list of regions to replicate secrets. Secrets Manager replicates the KMSKeyID objects to the list of regions specified in\n the parameter.
" + "smithy.api#documentation": "A list of Regions and KMS keys to replicate secrets.
" } }, "ForceOverwriteReplicaSecret": { "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { - "smithy.api#documentation": "(Optional) If set, the replication overwrites a secret with the same name in the\n destination region.
" + "smithy.api#documentation": "Specifies whether to overwrite a secret with the same name in the\n destination Region.
" } } } @@ -230,25 +230,25 @@ "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret that you just created.
\nSecrets Manager automatically adds several random characters to the name at the end of the ARN when\n you initially create a secret. This affects only the ARN and not the actual friendly name. \n This ensures that if you create a new secret with the same name as an old secret that you \n previously deleted, then users with access to the old secret don't \n automatically get access to the new secret because the ARNs are different.
\nThe ARN of the new secret. The ARN includes the name of the secret followed by six random \n characters. This ensures that if you create a new secret with the same name as a deleted secret, \n then users with access to the old secret don't get access to the new secret because the ARNs \n are different.
" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "The friendly name of the secret that you just created.
" + "smithy.api#documentation": "The name of the new secret.
" } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { - "smithy.api#documentation": "The unique identifier associated with the version of the secret you just created.
" + "smithy.api#documentation": "The unique identifier associated with the version of the new secret.
" } }, "ReplicationStatus": { "target": "com.amazonaws.secretsmanager#ReplicationStatusListType", "traits": { - "smithy.api#documentation": "Describes a list of replication status objects as InProgress, Failed or InSync.
A list of the replicas of this secret and their status:
\n\n Failed, which indicates that the replica was not created.
\n InProgress, which indicates that Secrets Manager is in the process of creating the replica.
\n InSync, which indicates that the replica was created.
Deletes the resource-based permission policy attached to the secret.
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\nsecretsmanager:DeleteResourcePolicy
\n\n Related operations\n
\nTo attach a resource policy to a secret, use PutResourcePolicy.
\nTo retrieve the current resource-based policy attached to a secret, use GetResourcePolicy.
\nTo list all of the currently available secrets, use ListSecrets.
\nDeletes the resource-based permission policy attached to the secret. To attach a policy to \n a secret, use PutResourcePolicy.
" } }, "com.amazonaws.secretsmanager#DeleteResourcePolicyRequest": { @@ -300,7 +300,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "Specifies the secret that you want to delete the attached resource-based policy for. You\n can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", + "smithy.api#documentation": "The ARN or name of the secret to delete the attached resource-based policy for.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", "smithy.api#required": {} } } @@ -318,7 +318,7 @@ "Name": { "target": "com.amazonaws.secretsmanager#NameType", "traits": { - "smithy.api#documentation": "The friendly name of the secret that the resource-based policy was deleted for.
" + "smithy.api#documentation": "The name of the secret that the resource-based policy was deleted for.
" } } } @@ -346,7 +346,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes an entire secret and all of the versions. You can optionally include a recovery\n window during which you can restore the secret. If you don't specify a recovery window value,\n the operation defaults to 30 days. Secrets Manager attaches a DeletionDate stamp to\n the secret that specifies the end of the recovery window. At the end of the recovery window,\n Secrets Manager deletes the secret permanently.
At any time before recovery window ends, you can use RestoreSecret to\n remove the DeletionDate and cancel the deletion of the secret.
You cannot access the encrypted secret information in any secret scheduled for deletion.\n If you need to access that information, you must cancel the deletion with RestoreSecret and then retrieve the information.
\nThere is no explicit operation to delete a version of a secret. Instead, remove all\n staging labels from the VersionStage field of a version. That marks the\n version as deprecated and allows Secrets Manager to delete it as needed. Versions without any\n staging labels do not show up in ListSecretVersionIds unless you\n specify IncludeDeprecated.
The permanent secret deletion at the end of the waiting period is performed as a\n background task with low priority. There is no guarantee of a specific time after the\n recovery window for the actual delete operation to occur.
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\nsecretsmanager:DeleteSecret
\n\n Related operations\n
\nTo create a secret, use CreateSecret.
\nTo cancel deletion of a version of a secret before the recovery window has expired,\n use RestoreSecret.
\nDeletes a secret and all of its versions. You can specify a recovery\n window during which you can restore the secret. The minimum recovery window is 7 days. \n The default recovery window is 30 days. Secrets Manager attaches a DeletionDate stamp to\n the secret that specifies the end of the recovery window. At the end of the recovery window,\n Secrets Manager deletes the secret permanently.
For information about deleting a secret in the console, see https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_delete-secret.html.
\nSecrets Manager performs the permanent secret deletion at the end of the waiting period as a\n background task with low priority. There is no guarantee of a specific time after the\n recovery window for the permanent delete to occur.
\nAt any time before recovery window ends, you can use RestoreSecret to\n remove the DeletionDate and cancel the deletion of the secret.
In a secret scheduled for deletion, you cannot access the encrypted secret value.\n To access that information, first cancel the deletion with RestoreSecret and then retrieve the information.
" } }, "com.amazonaws.secretsmanager#DeleteSecretRequest": { @@ -355,7 +355,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "Specifies the secret to delete. You can specify either the Amazon Resource Name (ARN) or\n the friendly name of the secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", + "smithy.api#documentation": "The ARN or name of the secret to delete.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", "smithy.api#required": {} } }, @@ -363,14 +363,14 @@ "target": "com.amazonaws.secretsmanager#RecoveryWindowInDaysType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "(Optional) Specifies the number of days that Secrets Manager waits before Secrets Manager can delete the\n secret. You can't use both this parameter and the ForceDeleteWithoutRecovery\n parameter in the same API call.
This value can range from 7 to 30 days with a default value of 30.
" + "smithy.api#documentation": "The number of days from 7 to 30 that Secrets Manager waits before permanently deleting the\n secret. You can't use both this parameter and ForceDeleteWithoutRecovery\n in the same call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.
(Optional) Specifies that the secret is to be deleted without any recovery window. You\n can't use both this parameter and the RecoveryWindowInDays parameter in the same\n API call.
An asynchronous background process performs the actual deletion, so there can be a short\n delay before the operation completes. If you write code to delete and then immediately\n recreate a secret with the same name, ensure that your code includes appropriate back off and\n retry logic.
\nUse this parameter with caution. This parameter causes the operation to skip the normal\n waiting period before the permanent deletion that Amazon Web Services would normally impose with the\n RecoveryWindowInDays parameter. If you delete a secret with the\n ForceDeleteWithouRecovery parameter, then you have no opportunity to recover\n the secret. You lose the secret permanently.
If you use this parameter and include a previously deleted or nonexistent secret, the\n operation does not return the error ResourceNotFoundException in order to\n correctly handle retries.
Specifies whether to delete the secret without any recovery window. You\n can't use both this parameter and RecoveryWindowInDays in the same\n call. If you don't use either, then Secrets Manager defaults to a 30 day recovery window.
Secrets Manager performs the actual deletion with an asynchronous background process, so there might \n be a short delay before the secret is permanently deleted. If you delete a secret and then \n immediately create a secret with the same name, use appropriate back off and retry logic.
\nUse this parameter with caution. This parameter causes the operation to skip the normal\n recovery window before the permanent deletion that Secrets Manager would normally impose with the\n RecoveryWindowInDays parameter. If you delete a secret with the\n ForceDeleteWithouRecovery parameter, then you have no opportunity to recover\n the secret. You lose the secret permanently.
The ARN of the secret that is now scheduled for deletion.
" + "smithy.api#documentation": "The ARN of the secret.
" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "The friendly name of the secret currently scheduled for deletion.
" + "smithy.api#documentation": "The name of the secret.
" } }, "DeletionDate": { "target": "com.amazonaws.secretsmanager#DeletionDateType", "traits": { - "smithy.api#documentation": "The date and time after which this secret can be deleted by Secrets Manager and can no longer be\n restored. This value is the date and time of the delete request plus the number of days\n specified in RecoveryWindowInDays.
The date and time after which this secret Secrets Manager can permanently delete this secret, \n and it can no longer be restored. This value is the date and time of the delete request \n plus the number of days in RecoveryWindowInDays.
Retrieves the details of a secret. It does not include the encrypted fields. Secrets\n Manager only returns fields populated with a value in the response.
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\nsecretsmanager:DescribeSecret
\n\n Related operations\n
\nTo create a secret, use CreateSecret.
\nTo modify a secret, use UpdateSecret.
\nTo retrieve the encrypted secret information in a version of the secret, use GetSecretValue.
\nTo list all of the secrets in the Amazon Web Services account, use ListSecrets.
\nRetrieves the details of a secret. It does not include the encrypted secret value. Secrets Manager\n only returns fields that have a value in the response.
" } }, "com.amazonaws.secretsmanager#DescribeSecretRequest": { @@ -433,7 +433,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "The identifier of the secret whose details you want to retrieve. You can specify either\n the Amazon Resource Name (ARN) or the friendly name of the secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", + "smithy.api#documentation": "The ARN or name of the secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", "smithy.api#required": {} } } @@ -451,44 +451,44 @@ "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "The user-provided friendly name of the secret.
" + "smithy.api#documentation": "The name of the secret.
" } }, "Description": { "target": "com.amazonaws.secretsmanager#DescriptionType", "traits": { - "smithy.api#documentation": "The user-provided description of the secret.
" + "smithy.api#documentation": "The description of the secret.
" } }, "KmsKeyId": { "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { - "smithy.api#documentation": "The ARN or alias of the Amazon Web Services KMS customer master key (CMK) that's used to encrypt the\n SecretString or SecretBinary fields in each version of the secret.\n If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the\n default Amazon Web Services KMS CMK (the one named awssecretsmanager) for this account.
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with \n the Amazon Web Services managed key aws/secretsmanager, this field is omitted.
Specifies whether automatic rotation is enabled for this secret.
\nTo enable rotation, use RotateSecret with\n AutomaticallyRotateAfterDays set to a value greater than 0. To disable\n rotation, use CancelRotateSecret.
Specifies whether automatic rotation is turned on for this secret.
\nTo turn on rotation, use RotateSecret. To turn off\n rotation, use CancelRotateSecret.
" } }, "RotationLambdaARN": { "target": "com.amazonaws.secretsmanager#RotationLambdaARNType", "traits": { - "smithy.api#documentation": "The ARN of a Lambda function that's invoked by Secrets Manager to rotate the\n secret either automatically per the schedule or manually by a call to\n RotateSecret.
The ARN of the Lambda function that Secrets Manager invokes to rotate the\n secret.
" } }, "RotationRules": { "target": "com.amazonaws.secretsmanager#RotationRulesType", "traits": { - "smithy.api#documentation": "A structure with the rotation configuration for this secret. This field is only populated \n if rotation is configured.
" + "smithy.api#documentation": "The rotation schedule and Lambda function for this secret. If the secret previously had rotation turned on, but \n it is now turned off, this field shows the previous rotation schedule and rotation function. If the secret never had \n rotation turned on, this field is omitted.
" } }, "LastRotatedDate": { "target": "com.amazonaws.secretsmanager#LastRotatedDateType", "traits": { - "smithy.api#documentation": "The last date and time that the rotation process for this secret was invoked.
\nThe most recent date and time that the Secrets Manager rotation process successfully\n completed. If the secret doesn't rotate, Secrets Manager returns a null value.
" + "smithy.api#documentation": "The last date and time that Secrets Manager rotated the secret. \n If the secret isn't configured for rotation, Secrets Manager returns null.
" } }, "LastChangedDate": { @@ -500,49 +500,49 @@ "LastAccessedDate": { "target": "com.amazonaws.secretsmanager#LastAccessedDateType", "traits": { - "smithy.api#documentation": "The last date that this secret was accessed. This value is truncated to midnight of the\n date and therefore shows only the date, not the time.
" + "smithy.api#documentation": "The last date that the secret value was retrieved. This value does not include the time. This field is omitted if the secret has never been retrieved.
" } }, "DeletedDate": { "target": "com.amazonaws.secretsmanager#DeletedDateType", "traits": { - "smithy.api#documentation": "This value exists if the secret is scheduled for deletion. Some time after the specified\n date and time, Secrets Manager deletes the secret and all of its versions.
\nIf a secret is scheduled for deletion, then its details, including the encrypted secret\n information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.
" + "smithy.api#documentation": "The date the secret is scheduled for deletion. If it is not scheduled for deletion, this \n field is omitted. When you delete a secret, Secrets Manager requires a \n recovery window of at least 7 days before deleting the secret. Some time after the deleted date, \n Secrets Manager deletes the secret, including all of its versions.
\nIf a secret is scheduled for deletion, then its details, including the encrypted secret\n value, is not accessible. To cancel a scheduled deletion and restore access to the secret, use RestoreSecret.
" } }, "Tags": { "target": "com.amazonaws.secretsmanager#TagListType", "traits": { - "smithy.api#documentation": "The list of user-defined tags that are associated with the secret. To add tags to a\n secret, use TagResource. To remove tags, use UntagResource.
" + "smithy.api#documentation": "The list of tags attached to the secret. To add tags to a\n secret, use TagResource. To remove tags, use UntagResource.
" } }, "VersionIdsToStages": { "target": "com.amazonaws.secretsmanager#SecretVersionsToStagesMapType", "traits": { - "smithy.api#documentation": "A list of all of the currently assigned VersionStage staging labels and the\n VersionId that each is attached to. Staging labels are used to keep track of\n the different versions during the rotation process.
A version that does not have any staging labels attached is considered deprecated and\n subject to deletion. Such versions are not included in this list.
\nA list of the versions of the secret that have staging labels attached.\n Versions that don't have staging labels are considered deprecated and Secrets Manager \n can delete them.
\nSecrets Manager uses staging labels to indicate the status of a secret version during rotation. The three \n staging labels for rotation are:
\n\n AWSCURRENT, which indicates the current version of the secret.
\n AWSPENDING, which indicates the version of the secret that contains new \n secret information that will become the next current version when rotation finishes.
During \n rotation, Secrets Manager creates an AWSPENDING version ID before creating the new secret version. \n To check if a secret version exists, call GetSecretValue.
\n AWSPREVIOUS, which indicates the previous current version of the secret. \n You can use this as the last known good version.
For more information about rotation and staging labels, see How rotation works.
" } }, "OwningService": { "target": "com.amazonaws.secretsmanager#OwningServiceType", "traits": { - "smithy.api#documentation": "Returns the name of the service that created this secret.
" + "smithy.api#documentation": "The name of the service that created this secret.
" } }, "CreatedDate": { "target": "com.amazonaws.secretsmanager#TimestampType", "traits": { - "smithy.api#documentation": "The date you created the secret.
" + "smithy.api#documentation": "The date the secret was created.
" } }, "PrimaryRegion": { "target": "com.amazonaws.secretsmanager#RegionType", "traits": { - "smithy.api#documentation": "Specifies the primary region for secret replication.
" + "smithy.api#documentation": "The Region the secret is in. If a secret is replicated to other Regions, the replicas are listed in ReplicationStatus.
Describes a list of replication status objects as InProgress, Failed or InSync.P\n
A list of the replicas of this secret and their status:
\n\n Failed, which indicates that the replica was not created.
\n InProgress, which indicates that Secrets Manager is in the process of creating the replica.
\n InSync, which indicates that the replica was created.
Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the\n customer master key (CMK) is available, enabled, and not in an invalid state. For more\n information, see How Key State Affects Use of a\n Customer Master Key.
", + "smithy.api#documentation": "Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the\n KMS key is available, enabled, and not in an invalid state. For more\n information, see Key state: Effect on your KMS key.
", "smithy.api#error": "client" } }, @@ -598,18 +598,18 @@ "Key": { "target": "com.amazonaws.secretsmanager#FilterNameStringType", "traits": { - "smithy.api#documentation": "Filters your list of secrets by a specific key.
" + "smithy.api#documentation": "The following are keys you can use:
\n\n description: Prefix match, not case-sensitive.
\n\n name: Prefix match, case-sensitive.
\n\n tag-key: Prefix match, case-sensitive.
\n\n tag-value: Prefix match, case-sensitive.
\n\n primary-region: Prefix match, case-sensitive.
\n\n all: Breaks the filter value string into words and then searches all attributes for matches. Not case-sensitive.
\nFilters your list of secrets by a specific value.
\nYou can prefix your search value with an exclamation mark (!) in order to perform negation filters.
The keyword to filter for.
\nYou can prefix your search value with an exclamation mark (!) in order to perform negation filters.
Allows you to add filters when you use the search function in Secrets Manager.
" + "smithy.api#documentation": "Allows you to add filters when you use the search function in Secrets Manager. For more information, see Find secrets in Secrets Manager.
" } }, "com.amazonaws.secretsmanager#FilterNameStringType": { @@ -697,7 +697,7 @@ } ], "traits": { - "smithy.api#documentation": "Generates a random password of the specified complexity. This operation is intended for\n use in the Lambda rotation function. Per best practice, we recommend that you specify the\n maximum length and include every character type that the system you are generating a password\n for can support.
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\nsecretsmanager:GetRandomPassword
\nGenerates a random password. We recommend that you specify the\n maximum length and include every character type that the system you are generating a password\n for can support.
" } }, "com.amazonaws.secretsmanager#GetRandomPasswordRequest": { @@ -707,55 +707,55 @@ "target": "com.amazonaws.secretsmanager#PasswordLengthType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "The desired length of the generated password. The default value if you do not include this\n parameter is 32 characters.
" + "smithy.api#documentation": "The length of the password. If you don't include this parameter, the \n default length is 32 characters.
" } }, "ExcludeCharacters": { "target": "com.amazonaws.secretsmanager#ExcludeCharactersType", "traits": { - "smithy.api#documentation": "A string that includes characters that should not be included in the generated password.\n The default is that all characters from the included sets can be used.
" + "smithy.api#documentation": "A string of the characters that you don't want in the password.
" } }, "ExcludeNumbers": { "target": "com.amazonaws.secretsmanager#ExcludeNumbersType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "Specifies that the generated password should not include digits. The default if you do not\n include this switch parameter is that digits can be included.
" + "smithy.api#documentation": "Specifies whether to exclude numbers from the password. If you don't \n include this switch, the password can contain numbers.
" } }, "ExcludePunctuation": { "target": "com.amazonaws.secretsmanager#ExcludePunctuationType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "Specifies that the generated password should not include punctuation characters. The\n default if you do not include this switch parameter is that punctuation characters can be\n included.
\nThe following are the punctuation characters that can be included in\n the generated password if you don't explicitly exclude them with\n ExcludeCharacters or ExcludePunctuation:
\n ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | }\n ~\n
Specifies whether to exclude the following punctuation characters from the password: \n ! \" # $ % & ' ( ) * + , - . / : ; < = > ? @ [ \\ ] ^ _ ` { | } ~. \n If you don't include this switch, the password can contain punctuation.
Specifies that the generated password should not include uppercase letters. The default if\n you do not include this switch parameter is that uppercase letters can be included.
" + "smithy.api#documentation": "Specifies whether to exclude uppercase letters from the password. If you \n don't include this switch, the password can contain uppercase letters.
" } }, "ExcludeLowercase": { "target": "com.amazonaws.secretsmanager#ExcludeLowercaseType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "Specifies that the generated password should not include lowercase letters. The default if\n you do not include this switch parameter is that lowercase letters can be included.
" + "smithy.api#documentation": "Specifies whether to exclude lowercase letters from the password. If\n you don't include this switch, the password can contain lowercase letters.
" } }, "IncludeSpace": { "target": "com.amazonaws.secretsmanager#IncludeSpaceType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "Specifies that the generated password can include the space character. The default if you\n do not include this switch parameter is that the space character is not included.
" + "smithy.api#documentation": "Specifies whether to include the space character. If you \n include this switch, the password can contain space characters.
" } }, "RequireEachIncludedType": { "target": "com.amazonaws.secretsmanager#RequireEachIncludedTypeType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "A boolean value that specifies whether the generated password must include at least one of\n every allowed character type. The default value is True and the operation\n requires at least one of every character type.
Specifies whether to include at least one upper and lowercase letter, one number, and one punctuation. \n If you don't include this switch, the password contains at least one of every character type.
" } } } @@ -766,7 +766,7 @@ "RandomPassword": { "target": "com.amazonaws.secretsmanager#RandomPasswordType", "traits": { - "smithy.api#documentation": "A string with the generated password.
" + "smithy.api#documentation": "A string with the password.
" } } } @@ -794,7 +794,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the JSON text of the resource-based policy document attached to the specified\n secret. The JSON request string input and response output displays formatted code\n with white space and line breaks for better readability. Submit your input as a single line \n JSON string.
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\nsecretsmanager:GetResourcePolicy
\n\n Related operations\n
\nTo attach a resource policy to a secret, use PutResourcePolicy.
\nTo delete the resource-based policy attached to a secret, use DeleteResourcePolicy.
\nTo list all of the currently available secrets, use ListSecrets.
\nRetrieves the JSON text of the resource-based policy document attached to the\n secret. For more information about permissions policies attached to a secret, see \n Permissions \n policies attached to a secret.
" } }, "com.amazonaws.secretsmanager#GetResourcePolicyRequest": { @@ -803,7 +803,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "Specifies the secret that you want to retrieve the attached resource-based policy for. You\n can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", + "smithy.api#documentation": "The ARN or name of the secret to retrieve the attached resource-based policy for.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", "smithy.api#required": {} } } @@ -821,13 +821,13 @@ "Name": { "target": "com.amazonaws.secretsmanager#NameType", "traits": { - "smithy.api#documentation": "The friendly name of the secret that the resource-based policy was retrieved for.
" + "smithy.api#documentation": "The name of the secret that the resource-based policy was retrieved for.
" } }, "ResourcePolicy": { "target": "com.amazonaws.secretsmanager#NonEmptyResourcePolicyType", "traits": { - "smithy.api#documentation": "A JSON-formatted string that describes the permissions that are associated with the\n attached secret. These permissions are combined with any permissions that are associated with\n the user or role that attempts to access this secret. The combined permissions specify who can\n access the secret and what actions they can perform. For more information, see Authentication and Access Control for\n Amazon Web Services Secrets Manager in the Amazon Web Services Secrets Manager User Guide.
" + "smithy.api#documentation": "A JSON-formatted string that contains the permissions policy \n attached to the secret. For more information about permissions policies, see Authentication and access control for\n Secrets Manager.
" } } } @@ -858,7 +858,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the contents of the encrypted fields SecretString or\n SecretBinary from the specified version of a secret, whichever contains\n content.
\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\nsecretsmanager:GetSecretValue
\nkms:Decrypt - required only if you use a customer-managed Amazon Web Services KMS key to encrypt the\n secret. You do not need this permission to use the account's default Amazon Web Services managed CMK for\n Secrets Manager.
\n\n Related operations\n
\nTo create a new version of the secret with different encrypted information, use PutSecretValue.
\nTo retrieve the non-encrypted details for the secret, use DescribeSecret.
\nRetrieves the contents of the encrypted fields SecretString or\n SecretBinary from the specified version of a secret, whichever contains\n content.
For information about retrieving the secret value in the console, see Retrieve secrets.
\nTo run this command, you must have secretsmanager:GetSecretValue permissions. \n If the secret is encrypted using a customer-managed key instead of the Amazon Web Services managed key \n aws/secretsmanager, then you also need kms:Decrypt permissions for that key.
Specifies the secret containing the version that you want to retrieve. You can specify\n either the Amazon Resource Name (ARN) or the friendly name of the secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", + "smithy.api#documentation": "The ARN or name of the secret to retrieve.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", "smithy.api#required": {} } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { - "smithy.api#documentation": "Specifies the unique identifier of the version of the secret that you want to retrieve. If\n you specify both this parameter and VersionStage, the two parameters must refer\n to the same secret version. If you don't specify either a VersionStage or\n VersionId then the default is to perform the operation on the version with the\n VersionStage value of AWSCURRENT.
This value is typically a UUID-type value with\n 32 hexadecimal digits.
" + "smithy.api#documentation": "The unique identifier of the version of the secret to retrieve. If\n you include both this parameter and VersionStage, the two parameters must refer\n to the same secret version. If you don't specify either a VersionStage or\n VersionId, then Secrets Manager returns the AWSCURRENT version.
This value is typically a UUID-type value with\n 32 hexadecimal digits.
" } }, "VersionStage": { "target": "com.amazonaws.secretsmanager#SecretVersionStageType", "traits": { - "smithy.api#documentation": "Specifies the secret version that you want to retrieve by the staging label attached to\n the version.
\nStaging labels are used to keep track of different versions during the rotation process.\n If you specify both this parameter and VersionId, the two parameters must refer\n to the same secret version . If you don't specify either a VersionStage or\n VersionId, then the default is to perform the operation on the version with the\n VersionStage value of AWSCURRENT.
The staging label of the version of the secret to retrieve.
\nSecrets Manager uses staging labels to keep track of different versions during the rotation process.\n If you include both this parameter and VersionId, the two parameters must refer\n to the same secret version. If you don't specify either a VersionStage or\n VersionId, Secrets Manager returns the AWSCURRENT version.
The decrypted part of the protected secret information that was originally provided as\n binary data in the form of a byte array. The response parameter represents the binary data as\n a base64-encoded\n string.
\nThis parameter is not used if the secret is created by the Secrets Manager console.
\nIf you store custom information in this field of the secret, then you must code your\n Lambda rotation function to parse and interpret whatever you store in the\n SecretString or SecretBinary fields.
The decrypted secret value, if the secret value was originally provided as\n binary data in the form of a byte array. The response parameter represents the binary data as\n a base64-encoded\n string.
\nIf the secret was created by using the Secrets Manager console, or if the secret value was \n originally provided as a string, then this field is omitted. The secret value appears in \n SecretString instead.
The decrypted part of the protected secret information that was originally provided as a\n string.
\nIf you create this secret by using the Secrets Manager console then only the\n SecretString parameter contains data. Secrets Manager stores the information as a\n JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret,\n UpdateSecret, or PutSecretValue API operations instead\n of the Secrets Manager console, or by using the Other secret type in\n the console, then you must code your Lambda rotation function to parse and interpret those\n values.
" + "smithy.api#documentation": "The decrypted secret value, if the secret value was originally provided as a string or \n through the Secrets Manager console.
\nIf this secret was created by using the console, then Secrets Manager stores the information as a\n JSON structure of key/value pairs.
" } }, "VersionStages": { @@ -927,7 +927,7 @@ "CreatedDate": { "target": "com.amazonaws.secretsmanager#CreatedDateType", "traits": { - "smithy.api#documentation": "The date and time that this version of the secret was created.
" + "smithy.api#documentation": "The date and time that this version of the secret was created. If you don't specify \n which version in VersionId or VersionStage, then Secrets Manager uses the \n AWSCURRENT version.
You provided an invalid NextToken value.
The NextToken value is invalid.
You provided an invalid value for a parameter.
", + "smithy.api#documentation": "The parameter name is invalid value.
", "smithy.api#error": "client" } }, @@ -979,7 +979,7 @@ } }, "traits": { - "smithy.api#documentation": "You provided a parameter value that is not valid for the current state of the\n resource.
\nPossible causes:
\nYou tried to perform the operation on a secret that's currently marked deleted.
\nYou tried to enable rotation on a secret that doesn't already have a Lambda function\n ARN configured and you didn't include such an ARN as a parameter in this call.
\nA parameter value is not valid for the current state of the\n resource.
\nPossible causes:
\nThe secret is scheduled for deletion.
\nYou tried to enable rotation on a secret that doesn't already have a Lambda function\n ARN configured and you didn't include such an ARN as a parameter in this call.
\nThe request failed because it would exceed one of the Secrets Manager internal limits.
", + "smithy.api#documentation": "The request failed because it would exceed one of the Secrets Manager quotas.
", "smithy.api#error": "client" } }, @@ -1042,7 +1042,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all of the versions attached to the specified secret. The output does not include\n the SecretString or SecretBinary fields. By default, the list\n includes only versions that have at least one staging label in VersionStage\n attached.
Always check the NextToken response parameter \n when calling any of the List* operations. These operations can occasionally return \n an empty or shorter than expected list of results even when there more results become available. \n When this happens, the NextToken response parameter contains a value to pass to the \n next call to the same API to request the next part of the list.
\n Minimum\n permissions\n
\nTo run this command, you must have the following permissions:
\nsecretsmanager:ListSecretVersionIds
\n\n Related operations\n
\nTo list the secrets in an account, use ListSecrets.
\nLists the versions for a secret.
\nTo list the secrets in the account, use ListSecrets.
\nTo get the secret value from SecretString or SecretBinary, \n call GetSecretValue.
\n Minimum\n permissions\n
\nTo run this command, you must have secretsmanager:ListSecretVersionIds permissions.
The identifier for the secret containing the versions you want to list. You can specify\n either the Amazon Resource Name (ARN) or the friendly name of the secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", + "smithy.api#documentation": "The ARN or name of the secret whose versions you want to list.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", "smithy.api#required": {} } }, @@ -1064,20 +1064,20 @@ "target": "com.amazonaws.secretsmanager#MaxResultsType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "(Optional) Limits the number of results you want to include in \n the response. If you don't include this parameter, it defaults to a value that's \n specific to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (isn't null). Include\n that value as the NextToken request parameter in the next call to the operation to \n get the next part of the results. Note that Secrets Manager might return fewer results than the maximum \n even when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.
The number of results to include in the response.
\nIf there are more results available, in the response, Secrets Manager includes NextToken. \n To get the next results, call ListSecretVersionIds again with the value from NextToken.
(Optional) Use this parameter in a request if you receive a \n NextToken response in a previous request indicating there's more\n output available. In a subsequent call, set it to the value of the previous call \n NextToken response to indicate where the output should continue from.
A token that indicates where the output should continue from, if a previous call \n did not show all results. To get the next results, call ListSecretVersionIds again with \n this value.
(Optional) Specifies that you want the results to include versions that do not have any\n staging labels attached to them. Such versions are considered deprecated and are subject to\n deletion by Secrets Manager as needed.
" + "smithy.api#documentation": "Specifies whether to include versions of secrets that don't have any\n staging labels attached to them. Versions without staging labels are considered deprecated and are subject to\n deletion by Secrets Manager.
" } } } @@ -1088,25 +1088,25 @@ "Versions": { "target": "com.amazonaws.secretsmanager#SecretVersionsListType", "traits": { - "smithy.api#documentation": "The list of the currently available versions of the specified secret.
" + "smithy.api#documentation": "A list of the versions of the secret.
" } }, "NextToken": { "target": "com.amazonaws.secretsmanager#NextTokenType", "traits": { - "smithy.api#documentation": "If present in the response, this value indicates that \n there's more output available than included in the current response. This can \n occur even when the response includes no values at all, such as when you ask for a filtered view \n of a very long list. Use this value in the NextToken request parameter in a \n subsequent call to the operation to continue processing and get the next part of the output. You \n should repeat this until the NextToken response element comes back empty (as \n null).
Secrets Manager includes this value if there's more output available than what is included \n in the current response. This can occur even when the response includes no values at all, \n such as when you ask for a filtered view of a long list. To get the next results, \n call ListSecretVersionIds again with this value.
The Amazon Resource Name (ARN) for the secret.
\nSecrets Manager automatically adds several random characters to the name at the end of the ARN when\n you initially create a secret. This affects only the ARN and not the actual friendly name. \n This ensures that if you create a new secret with the same name as an old secret that you \n previously deleted, then users with access to the old secret don't \n automatically get access to the new secret because the ARNs are different.
\nThe ARN of the secret.
" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "The friendly name of the secret.
" + "smithy.api#documentation": "The name of the secret.
" } } } @@ -1131,7 +1131,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists all of the secrets that are stored by Secrets Manager in the Amazon Web Services account. To list the\n versions currently stored for a specific secret, use ListSecretVersionIds.\n The encrypted fields SecretString and SecretBinary are not included\n in the output. To get that information, call the GetSecretValue\n operation.
Always check the NextToken response parameter \n when calling any of the List* operations. These operations can occasionally return \n an empty or shorter than expected list of results even when there more results become available. \n When this happens, the NextToken response parameter contains a value to pass to the \n next call to the same API to request the next part of the list.
\n Minimum\n permissions\n
\nTo run this command, you must have the following permissions:
\nsecretsmanager:ListSecrets
\n\n Related operations\n
\nTo list the versions attached to a secret, use ListSecretVersionIds.
\nLists the secrets that are stored by Secrets Manager in the Amazon Web Services account.
\nTo list the versions of a secret, use ListSecretVersionIds.
\nTo get the secret value from SecretString or SecretBinary, \n call GetSecretValue.
For information about finding secrets in the console, see Enhanced search capabilities \n for secrets in Secrets Manager.
\n\n Minimum\n permissions\n
\nTo run this command, you must have secretsmanager:ListSecrets permissions.
(Optional) Limits the number of results you want to include in \n the response. If you don't include this parameter, it defaults to a value that's \n specific to the operation. If additional items exist beyond the maximum you specify, the \n NextToken response element is present and has a value (isn't null). Include\n that value as the NextToken request parameter in the next call to the operation to \n get the next part of the results. Note that Secrets Manager might return fewer results than the maximum \n even when there are more results available. You should check NextToken after every \n operation to ensure that you receive all of the results.
The number of results to include in the response.
\nIf there are more results available, in the response, Secrets Manager includes NextToken. \n To get the next results, call ListSecrets again with the value from \n NextToken.
(Optional) Use this parameter in a request if you receive a \n NextToken response in a previous request indicating there's more\n output available. In a subsequent call, set it to the value of the previous call \n NextToken response to indicate where the output should continue from.
A token that indicates where the output should continue from, if a \n previous call did not show all results. To get the next results, call ListSecrets again \n with this value.
Lists the secret request filters.
" + "smithy.api#documentation": "The filters to apply to the list of secrets.
" } }, "SortOrder": { @@ -1181,7 +1181,7 @@ "NextToken": { "target": "com.amazonaws.secretsmanager#NextTokenType", "traits": { - "smithy.api#documentation": "If present in the response, this value indicates that \n there's more output available than included in the current response. This can \n occur even when the response includes no values at all, such as when you ask for a filtered view \n of a very long list. Use this value in the NextToken request parameter in a \n subsequent call to the operation to continue processing and get the next part of the output. You \n should repeat this until the NextToken response element comes back empty (as \n null).
Secrets Manager includes this value if \n there's more output available than what is included in the current response. This can \n occur even when the response includes no values at all, such as when you ask for a filtered view \n of a long list. To get the next results, call ListSecrets again \n with this value.
You provided a resource-based policy with syntax errors.
", + "smithy.api#documentation": "The resource policy has syntax errors.
", "smithy.api#error": "client" } }, @@ -1272,7 +1272,7 @@ } }, "traits": { - "smithy.api#documentation": "The BlockPublicPolicy parameter is set to true and the resource policy did not prevent broad access to the secret.
", + "smithy.api#documentation": "The BlockPublicPolicy parameter is set to true, and the resource policy did not prevent broad access to the secret.
Attaches the contents of the specified resource-based permission policy to a secret. A\n resource-based policy is optional. Alternatively, you can use IAM identity-based policies\n that specify the secret's Amazon Resource Name (ARN) in the policy statement's\n Resources element. You can also use a combination of both identity-based and\n resource-based policies. The affected users and roles receive the permissions that are\n permitted by all of the relevant policies. For more information, see Using Resource-Based\n Policies for Amazon Web Services Secrets Manager. For the complete description of the Amazon Web Services policy syntax and\n grammar, see IAM JSON\n Policy Reference in the IAM User Guide.
\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\nsecretsmanager:PutResourcePolicy
\n\n Related operations\n
\nTo retrieve the resource policy attached to a secret, use GetResourcePolicy.
\nTo delete the resource-based policy attached to a secret, use DeleteResourcePolicy.
\nTo list all of the currently available secrets, use ListSecrets.
\nAttaches a resource-based permission policy to a secret. A resource-based policy is \n optional. For more information, see Authentication and access control for Secrets Manager\n
\nFor information about attaching a policy in the console, see Attach a \n permissions policy to a secret.
" } }, "com.amazonaws.secretsmanager#PutResourcePolicyRequest": { @@ -1314,14 +1314,14 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "Specifies the secret that you want to attach the resource-based policy. You can specify\n either the ARN or the friendly name of the secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", + "smithy.api#documentation": "The ARN or name of the secret to attach the resource-based policy.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", "smithy.api#required": {} } }, "ResourcePolicy": { "target": "com.amazonaws.secretsmanager#NonEmptyResourcePolicyType", "traits": { - "smithy.api#documentation": "A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services\n resource-based policy. The policy in the string identifies who can access or manage this\n secret and its versions. For information on how to format a JSON parameter for the various\n command line tool environments, see Using\n JSON for Parameters in the CLI User Guide.
", + "smithy.api#documentation": "A JSON-formatted string for an Amazon Web Services\n resource-based policy. For example policies, see Permissions \n policy examples.
", "smithy.api#required": {} } }, @@ -1329,7 +1329,7 @@ "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "(Optional) If you set the parameter, BlockPublicPolicy to true, then you\n block resource-based policies that allow broad access to the secret.
Specifies whether to block resource-based policies that allow broad access to the secret. By default, Secrets Manager blocks policies that allow broad access, for example those that use a wildcard for the principal.
" } } } @@ -1340,13 +1340,13 @@ "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "The ARN of the secret retrieved by the resource-based policy.
" + "smithy.api#documentation": "The ARN of the secret.
" } }, "Name": { "target": "com.amazonaws.secretsmanager#NameType", "traits": { - "smithy.api#documentation": "The friendly name of the secret retrieved by the resource-based policy.
" + "smithy.api#documentation": "The name of the secret.
" } } } @@ -1383,7 +1383,7 @@ } ], "traits": { - "smithy.api#documentation": "Stores a new encrypted secret value in the specified secret. To do this, the operation\n creates a new version and attaches it to the secret. The version can contain a new\n SecretString value or a new SecretBinary value. You can also\n specify the staging labels that are initially attached to the new version.
We recommend you avoid calling PutSecretValue at a sustained rate of more than \n once every 10 minutes. When you update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you call PutSecretValue more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.
If this operation creates the first version for the secret then Secrets Manager\n automatically attaches the staging label AWSCURRENT to the new version.
If you do not specify a value for VersionStages then Secrets Manager automatically\n moves the staging label AWSCURRENT to this new version.
If this operation moves the staging label AWSCURRENT from another version to this\n version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to\n the version that AWSCURRENT was removed from.
This operation is idempotent. If a version with a VersionId with the same\n value as the ClientRequestToken parameter already exists and you specify the\n same secret data, the operation succeeds but does nothing. However, if the secret data is\n different, then the operation fails because you cannot modify an existing version; you can\n only create new ones.
If you call an operation to encrypt or decrypt the SecretString \n or SecretBinary for a secret in the same account as the calling user and that \n secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default \n Amazon Web Services managed customer master key (CMK) with the alias aws/secretsmanager. If this key \n doesn't already exist in your account then Secrets Manager creates it for you automatically. All\n users and roles in the same Amazon Web Services account automatically have access to use the default CMK. \n Note that if an Secrets Manager API call results in Amazon Web Services creating the account's \n Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the \n result.
If the secret resides in a different Amazon Web Services account from the credentials calling an API that \n requires encryption or decryption of the secret value then you must create and use a custom \n Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials \n from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the \n secret or when you update it by including it in the KMSKeyId. If you call an \n API that must encrypt or decrypt SecretString or SecretBinary \n using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account\n access to that other account's user or role for both the kms:GenerateDataKey and \n kms:Decrypt operations.
\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\nsecretsmanager:PutSecretValue
\nkms:GenerateDataKey - needed only if you use a customer-managed Amazon Web Services KMS key to encrypt\n the secret. You do not need this permission to use the account's default Amazon Web Services managed CMK\n for Secrets Manager.
\n\n Related operations\n
\nTo retrieve the encrypted value you store in the version of a secret, use GetSecretValue.
\nTo create a secret, use CreateSecret.
\nTo get the details for a secret, use DescribeSecret.
\nTo list the versions attached to a secret, use ListSecretVersionIds.
\nCreates a new version with a new encrypted secret value and attaches it to the secret. The \n version can contain a new SecretString value or a new SecretBinary value.
We recommend you avoid calling PutSecretValue at a sustained rate of more than \n once every 10 minutes. When you update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you call PutSecretValue more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.
You can specify the staging labels to attach to the new version in VersionStages. \n If you don't include VersionStages, then Secrets Manager automatically\n moves the staging label AWSCURRENT to this version. If this operation creates \n the first version for the secret, then Secrets Manager\n automatically attaches the staging label AWSCURRENT to it .
If this operation moves the staging label AWSCURRENT from another version to this\n version, then Secrets Manager also automatically moves the staging label AWSPREVIOUS to\n the version that AWSCURRENT was removed from.
This operation is idempotent. If a version with a VersionId with the same\n value as the ClientRequestToken parameter already exists, and you specify the\n same secret data, the operation succeeds but does nothing. However, if the secret data is\n different, then the operation fails because you can't modify an existing version; you can\n only create new ones.
Specifies the secret to which you want to add a new version. You can specify either the\n Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already\n exist.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", + "smithy.api#documentation": "The ARN or name of the secret to add a new version to.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
\nIf the secret doesn't already exist, use CreateSecret instead.
(Optional) Specifies a unique identifier for the new version of the secret.
\nIf you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can\n leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that\n in the request. If you don't use the SDK and instead generate a raw HTTP request to the\n Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself\n for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental\n creation of duplicate versions if there are failures and retries during the Lambda rotation\n function's processing. We recommend that you generate a UUID-type value to\n ensure uniqueness within the specified secret.
\nIf the ClientRequestToken value isn't already associated with a version\n of the secret then a new version of the secret is created.
If a version with this value already exists and that version's\n SecretString or SecretBinary values are the same as those in\n the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and the version of the\n SecretString and SecretBinary values are different from those\n in the request then the request fails because you cannot modify an existing secret\n version. You can only create new versions to store new secret values.
This value becomes the VersionId of the new version.
A unique identifier for the new version of the secret.
\nIf you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can\n leave this parameter empty because they generate a random UUID for you. If you don't \n use the SDK and instead generate a raw HTTP request to the\n Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself\n for new versions and include that value in the request.
This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental\n creation of duplicate versions if there are failures and retries during the Lambda rotation\n function processing. We recommend that you generate a UUID-type value to\n ensure uniqueness within the specified secret.
\nIf the ClientRequestToken value isn't already associated with a version\n of the secret then a new version of the secret is created.
If a version with this value already exists and that version's\n SecretString or SecretBinary values are the same as those in\n the request then the request is ignored. The operation is idempotent.
If a version with this value already exists and the version of the\n SecretString and SecretBinary values are different from those\n in the request, then the request fails because you can't modify a secret \n version. You can only create new versions to store new secret values.
This value becomes the VersionId of the new version.
(Optional) Specifies binary data that you want to encrypt and store in the new version of\n the secret. To use this parameter in the command-line tools, we recommend that you store your\n binary data in a file and then use the appropriate technique for your tool to pass the\n contents of the file as a parameter. Either SecretBinary or\n SecretString must have a value, but not both. They cannot both be empty.
This parameter is not accessible if the secret using the Secrets Manager console.
\n " + "smithy.api#documentation": "The binary data to encrypt and store in the new version of\n the secret. To use this parameter in the command-line tools, we recommend that you store your\n binary data in a file and then pass the\n contents of the file as a parameter.
\nYou must include SecretBinary or SecretString, but not both.
You can't access this value from the Secrets Manager console.
" } }, "SecretString": { "target": "com.amazonaws.secretsmanager#SecretStringType", "traits": { - "smithy.api#documentation": "(Optional) Specifies text data that you want to encrypt and store in this new version of\n the secret. Either SecretString or SecretBinary must have a value,\n but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the\n protected secret text in only the SecretString parameter. The Secrets Manager console\n stores the information as a JSON structure of key/value pairs that the default Lambda rotation\n function knows how to parse.
For storing multiple values, we recommend that you use a JSON text \n string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI\n in the Amazon Web Services CLI User Guide.
" + "smithy.api#documentation": "The text to encrypt and store in the new version of the secret.
\nYou must include SecretBinary or SecretString, but not both.
We recommend you create the secret string as JSON key/value pairs, as shown in the example.
" } }, "VersionStages": { "target": "com.amazonaws.secretsmanager#SecretVersionStagesType", "traits": { - "smithy.api#documentation": "(Optional) Specifies a list of staging labels that are attached to this version of the\n secret. These staging labels are used to track the versions through the rotation process by\n the Lambda rotation function.
\nA staging label must be unique to a single version of the secret. If you specify a staging\n label that's already associated with a different version of the same secret then that staging\n label is automatically removed from the other version and attached to this version.
\nIf you do not specify a value for VersionStages then Secrets Manager automatically\n moves the staging label AWSCURRENT to this new version.
A list of staging labels to attach to this version of the\n secret. Secrets Manager uses staging labels to track versions of a secret through the rotation process.
\nIf you specify a staging\n label that's already associated with a different version of the same secret, then Secrets Manager \n removes the label from the other version and attaches it to this version. \n If you specify \n AWSCURRENT, and it is already attached to another version, then Secrets Manager also \n moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.
If you don't include VersionStages, then Secrets Manager automatically\n moves the staging label AWSCURRENT to this version.
The Amazon Resource Name (ARN) for the secret for which you just created a version.
" + "smithy.api#documentation": "The ARN of the secret.
" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "The friendly name of the secret for which you just created or updated a version.
" + "smithy.api#documentation": "The name of the secret.
" } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { - "smithy.api#documentation": "The unique identifier of the version of the secret you just created or updated.
" + "smithy.api#documentation": "The unique identifier of the version of the secret.
" } }, "VersionStages": { "target": "com.amazonaws.secretsmanager#SecretVersionStagesType", "traits": { - "smithy.api#documentation": "The list of staging labels that are currently attached to this version of the secret.\n Staging labels are used to track a version as it progresses through the secret rotation\n process.
" + "smithy.api#documentation": "The list of staging labels that are currently attached to this version of the secret.\n Secrets Manager uses staging labels to track a version as it progresses through the secret rotation\n process.
" } } } @@ -1498,7 +1498,7 @@ } ], "traits": { - "smithy.api#documentation": "Remove regions from replication.
" + "smithy.api#documentation": "For a secret that is replicated to other Regions, deletes the secret replicas from the Regions you specify.
" } }, "com.amazonaws.secretsmanager#RemoveRegionsFromReplicationRequest": { @@ -1507,14 +1507,14 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "Remove a secret by SecretId from replica Regions.
The ARN or name of the secret.
", "smithy.api#required": {} } }, "RemoveReplicaRegions": { "target": "com.amazonaws.secretsmanager#RemoveReplicaRegionListType", "traits": { - "smithy.api#documentation": "Remove replication from specific Regions.
", + "smithy.api#documentation": "The Regions of the replicas to remove.
", "smithy.api#required": {} } } @@ -1526,13 +1526,13 @@ "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "The secret ARN removed from replication regions.
The ARN of the primary secret.
" } }, "ReplicationStatus": { "target": "com.amazonaws.secretsmanager#ReplicationStatusListType", "traits": { - "smithy.api#documentation": "Describes the remaining replication status after you remove regions from the replication list.
" + "smithy.api#documentation": "The status of replicas for this secret after you remove Regions.
" } } } @@ -1554,18 +1554,18 @@ "Region": { "target": "com.amazonaws.secretsmanager#RegionType", "traits": { - "smithy.api#documentation": "Describes a single instance of Region objects.
" + "smithy.api#documentation": "A Region code. For a list of Region codes, see Name and code of Regions.
" } }, "KmsKeyId": { "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { - "smithy.api#documentation": "Can be an ARN, Key ID, or Alias.
The ARN, key ID, or alias of the KMS key to encrypt the secret. If you don't include this field, Secrets Manager uses aws/secretsmanager.
(Optional) Custom type consisting of a Region (required) and the KmsKeyId which can be an ARN, Key ID, or Alias.
A custom type that specifies a Region and the KmsKeyId for a replica secret.
Converts an existing secret to a multi-Region secret and begins replication the secret to a\n list of new regions.
" + "smithy.api#documentation": "Replicates the secret to a new Regions. See Multi-Region secrets.
" } }, "com.amazonaws.secretsmanager#ReplicateSecretToRegionsRequest": { @@ -1600,21 +1600,21 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "Use the Secret Id to replicate a secret to regions.
The ARN or name of the secret to replicate.
", "smithy.api#required": {} } }, "AddReplicaRegions": { "target": "com.amazonaws.secretsmanager#AddReplicaRegionListType", "traits": { - "smithy.api#documentation": "Add Regions to replicate the secret.
", + "smithy.api#documentation": "A list of Regions in which to replicate the secret.
", "smithy.api#required": {} } }, "ForceOverwriteReplicaSecret": { "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { - "smithy.api#documentation": "(Optional) If set, Secrets Manager replication overwrites a secret with the same name in the\n destination region.
" + "smithy.api#documentation": "Specifies whether to overwrite a secret with the same name in the destination Region.
" } } } @@ -1625,13 +1625,13 @@ "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "Replicate a secret based on the ReplicaRegionType> consisting of a\n Region(required) and a KMSKeyId (optional) which can be the ARN, KeyID, or Alias.
The ARN of the primary secret.
" } }, "ReplicationStatus": { "target": "com.amazonaws.secretsmanager#ReplicationStatusListType", "traits": { - "smithy.api#documentation": "Describes the secret replication status as PENDING, SUCCESS or FAIL.
The status of replication.
" } } } @@ -1666,7 +1666,7 @@ "StatusMessage": { "target": "com.amazonaws.secretsmanager#StatusMessageType", "traits": { - "smithy.api#documentation": "Status message such as \"Secret with this name already exists in this\n region\".
" + "smithy.api#documentation": "Status message such as \"Secret with this name already exists in this\n region\".
" } }, "LastAccessedDate": { @@ -1703,7 +1703,7 @@ } }, "traits": { - "smithy.api#documentation": "We can't find the resource that you asked for.
", + "smithy.api#documentation": "Secrets Manager can't find the resource that you asked for.
", "smithy.api#error": "client" } }, @@ -1730,7 +1730,7 @@ } ], "traits": { - "smithy.api#documentation": "Cancels the scheduled deletion of a secret by removing the DeletedDate time\n stamp. This makes the secret accessible to query once again.
\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\nsecretsmanager:RestoreSecret
\n\n Related operations\n
\nTo delete a secret, use DeleteSecret.
\nCancels the scheduled deletion of a secret by removing the DeletedDate time\n stamp. You can access a secret again after it has been restored.
Specifies the secret that you want to restore from a previously scheduled deletion. You\n can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", + "smithy.api#documentation": "The ARN or name of the secret to restore.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", "smithy.api#required": {} } } @@ -1757,7 +1757,7 @@ "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "The friendly name of the secret that was restored.
" + "smithy.api#documentation": "The name of the secret that was restored.
" } } } @@ -1785,7 +1785,7 @@ } ], "traits": { - "smithy.api#documentation": "Configures and starts the asynchronous process of rotating this secret. If you include the\n configuration parameters, the operation sets those values for the secret and then immediately\n starts a rotation. If you do not include the configuration parameters, the operation starts a\n rotation with the values already stored in the secret. After the rotation completes, the\n protected service and its clients all use the new version of the secret.
\nThis required configuration information includes the ARN of an Amazon Web Services Lambda function and\n optionally, the time between scheduled rotations. The Lambda rotation function creates a new\n version of the secret and creates or updates the credentials on the protected service to\n match. After testing the new credentials, the function marks the new secret with the staging\n label AWSCURRENT so that your clients all immediately begin to use the new version. For more\n information about rotating secrets and how to configure a Lambda function to rotate the\n secrets for your protected service, see Rotating Secrets in Amazon Web Services Secrets Manager in the\n Amazon Web Services Secrets Manager User Guide.
Secrets Manager schedules the next rotation when the previous \n one completes. Secrets Manager schedules the date by adding the rotation interval (number of days) to the \n actual date of the last rotation. The service chooses the hour within that 24-hour date window \n randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour \n and influenced by a variety of factors that help distribute load.
\nThe\n rotation function must end with the versions of the secret in one of two states:
\nThe AWSPENDING and AWSCURRENT staging labels are attached to the same version of\n the secret, or
The AWSPENDING staging label is not attached to any version of the secret.
If the AWSPENDING staging label is present but not attached to the same version as\n AWSCURRENT then any later invocation of RotateSecret assumes that a previous\n rotation request is still in progress and returns an error.
\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\nsecretsmanager:RotateSecret
\nlambda:InvokeFunction (on the function specified in the secret's metadata)
\n\n Related operations\n
\nTo list the secrets in your account, use ListSecrets.
\nTo get the details for a version of a secret, use DescribeSecret.
\nTo create a new version of a secret, use CreateSecret.
\nTo attach staging labels to or remove staging labels from a version of a secret, use\n UpdateSecretVersionStage.
\nConfigures and starts the asynchronous process of rotating the secret.
\nIf you include the\n configuration parameters, the operation sets the values for the secret and then immediately\n starts a rotation. If you don't include the configuration parameters, the operation starts a\n rotation with the values already stored in the secret. For more information about rotation, \n see Rotate secrets.
\nTo configure rotation, you include the ARN of an Amazon Web Services Lambda function and the schedule \n for the rotation. The Lambda rotation function creates a new\n version of the secret and creates or updates the credentials on the database or service to\n match. After testing the new credentials, the function marks the new secret version with the staging\n label AWSCURRENT. Then anyone who retrieves the secret gets the new version. For more\n information, see How rotation works.
When rotation is successful, the AWSPENDING staging label might be attached to the same \n version as the AWSCURRENT version, or it might not be attached to any version.
If the AWSPENDING staging label is present but not attached to the same version as\n AWSCURRENT, then any later invocation of RotateSecret assumes that a previous\n rotation request is still in progress and returns an error.
To run this command, you must have secretsmanager:RotateSecret permissions and \n lambda:InvokeFunction permissions on the function specified in the secret's metadata.
Specifies the secret that you want to rotate. You can specify either the Amazon Resource\n Name (ARN) or the friendly name of the secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", + "smithy.api#documentation": "The ARN or name of the secret to rotate.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.secretsmanager#ClientRequestTokenType", "traits": { - "smithy.api#documentation": "(Optional) Specifies a unique identifier for the new version of the secret that helps\n ensure idempotency.
\nIf you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can\n leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that\n in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP\n request to the Secrets Manager service endpoint, then you must generate a\n ClientRequestToken yourself for new versions and include that value in the\n request.
You only need to specify your own value if you implement your own retry logic and want to\n ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to\n ensure uniqueness within the specified secret.
\nSecrets Manager uses this value to prevent the accidental creation of duplicate versions if\n there are failures and retries during the function's processing. This value becomes the\n VersionId of the new version.
A unique identifier for the new version of the secret that helps\n ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if\n there are failures and retries during rotation. This value becomes the\n VersionId of the new version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can\n leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that\n in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP\n request to the Secrets Manager service endpoint, then you must generate a\n ClientRequestToken yourself for new versions and include that value in the\n request.
You only need to specify this value if you implement your own retry logic and you want to\n ensure that Secrets Manager doesn't attempt to create a secret version twice. We recommend that you generate a UUID-type value to\n ensure uniqueness within the specified secret.
", "smithy.api#idempotencyToken": {} } }, "RotationLambdaARN": { "target": "com.amazonaws.secretsmanager#RotationLambdaARNType", "traits": { - "smithy.api#documentation": "(Optional) Specifies the ARN of the Lambda function that can rotate the secret.
" + "smithy.api#documentation": "The ARN of the Lambda rotation function that can rotate the secret.
" } }, "RotationRules": { @@ -1831,13 +1831,13 @@ "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "The friendly name of the secret.
" + "smithy.api#documentation": "The name of the secret.
" } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { - "smithy.api#documentation": "The ID of the new version of the secret created by the rotation started by this\n request.
" + "smithy.api#documentation": "The ID of the new version of the secret.
" } } } @@ -1861,7 +1861,7 @@ "target": "com.amazonaws.secretsmanager#AutomaticallyRotateAfterDaysType", "traits": { "smithy.api#box": {}, - "smithy.api#documentation": "Specifies the number of days between automatic scheduled rotations of the secret.
\nSecrets Manager schedules the next rotation when the previous \n one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the \n actual date of the last rotation. The service chooses the hour within that 24-hour date window \n randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour \n and influenced by a variety of factors that help distribute load.
" + "smithy.api#documentation": "Specifies the number of days between automatic scheduled rotations of the secret.
\nSecrets Manager schedules the next rotation when the previous \n one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the \n actual date of the last rotation. The service chooses the hour within that 24-hour date window \n randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour \n and influenced by a variety of factors that help distribute load.
" } } }, @@ -1903,13 +1903,13 @@ "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret.
\nFor more information about ARNs in Secrets Manager, see Policy Resources in the\n Amazon Web Services Secrets Manager User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret.
" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "The friendly name of the secret. You can use forward slashes in the name to represent a\n path hierarchy. For example, /prod/databases/dbserver1 could represent the secret\n for a server named dbserver1 in the folder databases in the folder\n prod.
The friendly name of the secret. You can use forward slashes in the name to represent a\n path hierarchy. For example, /prod/databases/dbserver1 could represent the secret\n for a server named dbserver1 in the folder databases in the folder\n prod.
The ARN or alias of the Amazon Web Services KMS customer master key (CMK) used to encrypt the\n SecretString and SecretBinary fields in each version of the\n secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with\n the default KMS CMK, the key named awssecretsmanager, for this account.
The ARN of the KMS key that Secrets Manager uses to encrypt the secret value. If the secret is encrypted with \n the Amazon Web Services managed key aws/secretsmanager, this field is omitted.
Removes the secret from replication and promotes the secret to a regional secret in the replica Region.
" + "smithy.api#documentation": "Removes the link between the replica secret and the primary secret and promotes the replica to a primary secret in the replica Region.
\nYou must call this operation from the Region in which you want to promote the replica to a primary secret.
" } }, "com.amazonaws.secretsmanager#StopReplicationToReplicaRequest": { @@ -2185,7 +2185,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "Response to StopReplicationToReplica of a secret, based on the SecretId.
The ARN of the primary secret.
", "smithy.api#required": {} } } @@ -2197,7 +2197,7 @@ "ARN": { "target": "com.amazonaws.secretsmanager#SecretARNType", "traits": { - "smithy.api#documentation": "Response StopReplicationToReplica of a secret, based on the ARN,.
The ARN of the promoted secret. The ARN is the same as the original primary secret except the Region is changed.
" } } } @@ -2263,7 +2263,7 @@ } ], "traits": { - "smithy.api#documentation": "Attaches one or more tags, each consisting of a key name and a value, to the specified\n secret. Tags are part of the secret's overall metadata, and are not associated with any\n specific version of the secret. This operation only appends tags to the existing list of tags.\n To remove tags, you must use UntagResource.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per secret—50
\nMaximum key length—127 Unicode characters in UTF-8
\nMaximum value length—255 Unicode characters in UTF-8
\nTag keys and values are case sensitive.
\nDo not use the aws: prefix in your tag names or values because Amazon Web Services reserves it\n for Amazon Web Services use. You can't edit or delete tag names or values with this \n prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources,\n remember other services might have restrictions on allowed characters. Generally\n allowed characters: letters, spaces, and numbers representable in UTF-8, plus the\n following special characters: + - = . _ : / @.
\nIf you use tags as part of your security strategy, then adding or removing a tag can\n change permissions. If successfully completing this operation would result in you losing\n your permissions for this secret, then the operation is blocked and returns an Access Denied\n error.
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\nsecretsmanager:TagResource
\n\n Related operations\n
\nTo remove one or more tags from the collection attached to a secret, use UntagResource.
\nTo view the list of tags attached to a secret, use DescribeSecret.
\nAttaches tags to a secret. Tags consist of a key name and a value. Tags are part of the \n secret's metadata. They are not associated with specific versions of the secret. This operation appends tags to the existing list of tags.
\nThe following restrictions apply to tags:
\nMaximum number of tags per secret: 50
\nMaximum key length: 127 Unicode characters in UTF-8
\nMaximum value length: 255 Unicode characters in UTF-8
\nTag keys and values are case sensitive.
\nDo not use the aws: prefix in your tag names or values because Amazon Web Services reserves it\n for Amazon Web Services use. You can't edit or delete tag names or values with this \n prefix. Tags with this prefix do not count against your tags per secret limit.
If you use your tagging schema across multiple services and resources,\n other services might have restrictions on allowed characters. Generally\n allowed characters: letters, spaces, and numbers representable in UTF-8, plus the\n following special characters: + - = . _ : / @.
\nIf you use tags as part of your security strategy, then adding or removing a tag can\n change permissions. If successfully completing this operation would result in you losing\n your permissions for this secret, then the operation is blocked and returns an Access Denied\n error.
\nThe identifier for the secret that you want to attach tags to. You can specify either the\n Amazon Resource Name (ARN) or the friendly name of the secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", + "smithy.api#documentation": "The identifier for the secret to attach tags to. You can specify either the\n Amazon Resource Name (ARN) or the friendly name of the secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.secretsmanager#TagListType", "traits": { - "smithy.api#documentation": "The tags to attach to the secret. Each element in the list consists of a Key\n and a Value.
This parameter to the API requires a JSON text string argument.
\nFor storing multiple values, we recommend that you use a JSON text \n string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI\n in the Amazon Web Services CLI User Guide.
", + "smithy.api#documentation": "The tags to attach to the secret as a JSON text string argument. Each element in the list consists of a Key\n and a Value.
For storing multiple values, we recommend that you use a JSON text \n string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI\n in the Amazon Web Services CLI User Guide.
", "smithy.api#required": {} } } @@ -2317,7 +2317,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes one or more tags from the specified secret.
\nThis operation is idempotent. If a requested tag is not attached to the secret, no error\n is returned and the secret metadata is unchanged.
\nIf you use tags as part of your security strategy, then removing a tag can change\n permissions. If successfully completing this operation would result in you losing your\n permissions for this secret, then the operation is blocked and returns an Access Denied\n error.
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\nsecretsmanager:UntagResource
\n\n Related operations\n
\nTo add one or more tags to the collection attached to a secret, use TagResource.
\nTo view the list of tags attached to a secret, use DescribeSecret.
\nRemoves specific tags from a secret.
\nThis operation is idempotent. If a requested tag is not attached to the secret, no error\n is returned and the secret metadata is unchanged.
\nIf you use tags as part of your security strategy, then removing a tag can change\n permissions. If successfully completing this operation would result in you losing your\n permissions for this secret, then the operation is blocked and returns an Access Denied\n error.
\nThe identifier for the secret that you want to remove tags from. You can specify either\n the Amazon Resource Name (ARN) or the friendly name of the secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", + "smithy.api#documentation": "The ARN or name of the secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.secretsmanager#TagKeyListType", "traits": { - "smithy.api#documentation": "A list of tag key names to remove from the secret. You don't specify the value. Both the\n key and its associated value are removed.
\nThis parameter to the API requires a JSON text string argument.
\nFor storing multiple values, we recommend that you use a JSON text \n string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI\n in the Amazon Web Services CLI User Guide.
", + "smithy.api#documentation": "A list of tag key names to remove from the secret. You don't specify the value. Both the\n key and its associated value are removed.
\nThis parameter requires a JSON text string argument.
\nFor storing multiple values, we recommend that you use a JSON text \n string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI\n in the Amazon Web Services CLI User Guide.
", "smithy.api#required": {} } } @@ -2377,7 +2377,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies many of the details of the specified secret.
\nTo change the secret value, you can also use PutSecretValue.
\nTo change the rotation configuration of a secret, use RotateSecret\n instead.
\n \nWe recommend you avoid calling UpdateSecret at a sustained rate of more than \n once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you update the secret value more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.
The Secrets Manager console uses only the SecretString parameter and therefore limits\n you to encrypting and storing only a text string. To encrypt and store binary data as part\n of the version of a secret, you must use either the Amazon Web Services CLI or one of the Amazon Web Services\n SDKs.
If a version with a VersionId with the same value as the\n ClientRequestToken parameter already exists, the operation results in an\n error. You cannot modify an existing version, you can only create a new version.
If you include SecretString or SecretBinary to create a new\n secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new\n version.
If you call an operation to encrypt or decrypt the SecretString \n or SecretBinary for a secret in the same account as the calling user and that \n secret doesn't specify a Amazon Web Services KMS encryption key, Secrets Manager uses the account's default \n Amazon Web Services managed customer master key (CMK) with the alias aws/secretsmanager. If this key \n doesn't already exist in your account then Secrets Manager creates it for you automatically. All\n users and roles in the same Amazon Web Services account automatically have access to use the default CMK. \n Note that if an Secrets Manager API call results in Amazon Web Services creating the account's \n Amazon Web Services-managed CMK, it can result in a one-time significant delay in returning the \n result.
If the secret resides in a different Amazon Web Services account from the credentials calling an API that \n requires encryption or decryption of the secret value then you must create and use a custom \n Amazon Web Services KMS CMK because you can't access the default CMK for the account using credentials \n from a different Amazon Web Services account. Store the ARN of the CMK in the secret when you create the \n secret or when you update it by including it in the KMSKeyId. If you call an \n API that must encrypt or decrypt SecretString or SecretBinary \n using credentials from a different account then the Amazon Web Services KMS key policy must grant cross-account\n access to that other account's user or role for both the kms:GenerateDataKey and \n kms:Decrypt operations.
\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\nsecretsmanager:UpdateSecret
\nkms:GenerateDataKey - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret.\n You do not need this permission to use the account's Amazon Web Services managed CMK for\n Secrets Manager.
\nkms:Decrypt - needed only if you use a custom Amazon Web Services KMS key to encrypt the secret. You do\n not need this permission to use the account's Amazon Web Services managed CMK for Secrets Manager.
\n\n Related operations\n
\nTo create a new secret, use CreateSecret.
\nTo add only a new version to an existing secret, use PutSecretValue.
\nTo get the details for a secret, use DescribeSecret.
\nTo list the versions contained in a secret, use ListSecretVersionIds.
\nModifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.
\nTo change the rotation configuration of a secret, use RotateSecret instead.
\n \nWe recommend you avoid calling UpdateSecret at a sustained rate of more than \n once every 10 minutes. When you call UpdateSecret to update the secret value, Secrets Manager creates a new version \n of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not \n remove versions created less than 24 hours ago. If you update the secret value more \n than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach \n the quota for secret versions.
If you include SecretString or SecretBinary to create a new\n secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new\n version.
If you call this operation with a VersionId that matches an existing version's \n ClientRequestToken, the operation results in an error. You can't modify an existing \n version, you can only create a new version. To remove a version, remove all staging labels from it. See \n UpdateSecretVersionStage.
If you don't specify an KMS encryption key, Secrets Manager uses the Amazon Web Services managed key \n aws/secretsmanager. If this key doesn't already exist in your account, then Secrets Manager \n creates it for you automatically. All users and roles in the Amazon Web Services account automatically have access \n to use aws/secretsmanager. Creating aws/secretsmanager can result in a one-time \n significant delay in returning the result.
If the secret is in a different Amazon Web Services account from the credentials calling the API, then you can't \n use aws/secretsmanager to encrypt the secret, and you must create and use a customer managed key.
To run this command, you must have secretsmanager:UpdateSecret permissions. If you use a \n customer managed key, you must also have kms:GenerateDataKey and kms:Decrypt permissions .
Specifies the secret that you want to modify or to which you want to add a new version.\n You can specify either the Amazon Resource Name (ARN) or the friendly name of the\n secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", + "smithy.api#documentation": "The ARN or name of the secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.secretsmanager#ClientRequestTokenType", "traits": { - "smithy.api#documentation": "(Optional) If you want to add a new version to the secret, this parameter specifies a\n unique identifier for the new version that helps ensure idempotency.
\nIf you use the Amazon Web Services CLI or one of the Amazon Web Services SDK to call this operation, then you can\n leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that\n in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager\n service endpoint, then you must generate a ClientRequestToken yourself for new\n versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic\n and want to ensure that a given secret is not created twice. We recommend that you generate a\n UUID-type\n value to ensure uniqueness within the specified secret.
\nSecrets Manager uses this value to prevent the accidental creation of duplicate versions if\n there are failures and retries during the Lambda rotation function's processing.
\nIf the ClientRequestToken value isn't already associated with a version\n of the secret then a new version of the secret is created.
If a version with this value already exists and that version's\n SecretString and SecretBinary values are the same as those in\n the request then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's\n SecretString and SecretBinary values are different from the\n request then an error occurs because you cannot modify an existing secret value.
This value becomes the VersionId of the new version.
If you include SecretString or SecretBinary, then Secrets Manager creates \n a new version for the secret, and this parameter specifies the unique identifier for the new \n version.
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can\n leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it\n as the value for this parameter in the request. If you don't use the SDK and instead\n generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a\n ClientRequestToken yourself for the new version and include the value in the\n request.
This value becomes the VersionId of the new version.
(Optional) Specifies an updated user-provided description of the secret.
" + "smithy.api#documentation": "The description of the secret.
" } }, "KmsKeyId": { "target": "com.amazonaws.secretsmanager#KmsKeyIdType", "traits": { - "smithy.api#documentation": "(Optional) Specifies an updated ARN or alias of the Amazon Web Services KMS customer master key (CMK) that Secrets Manager \n uses to encrypt the protected text in new versions of this secret as well as any existing versions of this secret that have the staging labels AWSCURRENT, AWSPENDING, or AWSPREVIOUS. For more information about staging labels, see Staging\n Labels in the Amazon Web Services Secrets Manager User Guide.
\nYou can only use the account's default CMK to encrypt and decrypt if you call this\n operation using credentials from the same account that owns the secret. If the secret is in\n a different account, then you must create a custom CMK and provide the ARN of that CMK in\n this field. The user making the call must have permissions to both the secret and the CMK in\n their respective accounts.
\nThe ARN, key ID, or alias of the KMS key that Secrets Manager \n uses to encrypt new secret versions as well as any existing versions the staging labels \n AWSCURRENT, AWSPENDING, or AWSPREVIOUS. \n For more information about versions and staging labels, see Concepts: Version.
You can only use the Amazon Web Services managed key aws/secretsmanager if you call this\n operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in\n a different account, then you must use a customer managed key and provide the ARN of that KMS key in\n this field. The user making the call must have permissions to both the secret and the KMS key in\n their respective accounts.
(Optional) Specifies updated binary data that you want to encrypt and store in the new\n version of the secret. To use this parameter in the command-line tools, we recommend that you\n store your binary data in a file and then use the appropriate technique for your tool to pass\n the contents of the file as a parameter. Either SecretBinary or\n SecretString must have a value, but not both. They cannot both be empty.
This parameter is not accessible using the Secrets Manager console.
" + "smithy.api#documentation": "The binary data to encrypt and store in the new\n version of the secret. We recommend that you\n store your binary data in a file and then pass\n the contents of the file as a parameter.
\nEither SecretBinary or\n SecretString must have a value, but not both.
You can't access this parameter in the Secrets Manager console.
" } }, "SecretString": { "target": "com.amazonaws.secretsmanager#SecretStringType", "traits": { - "smithy.api#documentation": "(Optional) Specifies updated text data that you want to encrypt and store in this new\n version of the secret. Either SecretBinary or SecretString must have\n a value, but not both. They cannot both be empty.
If you create this secret by using the Secrets Manager console then Secrets Manager puts the\n protected secret text in only the SecretString parameter. The Secrets Manager console\n stores the information as a JSON structure of key/value pairs that the default Lambda rotation\n function knows how to parse.
For storing multiple values, we recommend that you use a JSON text \n string argument and specify key/value pairs. For more information, see Specifying parameter values for the Amazon Web Services CLI\n in the Amazon Web Services CLI User Guide.
" + "smithy.api#documentation": "The text data to encrypt and store in the new\n version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
\nEither SecretBinary or SecretString must have\n a value, but not both.
The ARN of the secret that was updated.
\nSecrets Manager automatically adds several random characters to the name at the end of the ARN when\n you initially create a secret. This affects only the ARN and not the actual friendly name. \n This ensures that if you create a new secret with the same name as an old secret that you \n previously deleted, then users with access to the old secret don't \n automatically get access to the new secret because the ARNs are different.
\nThe ARN of the secret that was updated.
" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "The friendly name of the secret that was updated.
" + "smithy.api#documentation": "The name of the secret that was updated.
" } }, "VersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { - "smithy.api#documentation": "If a new version of the secret was created by this operation, then VersionId\n contains the unique identifier of the new version.
If Secrets Manager created a new version of the secret during this operation, then VersionId\n contains the unique identifier of the new version.
Modifies the staging labels attached to a version of a secret. Staging labels are used to\n track a version as it progresses through the secret rotation process. You can attach a staging\n label to only one version of a secret at a time. If a staging label to be added is already\n attached to another version, then it is moved--removed from the other version first and\n then attached to this one. For more information about staging labels, see Staging\n Labels in the Amazon Web Services Secrets Manager User Guide.
\nThe staging labels that you specify in the VersionStage parameter are added\n to the existing list of staging labels--they don't replace it.
You can move the AWSCURRENT staging label to this version by including it in this\n call.
Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS\n to the version that AWSCURRENT was removed from.
If this action results in the last label being removed from a version, then the version is\n considered to be 'deprecated' and can be deleted by Secrets Manager.
\n\n Minimum permissions\n
\nTo run this command, you must have the following permissions:
\nsecretsmanager:UpdateSecretVersionStage
\n\n Related operations\n
\nTo get the list of staging labels that are currently associated with a version of a\n secret, use \n DescribeSecret\n and examine the\n SecretVersionsToStages response value.
Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to\n track a version as it progresses through the secret rotation process. Each staging label can be \n attached to only one version at a time. To add a staging label to a version when it is already \n attached to another version, Secrets Manager first removes it from the other version first and\n then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.
\nThe staging labels that you specify in the VersionStage parameter are added\n to the existing list of staging labels for the version.
You can move the AWSCURRENT staging label to this version by including it in this\n call.
Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS\n to the version that AWSCURRENT was removed from.
If this action results in the last label being removed from a version, then the version is\n considered to be 'deprecated' and can be deleted by Secrets Manager.
" } }, "com.amazonaws.secretsmanager#UpdateSecretVersionStageRequest": { @@ -2481,7 +2481,7 @@ "SecretId": { "target": "com.amazonaws.secretsmanager#SecretIdType", "traits": { - "smithy.api#documentation": "Specifies the secret with the version with the list of staging labels you want to modify.\n You can specify either the Amazon Resource Name (ARN) or the friendly name of the\n secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", + "smithy.api#documentation": "The ARN or the name of the secret with the version and staging labelsto modify.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
", "smithy.api#required": {} } }, @@ -2495,13 +2495,13 @@ "RemoveFromVersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { - "smithy.api#documentation": "Specifies the secret version ID of the version that the staging label is to be removed\n from. If the staging label you are trying to attach to one version is already attached to a\n different version, then you must include this parameter and specify the version that the label\n is to be removed from. If the label is attached and you either do not specify this parameter,\n or the version ID does not match, then the operation fails.
" + "smithy.api#documentation": "The ID of the version that the staging label is to be removed\n from. If the staging label you are trying to attach to one version is already attached to a\n different version, then you must include this parameter and specify the version that the label\n is to be removed from. If the label is attached and you either do not specify this parameter,\n or the version ID does not match, then the operation fails.
" } }, "MoveToVersionId": { "target": "com.amazonaws.secretsmanager#SecretVersionIdType", "traits": { - "smithy.api#documentation": "(Optional) The secret version ID that you want to add the staging label. If you want to\n remove a label from a version, then do not specify this parameter.
\nIf the staging label is already attached to a different version of the secret, then you\n must also specify the RemoveFromVersionId parameter.
The ID of the version to add the staging label to. To\n remove a label from a version, then do not specify this parameter.
\nIf the staging label is already attached to a different version of the secret, then you\n must also specify the RemoveFromVersionId parameter.
The ARN of the secret with the modified staging label.
" + "smithy.api#documentation": "The ARN of the secret that was updated.
" } }, "Name": { "target": "com.amazonaws.secretsmanager#SecretNameType", "traits": { - "smithy.api#documentation": "The friendly name of the secret with the modified staging label.
" + "smithy.api#documentation": "The name of the secret that was updated.
" } } } @@ -2549,7 +2549,7 @@ } ], "traits": { - "smithy.api#documentation": "Validates that the resource policy does not grant a wide range of IAM principals access to\n your secret. The JSON request string input and response output displays formatted code\n with white space and line breaks for better readability. Submit your input as a single line \n JSON string. A resource-based policy is optional for secrets.
\nThe API performs three checks when validating the secret:
\nSends a call to Zelkova, an automated reasoning engine, to ensure your Resource Policy does not\n allow broad access to your secret.
\nChecks for correct syntax in a policy.
\nVerifies the policy does not lock out a caller.
\n\n Minimum Permissions\n
\nYou must have the permissions required to access the following APIs:
\n\n secretsmanager:PutResourcePolicy\n
\n secretsmanager:ValidateResourcePolicy\n
Validates that a resource policy does not grant a wide range of principals access to\n your secret. A resource-based policy is optional for secrets.
\nThe API performs three checks when validating the policy:
\nSends a call to Zelkova, an automated reasoning engine, to ensure your resource policy does not\n allow broad access to your secret, for example policies that use a wildcard for the principal.
\nChecks for correct syntax in a policy.
\nVerifies the policy does not lock out a caller.
\n(Optional) The identifier of the secret with the resource-based policy you want to\n validate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the\n secret.
\nFor an ARN, we recommend that you specify a complete ARN rather \n than a partial ARN.
" + "smithy.api#documentation": "This field is reserved for internal use.
" } }, "ResourcePolicy": { "target": "com.amazonaws.secretsmanager#NonEmptyResourcePolicyType", "traits": { - "smithy.api#documentation": "A JSON-formatted string constructed according to the grammar and syntax for an Amazon Web Services\n resource-based policy. The policy in the string identifies who can access or manage this\n secret and its versions. For information on how to format a JSON parameter for the various\n command line tool environments, see Using\n JSON for Parameters in the CLI User Guide.publi
", + "smithy.api#documentation": "A JSON-formatted string that contains an Amazon Web Services\n resource-based policy. The policy in the string identifies who can access or manage this\n secret and its versions. For example policies, see Permissions policy examples.
", "smithy.api#required": {} } } @@ -2576,13 +2576,13 @@ "PolicyValidationPassed": { "target": "com.amazonaws.secretsmanager#BooleanType", "traits": { - "smithy.api#documentation": "Returns a message stating that your Reource Policy passed validation.
" + "smithy.api#documentation": "True if your policy passes validation, otherwise false.
" } }, "ValidationErrors": { "target": "com.amazonaws.secretsmanager#ValidationErrorsType", "traits": { - "smithy.api#documentation": "Returns an error message if your policy doesn't pass validatation.
" + "smithy.api#documentation": "Validation errors if your policy didn't pass validation.
" } } } @@ -2615,6 +2615,21 @@ }, "com.amazonaws.secretsmanager#secretsmanager": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "Secrets Manager", + "arnNamespace": "secretsmanager", + "cloudFormationName": "SecretsManager", + "cloudTrailEventSource": "secretsmanager.amazonaws.com", + "endpointPrefix": "secretsmanager" + }, + "aws.auth#sigv4": { + "name": "secretsmanager" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.
\n \nThis guide provides descriptions of the Secrets Manager API. For more information about using this\n service, see the Amazon Web Services Secrets Manager User Guide.
\n \n\n API Version\n
\n \nThis version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.
\nAs an alternative to using the API, you can use one of the Amazon Web Services SDKs, which consist of\n libraries and sample code for various programming languages and platforms such as Java,\n Ruby, .NET, iOS, and Android. The SDKs provide a convenient way to create programmatic\n access to Amazon Web Services Secrets Manager. For example, the SDKs provide cryptographically signing requests,\n managing errors, and retrying requests automatically. For more information about the Amazon Web Services\n SDKs, including downloading and installing them, see Tools for Amazon Web Services.
\nWe recommend you use the Amazon Web Services SDKs to make programmatic API calls to Secrets Manager. However, you\n also can use the Secrets Manager HTTP Query API to make direct calls to the Secrets Manager web service. To learn\n more about the Secrets Manager HTTP Query API, see Making Query Requests in the\n Amazon Web Services Secrets Manager User Guide.
\nSecrets Manager API supports GET and POST requests for all actions, and doesn't require you to use\n GET for some actions and POST for others. However, GET requests are subject to the limitation\n size of a URL. Therefore, for operations that require larger sizes, use a POST request.
\n \n \n \n \n \n \n \n\n Support and Feedback for Amazon Web Services Secrets Manager\n
\n \nWe welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more\n information about the Amazon Web Services Discussion Forums, see Forums\n Help.
\n \n\n How examples are presented\n
\n \nThe JSON that Amazon Web Services Secrets Manager expects as your request parameters and the service returns as a\n response to HTTP query requests contain single, long strings without line breaks or white\n space formatting. The JSON shown in the examples displays the code formatted with both line\n breaks and white space to improve readability. When example input parameters can also cause\n long strings extending beyond the screen, you can insert line breaks to enhance readability.\n You should always submit the input as a single JSON text string.
\n \n \n\n Logging API Requests\n
\nAmazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services\n account and delivers log files to an Amazon S3 bucket. By using information that's collected\n by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the\n request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services\n CloudTrail, see Logging\n Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide.\n To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.
", + "smithy.api#title": "AWS Secrets Manager" + }, "version": "2017-10-17", "operations": [ { @@ -2683,22 +2698,7 @@ { "target": "com.amazonaws.secretsmanager#ValidateResourcePolicy" } - ], - "traits": { - "aws.api#service": { - "sdkId": "Secrets Manager", - "arnNamespace": "secretsmanager", - "cloudFormationName": "SecretsManager", - "cloudTrailEventSource": "secretsmanager.amazonaws.com", - "endpointPrefix": "secretsmanager" - }, - "aws.auth#sigv4": { - "name": "secretsmanager" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Web Services Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.
\n \nThis guide provides descriptions of the Secrets Manager API. For more information about using this\n service, see the Amazon Web Services Secrets Manager User Guide.
\n \n\n API Version\n
\n \nThis version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.
\nAs an alternative to using the API, you can use one of the Amazon Web Services SDKs, which consist of\n libraries and sample code for various programming languages and platforms such as Java,\n Ruby, .NET, iOS, and Android. The SDKs provide a convenient way to create programmatic\n access to Amazon Web Services Secrets Manager. For example, the SDKs provide cryptographically signing requests,\n managing errors, and retrying requests automatically. For more information about the Amazon Web Services\n SDKs, including downloading and installing them, see Tools for Amazon Web Services.
\nWe recommend you use the Amazon Web Services SDKs to make programmatic API calls to Secrets Manager. However, you\n also can use the Secrets Manager HTTP Query API to make direct calls to the Secrets Manager web service. To learn\n more about the Secrets Manager HTTP Query API, see Making Query Requests in the\n Amazon Web Services Secrets Manager User Guide.
\nSecrets Manager API supports GET and POST requests for all actions, and doesn't require you to use\n GET for some actions and POST for others. However, GET requests are subject to the limitation\n size of a URL. Therefore, for operations that require larger sizes, use a POST request.
\n \n \n \n \n \n \n \n\n Support and Feedback for Amazon Web Services Secrets Manager\n
\n \nWe welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the Amazon Web Services Secrets Manager Discussion Forum. For more\n information about the Amazon Web Services Discussion Forums, see Forums\n Help.
\n \n\n How examples are presented\n
\n \nThe JSON that Amazon Web Services Secrets Manager expects as your request parameters and the service returns as a\n response to HTTP query requests contain single, long strings without line breaks or white\n space formatting. The JSON shown in the examples displays the code formatted with both line\n breaks and white space to improve readability. When example input parameters can also cause\n long strings extending beyond the screen, you can insert line breaks to enhance readability.\n You should always submit the input as a single JSON text string.
\n \n \n\n Logging API Requests\n
\nAmazon Web Services Secrets Manager supports Amazon Web Services CloudTrail, a service that records Amazon Web Services API calls for your Amazon Web Services\n account and delivers log files to an Amazon S3 bucket. By using information that's collected\n by Amazon Web Services CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the\n request, when it was made, and so on. For more about Amazon Web Services Secrets Manager and support for Amazon Web Services\n CloudTrail, see Logging\n Amazon Web Services Secrets Manager Events with Amazon Web Services CloudTrail in the Amazon Web Services Secrets Manager User Guide.\n To learn more about CloudTrail, including enabling it and find your log files, see the Amazon Web Services CloudTrail User Guide.
", - "smithy.api#title": "AWS Secrets Manager" - } + ] } } } diff --git a/codegen/sdk/aws-models/securityhub.2018-10-26.json b/codegen/sdk/aws-models/securityhub.2018-10-26.json index 8b8a344b644..4ce4744a5fe 100644 --- a/codegen/sdk/aws-models/securityhub.2018-10-26.json +++ b/codegen/sdk/aws-models/securityhub.2018-10-26.json @@ -1051,6 +1051,26 @@ "smithy.api#documentation": "Contains information about a version 2 stage for Amazon API Gateway.
" } }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupAvailabilityZonesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupAvailabilityZonesListDetails": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The name of the Availability Zone.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An Availability Zone for the automatic scaling group.
" + } + }, "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupDetails": { "type": "structure", "members": { @@ -1083,12 +1103,160 @@ "traits": { "smithy.api#documentation": "Indicates when the auto scaling group was created.
\nUses the date-time format specified in RFC 3339 section 5.6, Internet\n Date/Time Format. The value cannot contain spaces. For example,\n 2020-03-22T13:22:13.933Z.
The mixed instances policy for the automatic scaling group.
" + } + }, + "AvailabilityZones": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupAvailabilityZonesList", + "traits": { + "smithy.api#documentation": "The list of Availability Zones for the automatic scaling group.
" + } } }, "traits": { "smithy.api#documentation": "Provides details about an auto scaling group.
" } }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyDetails": { + "type": "structure", + "members": { + "InstancesDistribution": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails", + "traits": { + "smithy.api#documentation": "The instances distribution. The instances distribution specifies 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 capacity.
" + } + }, + "LaunchTemplate": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails", + "traits": { + "smithy.api#documentation": "The launch template to use and the instance types (overrides) to use to provision EC2 instances to fulfill On-Demand and Spot capacities.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The mixed instances policy for the automatic scaling group.
" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyInstancesDistributionDetails": { + "type": "structure", + "members": { + "OnDemandAllocationStrategy": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "How to allocate instance types to fulfill On-Demand capacity.
" + } + }, + "OnDemandBaseCapacity": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand Instances.
" + } + }, + "OnDemandPercentageAboveBaseCapacity": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "The percentage of On-Demand Instances and Spot Instances for additional capacity beyond OnDemandBaseCapacity.
How to allocate instances across Spot Instance pools.
" + } + }, + "SpotInstancePools": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "The number of Spot Instance pools across which to allocate your Spot Instances.
" + } + }, + "SpotMaxPrice": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The maximum price per unit hour that you are willing to pay for a Spot Instance.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about the instances distribution.
" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateDetails": { + "type": "structure", + "members": { + "LaunchTemplateSpecification": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification", + "traits": { + "smithy.api#documentation": "The launch template to use.
" + } + }, + "Overrides": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesList", + "traits": { + "smithy.api#documentation": "Property values to use to override the values in the launch template.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes a launch template and overrides for a mixed instances policy.
" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateLaunchTemplateSpecification": { + "type": "structure", + "members": { + "LaunchTemplateId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The identifier of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.
The name of the launch template. You must specify either LaunchTemplateId or LaunchTemplateName.
Identifies the version of the launch template. You can specify a version identifier, or use the values $Latest or $Default.
Details about the launch template to use.
" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails" + } + }, + "com.amazonaws.securityhub#AwsAutoScalingAutoScalingGroupMixedInstancesPolicyLaunchTemplateOverridesListDetails": { + "type": "structure", + "members": { + "InstanceType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The instance type. For example, m3.xlarge.
The number of capacity units provided by the specified instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Property values to use to override the values in the launch template.
" + } + }, "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationBlockDeviceMappingsDetails": { "type": "structure", "members": { @@ -1281,6 +1449,12 @@ "traits": { "smithy.api#documentation": "The user data to make available to the launched EC2 instances. Must be base64-encoded\n text.
" } + }, + "MetadataOptions": { + "target": "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationMetadataOptions", + "traits": { + "smithy.api#documentation": "The metadata options for the instances.
" + } } }, "traits": { @@ -1301,6 +1475,32 @@ "smithy.api#documentation": "Information about the type of monitoring for instances in the group.
" } }, + "com.amazonaws.securityhub#AwsAutoScalingLaunchConfigurationMetadataOptions": { + "type": "structure", + "members": { + "HttpEndpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "Enables or disables the HTTP metadata endpoint on your instances. By default, the metadata endpoint is enabled.
" + } + }, + "HttpPutResponseHopLimit": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "The HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Indicates whether token usage is required or optional for metadata requests. By default, token usage is optional.
The metadata options for the instances.
" + } + }, "com.amazonaws.securityhub#AwsCertificateManagerCertificateDetails": { "type": "structure", "members": { @@ -8306,149 +8506,325 @@ "com.amazonaws.securityhub#AwsLambdaLayerVersionNumber": { "type": "long" }, - "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigDetails": { + "com.amazonaws.securityhub#AwsNetworkFirewallFirewallDetails": { "type": "structure", "members": { - "InstanceCount": { - "target": "com.amazonaws.securityhub#Integer", + "DeleteProtection": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "The number of data nodes to use in the OpenSearch domain.
" + "smithy.api#documentation": "Whether the firewall is protected from deletion. If set to true, then the firewall cannot be deleted.
Whether UltraWarm is enabled.
" + "smithy.api#documentation": "A description of the firewall.
" } }, - "WarmCount": { - "target": "com.amazonaws.securityhub#Integer", + "FirewallArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "The number of UltraWarm instances.
" + "smithy.api#documentation": "The ARN of the firewall.
" } }, - "DedicatedMasterEnabled": { + "FirewallId": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The identifier of the firewall.
" + } + }, + "FirewallName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "A descriptive name of the firewall.
" + } + }, + "FirewallPolicyArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ARN of the firewall policy.
" + } + }, + "FirewallPolicyChangeProtection": { "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "Whether to use a dedicated master node for the OpenSearch domain. A dedicated master node performs cluster management tasks, but does not hold data or respond to data upload requests.
" + "smithy.api#documentation": "Whether the firewall is protected from a change to the firewall policy. If set to true, you cannot associate a different policy with the firewall.
Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is true.
Whether the firewall is protected from a change to the subnet associations. If set to true, you cannot map different subnets to the firewall.
The number of instances to use for the master node. If this attribute is specified, then DedicatedMasterEnabled must be true.
The public subnets that Network Firewall uses for the firewall. Each subnet must belong to a different Availability Zone.
" } }, - "InstanceType": { + "VpcId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "The instance type for your data nodes.
" + "smithy.api#documentation": "The identifier of the VPC where the firewall is used.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details about an Network Firewall firewall.
" + } + }, + "com.amazonaws.securityhub#AwsNetworkFirewallFirewallPolicyDetails": { + "type": "structure", + "members": { + "FirewallPolicy": { + "target": "com.amazonaws.securityhub#FirewallPolicyDetails", + "traits": { + "smithy.api#documentation": "The firewall policy configuration.
" } }, - "WarmType": { + "FirewallPolicyArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "The type of UltraWarm instance.
" + "smithy.api#documentation": "The ARN of the firewall policy.
" } }, - "ZoneAwarenessEnabled": { - "target": "com.amazonaws.securityhub#Boolean", + "FirewallPolicyId": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "Whether to enable zone awareness for the OpenSearch domain. When zone awareness is enabled, OpenSearch Service allocates the cluster's nodes and replica index shards across Availability Zones (AZs) in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.
" + "smithy.api#documentation": "The identifier of the firewall policy.
" } }, - "DedicatedMasterType": { + "FirewallPolicyName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "The hardware configuration of the computer that hosts the dedicated master node.
\nIf this attribute is specified, then DedicatedMasterEnabled must be true.\n
The name of the firewall policy.
" + } + }, + "Description": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "A description of the firewall policy.
" } } }, "traits": { - "smithy.api#documentation": "Details about the configuration of an OpenSearch cluster.
" + "smithy.api#documentation": "Details about a firewall policy. A firewall policy defines the behavior of a network firewall.
" } }, - "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails": { + "com.amazonaws.securityhub#AwsNetworkFirewallFirewallSubnetMappingsDetails": { "type": "structure", "members": { - "AvailabilityZoneCount": { - "target": "com.amazonaws.securityhub#Integer", + "SubnetId": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "The number of Availability Zones that the domain uses. Valid values are 2 and 3. The default is 2.
" + "smithy.api#documentation": "The identifier of the subnet
" } } }, "traits": { - "smithy.api#documentation": "Configuration options for zone awareness.
" + "smithy.api#documentation": "A public subnet that Network Firewall uses for the firewall.
" } }, - "com.amazonaws.securityhub#AwsOpenSearchServiceDomainDetails": { + "com.amazonaws.securityhub#AwsNetworkFirewallFirewallSubnetMappingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#AwsNetworkFirewallFirewallSubnetMappingsDetails" + } + }, + "com.amazonaws.securityhub#AwsNetworkFirewallRuleGroupDetails": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "Capacity": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "The ARN of the OpenSearch Service domain.
" + "smithy.api#documentation": "The maximum number of operating resources that this rule group can use.
" } }, - "AccessPolicies": { + "Description": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "IAM policy document that specifies the access policies for the OpenSearch Service domain.
" + "smithy.api#documentation": "A description of the rule group.
" } }, - "DomainName": { - "target": "com.amazonaws.securityhub#NonEmptyString", + "RuleGroup": { + "target": "com.amazonaws.securityhub#RuleGroupDetails", "traits": { - "smithy.api#documentation": "The name of the endpoint.
" + "smithy.api#documentation": "Details about the rule group.
" } }, - "Id": { + "RuleGroupArn": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "The identifier of the domain.
" + "smithy.api#documentation": "The ARN of the rule group.
" } }, - "DomainEndpoint": { + "RuleGroupId": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "The domain endpoint.
" + "smithy.api#documentation": "The identifier of the rule group.
" } }, - "EngineVersion": { + "RuleGroupName": { "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "The version of the domain engine.
" + "smithy.api#documentation": "The descriptive name of the rule group.
" } }, - "EncryptionAtRestOptions": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails", + "Type": { + "target": "com.amazonaws.securityhub#NonEmptyString", "traits": { - "smithy.api#documentation": "Details about the configuration for encryption at rest.
" + "smithy.api#documentation": "The type of rule group. A rule group can be stateful or stateless.
" } - }, - "NodeToNodeEncryptionOptions": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails", + } + }, + "traits": { + "smithy.api#documentation": "Details about an Network Firewall rule group. Rule groups are used to inspect and control network traffic. Stateless rule groups apply to individual packets. Stateful rule groups apply to packets in the context of their traffic flow.
\nRule groups are referenced in firewall policies.\n
" + } + }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigDetails": { + "type": "structure", + "members": { + "InstanceCount": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "Details about the configuration for node-to-node encryption.
" + "smithy.api#documentation": "The number of data nodes to use in the OpenSearch domain.
" } }, - "ServiceSoftwareOptions": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails", + "WarmEnabled": { + "target": "com.amazonaws.securityhub#Boolean", "traits": { - "smithy.api#documentation": "Information about the status of a domain relative to the latest service software.
" + "smithy.api#documentation": "Whether UltraWarm is enabled.
" } }, - "ClusterConfig": { - "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigDetails", + "WarmCount": { + "target": "com.amazonaws.securityhub#Integer", "traits": { - "smithy.api#documentation": "Details about the configuration of an OpenSearch cluster.
" + "smithy.api#documentation": "The number of UltraWarm instances.
" + } + }, + "DedicatedMasterEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "Whether to use a dedicated master node for the OpenSearch domain. A dedicated master node performs cluster management tasks, but does not hold data or respond to data upload requests.
" + } + }, + "ZoneAwarenessConfig": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails", + "traits": { + "smithy.api#documentation": "Configuration options for zone awareness. Provided if ZoneAwarenessEnabled is true.
The number of instances to use for the master node. If this attribute is specified, then DedicatedMasterEnabled must be true.
The instance type for your data nodes.
" + } + }, + "WarmType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The type of UltraWarm instance.
" + } + }, + "ZoneAwarenessEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "Whether to enable zone awareness for the OpenSearch domain. When zone awareness is enabled, OpenSearch Service allocates the cluster's nodes and replica index shards across Availability Zones (AZs) in the same Region. This prevents data loss and minimizes downtime if a node or data center fails.
" + } + }, + "DedicatedMasterType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The hardware configuration of the computer that hosts the dedicated master node.
\nIf this attribute is specified, then DedicatedMasterEnabled must be true.\n
Details about the configuration of an OpenSearch cluster.
" + } + }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigZoneAwarenessConfigDetails": { + "type": "structure", + "members": { + "AvailabilityZoneCount": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "The number of Availability Zones that the domain uses. Valid values are 2 and 3. The default is 2.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Configuration options for zone awareness.
" + } + }, + "com.amazonaws.securityhub#AwsOpenSearchServiceDomainDetails": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ARN of the OpenSearch Service domain.
" + } + }, + "AccessPolicies": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "IAM policy document that specifies the access policies for the OpenSearch Service domain.
" + } + }, + "DomainName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The name of the endpoint.
" + } + }, + "Id": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The identifier of the domain.
" + } + }, + "DomainEndpoint": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The domain endpoint.
" + } + }, + "EngineVersion": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The version of the domain engine.
" + } + }, + "EncryptionAtRestOptions": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainEncryptionAtRestOptionsDetails", + "traits": { + "smithy.api#documentation": "Details about the configuration for encryption at rest.
" + } + }, + "NodeToNodeEncryptionOptions": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainNodeToNodeEncryptionOptionsDetails", + "traits": { + "smithy.api#documentation": "Details about the configuration for node-to-node encryption.
" + } + }, + "ServiceSoftwareOptions": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainServiceSoftwareOptionsDetails", + "traits": { + "smithy.api#documentation": "Information about the status of a domain relative to the latest service software.
" + } + }, + "ClusterConfig": { + "target": "com.amazonaws.securityhub#AwsOpenSearchServiceDomainClusterConfigDetails", + "traits": { + "smithy.api#documentation": "Details about the configuration of an OpenSearch cluster.
" } }, "DomainEndpointOptions": { @@ -11165,6 +11541,26 @@ "target": "com.amazonaws.securityhub#AwsS3BucketBucketLifecycleConfigurationRulesTransitionsDetails" } }, + "com.amazonaws.securityhub#AwsS3BucketBucketVersioningConfiguration": { + "type": "structure", + "members": { + "IsMfaDeleteEnabled": { + "target": "com.amazonaws.securityhub#Boolean", + "traits": { + "smithy.api#documentation": "Specifies whether MFA delete is currently enabled in the S3 bucket versioning configuration. If the S3 bucket was never configured with MFA delete, then this attribute is not included.
" + } + }, + "Status": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The versioning status of the S3 bucket.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Describes the versioning state of an S3 bucket.
" + } + }, "com.amazonaws.securityhub#AwsS3BucketDetails": { "type": "structure", "members": { @@ -11233,6 +11629,12 @@ "traits": { "smithy.api#documentation": "The notification configuration for the S3 bucket.
" } + }, + "BucketVersioningConfiguration": { + "target": "com.amazonaws.securityhub#AwsS3BucketBucketVersioningConfiguration", + "traits": { + "smithy.api#documentation": "The versioning state of an S3 bucket.
" + } } }, "traits": { @@ -12431,7 +12833,7 @@ "WorkflowStatus": { "target": "com.amazonaws.securityhub#StringFilterList", "traits": { - "smithy.api#documentation": "The status of the investigation into a finding. Allowed values are the following.
\n\n NEW - The initial state of a finding, before it is reviewed.
Security Hub also resets the workflow status from NOTIFIED or\n RESOLVED to NEW in the following cases:
The record state changes from ARCHIVED to ACTIVE.
The compliance status changes from PASSED to either WARNING,\n FAILED, or NOT_AVAILABLE.
\n NOTIFIED - Indicates that the resource owner has been notified about\n the security issue. Used when the initial reviewer is not the resource owner, and\n needs intervention from the resource owner.
\n SUPPRESSED - The finding will not be reviewed again and will not be\n acted upon.
\n RESOLVED - The finding was reviewed and remediated and is now\n considered resolved.
The status of the investigation into a finding. Allowed values are the following.
\n\n NEW - The initial state of a finding, before it is reviewed.
Security Hub also resets the workflow status from NOTIFIED or\n RESOLVED to NEW in the following cases:
\n RecordState changes from ARCHIVED to ACTIVE.
\n Compliance.Status changes from PASSED to either WARNING,\n FAILED, or NOT_AVAILABLE.
\n NOTIFIED - Indicates that the resource owner has been notified about\n the security issue. Used when the initial reviewer is not the resource owner, and\n needs intervention from the resource owner.
If one of the following occurs, the workflow status is changed automatically from\n NOTIFIED to NEW:
\n RecordState changes from ARCHIVED to\n ACTIVE.
\n Compliance.Status changes from PASSED to FAILED,\n WARNING, or NOT_AVAILABLE.
\n SUPPRESSED - Indicates that you reviewed the finding and do not believe that any action is\n needed.
The workflow status of a SUPPRESSED finding does not change if\n RecordState changes from ARCHIVED to\n ACTIVE.
\n RESOLVED - The finding was reviewed and remediated and is now\n considered resolved.
The finding remains RESOLVED unless one of the following occurs:
\n RecordState changes from ARCHIVED to\n ACTIVE.
\n Compliance.Status changes from PASSED to FAILED,\n WARNING, or NOT_AVAILABLE.
In those cases, the workflow status is automatically reset to NEW.
For findings from controls, if Compliance.Status is PASSED,\n then Security Hub automatically sets the workflow status to RESOLVED.
Imports security findings generated from an integrated product into Security Hub.\n This action is requested by the integrated product to import its findings into\n Security Hub.
\nThe maximum allowed size for a finding is 240 Kb. An error is returned for any finding\n larger than 240 Kb.
\nAfter a finding is created, BatchImportFindings cannot be used to update\n the following finding fields and objects, which Security Hub customers use to manage their\n investigation workflow.
\n Note\n
\n UserDefinedFields\n
\n VerificationState\n
\n Workflow\n
Finding providers also should not use BatchImportFindings to update the following attributes.
\n Confidence\n
\n Criticality\n
\n RelatedFindings\n
\n Severity\n
\n Types\n
Instead, finding providers use FindingProviderFields to provide values for these attributes.
Imports security findings generated by a finding provider into Security Hub.\n This action is requested by the finding provider to import its findings into\n Security Hub.
\n\n BatchImportFindings must be called by one of the following:
The account that is associated with the findings. The identifier of the associated\n account is the value of the AwsAccountId attribute for the finding.
An account that is allow-listed for an official Security Hub partner integration.
\nThe maximum allowed size for a finding is 240 Kb. An error is returned for any finding\n larger than 240 Kb.
\nAfter a finding is created, BatchImportFindings cannot be used to update\n the following finding fields and objects, which Security Hub customers use to manage their\n investigation workflow.
\n Note\n
\n UserDefinedFields\n
\n VerificationState\n
\n Workflow\n
Finding providers also should not use BatchImportFindings to update the following attributes.
\n Confidence\n
\n Criticality\n
\n RelatedFindings\n
\n Severity\n
\n Types\n
Instead, finding providers use FindingProviderFields to provide values for these attributes.
Creates a member association in Security Hub between the specified accounts and the account\n used to make the request, which is the administrator account. If you are integrated with\n Organizations, then the administrator account is designated by the organization management account.
\n\n CreateMembers is always used to add accounts that are not organization\n members.
For accounts that are managed using Organizations, CreateMembers is only used\n in the following cases:
Security Hub is not configured to automatically add new organization accounts.
\nThe account was disassociated or deleted in Security Hub.
\nThis action can only be used by an account that has Security Hub enabled. To enable Security Hub, you\n can use the EnableSecurityHub operation.
For accounts that are not organization members, you create the account association and\n then send an invitation to the member account. To send the invitation, you use the\n InviteMembers operation. If the account owner accepts\n the invitation, the account becomes a member account in Security Hub.
Accounts that are managed using Organizations do not receive an invitation. They\n automatically become a member account in Security Hub.
\nIf the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.
\nFor organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.
\nA permissions policy is added that permits the administrator account to view the findings\n generated in the member account.
\nTo remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.
Creates a member association in Security Hub between the specified accounts and the account\n used to make the request, which is the administrator account. If you are integrated with\n Organizations, then the administrator account is designated by the organization management account.
\n\n CreateMembers is always used to add accounts that are not organization\n members.
For accounts that are managed using Organizations, CreateMembers is only used\n in the following cases:
Security Hub is not configured to automatically add new organization accounts.
\nThe account was disassociated or deleted in Security Hub.
\nThis action can only be used by an account that has Security Hub enabled. To enable Security Hub, you\n can use the EnableSecurityHub operation.
For accounts that are not organization members, you create the account association and\n then send an invitation to the member account. To send the invitation, you use the\n InviteMembers operation. If the account owner accepts\n the invitation, the account becomes a member account in Security Hub.
Accounts that are managed using Organizations do not receive an invitation. They\n automatically become a member account in Security Hub.
\nIf the organization account does not have Security Hub enabled, then Security Hub and the default standards are automatically enabled. Note that Security Hub cannot be enabled automatically for the organization management account. The organization management account must enable Security Hub before the administrator account enables it as a member account.
\nFor organization accounts that already have Security Hub enabled, Security Hub does not make any other changes to those accounts. It does not change their enabled standards or controls.
\nA permissions policy is added that permits the administrator account to view the findings\n generated in the member account.
\nTo remove the association between the administrator and member accounts, use the DisassociateFromMasterAccount or DisassociateMembers operation.
The severity assigned to the finding by the finding provider.
" } }, + "com.amazonaws.securityhub#FirewallPolicyDetails": { + "type": "structure", + "members": { + "StatefulRuleGroupReferences": { + "target": "com.amazonaws.securityhub#FirewallPolicyStatefulRuleGroupReferencesList", + "traits": { + "smithy.api#documentation": "The stateful rule groups that are used in the firewall policy.
" + } + }, + "StatelessCustomActions": { + "target": "com.amazonaws.securityhub#FirewallPolicyStatelessCustomActionsList", + "traits": { + "smithy.api#documentation": "The custom action definitions that are available to use in the firewall policy's StatelessDefaultActions setting.
The actions to take on a packet if it doesn't match any of the stateless rules in the policy.
\nYou must specify a standard action (aws:pass, aws:drop, aws:forward_to_sfe), and can optionally include a custom action from StatelessCustomActions.\n
The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy.
\nYou must specify a standard action (aws:pass, aws:drop, aws:forward_to_sfe), and can optionally include a custom action from StatelessCustomActions.\n
The stateless rule groups that are used in the firewall policy.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines the behavior of the firewall.
" + } + }, + "com.amazonaws.securityhub#FirewallPolicyStatefulRuleGroupReferencesDetails": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ARN of the stateful rule group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A stateful rule group that is used by the firewall policy.
" + } + }, + "com.amazonaws.securityhub#FirewallPolicyStatefulRuleGroupReferencesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#FirewallPolicyStatefulRuleGroupReferencesDetails" + } + }, + "com.amazonaws.securityhub#FirewallPolicyStatelessCustomActionsDetails": { + "type": "structure", + "members": { + "ActionDefinition": { + "target": "com.amazonaws.securityhub#StatelessCustomActionDefinition", + "traits": { + "smithy.api#documentation": "The definition of the custom action.
" + } + }, + "ActionName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The name of the custom action.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A custom action that can be used for stateless packet handling.
" + } + }, + "com.amazonaws.securityhub#FirewallPolicyStatelessCustomActionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#FirewallPolicyStatelessCustomActionsDetails" + } + }, + "com.amazonaws.securityhub#FirewallPolicyStatelessRuleGroupReferencesDetails": { + "type": "structure", + "members": { + "Priority": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "The order in which to run the stateless rule group.
" + } + }, + "ResourceArn": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The ARN of the stateless rule group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A stateless rule group that is used by the firewall policy.
" + } + }, + "com.amazonaws.securityhub#FirewallPolicyStatelessRuleGroupReferencesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#FirewallPolicyStatelessRuleGroupReferencesDetails" + } + }, "com.amazonaws.securityhub#GeoLocation": { "type": "structure", "members": { @@ -18477,6 +18989,24 @@ "traits": { "smithy.api#documentation": "Details about an Amazon EKS cluster.
" } + }, + "AwsNetworkFirewallFirewallPolicy": { + "target": "com.amazonaws.securityhub#AwsNetworkFirewallFirewallPolicyDetails", + "traits": { + "smithy.api#documentation": "Details about an Network Firewall firewall policy.
" + } + }, + "AwsNetworkFirewallFirewall": { + "target": "com.amazonaws.securityhub#AwsNetworkFirewallFirewallDetails", + "traits": { + "smithy.api#documentation": "Details about an Network Firewall firewall.
" + } + }, + "AwsNetworkFirewallRuleGroup": { + "target": "com.amazonaws.securityhub#AwsNetworkFirewallRuleGroupDetails", + "traits": { + "smithy.api#documentation": "Details about an Network Firewall rule group.
" + } } }, "traits": { @@ -18531,21 +19061,530 @@ "target": "com.amazonaws.securityhub#Result" } }, - "com.amazonaws.securityhub#SecurityGroups": { - "type": "list", - "member": { - "target": "com.amazonaws.securityhub#NonEmptyString" + "com.amazonaws.securityhub#RuleGroupDetails": { + "type": "structure", + "members": { + "RuleVariables": { + "target": "com.amazonaws.securityhub#RuleGroupVariables", + "traits": { + "smithy.api#documentation": "Additional settings to use in the specified rules.
" + } + }, + "RulesSource": { + "target": "com.amazonaws.securityhub#RuleGroupSource", + "traits": { + "smithy.api#documentation": "The rules and actions for the rule group.
\nFor stateful rule groups, can contain RulesString, RulesSourceList, or StatefulRules.
For stateless rule groups, contains StatelessRulesAndCustomActions.
Details about the rule group.
" } }, - "com.amazonaws.securityhub#SecurityHubAPIService": { - "type": "service", - "version": "2018-10-26", - "operations": [ - { - "target": "com.amazonaws.securityhub#AcceptAdministratorInvitation" + "com.amazonaws.securityhub#RuleGroupSource": { + "type": "structure", + "members": { + "RulesSourceList": { + "target": "com.amazonaws.securityhub#RuleGroupSourceListDetails", + "traits": { + "smithy.api#documentation": "Stateful inspection criteria for a domain list rule group. A domain list rule group determines access by specific protocols to specific domains.
" + } }, - { - "target": "com.amazonaws.securityhub#AcceptInvitation" + "RulesString": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "Stateful inspection criteria, provided in Suricata compatible intrusion prevention system (IPS) rules.
" + } + }, + "StatefulRules": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesList", + "traits": { + "smithy.api#documentation": "Suricata rule specifications.
" + } + }, + "StatelessRulesAndCustomActions": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesAndCustomActionsDetails", + "traits": { + "smithy.api#documentation": "The stateless rules and custom actions used by a stateless rule group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The rules and actions for the rule group.
" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceCustomActionsDetails": { + "type": "structure", + "members": { + "ActionDefinition": { + "target": "com.amazonaws.securityhub#StatelessCustomActionDefinition", + "traits": { + "smithy.api#documentation": "The definition of a custom action.
" + } + }, + "ActionName": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "A descriptive name of the custom action.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A custom action definition. A custom action is an optional, non-standard action to use for stateless packet handling.
" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceCustomActionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceCustomActionsDetails" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceListDetails": { + "type": "structure", + "members": { + "GeneratedRulesType": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "Indicates whether to allow or deny access to the domains listed in Targets.
The protocols that you want to inspect. Specify LS_SNI for HTTPS. Specify HTTP_HOST for HTTP. You can specify either or both.
The domains that you want to inspect for in your traffic flows. You can provide full domain names, or use the '.' prefix as a wildcard. For example, .example.com matches all domains that end with example.com.
Stateful inspection criteria for a domain list rule group.
" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesDetails": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria.
" + } + }, + "Header": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesHeaderDetails", + "traits": { + "smithy.api#documentation": "The stateful inspection criteria for the rule.
" + } + }, + "RuleOptions": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesOptionsList", + "traits": { + "smithy.api#documentation": "Additional options for the rule.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A Suricata rule specification.
" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesHeaderDetails": { + "type": "structure", + "members": { + "Destination": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The destination IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.
The destination port to inspect for. You can specify an individual port, such as 1994. You also can specify a port range, such as 1990:1994. To match with any port, specify ANY.
The direction of traffic flow to inspect. If set to ANY, the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set to FORWARD, the inspection only matches traffic going from the source to the destination.
The protocol to inspect for. To inspector for all protocols, use IP.
The source IP address or address range to inspect for, in CIDR notation. To match with any address, specify ANY.
The source port to inspect for. You can specify an individual port, such as 1994. You also can specify a port range, such as 1990:1994. To match with any port, specify ANY.
The inspection criteria for a stateful rule.
" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesDetails" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesOptionsDetails": { + "type": "structure", + "members": { + "Keyword": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "A keyword to look for.
" + } + }, + "Settings": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesRuleOptionsSettingsList", + "traits": { + "smithy.api#documentation": "A list of settings.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A rule option for a stateful rule.
" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesOptionsDetails" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatefulRulesRuleOptionsSettingsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleDefinition": { + "type": "structure", + "members": { + "Actions": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "The actions to take on a packet that matches one of the stateless rule definition's match attributes. You must specify a standard action (aws:pass, aws:drop, or aws:forward_to_sfe). You can then add custom actions.
The criteria for Network Firewall to use to inspect an individual packet in a stateless rule inspection.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The definition of the stateless rule.
" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributes": { + "type": "structure", + "members": { + "DestinationPorts": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationPortsList", + "traits": { + "smithy.api#documentation": "A list of port ranges to specify the destination ports to inspect for.
" + } + }, + "Destinations": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationsList", + "traits": { + "smithy.api#documentation": "The destination IP addresses and address ranges to inspect for, in CIDR notation.
" + } + }, + "Protocols": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesProtocolsList", + "traits": { + "smithy.api#documentation": "The protocols to inspect for.
" + } + }, + "SourcePorts": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcePortsList", + "traits": { + "smithy.api#documentation": "A list of port ranges to specify the source ports to inspect for.
" + } + }, + "Sources": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcesList", + "traits": { + "smithy.api#documentation": "The source IP addresses and address ranges to inspect for, in CIDR notation.
" + } + }, + "TcpFlags": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesTcpFlagsList", + "traits": { + "smithy.api#documentation": "The TCP flags and masks to inspect for.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Criteria for the stateless rule.
" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "The starting port value for the port range.
" + } + }, + "ToPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "The ending port value for the port range.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A port range to specify the destination ports to inspect for.
" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationPortsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationPorts" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinations": { + "type": "structure", + "members": { + "AddressDefinition": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "An IP address or a block of IP addresses.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A destination IP address or range.
" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinationsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesDestinations" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesProtocolsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#Integer" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcePorts": { + "type": "structure", + "members": { + "FromPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "The starting port value for the port range.
" + } + }, + "ToPort": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "The ending port value for the port range.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A port range to specify the source ports to inspect for.
" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcePortsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcePorts" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSources": { + "type": "structure", + "members": { + "AddressDefinition": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "An IP address or a block of IP addresses.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A source IP addresses and address range to inspect for.
" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSourcesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesSources" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesTcpFlags": { + "type": "structure", + "members": { + "Flags": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "Defines the flags from the Masks setting that must be set in order for the packet to match. Flags that are listed must be set. Flags that are not listed must not be set.
The set of flags to consider in the inspection. If not specified, then all flags are inspected.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A set of TCP flags and masks to inspect for.
" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesTcpFlagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleMatchAttributesTcpFlags" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesAndCustomActionsDetails": { + "type": "structure", + "members": { + "CustomActions": { + "target": "com.amazonaws.securityhub#RuleGroupSourceCustomActionsList", + "traits": { + "smithy.api#documentation": "Custom actions for the rule group.
" + } + }, + "StatelessRules": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesList", + "traits": { + "smithy.api#documentation": "Stateless rules for the rule group.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Stateless rules and custom actions for a stateless rule group.
" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesDetails": { + "type": "structure", + "members": { + "Priority": { + "target": "com.amazonaws.securityhub#Integer", + "traits": { + "smithy.api#documentation": "Indicates the order in which to run this rule relative to all of the rules in the stateless rule group.
" + } + }, + "RuleDefinition": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRuleDefinition", + "traits": { + "smithy.api#documentation": "Provides the definition of the stateless rule.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A stateless rule in the rule group.
" + } + }, + "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#RuleGroupSourceStatelessRulesDetails" + } + }, + "com.amazonaws.securityhub#RuleGroupVariables": { + "type": "structure", + "members": { + "IpSets": { + "target": "com.amazonaws.securityhub#RuleGroupVariablesIpSetsDetails", + "traits": { + "smithy.api#documentation": "A list of IP addresses and address ranges, in CIDR notation.
" + } + }, + "PortSets": { + "target": "com.amazonaws.securityhub#RuleGroupVariablesPortSetsDetails", + "traits": { + "smithy.api#documentation": "A list of port ranges.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Additional settings to use in the specified rules.
" + } + }, + "com.amazonaws.securityhub#RuleGroupVariablesIpSetsDetails": { + "type": "structure", + "members": { + "Definition": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "The list of IP addresses and ranges.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of IP addresses and address ranges, in CIDR notation.
" + } + }, + "com.amazonaws.securityhub#RuleGroupVariablesPortSetsDetails": { + "type": "structure", + "members": { + "Definition": { + "target": "com.amazonaws.securityhub#NonEmptyStringList", + "traits": { + "smithy.api#documentation": "The list of port ranges.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A list of port ranges.
" + } + }, + "com.amazonaws.securityhub#SecurityGroups": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#NonEmptyString" + } + }, + "com.amazonaws.securityhub#SecurityHubAPIService": { + "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "SecurityHub", + "arnNamespace": "securityhub", + "cloudFormationName": "SecurityHub", + "cloudTrailEventSource": "securityhub.amazonaws.com", + "endpointPrefix": "securityhub" + }, + "aws.auth#sigv4": { + "name": "securityhub" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Security Hub provides you with a comprehensive view of the security state of your Amazon Web Services environment and resources. It also provides you with the readiness status\n of your environment based on controls from supported security standards. Security Hub collects\n security data from Amazon Web Services accounts, services, and integrated third-party products and helps\n you analyze security trends in your environment to identify the highest priority security\n issues. For more information about Security Hub, see the Security HubUser\n Guide\n .
\nWhen you use operations in the Security Hub API, the requests are executed only in the Amazon Web Services\n Region that is currently active or in the specific Amazon Web Services Region that you specify in your\n request. Any configuration or settings change that results from the operation is applied\n only to that Region. To make the same change in other Regions, execute the same command for\n each Region to apply the change to.
\nFor example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of\n the member account with the administrator account is created only in the us-west-2\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.
The following throttling limits apply to using Security Hub API operations.
\n\n BatchEnableStandards - RateLimit of 1\n request per second, BurstLimit of 1 request per second.
\n GetFindings - RateLimit of 3 requests per second.\n BurstLimit of 6 requests per second.
\n UpdateFindings - RateLimit of 1 request per\n second. BurstLimit of 5 requests per second.
\n UpdateStandardsControl - RateLimit of\n 1 request per second, BurstLimit of 5 requests per second.
All other operations - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.
Security Hub provides you with a comprehensive view of the security state of your Amazon Web Services environment and resources. It also provides you with the readiness status\n of your environment based on controls from supported security standards. Security Hub collects\n security data from Amazon Web Services accounts, services, and integrated third-party products and helps\n you analyze security trends in your environment to identify the highest priority security\n issues. For more information about Security Hub, see the Security HubUser\n Guide\n .
\nWhen you use operations in the Security Hub API, the requests are executed only in the Amazon Web Services\n Region that is currently active or in the specific Amazon Web Services Region that you specify in your\n request. Any configuration or settings change that results from the operation is applied\n only to that Region. To make the same change in other Regions, execute the same command for\n each Region to apply the change to.
\nFor example, if your Region is set to us-west-2, when you use CreateMembers to add a member account to Security Hub, the association of\n the member account with the administrator account is created only in the us-west-2\n Region. Security Hub must be enabled for the member account in the same Region that the invitation\n was sent from.
The following throttling limits apply to using Security Hub API operations.
\n\n BatchEnableStandards - RateLimit of 1\n request per second, BurstLimit of 1 request per second.
\n GetFindings - RateLimit of 3 requests per second.\n BurstLimit of 6 requests per second.
\n UpdateFindings - RateLimit of 1 request per\n second. BurstLimit of 5 requests per second.
\n UpdateStandardsControl - RateLimit of\n 1 request per second, BurstLimit of 5 requests per second.
All other operations - RateLimit of 10 requests per second.\n BurstLimit of 30 requests per second.
The reason code that represents the reason for the current status of a standard subscription.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The reason for the current status of a standard subscription.
" + } + }, "com.amazonaws.securityhub#StandardsSubscription": { "type": "structure", "members": { @@ -19176,6 +20215,12 @@ "smithy.api#documentation": "The status of the standard subscription.
\nThe status values are as follows:
\n\n PENDING - Standard is in the process of being enabled.
\n READY - Standard is enabled.
\n INCOMPLETE - Standard could not be enabled completely. Some controls may not be available.
\n DELETING - Standard is in the process of being disabled.
\n FAILED - Standard could not be disabled.
The reason for the current status.
" + } } }, "traits": { @@ -19233,6 +20278,54 @@ "target": "com.amazonaws.securityhub#StandardsSubscription" } }, + "com.amazonaws.securityhub#StatelessCustomActionDefinition": { + "type": "structure", + "members": { + "PublishMetricAction": { + "target": "com.amazonaws.securityhub#StatelessCustomPublishMetricAction", + "traits": { + "smithy.api#documentation": "Information about metrics to publish to CloudWatch.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The definition of a custom action that can be used for stateless packet handling.
" + } + }, + "com.amazonaws.securityhub#StatelessCustomPublishMetricAction": { + "type": "structure", + "members": { + "Dimensions": { + "target": "com.amazonaws.securityhub#StatelessCustomPublishMetricActionDimensionsList", + "traits": { + "smithy.api#documentation": "Defines CloudWatch dimension values to publish.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information about metrics to publish to CloudWatch.
" + } + }, + "com.amazonaws.securityhub#StatelessCustomPublishMetricActionDimension": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.securityhub#NonEmptyString", + "traits": { + "smithy.api#documentation": "The value to use for the custom metric dimension.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Defines a CloudWatch dimension value to publish.
" + } + }, + "com.amazonaws.securityhub#StatelessCustomPublishMetricActionDimensionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.securityhub#StatelessCustomPublishMetricActionDimension" + } + }, "com.amazonaws.securityhub#StatusReason": { "type": "structure", "members": { @@ -19254,6 +20347,21 @@ "smithy.api#documentation": "Provides additional context for the value of Compliance.Status.
\n Product update\n
\nAs of March 31, 2022, Amazon Web Services will discontinue Server Migration Service (Amazon Web Services SMS).\n Going forward, we recommend Amazon Web Services Application Migration Service (Amazon Web Services MGN) as the primary migration\n service for lift-and-shift migrations.
\nYou can initiate new migration jobs in Server Migration Service until January 1, 2022.\n Complete these active migration projects by March 31, 2022. For more information, see\n When\n to Choose AWS Application Migration Service.
\nServer Migration Service (Server Migration Service) makes it easier and faster for you to migrate your\n on-premises workloads to Amazon Web Services. To learn more about Server Migration Service, see the following \n resources:
\nAWS Server Migration Service (AWS SMS) makes it easier and faster for you to migrate your\n on-premises workloads to AWS. To learn more about AWS SMS, see the following \n resources:
\nThe name of the service role in the customer's account used by AWS SMS.
" + "smithy.api#documentation": "The name of the service role in the customer's account used by Server Migration Service.
" } }, "totalServerGroups": { @@ -789,7 +789,7 @@ "roleName": { "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "The name of the service role in the customer's account to be used by AWS SMS.
" + "smithy.api#documentation": "The name of the service role in the customer's account to be used by Server Migration Service.
" } }, "clientToken": { @@ -873,7 +873,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a replication job. The replication job schedules periodic replication runs\n to replicate your server to AWS. Each replication run creates an Amazon Machine Image\n (AMI).
" + "smithy.api#documentation": "Creates a replication job. The replication job schedules periodic replication runs\n to replicate your server to Amazon Web Services. Each replication run creates an Amazon Machine Image\n (AMI).
" } }, "com.amazonaws.sms#CreateReplicationJobRequest": { @@ -914,7 +914,7 @@ "roleName": { "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "The name of the IAM role to be used by the AWS SMS.
" + "smithy.api#documentation": "The name of the IAM role to be used by the Server Migration Service.
" } }, "description": { @@ -980,7 +980,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified application. Optionally deletes the launched stack associated with\n the application and all AWS SMS replication jobs for servers in the application.
" + "smithy.api#documentation": "Deletes the specified application. Optionally deletes the launched stack associated with\n the application and all Server Migration Service replication jobs for servers in the application.
" } }, "com.amazonaws.sms#DeleteAppLaunchConfiguration": { @@ -1169,7 +1169,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified replication job.
\nAfter you delete a replication job, there are no further replication runs. AWS\n deletes the contents of the Amazon S3 bucket used to store AWS SMS artifacts. The AMIs created\n by the replication runs are not deleted.
" + "smithy.api#documentation": "Deletes the specified replication job.
\nAfter you delete a replication job, there are no further replication runs. Amazon Web Services\n deletes the contents of the Amazon S3 bucket used to store Server Migration Service artifacts. The AMIs created\n by the replication runs are not deleted.
" } }, "com.amazonaws.sms#DeleteReplicationJobRequest": { @@ -1248,7 +1248,7 @@ } ], "traits": { - "smithy.api#documentation": "Disassociates the specified connector from AWS SMS.
\nAfter you disassociate a connector, it is no longer available to support\n replication jobs.
" + "smithy.api#documentation": "Disassociates the specified connector from Server Migration Service.
\nAfter you disassociate a connector, it is no longer available to support\n replication jobs.
" } }, "com.amazonaws.sms#DisassociateConnectorRequest": { @@ -1275,6 +1275,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "DryRunOperationException", + "httpResponseCode": 412 + }, "smithy.api#documentation": "The user has the required permissions, so the request would have succeeded, \n but a dry run was performed.
", "smithy.api#error": "client", "smithy.api#httpError": 412 @@ -1402,7 +1406,7 @@ } ], "traits": { - "smithy.api#documentation": "Generates an AWS CloudFormation template based on the current launch configuration and writes it to\n an Amazon S3 object in the customer’s Amazon S3 bucket.
" + "smithy.api#documentation": "Generates an CloudFormation template based on the current launch configuration and writes it to\n an Amazon S3 object in the customer’s Amazon S3 bucket.
" } }, "com.amazonaws.sms#GenerateTemplateRequest": { @@ -1411,13 +1415,13 @@ "appId": { "target": "com.amazonaws.sms#AppId", "traits": { - "smithy.api#documentation": "The ID of the application associated with the AWS CloudFormation template.
" + "smithy.api#documentation": "The ID of the application associated with the CloudFormation template.
" } }, "templateFormat": { "target": "com.amazonaws.sms#OutputFormat", "traits": { - "smithy.api#documentation": "The format for generating the AWS CloudFormation template.
" + "smithy.api#documentation": "The format for generating the CloudFormation template.
" } } } @@ -1514,7 +1518,7 @@ "roleName": { "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "The name of the service role in the customer's account that AWS CloudFormation uses to launch the\n application.
" + "smithy.api#documentation": "The name of the service role in the customer's account that CloudFormation uses to launch the\n application.
" } }, "autoLaunch": { @@ -1740,7 +1744,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the connectors registered with the AWS SMS.
", + "smithy.api#documentation": "Describes the connectors registered with the Server Migration Service.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -2038,7 +2042,7 @@ } ], "traits": { - "smithy.api#documentation": "Allows application import from AWS Migration Hub.
" + "smithy.api#documentation": "Allows application import from Migration Hub.
" } }, "com.amazonaws.sms#ImportAppCatalogRequest": { @@ -2047,7 +2051,7 @@ "roleName": { "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "The name of the service role. If you omit this parameter, we create a service-linked role\n for AWS Migration Hub in your account. Otherwise, the role that you provide must have the policy\n and trust policy described in the AWS Migration Hub User Guide.
" + "smithy.api#documentation": "The name of the service role. If you omit this parameter, we create a service-linked role\n for Migration Hub in your account. Otherwise, the role that you provide must have the policy\n and trust policy described in the Migration Hub User Guide.
" } } } @@ -2099,7 +2103,7 @@ "com.amazonaws.sms#InstanceId": { "type": "string", "traits": { - "smithy.api#pattern": "(^i-(\\w{8}|\\w{17})$)|(^mi-\\w{17}$)" + "smithy.api#pattern": "^(^i-(\\w{8}|\\w{17})$)|(^mi-\\w{17}$)$" } }, "com.amazonaws.sms#InstanceType": { @@ -2113,6 +2117,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InternalError", + "httpResponseCode": 500 + }, "smithy.api#documentation": "An internal error occurred.
", "smithy.api#error": "server", "smithy.api#httpError": 500 @@ -2126,6 +2134,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "InvalidParameter", + "httpResponseCode": 400 + }, "smithy.api#documentation": "A specified parameter is not valid.
", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2163,7 +2175,7 @@ } ], "traits": { - "smithy.api#documentation": "Launches the specified application as a stack in AWS CloudFormation.
" + "smithy.api#documentation": "Launches the specified application as a stack in CloudFormation.
" } }, "com.amazonaws.sms#LaunchAppRequest": { @@ -2317,6 +2329,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "MissingRequiredParameter", + "httpResponseCode": 400 + }, "smithy.api#documentation": "A required parameter is missing.
", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2333,6 +2349,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "NoConnectorsAvailable", + "httpResponseCode": 430 + }, "smithy.api#documentation": "There are no connectors available.
", "smithy.api#error": "client", "smithy.api#httpError": 430 @@ -2400,7 +2420,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides information to AWS SMS about whether application validation is successful.
" + "smithy.api#documentation": "Provides information to Server Migration Service about whether application validation is successful.
" } }, "com.amazonaws.sms#NotifyAppValidationOutputRequest": { @@ -2439,6 +2459,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "OperationNotPermitted", + "httpResponseCode": 403 + }, "smithy.api#documentation": "This operation is not allowed.
", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -2500,7 +2524,7 @@ "roleName": { "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "The name of service role in the customer's account that AWS CloudFormation uses to launch the\n application.
" + "smithy.api#documentation": "The name of service role in the customer's account that CloudFormation uses to launch the\n application.
" } }, "autoLaunch": { @@ -2688,7 +2712,7 @@ "roleName": { "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "The name of the IAM role to be used by AWS SMS.
" + "smithy.api#documentation": "The name of the IAM role to be used by Server Migration Service.
" } }, "latestAmiId": { @@ -2752,6 +2776,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReplicationJobAlreadyExists", + "httpResponseCode": 400 + }, "smithy.api#documentation": "The specified replication job already exists.
", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -2777,6 +2805,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReplicationJobNotFound", + "httpResponseCode": 404 + }, "smithy.api#documentation": "The specified replication job does not exist.
", "smithy.api#error": "client", "smithy.api#httpError": 404 @@ -2915,6 +2947,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ReplicationRunLimitExceeded", + "httpResponseCode": 429 + }, "smithy.api#documentation": "You have exceeded the number of on-demand replication runs you can request in a\n 24-hour period.
", "smithy.api#error": "client", "smithy.api#httpError": 429 @@ -3090,7 +3126,7 @@ "command": { "target": "com.amazonaws.sms#Command", "traits": { - "smithy.api#documentation": "The command to run the validation script
" + "smithy.api#documentation": "The command to run the validation script.
" } }, "executionTimeoutSeconds": { @@ -3174,6 +3210,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "ServerCannotBeReplicated", + "httpResponseCode": 400 + }, "smithy.api#documentation": "The specified server cannot be replicated.
", "smithy.api#error": "client", "smithy.api#httpError": 400 @@ -3343,7 +3383,7 @@ "logicalId": { "target": "com.amazonaws.sms#LogicalId", "traits": { - "smithy.api#documentation": "The logical ID of the server in the AWS CloudFormation template.
" + "smithy.api#documentation": "The logical ID of the server in the CloudFormation template.
" } }, "vpc": { @@ -3829,6 +3869,10 @@ "type": "structure", "members": {}, "traits": { + "aws.protocols#awsQueryError": { + "code": "TemporarilyUnavailable", + "httpResponseCode": 503 + }, "smithy.api#documentation": "The service is temporarily unavailable.
", "smithy.api#error": "server", "smithy.api#httpError": 503 @@ -3901,6 +3945,10 @@ } }, "traits": { + "aws.protocols#awsQueryError": { + "code": "UnauthorizedOperation", + "httpResponseCode": 403 + }, "smithy.api#documentation": "You lack permissions needed to perform this operation. Check your IAM policies,\n and ensure that you are using the correct access keys.
", "smithy.api#error": "client", "smithy.api#httpError": 403 @@ -3959,7 +4007,7 @@ "roleName": { "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "The name of the service role in the customer's account used by AWS SMS.
" + "smithy.api#documentation": "The name of the service role in the customer's account used by Server Migration Service.
" } }, "serverGroups": { @@ -4068,7 +4116,7 @@ "roleName": { "target": "com.amazonaws.sms#RoleName", "traits": { - "smithy.api#documentation": "The name of the IAM role to be used by AWS SMS.
" + "smithy.api#documentation": "The name of the IAM role to be used by Server Migration Service.
" } }, "description": { diff --git a/codegen/sdk/aws-models/snowball.2016-06-30.json b/codegen/sdk/aws-models/snowball.2016-06-30.json index 1e6bb0902ca..f5167b978c7 100644 --- a/codegen/sdk/aws-models/snowball.2016-06-30.json +++ b/codegen/sdk/aws-models/snowball.2016-06-30.json @@ -539,7 +539,10 @@ "type": "structure", "members": { "ConflictResource": { - "target": "com.amazonaws.snowball#String" + "target": "com.amazonaws.snowball#String", + "traits": { + "smithy.api#documentation": "You get this resource when you call CreateReturnShippingLabel more than once when other requests are not completed. .
Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.
Use the LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value,\n you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.
Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.
Use the AWS_LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value,\n you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.
Specifies the file transfer protocol or protocols over which your file transfer protocol\n client can connect to your server's endpoint. The available protocols are:
\n\n\n SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over\n SSH
\n FTPS (File Transfer Protocol Secure): File transfer with TLS\n encryption
\n FTP (File Transfer Protocol): Unencrypted file transfer
If you select FTPS, you must choose a certificate stored in Amazon Web Services Certificate\n Manager (ACM) which is used to identify your server when clients connect to it over\n FTPS.
If Protocol includes either FTP or FTPS, then the\n EndpointType must be VPC and the\n IdentityProviderType must be AWS_DIRECTORY_SERVICE or API_GATEWAY.
If Protocol includes FTP, then\n AddressAllocationIds cannot be associated.
If Protocol is set only to SFTP, the EndpointType\n can be set to PUBLIC and the IdentityProviderType can be set to\n SERVICE_MANAGED.
The protocol settings that are configured for your server.
\n\n Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols).\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n
Use the TlsSessionResumptionMode parameter to determine whether or not your Transfer server\n resumes recent, negotiated sessions through a unique session ID.
The public portion of the Secure Shell (SSH) key used to authenticate the user to the\n server.
" + "smithy.api#documentation": "The public portion of the Secure Shell (SSH) key used to authenticate the user to the\n server.
\n\n Currently, Transfer Family does not accept elliptical curve keys (keys beginning with ecdsa).\n
Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.
Use the LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value,\n you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.
Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.
Use the AWS_LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value,\n you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.
The identifier of the Amazon Web ServicesDirectory Service directory that you want to stop sharing.
" + "smithy.api#documentation": "The identifier of the Amazon Web Services Directory Service directory that you want to stop sharing.
" } }, "Function": { @@ -2738,7 +2744,7 @@ "IdentityProviderType": { "target": "com.amazonaws.transfer#IdentityProviderType", "traits": { - "smithy.api#documentation": "Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.
Use the LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value,\n you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.
Specifies the mode of authentication for a server. The default value is\n SERVICE_MANAGED, which allows you to store and access user credentials within\n the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to\n Active Directory groups in Amazon Web Services Managed Active Directory or Microsoft Active Directory in your\n on-premises environment or in Amazon Web Services using AD Connectors. This option also requires you to\n provide a Directory ID using the IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of your choosing. The\n API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call\n for authentication using the IdentityProviderDetails parameter.
Use the AWS_LAMBDA value to directly use a Lambda function as your identity provider. If you choose this value,\n you must specify the ARN for the lambda function in the Function parameter for the IdentityProviderDetails data type.
\n Indicates passive mode, for FTP and FTPS protocols.\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n For example:\n
\n\n \n aws transfer update-server --protocol-details PassiveIp=0.0.0.0\n \n
Replace \n 0.0.0.0\n in the example above with the actual IP address you want to use.
\n If you change the PassiveIp value, you must stop and then restart your Transfer server for the change to take effect. For details on using Passive IP (PASV) in a NAT environment, see Configuring your FTPS server behind a firewall or NAT with Amazon Web Services Transfer Family.\n
A property used with Transfer servers that use the FTPS protocol. TLS Session Resumption provides a mechanism to resume or share a negotiated secret\n key between the control and data connection for an FTPS session. TlsSessionResumptionMode determines whether or not the server resumes recent,\n negotiated sessions through a unique session ID. This property is available during CreateServer and UpdateServer calls.\n If a TlsSessionResumptionMode value is not specified during CreateServer, it is set to ENFORCED by default.
\n DISABLED: the server does not process TLS session resumption client requests and creates a new TLS session for each request.
\n ENABLED: the server processes and accepts clients that are performing TLS session resumption.\n The server doesn't reject client data connections that do not perform the TLS session resumption client processing.
\n ENFORCED: the server processes and accepts clients that are performing TLS session resumption.\n The server rejects client data connections that do not perform the TLS session resumption client processing.\n Before you set the value to ENFORCED, test your clients.
Not all FTPS clients perform TLS session resumption. So, if you choose to enforce\n TLS session resumption, you prevent any connections from FTPS clients that don't perform\n the protocol negotiation. To determine whether or not you can use the\n ENFORCED value, you need to test your clients.
\n The protocol settings that are configured for your server.\n
\n\n This type is only valid in the UpdateServer API.\n
\n The protocol settings that are configured for your server.\n
" } }, "com.amazonaws.transfer#Protocols": { @@ -3924,6 +3936,25 @@ "smithy.api#httpError": 429 } }, + "com.amazonaws.transfer#TlsSessionResumptionMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DISABLED", + "name": "DISABLED" + }, + { + "value": "ENABLED", + "name": "ENABLED" + }, + { + "value": "ENFORCED", + "name": "ENFORCED" + } + ] + } + }, "com.amazonaws.transfer#TransferService": { "type": "service", "traits": { @@ -4233,7 +4264,7 @@ "ProtocolDetails": { "target": "com.amazonaws.transfer#ProtocolDetails", "traits": { - "smithy.api#documentation": "\n The protocol settings that are configured for your server.\n
\n\n Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols).\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n
\n The protocol settings that are configured for your server.\n
\n\n Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols).\n Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.\n
Use the TlsSessionResumptionMode parameter to determine whether or not your Transfer server\n resumes recent, negotiated sessions through a unique session ID.
Deletes the email monitoring configuration for a specified organization.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#DeleteEmailMonitoringConfigurationRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "The ID of the organization from which the email monitoring configuration is deleted.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#DeleteEmailMonitoringConfigurationResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.workmail#DeleteGroup": { "type": "operation", "input": { @@ -1604,6 +1644,62 @@ "type": "structure", "members": {} }, + "com.amazonaws.workmail#DescribeEmailMonitoringConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#DescribeEmailMonitoringConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.workmail#DescribeEmailMonitoringConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + }, + { + "target": "com.amazonaws.workmail#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Describes the current email monitoring configuration for a specified organization.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#DescribeEmailMonitoringConfigurationRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "The ID of the organization for which the email monitoring configuration is described.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#DescribeEmailMonitoringConfigurationResponse": { + "type": "structure", + "members": { + "RoleArn": { + "target": "com.amazonaws.workmail#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.
" + } + }, + "LogGroupArn": { + "target": "com.amazonaws.workmail#LogGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.
" + } + } + } + }, "com.amazonaws.workmail#DescribeGroup": { "type": "operation", "input": { @@ -4269,6 +4365,16 @@ } } }, + "com.amazonaws.workmail#LogGroupArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 47, + "max": 562 + }, + "smithy.api#pattern": "^arn:aws:logs:[a-z\\-0-9]*:[0-9]{12}:log-group:([\\.\\-_/#A-Za-z0-9]+):\\*$" + } + }, "com.amazonaws.workmail#MailDomainInUseException": { "type": "structure", "members": { @@ -5062,6 +5168,63 @@ "type": "structure", "members": {} }, + "com.amazonaws.workmail#PutEmailMonitoringConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.workmail#PutEmailMonitoringConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.workmail#PutEmailMonitoringConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.workmail#InvalidParameterException" + }, + { + "target": "com.amazonaws.workmail#OrganizationNotFoundException" + }, + { + "target": "com.amazonaws.workmail#OrganizationStateException" + }, + { + "target": "com.amazonaws.workmail#ResourceNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Creates or updates the email monitoring configuration for a specified organization.
", + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.workmail#PutEmailMonitoringConfigurationRequest": { + "type": "structure", + "members": { + "OrganizationId": { + "target": "com.amazonaws.workmail#OrganizationId", + "traits": { + "smithy.api#documentation": "The ID of the organization for which the email monitoring configuration is set.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.workmail#RoleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM Role associated with the email monitoring configuration.
", + "smithy.api#required": {} + } + }, + "LogGroupArn": { + "target": "com.amazonaws.workmail#LogGroupArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the CloudWatch Log group associated with the email monitoring configuration.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.workmail#PutEmailMonitoringConfigurationResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.workmail#PutInboundDmarcSettings": { "type": "operation", "input": { @@ -6515,6 +6678,21 @@ }, "com.amazonaws.workmail#WorkMailService": { "type": "service", + "traits": { + "aws.api#service": { + "sdkId": "WorkMail", + "arnNamespace": "workmail", + "cloudFormationName": "WorkMail", + "cloudTrailEventSource": "workmail.amazonaws.com", + "endpointPrefix": "workmail" + }, + "aws.auth#sigv4": { + "name": "workmail" + }, + "aws.protocols#awsJson1_1": {}, + "smithy.api#documentation": "Amazon WorkMail is a secure, managed business email and calendaring service with support for\n existing desktop and mobile email clients. You can access your email, contacts, and\n calendars using Microsoft Outlook, your browser, or other native iOS and Android email\n applications. You can integrate WorkMail with your existing corporate directory and control\n both the keys that encrypt your data and the location in which your data is\n stored.
\nThe WorkMail API is designed for the following scenarios:
\nListing and describing organizations
\nManaging users
\nManaging groups
\nManaging resources
\nAll WorkMail API operations are Amazon-authenticated and certificate-signed. They not\n only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management\n users and roles to help facilitate access, trust, and permission policies. By creating a\n role and allowing an IAM user to access the WorkMail site, the IAM user gains full\n administrative visibility into the entire WorkMail organization (or as set in the IAM\n policy). This includes, but is not limited to, the ability to create, update, and delete\n users, groups, and resources. This allows developers to perform the scenarios listed above,\n as well as give users the ability to grant access on a selective basis using the IAM\n model.
", + "smithy.api#title": "Amazon WorkMail" + }, "version": "2017-10-01", "operations": [ { @@ -6550,6 +6728,9 @@ { "target": "com.amazonaws.workmail#DeleteAlias" }, + { + "target": "com.amazonaws.workmail#DeleteEmailMonitoringConfiguration" + }, { "target": "com.amazonaws.workmail#DeleteGroup" }, @@ -6580,6 +6761,9 @@ { "target": "com.amazonaws.workmail#DeregisterMailDomain" }, + { + "target": "com.amazonaws.workmail#DescribeEmailMonitoringConfiguration" + }, { "target": "com.amazonaws.workmail#DescribeGroup" }, @@ -6667,6 +6851,9 @@ { "target": "com.amazonaws.workmail#PutAccessControlRule" }, + { + "target": "com.amazonaws.workmail#PutEmailMonitoringConfiguration" + }, { "target": "com.amazonaws.workmail#PutInboundDmarcSettings" }, @@ -6712,22 +6899,7 @@ { "target": "com.amazonaws.workmail#UpdateResource" } - ], - "traits": { - "aws.api#service": { - "sdkId": "WorkMail", - "arnNamespace": "workmail", - "cloudFormationName": "WorkMail", - "cloudTrailEventSource": "workmail.amazonaws.com", - "endpointPrefix": "workmail" - }, - "aws.auth#sigv4": { - "name": "workmail" - }, - "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon WorkMail is a secure, managed business email and calendaring service with support for\n existing desktop and mobile email clients. You can access your email, contacts, and\n calendars using Microsoft Outlook, your browser, or other native iOS and Android email\n applications. You can integrate WorkMail with your existing corporate directory and control\n both the keys that encrypt your data and the location in which your data is\n stored.
\nThe WorkMail API is designed for the following scenarios:
\nListing and describing organizations
\nManaging users
\nManaging groups
\nManaging resources
\nAll WorkMail API operations are Amazon-authenticated and certificate-signed. They not\n only require the use of the AWS SDK, but also allow for the exclusive use of AWS Identity and Access Management\n users and roles to help facilitate access, trust, and permission policies. By creating a\n role and allowing an IAM user to access the WorkMail site, the IAM user gains full\n administrative visibility into the entire WorkMail organization (or as set in the IAM\n policy). This includes, but is not limited to, the ability to create, update, and delete\n users, groups, and resources. This allows developers to perform the scenarios listed above,\n as well as give users the ability to grant access on a selective basis using the IAM\n model.
", - "smithy.api#title": "Amazon WorkMail" - } + ] } } }